Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
nts-scripts
Advanced tools
Simple npm `scripts` and common `devDependencies` to help build a Node TypeScript app.
Simple npm scripts
and common devDependencies
to help build a Node TypeScript app.
Inspired by Create React App's react-scripts package 👏
build
Compiles your TypeScript. Expects a tsconfig.json
file with an include
property and a compilerOptions.outDir
property.
clean
Deletes your compiled TypeScript. Expects a tsconfig.json
file with a compilerOptions.outDir
property.
format
Runs prettier
against all files. Uses your .gitignore
file if it exists to ignore. Semi-customizable with args.
lint
Runs eslint
against all files. Uses your .gitignore
file if it exists to ignore. Semi-customizable with args.
start
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.
watch
Essentially the same as start
except your project will re-build/start when changes are seen in your outDir
. Semi-customizable with args.
tsconfig.json
At a minimum the properties below are required. The values can be customized.
{
"compilerOptions": {
"outDir": "./build"
},
"include": ["./src"]
}
.gitignore
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
.eslintrc.js
An eslint config is required. Below is the simplest setup.
module.exports = {
extends: [
'plugin:@typescript-eslint/recommended',
'plugin:prettier/recommended',
'prettier',
],
parser: '@typescript-eslint/parser',
};
.importsortrc.js
The config below is required.
module.exports = {
'.ts, .js': {
style: 'module',
parser: 'typescript',
},
};
jest.config.js
At a minimum the config below is required. NOTE: If you customized the outDir
in your tsconfig.json
, update '<rootDir>/build/'
to match.
module.exports = {
preset: 'ts-jest',
testPathIgnorePatterns: ['<rootDir>/build/', '<rootDir>/node_modules/'],
};
.prettierrc.js
It's recommended you setup a Prettier configuration file.
.nvmrc
Using nvm
along with an .nvmrc
file to automatically switch to the appropriate version of Node can be extremely helpful.
.vscode/settings.json
If you're using VS Code, a project-level settings file may be helpful to customize your experience.
FAQs
Simple npm `scripts` and common `devDependencies` to help build a Node TypeScript app.
We found that nts-scripts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.