nts-scripts

Simple npm scripts and common devDependencies to help build a Node TypeScript app.

Inspired by Create React App's react-scripts package 👏

Included dependencies

- TypeScript
- Jest
- Eslint
- Prettier
- Along with other TypeScript supporting dependencies. See the package.json file for the full list.

Available scripts

$3

Compiles your TypeScript. Expects a tsconfig.json file with an include property and a compilerOptions.outDir property.

$3

Deletes your compiled TypeScript. Expects a tsconfig.json file with a compilerOptions.outDir property.

$3

Runs prettier against all files. Uses your .gitignore file if it exists to ignore. Semi-customizable with args.

$3

Runs eslint against all files. Uses your .gitignore file if it exists to ignore. Semi-customizable with args.

$3

Cleans, builds, and starts your Node project with debugging enabled. Targets the main property in your package.json first and falls back to the outDir property second. Semi-customizable with args.

$3

Essentially the same as start except your project will re-build/start when changes are seen in your outDir. Semi-customizable with args.

Project requirements

$3

At a minimum the properties below are required. The values can be customized.

``json
{
"compilerOptions": {
"outDir": "./build"
},
"include": ["./src"]
}
`

$3

At least ignore the folders below. NOTE: If you customized the outDir in your tsconfig.json, update the build line here to match.

`
build
coverage
node_modules
`

$3

An eslint config is required. Below is the simplest setup.

`js
module.exports = {
extends: [
'plugin:@typescript-eslint/recommended',
'plugin:prettier/recommended',
'prettier',
],
parser: '@typescript-eslint/parser',
};
`

$3

The config below is required.

`js
module.exports = {
'.ts, .js': {
style: 'module',
parser: 'typescript',
},
};
`

$3

At a minimum the config below is required. NOTE: If you customized the outDir in your tsconfig.json, update '/build/' to match.

`js
module.exports = {
preset: 'ts-jest',
testPathIgnorePatterns: ['/build/', '/node_modules/'],
};
`

Project recommendations

$3

It's recommended you setup a Prettier configuration file.

$3

Using nvm along with an .nvmrc` file to automatically switch to the appropriate version of Node can be extremely helpful.

$3

If you're using VS Code, a project-level settings file may be helpful to customize your experience.