---

[![version][version-badge]][package]
[![downloads][downloads-badge]][npmcharts]
[![GitHub Workflow Status][actions-badge]][actions-badge]
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]
[![Semantic Release][semantic-release-badge]][semantic-release]
[![Commitizen friendly][commitizen-badge]][commitizen]

Motivation

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

- Installation
- Husky Setup
- Usage
- Overriding Config
- TypeScript Support
- LICENSE

Installation

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

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

$3

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:

`sh
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:

`sh
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.

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.

$3

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.

#### eslint

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

`json
{"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.

#### babel

Or, for babel, a .babelrc with:

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

#### jest

Or, for jest:

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

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

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

#### lint-staged

Or, for lint-staged:

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

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

#### commitlint

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

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

module.exports = {
...commitlint,
rules: {
// overrides here
},
}
`

`json
// 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.

$3

As of this writing, jest esmodule support is still a
WIP. If you're testing a nodejs
esmodule, you need to pass the --experimental-vm-modules flag to node. For
example:

package.json

`json
"scripts": {
"test": "NODE_OPTIONS=--experimental-vm-modules cod-scripts test"
}
`

See:

$3

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.

LICENSE

MIT

[npm]: https://www.npmjs.com
[node]: https://nodejs.org
[semantic-release]: https://github.com/semantic-release/semantic-release
[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[prs]: http://makeapullrequest.com
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[commitizen]: http://commitizen.github.io/cz-cli/
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[npmcharts]: http://npmcharts.com/compare/cod-scripts
[version-badge]: https://img.shields.io/npm/v/cod-scripts.svg?style=flat-square
[package]: https://www.npmjs.com/package/cod-scripts
[downloads-badge]: https://img.shields.io/npm/dm/cod-scripts.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/cod-scripts.svg?style=flat-square
[license]: https://github.com/codfish/cod-scripts/blob/master/LICENSE
[actions]: https://github.com/codfish/cod-scripts/actions
[actions-badge]: https://img.shields.io/github/workflow/status/codfish/cod-scripts/Release/master