standard
Advanced tools
The 'standard' npm package is a JavaScript style guide, linter, and formatter all in one. It enforces a consistent coding style without the need for configuration, making it easier to maintain code quality across projects.
Linting
Linting is the process of running a program that will analyze code for potential errors. The 'standard' package provides a zero-configuration linter that checks for style and programming errors.
npx standardAuto-fixing
The 'standard' package can automatically fix some of the issues it finds in your code. This feature helps in maintaining code quality by automatically correcting common style and formatting issues.
npx standard --fixIntegration with Editors
The 'standard' package can be integrated with various code editors like VSCode, Sublime Text, and Atom. This allows for real-time linting and auto-fixing as you write code.
/* Example for VSCode */
{
"editor.formatOnSave": true,
"javascript.validate.enable": false,
"standard.enable": true
}ESLint is a highly configurable linter for JavaScript and JSX. Unlike 'standard', which comes with a predefined set of rules, ESLint allows you to define your own rules or extend from popular style guides like Airbnb or Google.
Prettier is an opinionated code formatter that supports many languages. It focuses on code formatting rather than linting. While 'standard' includes both linting and formatting, Prettier is often used in conjunction with ESLint for a more comprehensive solution.
XO is a JavaScript linter with great defaults and minimal configuration. It is similar to 'standard' in that it aims to provide a zero-config experience, but it also allows for some customization and extends ESLint under the hood.
No decisions to make. No .eslintrc, .jshintrc, or .jscsrc files to manage. It just
works.
This module saves you (and others!) time in two ways:
Install with:
npm install standard
(, [, or `
if (condition) { ... }function name (arg) { ... }=== instead of == – but obj == null is allowed to check null || undefined.err function parameterwindow – except document and navigator are okay
open, length,
event, and name.standard a try today!To get a better idea, take a look at
a sample file written
in JavaScript Standard Style, or check out some of
the repositories that use
standard.
pre-commit hook?standard. What packages should I know about?The easiest way to use JavaScript 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 -g installs standard globally on your system,
omit it if you want to install in the current working directory):
npm install standard --global
Or, you can run this command to install standard locally, for use in your module:
npm install standard --save-dev
Node.js and npm are required to run the preceding commands.
After you've installed standard, you should be able to use the standard program. The
simplest use case would be checking the style of all JavaScript files in the
current working directory:
$ standard
Error: Use JavaScript Standard Style
lib/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 standard instead of your shell:
$ standard "src/util/**/*.js" "test/**/*.js"
Note: by default standard will look for all files matching the patterns:
**/*.js, **/*.jsx.
package.json{
"name": "my-cool-package",
"devDependencies": {
"standard": "*"
},
"scripts": {
"test": "standard && node my-tests.js"
}
}
npm test$ npm test
Error: Use JavaScript Standard Style
lib/torrent.js:950:11: Expected '===' and instead saw '=='.
Use this in one of your projects? Include one of these badges in your readme to let people know that your code is using the standard style.
[](https://github.com/feross/standard)
[](http://standardjs.com/)
First, install standard. Then, install the appropriate plugin for your editor:
Using Package Control, install SublimeLinter and SublimeLinter-contrib-standard.
For automatic formatting on save, install StandardFormat.
Install linter-js-standard.
For automatic formatting, install standard-formatter. For snippets, install standardjs-snippets.
Install Syntastic and add this line to .vimrc:
let g:syntastic_javascript_checkers = ['standard']
For automatic formatting on save, install standard-format
npm install -g standard-format
and add these two lines to .vimrc:
autocmd bufwritepost *.js silent !standard-format -w %
set autoread
Install Flycheck and check out the manual to learn how to enable it in your projects.
Search the extension registry for "Standard Code Style".
Install vscode-standardjs. (Includes support for automatic formatting.)
For React snippets, install vscode-react-standard.
Both WebStorm and PhpStorm can be configured for Standard Style.
The beauty of JavaScript Standard Style is that it's simple. No one wants to maintain multiple hundred-line style configuration files for every module/project they work on. Enough of this madness!
This module saves you time in two ways:
Adopting standard style means ranking the importance of code clarity and
community conventions higher than personal style. This might not make sense for
100% of projects and development cultures, however open source can be a hostile
place for newbies. Setting up clear, automated contributor expectations makes a
project healthier.
No. The whole point of standard is to avoid bikeshedding about
style. There are lots of debates online about tabs vs. spaces, etc. that will never
be resolved. These debates just distract from getting stuff done. At the end of the
day you have to 'just pick something', and that's the whole philosophy of
standard -- its a bunch of sensible 'just pick something' opinions. Hopefully,
users see the value in that over defending their own opinions.
Of course it's not! The style laid out here is not affiliated with any official web
standards groups, which is why this repo is called feross/standard and not
ECMA/standard.
The word "standard" has more meanings than just "web standard" :-) For example:
Yes! You can use standard --fix to automatically fix most issues automatically.
standard --fix is built into standard (since v8.0.0) for maximum convenience.
Lots of problems are fixable, but some errors, like not handling errors in
node-style callbacks, must be fixed manually.
To save you time, standard outputs a message ("Run standard --fix to automatically fix some
problems.") when it detects problems that can be fixed automatically.
Alternatively, if you have an ES5-only codebase, you can try
standard-format (a separate package), but it likely will not
be maintained going forward since standard --fix works so well, and does not
require us to maintain two tools with separate rule configurations.
The paths node_modules/**, *.min.js, bundle.js, coverage/**, hidden
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 standard.ignore property to package.json:
"standard": {
"ignore": [
"**/out/",
"/lib/select2/",
"/lib/ckeditor/",
"tmp.js"
]
}
In rare cases, you'll need to break a rule and hide the warning generated by
standard.
JavaScript Standard Style uses eslint under-the-hood and
you can hide warnings as you normally would if you used eslint directly.
To get verbose output (so you can find the particular rule name to ignore), run:
$ standard --verbose
Error: Use JavaScript Standard Style
routes/error.js:20:36: 'file' was used before it was defined. (no-use-before-define)
Disable all rules on a specific line:
file = 'I know what I am doing' // eslint-disable-line
Or, disable only the "no-use-before-define" rule:
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 */
console.log('offending code goes here...')
console.log('offending code goes here...')
console.log('offending code goes here...')
/* eslint-enable no-use-before-define */
Some packages (e.g. mocha) put their functions (e.g. describe, it) on the
global object (poor form!). Since these functions are not defined or required
anywhere in your code, 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.
To let 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 package.json:
{
"standard": {
"globals": [ "myVar1", "myVar2" ]
}
}
Before you use a custom parser, consider whether the added complexity in your build process is worth it.
standard supports custom JS parsers. To use a custom parser, install it from npm
(example: npm install babel-eslint) and add this to your package.json:
{
"standard": {
"parser": "babel-eslint"
}
}
If you're using standard globally (you installed it with -g), then you also
need to install babel-eslint globally with npm install babel-eslint -g.
Before you use a custom JS language variant, consider whether the added complexity in your build process (and effort required to get new contributors up-to-speed) is worth it.
standard supports ESLint plugins. Use one of these to transform your code into
valid JavaScript before standard sees it. To use a custom parser, install it from
npm (example: npm install eslint-plugin-flowtype) and add this to your
package.json:
{
"standard": {
"plugins": [
"flowtype"
]
}
}
If you're using standard globally (you installed it with -g), then you also
need to install eslint-plugin-flowtype globally with
npm install eslint-plugin-flowtype -g.
No. The point of standard is to save you time by picking reasonable rules so you
can spend your time solving actual problems. If you really do want to configure
hundreds of eslint rules individually, you can always use eslint directly.
If you just want to tweak a couple rules, consider using this shareable config and layering your changes on top.
Pro tip: Just use standard and move on. There are actual real problems that you
could spend your time solving! :P
Add this to the top of your files:
/* eslint-env serviceworker */
This lets standard (as well as humans reading your code) know that self is a
global in web worker code.
To support mocha in your test files, add this to the beginning of your test files:
/* eslint-env mocha */
Where mocha can be one of jasmine, qunit, phantomjs, and so on. To see a
full list, check ESLint's
specifying environments
documentation. For a list of what globals are available for these environments,
check the
globals npm
module.
pre-commit hook?Funny you should ask!
#!/bin/sh
# Ensure all javascript files staged for commit pass standard code style
git diff --name-only --cached --relative | grep '\.jsx\?$' | xargs standard
if [ $? -ne 0 ]; then exit 1; fi
Alternatively, overcommit is a Git hook
manager that includes support for running standard as a Git pre-commit hook.
To enable this, add the following to your .overcommit.yml file:
PreCommit:
Standard:
enabled: true
The built-in output is simple and straightforward, but if you like shiny things, install snazzy:
npm install snazzy
And run:
$ standard --verbose | snazzy
There's also standard-tap, standard-json, standard-reporter, and standard-summary.
standard.lintText(text, [opts], callback)Lint the provided source text to enforce JavaScript Standard Style. An opts object may
be provided:
var opts = {
fix: false, // automatically fix problems
globals: [], // global variables to declare
plugins: [], // eslint plugins
envs: [], // eslint environment
parser: '' // js parser (e.g. babel-eslint)
}
The callback will be called with an Error and results object:
var results = {
results: [
{
filePath: '',
messages: [
{ ruleId: '', message: '', line: 0, column: 0 }
],
errorCount: 0,
warningCount: 0
}
],
errorCount: 0,
warningCount: 0
}
standard.lintFiles(files, [opts], callback)Lint the provided files globs. An opts object may be provided:
var opts = {
ignore: [], // file globs to ignore (has sane defaults)
cwd: '', // current working directory (default: process.cwd())
fix: false, // automatically fix problems
globals: [], // global variables to declare
plugins: [], // eslint plugins
envs: [], // eslint environment
parser: '' // js parser (e.g. babel-eslint)
}
The callback will be called with an Error and results object (same as above).
Join us in #standard on freenode.
Contributions are welcome! Check out the issues or the PRs, and make your own if you want something that you don't see there.
standard. What packages should I know about?There are also many editor plugins, a list of
npm packages that use standard,
and an awesome list of
packages in the standard ecosystem.
MIT. Copyright (c) Feross Aboukhadijeh.
FAQs
JavaScript Standard Style
The npm package standard receives a total of 394,098 weekly downloads. As such, standard popularity was classified as popular.
We found that standard demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 16 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.