NodeOS Standard Style
No decisions to make. No
.jscsrc files to manage. It just
This module saves you (and others!) time in two ways:
- No configuration. The easiest way to enforce consistent style in your project. Just drop it in.
- Catch style errors before they're submitted in PRs. Saves precious code review time by eliminating back-and-forth between maintainer and contributor.
npm install nodeos-standard
For a quick list of the rules, please refer to ESLint's recommended rules here.
The specific additions to these rules are as followed:
- semicolons are optional
- Unix style line breaks
Table of Contents
- How do I ignore files?
- How do I hide a certain warning?
- I use a library that pollutes the global namespace. How do I prevent "variable is not defined" errors?
- Can I use a custom JS parser for bleeding-edge ES6 or ES7 support?
- What about Web Workers?
- What about Mocha, Jasmine, QUnit, etc?
- Is there a Git
- How do I make the output all colorful and pretty?
- Node.js API
The easiest way to use NodeOS Standard Style to check your code is to install
it globally as a Node command line program. To do so, simply run the following
command in your terminal (flag
standard globally on your system,
omit it if you want to install in the current working directory):
npm install nodeos-standard --global
Or, you can run this command to install
nodeos-standard locally, for use in your module:
npm install nodeos-standard --save-dev
After you've installed
nodeos-standard, you should be able to use the
nodeos-standard program. The
current working directory:
$ nodeos-standardError: Use NodeOS Standard Stylelib/torrent.js:950:11: Expected '===' and instead saw '=='.
You can optionally pass in a directory (or directories) using the glob pattern. Be sure to quote paths containing glob patterns so that they are expanded by nodeos-standard instead of your shell:
$ nodeos-standard "src/util/**/*.js" "test/**/*.js"
Note: by default
nodeos-standard will look for all files matching the patterns:
What you might do if you're clever
- Add it to
- Check style automatically when you run
$ npm test Error: Use NodeOS Standard Style lib/torrent.js:950:11: Expected '===' and instead saw '=='.
- Never give style feedback on a pull request again!
How do I ignore files?
files/folders (beginning with
.), and all patterns in a project's root
.gitignore file are automatically ignored.
Sometimes you need to ignore additional folders or specific minified files. To do
that, add a
nodeos-standard.ignore property to
How do I hide a certain warning?
In rare cases, you'll need to break a rule and hide the warning generated by
NodeOS Standard Style uses
eslint under-the-hood and
you can hide warnings as you normally would if you used
To get verbose output (so you can find the particular rule name to ignore), run:
$ nodeos-standard --verboseError: Use NodeOS Standard Styleroutes/error.js:20:36: 'file' was used before it was defined.
Disable all rules on a specific line:
file = 'I know what I am doing' // eslint-disable-line
Or, disable only the
file = 'I know what I am doing' // eslint-disable-line no-use-before-define
Or, disable the
"no-use-before-define" rule for multiple lines:
/* eslint-disable no-use-before-define */consoleconsoleconsole/* eslint-enable no-use-before-define */
I use a library that pollutes the global namespace. How do I prevent "variable is not defined" errors?
Some packages (e.g.
mocha) put their functions (e.g.
it) on the
global object (poor form!). Since these functions are not defined or
anywhere in your code,
nodeos-standard will warn that you're using a variable that is
not defined (usually, this rule is really useful for catching typos!). But we want
to disable it for these global variables.
nodeos-standard (as well as humans reading your code) know that certain variables
are global in your code, add this to the top of your file:
/* global myVar1, myVar2 */
If you have hundreds of files, adding comments to every file can be tedious. In
these cases, you can add this to
Can I use a custom JS parser for bleeding-edge ES6 or ES7 support?
nodeos-standard supports custom JS parsers. To use a custom parser, install it from npm
npm install babel-eslint) and add this to your
If you're using
nodeos-standard globally (you installed it with
-g), then you also
need to install
babel-eslint globally with
npm install babel-eslint -g.
What about Web Workers?
Add this to the top of your files:
/* eslint-env serviceworker */
nodeos-standard (as well as humans reading your code) know that
self is a
global in web worker code.
What about Mocha, Jasmine, QUnit, etc?
To support mocha in your test files, add this to the beginning of your test files:
/* eslint-env mocha */
mocha can be one of
phantomjs, and so on. To see a
full list, check ESLint's
documentation. For a list of what globals are available for these environments,
Is there a Git
Funny you should ask!
How do I make the output all colorful and pretty?
The built-in output is simple and straightforward, but if you like shiny things, install snazzy:
npm install snazzy
$ nodeos-standard --verbose | snazzy
nodeos-standard.lintText(text, [opts], callback)
Lint the provided source
opts object may
var opts =globals: // global variables to declareparser: '' // custom js parser (e.g. babel-eslint)
callback will be called with an
var results =results:filePath: ''messages:ruleId: '' message: '' line: 0 column: 0errorCount: 0warningCount: 0errorCount: 0warningCount: 0
nodeos-standard.lintFiles(files, [opts], callback)
Lint the provided
files globs. An
opts object may be provided:
var opts =globals: // global variables to declareparser: '' // custom js parser (e.g. babel-eslint)ignore: // file globs to ignore (has sane defaults)cwd: '' // current working directory (default: process.cwd())
callback will be called with an
results object (same as above).