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

skod-scripts

Handle node projects development tasks with no configuration.

Install

$ yarn add --dev skod-scripts

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

Usage

skod-scripts exposes a series of scripts to handle development tasks.

$ skod-scripts [script] [options]

Available scripts

init

Adds the available scripts to the project's package.json.

WARNING: it will override anything you have in the properties test, lint and format of the scripts field.

format

Runs prettier on write mode.

lint

Runs ESLint with --cache flag, you can override that with --no-cache.

Since ESLint editor integrations require project based configuration to work a local eslintrc is needed, for that you can use eslint-config-d.

{
  "extends": [
    "d"
  ]
}

NOTE: a .eslintignore is required until this eslint issue is resolved.

test

Runs Jest. By default it runs in watch mode unless you are checking coverage (--coverage), used the --no-watch flag or is running in CI (checked by is-ci).

Configuration

skod-scripts provides an opinionated set of configurations. But all of it can be overridden by adding your own. skod-scripts will use the configuration files (or package.json property) for each tool if present. The default configuration can be found here.

TODO

  • precommit hook to format and lint code.
  • Run (lint, format) with the provided list of files instead of the default ones.
  • Forward options & flags to the scripts.

Inspiration

skod-scripts is our take to provide "tools without config". It was strongly inspired by @kentcdodds's version kcskod-scripts.

LICENSE

MIT

Current Tags

  • 0.18.0                                ...           latest (2 years ago)

18 Versions

  • 0.18.0                                ...           2 years ago
  • 0.17.0                                ...           2 years ago
  • 0.15.0                                ...           2 years ago
  • 0.14.0                                ...           2 years ago
  • 0.13.1                                ...           2 years ago
  • 0.13.0                                ...           2 years ago
  • 0.12.0                                ...           2 years ago
  • 0.11.0                                ...           2 years ago
  • 0.10.0                                ...           2 years ago
  • 0.8.0                                ...           2 years ago
  • 0.7.0                                ...           2 years ago
  • 0.6.0                                ...           2 years ago
  • 0.5.0                                ...           2 years ago
  • 0.4.0                                ...           2 years ago
  • 0.3.0                                ...           2 years ago
  • 0.2.0                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
  • 0.0.0-semantically-released                                ...           2 years ago

Copyright 2014 - 2016 © taobao.org |