hardchor-scripts
CLI for common scripts for my projects
Last updated 3 months ago by hardchor .
MIT · Original npm · Tarball · package.json
$ cnpm install hardchor-scripts 
SYNC missed versions from official npm registry.

hardchor-scripts ????????

CLI toolbox for common scripts for my projects


[![Build Status][build-badge]][build] [![Code Coverage][coverage-badge]][coverage] version downloads MIT License

PRs Welcome Watch on GitHub Star on GitHub

Initially forked from kcd-scripts and amended to my needs!

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

Usage

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

Overriding Config

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

Or, for jest:

const { jest: jestConfig } = require('hardchor-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: hardchor-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.

Inspiration

This is inspired by kcd-scripts and react-scripts.

Current Tags

  • 0.0.5                                ...           latest (3 months ago)

1 Versions

  • 0.0.5                                ...           3 months ago

Copyright 2014 - 2016 © taobao.org |