README
dr-scripts
CLI toolbox providing common scripts for Node.js projects.
Adapted from Kent C. Dodds' kcd-scripts package and "How toolkits (like react-scripts) work" video.
Purpose
dr-scripts is a CLI tool that abstracts away configuration for Node.js projects. It's responsible for:
- Formatting
- Initializing new repositories (see below for Usage)
- Linting
- Testing
- Validating commit messages
- Validating the codebase pre-commit
Installation
To work on this toolbox:
Usage
When creating a new repository/starting a new project:
- Create and intialize a new Git repository:
mkdir repo-name && cd repo-name && git init
- Initialize the project with a name and files:
npx dr-scripts init-repo repo-name
- Install dr-scripts as a development dependency:
npm install --save-dev dr-scripts
After completing the above steps, open the package.json
file to see the results of the init-repo
script.