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

???? gd-scripts ????

CLI with common scripts to build, test and run my projects, inspired from kcd-scripts.

CI Status npm version npm downloads

Introduction

This is a CLI that abstracts away all configuration for my open source projects including linting, testing, building, running, and more.

Installation

npm:

npm install --save-dev gd-scripts

yarn:

yarn add -D gd-scripts

Usage

This is a CLI and exposes a bin called gd-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 packages/gd-scripts/src/scripts.

This project is also used to run scripts like building and testing on 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 gd-scripts.

Configuration

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

Note: gd-scripts intentionally does not merge things for you when you start extending configs 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.

eslint

To enable editor support for eslint, you can create a .eslintrc.js file on the root folder, containing:

module.exports = require('gd-scripts/eslint')

Or if you want to extend it:

const baseConfig = require('gd-scripts/eslint')

const extendedConfig = {
  // ...
}

module.exports = {
  ...baseConfig,
  ...extendedConfig,
}

prettier

To enable editor support for prettier, you can create a .prettierrc.js file on the root folder, containing:

module.exports = require('gd-scripts/prettier')

typescript

To enable editor support for typescript, you can create a tsconfig.json file on the root folder, containing:

{
  "extends": "./node_modules/gd-scripts/typescript.json"
}

Or if you want to extend it:

{
  "extends": "./node_modules/gd-scripts/typescript.json",
  "compilerOptions": {
    // ...
  }
}

semantic-release

In order to use the default config for semantic-release, you can add a release.config.js file on the root of your project, containing:

module.exports = require('gd-scripts/release.config')

Or if you want to extend it:

const baseConfig = require('gd-scripts/release.config')

const extendedConfig = {
  // ...
}

module.exports = {
  ...baseConfig,
  ...extendedConfig,
}

Inspiration

This is inspired by kcd-scripts, which is heavy inspired by react-scripts.

LICENSE

MIT

Current Tags

  • 6.0.2                                ...           latest (4 months ago)
  • 0.0.0-beta.16                                ...           next (a year ago)

88 Versions

  • 6.0.2                                ...           4 months ago
  • 6.0.1                                ...           4 months ago
  • 6.0.0                                ...           4 months ago
  • 5.0.9                                ...           9 months ago
  • 5.0.8                                ...           a year ago
  • 5.0.7                                ...           a year ago
  • 5.0.6                                ...           a year ago
  • 5.0.5                                ...           a year ago
  • 5.0.4                                ...           a year ago
  • 5.0.3                                ...           a year ago
  • 5.0.2                                ...           a year ago
  • 5.0.1                                ...           a year ago
  • 5.0.0                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 0.0.0-beta.16                                ...           a year ago
  • 0.0.0                                ...           a year ago
  • 0.0.0-beta.15                                ...           a year ago
  • 0.0.0-beta.14                                ...           a year ago
  • 0.0.0-beta.13                                ...           a year ago
  • 0.0.0-beta.12                                ...           a year ago
  • 0.0.0-beta.11                                ...           2 years ago
  • 0.0.0-beta.10                                ...           2 years ago
  • 0.0.0-beta.9                                ...           2 years ago
  • 3.1.4                                ...           2 years ago
  • 0.0.0-beta.8                                ...           2 years ago
  • 3.1.3                                ...           2 years ago
  • 0.0.0-beta.7                                ...           2 years ago
  • 0.0.0-beta.6                                ...           2 years ago
  • 0.0.0-beta.5                                ...           2 years ago
  • 0.0.0-beta.4                                ...           2 years ago
  • 3.1.2                                ...           2 years ago
  • 0.0.0-beta.3                                ...           2 years ago
  • 0.0.0-beta.2                                ...           2 years ago
  • 0.0.0-beta.1                                ...           2 years ago
  • 0.0.0-beta.0                                ...           2 years ago
  • 3.1.1                                ...           2 years ago
  • 3.1.0                                ...           2 years ago
  • 3.0.1                                ...           2 years ago
  • 1.4.0-beta.13                                ...           2 years ago
  • 1.4.0-beta.12                                ...           2 years ago
  • 3.0.0                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 1.4.0-beta.11                                ...           2 years ago
  • 1.4.0-beta.10                                ...           2 years ago
  • 1.4.0-beta.9                                ...           2 years ago
  • 1.4.0-beta.8                                ...           2 years ago
  • 1.4.0-beta.7                                ...           2 years ago
  • 1.4.0-beta.6                                ...           2 years ago
  • 1.4.0-beta.5                                ...           2 years ago
  • 1.4.0-beta.4                                ...           2 years ago
  • 1.4.0-beta.3                                ...           2 years ago
  • 1.4.0-beta.2                                ...           2 years ago
  • 1.4.0-beta.1                                ...           2 years ago
  • 1.3.4                                ...           2 years ago
  • 1.3.3                                ...           2 years ago
  • 1.3.2                                ...           2 years ago
  • 1.3.1                                ...           2 years ago
  • 1.3.0                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.3-beta.6                                ...           2 years ago
  • 1.0.2-beta.5                                ...           2 years ago
  • 1.0.2-beta.4                                ...           2 years ago
  • 1.0.2-beta.3                                ...           2 years ago
  • 1.0.2-beta.2                                ...           2 years ago
  • 1.0.2-beta.1                                ...           2 years ago
  • 1.0.2-beta.0                                ...           2 years ago
  • 1.0.2-beta                                ...           2 years ago
  • 0.0.1-beta                                ...           2 years ago
  • 0.0.0-development                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.1.13                                ...           2 years ago
  • 0.1.12                                ...           2 years ago
  • 0.1.11                                ...           2 years ago
  • 0.1.10                                ...           2 years ago
  • 0.1.9                                ...           2 years ago
  • 0.1.8                                ...           2 years ago
  • 0.1.7                                ...           2 years ago
  • 0.1.6                                ...           2 years ago
  • 0.1.5                                ...           2 years ago
  • 0.1.4                                ...           2 years ago
  • 0.1.3                                ...           2 years ago
  • 0.1.2                                ...           2 years ago
  • 0.1.1                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (29)
Dev Dependencies (17)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |