ada-scripts
CLI for common scripts for my projects
Last updated 2 days ago by talves .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install ada-scripts 
SYNC missed versions from official npm registry.

ada-scripts ????????

CLI toolbox for common scripts for my projects


Code Coverage version downloads MIT License

All Contributors PRs Welcome Code of Conduct

Watch on GitHub Star on GitHub Tweet

The problem

Kent C. Dodds did a bunch of open source and wanted to make it easier to maintain so many projects. I will follow his pattern, because it's Kent and he has done the hard part for us! A lot of the wording here was from the original fork. See kcd-scripts for original.

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 ada-scripts

or

yarn add ada-scripts --dev

Usage

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

Overriding Config

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

Or, for jest:

const {jest: jestConfig} = require('ada-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: ada-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 ada-scripts. If you customised your .babelrc-file you might need to manually add @babel/preset-flow to the presets-section.

Inspiration

This is heavily inspired by kcd-scripts which was inspired by react-scripts.

Other Solutions

If you want to make your own, I recommend you fork kcd-scripts! This is a specific to me solution.

Contributors

Thanks goes to these people (emoji key):

Tony Alves
Tony Alves

????
Kent C. Dodds
Kent C. Dodds

???? ???? ???? ⚠️

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

LICENSE

MIT

Current Tags

  • 2.0.2                                ...           latest (2 days ago)

3 Versions

  • 2.0.2                                ...           2 days ago
  • 2.0.1                                ...           3 months ago
  • 2.0.0                                ...           6 months ago
Maintainers (1)
Downloads
Today 0
This Week 12
This Month 12
Last Day 12
Last Week 0
Last Month 3
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |