npm

Need private packages and team management tools?Check out npm Orgs. »

kcd-scripts

1.7.0 • Public • Published

kcd-scripts 🛠📦

CLI toolbox for common scripts for my projects


Build Status Code Coverage version downloads MIT License

All Contributors 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 kcd-scripts

Usage

This is a CLI and exposes a bin called kcd-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 kcd-scripts.

Overriding Config

Unlike react-scripts, kcd-scripts allows you to specify your own configuration for things and have that plug directly into the way things work with kcd-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 kcd-scripts will use that instead of it's own internal config. In addition, kcd-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/kcd-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": ["kcd-scripts/babel"]}

Or, for jest:

const {jest: jestConfig} = require('kcd-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',
  },
})

Note: kcd-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 kcd-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.

Other Solutions

I'm not aware of any, if you are please make a pull request and add it here! Again, this is a very specific-to-me solution.

Contributors

Thanks goes to these people (emoji key):

Kent C. Dodds
Kent C. Dodds

💻 📖 🚇 ⚠️
Suhas Karanth
Suhas Karanth

💻 🐛 ⚠️
Matt Parrish
Matt Parrish

💻 ⚠️
Mateus
Mateus

💻 ⚠️
Macklin Underdown
Macklin Underdown

💻 ⚠️
stereobooster
stereobooster

💻 ⚠️
Dony Sukardi
Dony Sukardi

🐛 💻
Alexander Nanberg
Alexander Nanberg

💻
Alex Liang
Alex Liang

💻
Jeff Detmer
Jeff Detmer

💻
Alex Zherdev
Alex Zherdev

💻
Adam Harrington
Adam Harrington

💻 ⚠️
Adrià Fontcuberta
Adrià Fontcuberta

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT

Keywords

none

install

npm i kcd-scripts

Downloadsweekly downloads

1,243

version

1.7.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability