This is a template repo for Node.js projects written in TypeScript. This template works for libraries and/or CLIs.
Create a new git repo and copy the contents of this repo into it.
If you don't need a CLI, then:
- Delete the following files and directories:
binsrc/clitest/specs/cli.spec.jstest/utils/project-cli-name.js
- Delete the following fields in
package.json:binfiles.bindevDependencies.chai-execdependencies.command-line-args
Replace all occurrences of the following placeholders in all files:
| Placeholder | Description |
|---|---|
project-package-name | This is the name of the NPM package. It should also match the GitHub repo name. It should be kebab-cased. |
project-cli-name | The name of the CLI program for this project, if any. |
projectExportName | The name of the library's default export, if any. This should be a valid JavaScript identifier name. |
Friendly Project Name | This is the human friendly name of the project that is used in the ReadMe, descriptions, and docs pages |
This is the project description | A short, human friendly description of the project that is used in the ReadMe and package.json |
Find all "TODO" notes in the code and follow their instructions.
Delete this file and replace it with README_md.