standardize

1.2.2 • Public • Published

standardize

stable

Scaffolds standard style for a new module.

  • runs npm install --save-dev standard
  • adds standard to your "scripts" test

PRs/suggestions welcome.

Install

npm install standardize -g

Example

Just run standardize on your module directory

standardize

It will auto-install standard (if it isn't already installed), then add a new script field that looks like:

  "scripts": {
    "test": "standard"
  }

If the existing script starts with node or tape, then standard will be prefixed like so:

  "scripts": {
    "test": "standard && node test.js"
  }

You can specify standardize --snazzy if you would rather install and use snazzy in your module, for better error reporting.

semistandard

You can use standardize --semi to install semistandard instead of standard.

Usage

NPM

CLI

Usage:
  standardize [opts]
  
Options:
  --snazzy    use a pretty-printer for standard
  --silent    does not log anything to terminal
  
Example:
  standardize --snazzy --silent

API

standardize([opt], cb)

Standardizes the module at process.cwd() and calls cb(err) when finished. Options:

  • cwd the base directory to install from
  • package the package.json path, defaults to path.join(cwd, 'package.json')
  • verbose whether to print install and update information to stderr (default false)

Example:

var standardize = require('standardize')
var path = require('path')
 
standardize({
  cwd: process.cwd(),
  package: path.join(process.cwd(), 'package.json')
}, function (err) {
  if (err) throw err
  console.log("updated!")
})

License

MIT, see LICENSE.md for details.

Package Sidebar

Install

npm i standardize

Weekly Downloads

9

Version

1.2.2

License

MIT

Last publish

Collaborators

  • mattdesl