CLI for common scripts for my projects

npm install cod-scripts@10.0.0


cod-scripts 🛠📦

CLI toolbox for common scripts for my projects

version downloads GitHub Workflow Status MIT License PRs Welcome Semantic Release Commitizen friendly


This helps me maintain personal & work projects without duplication. This is a CLI that abstracts away all configuration for my open source projects for linting, testing, building, and more.

Table of Contents


This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev cod-scripts
npm install --save @babel/runtime

Husky Setup

In order to take advantage of the pre-commit script & lint-staged configuration in cod-scripts, you'll need to setup husky in addition to installing this package.

First time installing cod-scripts

If this is the first time installing cod-scripts in your project, run the following:

npx husky install
npm set-script prepare "husky install"
npx husky add .husky/pre-commit 'npx --no-install cod-scripts pre-commit'
npx husky add .husky/commit-msg 'npx --no-install cod-scripts commitlint --edit "$1"'

Note: See the overriding lint-staged section below to see how you can extend the lint-staged script from cod-scripts.

Upgrading from an older version of cod-scripts

Just running the following should work:

npm exec -- github:typicode/husky-4-to-7 --remove-v4-config
npm set-script prepare "husky install"

Important: You will need to edit .husky/commit-msg after running the above command. Change -E HUSKY_GIT_PARAMS --> --edit $1.

Note: Run npm install -g npm if the above command fails. You may be running an older version of npm that doesn't have the exec command.


This is a CLI and exposes a bin called cod-scripts. I don't really plan on documenting or testing it super duper well because it's really specific to my needs. You'll find all available scripts in src/scripts.

This project actually dogfoods itself. If you look in the package.json, you'll find scripts with node src {scriptName}. This serves as an example of some of the things you can do with cod-scripts.

Overriding Config

Unlike react-scripts, cod-scripts allows you to specify your own configuration for things and have that plug directly into the way things work with cod-scripts. There are various ways that it works, but basically if you want to have your own config for something, just add the configuration and cod-scripts will use that instead of it's own internal config. In addition, cod-scripts exposes its configuration so you can use it and override only the parts of the config you need to.

This can be a very helpful way to make editor integration work for tools like ESLint which require project-based ESLint configuration to be present to work.


So, if we were to do this for ESLint, you could create an .eslintrc with the contents of:

{"extends": "./node_modules/cod-scripts/eslint.js"}

Note: for now, you'll have to include an .eslintignore in your project until this eslint issue is resolved.


Or, for babel, a .babelrc with:

{"presets": ["cod-scripts/babel"]}


Or, for jest:

const {jest: jestConfig} = require('cod-scripts/config')

module.exports = Object.assign(jestConfig, {
  // your overrides here

  // for test written in Typescript, add:
  transform: {
    '\\.(ts|tsx)$': '<rootDir>/node_modules/ts-jest/preprocessor.js',


Or, for lint-staged:

// lint-staged.config.js or .lintstagedrc.js
const {lintStaged} = require('cod-scripts/config')

module.exports = {
  '': [`${doctoc} --maxlevel 3 --notitle`],


Or, for commitlint, a commitlint.config.js file or commitlint prop in package.json:

// commitlint.config.js or .commitlintrc.js
const {commitlint} = require('cod-scripts/config')

module.exports = {
  rules: {
    // overrides here
// package.json
  "commitlint": {
    "extends": ["./node_modules/cod-scripts/commitlint"],
    "rules": {
      // your overrides here

Note: cod-scripts intentionally does not merge things for you when you start configuring things to make it less magical and more straightforward. Extending can take place on your terms. I think this is actually a great way to do this.

TypeScript Support

If the tsconfig.json-file is present in the project root directory and typescript is a dependency the @babel/preset-typescript will automatically get loaded when you use the default babel config that comes with cod-scripts. If you customised your .babelrc-file you might need to manually add @babel/preset-typescript to the presets-section.

cod-scripts will automatically load any .ts and .tsx files, including the default entry point, so you don't have to worry about any rollup configuration.

If you have a typecheck script (normally set to kcd-scripts typecheck) that will be run as part of the validate script (which is run as part of the pre-commit script as well).

TypeScript definition files will also automatically be generated during the build script.