dr-scripts

CLI toolbox providing common scripts for Node.js projects.

Usage no npm install needed!

<script type="module">
  import drScripts from 'https://cdn.skypack.dev/dr-scripts';
</script>

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:

  1. Prerequisite: Have Node.js and NPM installed.
  2. Clone the repository and cd into it.
  3. Run npm install.

Usage

When creating a new repository/starting a new project:

  1. Create and intialize a new Git repository: mkdir repo-name && cd repo-name && git init
  2. Initialize the project with a name and files: npx dr-scripts init-repo repo-name
  3. 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.