joaopalmeiro / template-ts-jiti-script

Opinionated TypeScript + jiti template for new scripts.

template-ts-jiti-script

Opinionated TypeScript + jiti template for new scripts.

Getting Started

1. Go to or create the project folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-ts-jiti-script

or

npx degit github:joaopalmeiro/template-ts-jiti-script --force

3. Search for template-ts-jiti-script and replace it with the project name. Ignore the template repository URL in the NOTES.md file.
4. Search for Opinionated TypeScript + jiti template for new scripts./Opinionated [TypeScript](https://www.typescriptlang.org/) + [jiti](https://github.com/unjs/jiti) template for new scripts. and replace it with the (short) project description.
5. Search for João Palmeiro and replace it with the author's name.
6. Search for [e-mail] and replace it with the author's email address.
7. Change the author.url field in the package.json file to the author's website/social media profile.
8. Install fnm (if necessary).
9. Run the first two commands in the Development section to install Node.js and the development dependencies.
10. Open the NOTES.md file and install the project-specific dependencies according to the first command in the Commands section. Run the second command if you are going to use Node.js modules.
11. Delete the TEMPLATE.md file.
12. Delete the Getting Started section.

Development

Install fnm (if necessary).

fnm install && fnm use && node --version && npm --version

npm install

npm run dev

npm run lint

npm run format