Skip to content
CLI toolbox for common scripts for my projects
JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 23 commits ahead, 14 commits behind kentcdodds:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: fix npm registry Sep 16, 2019
src feat(jest): add fetch polyfill using react-app-polyfill Oct 3, 2019
.eslintignore
.gitattributes
.gitignore
.npmrc feat: kcd -> cod Sep 15, 2019
CHANGELOG.md feat: kcd -> cod Sep 15, 2019
CONTRIBUTING.md
LICENSE docs: update LICENSE Sep 16, 2019
README.md
babel.js feat: kcd -> cod Sep 15, 2019
commitlint.js
config.js feat: kcd -> cod Sep 15, 2019
eslint.js
jest.config.js
jest.js
package.json
prettier.js

README.md

cod-scripts 🛠📦

CLI toolbox for common scripts for my projects


Build Status Code Coverage version downloads MIT License

PRs Welcome Code of Conduct

Watch on GitHub Star on GitHub Tweet

The problem

I do a bunch of open source and want to make it easier to maintain so many projects.

This solution

This is a CLI that abstracts away all configuration for my open source projects for linting, testing, building, and more.

Table of Contents

Installation

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

Usage

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 commitlint, a commitlint.config.js file or commitlint prop in package.json:

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

module.exports = {
  ...commitlintConfig,
  rules: {
    // overrides here
  },
};
// package.json
{
  "commitlint": {
    "extends": ["./node_modules/cod-scripts/commitlint"],
    "rules": {
      // your overrides here
      // https://commitlint.js.org/#/reference-rules
    }
  }
}

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.

Flow support

If the flow-bin is a dependency on the project the @babel/preset-flow 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-flow to the presets-section.

Inspiration

This is inspired by react-scripts.

LICENSE

MIT

You can’t perform that action at this time.