anvilabs-scripts

Opinionated CLI toolkits for our Node / Backpack projects. See individual packages in packages.

NOTE: we use TypeScript in our projects, so these toolkits are specifically tailored for usage with TypeScript.

Installation

Install the wanted toolkit as a development dependency:

$ yarn add anvilabs-scripts-x --dev
# or
$ npm install anvilabs-scripts-x --save-dev

NOTE: it includes all the dependencies (babel, eslint, tslint, typescript, prettier, jest, etc) so you don't have to install them.

Available toolkits include:

• anvilabs-scripts-node.
• anvilabs-scripts-backpack.

Usage

The packages hosted in these repo expose binaries called anvilabs-scripts-x (e.g. anvilabs-scripts-node):

$ anvilabs-scripts-x [script] [options]

You can find all available scripts in the src/scripts of the respective package in packages.

Overriding Config

You can specify your own config for some scripts bundled with a given toolkit. There are various ways that it works, but basically if you want to have your own config for something, just add the config and the toolkit will use that instead of it's own internal config. In addition, all toolkits expose their configs so you can use them 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.js with the contents of:

module.exports = {
  extends: 'anvilabs-scripts-node/eslint',
};

Or, for babel, a .babelrc with:

{
  "presets": ["anvilabs-scripts-node/babel"]
}

Or, for jest, a jest.config.js with:

module.exports = {
  ...require('anvilabs-scripts-node/jest'),
  // your overrides
});

Or, for tsc, a tsconfig.json with:

{
  "extends": "./node_modules/anvilabs-scripts-node/tsconfig.json",
  "compilerOptions": {
    "baseUrl": "./"
  },
  "include": ["*/*.json", "src/**/*.js", "src/**/*.ts", "typings/**/*.d.ts"],
  "exclude": ["node_modules", "src/**/__tests__"]
}

Or, for tslint, a tslint.json with:

{
  "extends": "anvilabs-scripts-node/tslint.json"
}

Or, for backpack, a backpack.config.js with:

module.exports = {
  webpack: (config, options, webpack) => ({
    ...require('anvilabs-scripts-backpack/backpack').webpack(config),
    // your overrides
  }),
};

Credits

Inspired by:

• react-scripts
• kcd-scripts
• d-scripts

License

MIT License © Anvilabs LLC