English• Español (Latinoamérica)• Français• Bahasa Indonesia• Italiano (Italian)• Nhật Bản ngữ (Japanese)• 한국어 (Korean)• Português (Brasil)• Giản thể tiếng Trung (Simplified Chinese)• Phồn thể tiếng Trung (Taiwanese Mandarin)
This module saves you (and others!) time in three ways:
- No configuration.The easiest way to enforce code quality in your
project. No decisions to make. No
.eslintrc
files to manage. It just works. - Automatically format code.Just run
standard --fix
and say goodbye to messy or inconsistent code. - Catch style issues & programmer errors early.Save precious code review time by eliminating back-and-forth between reviewer & contributor.
Give it a try by runningnpx standard --fix
right now!
- Quick start
- FAQ
- Why should I use JavaScript Standard Style?
- Who uses JavaScript Standard Style?
- Are there text editor plugins?
- Is there a readme badge?
- I disagree with rule X, can you change it?
- But this isn't a real web standard!
- Is there an automatic formatter?
- How do I ignore files?
- How do I disable a rule?
- I use a library that pollutes the global namespace. How do I prevent "variable is not defined" errors?
- How do I use experimental JavaScript (ES Next) features?
- Can I use a JavaScript language variant, like Flow or TypeScript?
- What about Mocha, Jest, Jasmine, QUnit, etc?
- What about Web Workers and Service Workers?
- What is the difference between warnings and errors?
- Can I check code inside of Markdown or HTML files?
- Is there a Git
pre-commit
hook? - How do I make the output all colorful and pretty?
- Is there a Node.js API?
- How do I contribute to StandardJS?
The easiest way to use JavaScript Standard Style is to install it globally as a Node command line program. Run the following command in Terminal:
$ npm install standard --global
Or, you can installstandard
locally, for use in a single project:
$ npm install standard --save-dev
Note: To run the preceding commands,Node.jsandnpmmust be installed.
After you've installedstandard
,you should be able to use thestandard
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'=='.
If you've installedstandard
locally, run withnpx
instead:
$ npx standard
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 defaultstandard
will look for all files matching the patterns:
**/*.js
,**/*.jsx
.
-
Add it to
package.json
{ "name":"my-cool-package", "devDependencies":{ "standard":"*" }, "scripts":{ "test":"standard && node my-tests.js" } }
-
Style is checked automatically when you run
npm test
$ npmtest Error: Use JavaScript Standard Style lib/torrent.js:950:11: Expected'==='and instead saw'=='.
-
Never give style feedback on a pull request again!
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 (and others!) time in three ways:
- No configuration.The easiest way to enforce consistent style in your project. Just drop it in.
- Automatically format code.Just run
standard --fix
and say goodbye to messy or inconsistent code. - Catch style issues & programmer errors early.Save precious code review time by eliminating back-and-forth between reviewer & contributor.
Adoptingstandard
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.
For more info, see the conference talk"Write Perfect Code with Standard and
ESLint".In this talk, you'll learn
about linting, when to usestandard
versuseslint
,and howprettier
compares
tostandard
.
Your Logo Here |
---|
In addition to companies, many community members usestandard
on packages that
aretoo numerous
to list here.
standard
is also the top-starred linter in GitHub's
Clean Code Lintershowcase.
First, installstandard
.Then, install the appropriate plugin for your editor:
UsingPackage Control,installSublimeLinterand SublimeLinter-contrib-standard.
For automatic formatting on save, installStandardFormat.
Installlinter-js-standard.
Alternatively, you can installlinter-js-standard-engine.Instead of
bundling a version ofstandard
it will automatically use the version installed
in your current project. It will also work out of the box with other linters based
onstandard-engine.
For automatic formatting, installstandard-formatter.For snippets, installstandardjs-snippets.
Installvscode-standard.(Includes support for automatic formatting.)
For JS snippets, install:vscode-standardjs-snippets.For React snippets, installvscode-react-standard.
Installale.And add these lines to your.vimrc
file.
letg:ale_linters={
\'javascript':['standard'],
\}
letg:ale_fixers={'javascript':['standard']}
This sets standard as your only linter and fixer for javascript files and so prevents conflicts with eslint. For linting and automatic fi xing on save, add these lines to.vimrc
:
letg:ale_lint_on_save=1
letg:ale_fix_on_save=1
Alternative plugins to consider includeneomakeandsyntastic,both of which have built-in support forstandard
(though configuration may be necessary).
InstallFlycheckand check out themanualto learn how to enable it in your projects.
Search the extension registry for"Standard Code Style"and click "Install".
WebStormrecently announced native support
forstandard
directly in the IDE.
If you still prefer to configurestandard
manually,follow this guide.This applies to all JetBrains products, including PhpStorm, IntelliJ, RubyMine, etc.
Yes! If you usestandard
in your project, you can include one of these badges in
your readme to let people know that your code is using the standard style.
[![JavaScript Style Guide](https://cdn.rawgit /standard/standard/master/badge.svg)](https://github /standard/standard)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs)
No. The whole point ofstandard
is to save you time by avoiding
bikesheddingabout code 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 ofstandard
-- its a bunch of sensible 'just pick
something' opinions. Hopefully, users see the value in that over defending their
own opinions.
There are a couple of similar packages for anyone who does not want to completely acceptstandard
:
- semistandard- standard, with semicolons
- standardx- standard, with custom tweaks
If you really want to configure hundreds of ESLint rules individually, you can
always useeslint
directly with
eslint-config-standardto
layer your changes on top.
standard-eject
can help
you migrate fromstandard
toeslint
andeslint-config-standard
.
Pro tip: Just usestandard
and move on. There are actual real problems that you
could spend your time solving!:P
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 calledstandard/standard
and not
ECMA/standard
.
The word "standard" has more meanings than just "web standard":-) For example:
- This module helps hold our code to a highstandard of quality.
- This module ensures that new contributors follow some basicstyle standards.
Yes! You can usestandard --fix
to fix most issues automatically.
standard --fix
is built intostandard
for maximum convenience. Most problems
are fixable, but some errors (like forgetting to handle errors) must be fixed
manually.
To save you time,standard
outputs the message "Run standard --fix to automatically fix some problems
"when it detects problems that can be fixed
automatically.
Certain paths (node_modules/
,coverage/
,vendor/
,*.min.js
,
and files/folders that begin with.
like.git/
) are automatically ignored.
Paths in a project's root.gitignore
file are also automatically ignored.
Sometimes you need to ignore additional folders or specific minified files. To do
that, add astandard.ignore
property topackage.json
:
"standard":{
"ignore":[
"**/out/",
"/lib/select2/",
"/lib/ckeditor/",
"tmp.js"
]
}
In rare cases, you'll need to break a rule and hide the error generated by
standard
.
JavaScript Standard Style usesESLintunder-the-hood and you can hide errors as you normally would if you used ESLint directly.
Disableall ruleson a specific line:
file='I know what I am doing'// eslint-disable-line
Or, disableonlythe"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 formultiple 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 */
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.describe
,it
) on the
global object (poor form!). Since these functions are not defined orrequire
'd
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 letstandard
(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, it may be desirable to avoid adding comments to every file. In this case, run:
$ standard --global myVar1 --global myVar2
Or, add this topackage.json
:
{
"standard":{
"globals":["myVar1","myVar2"]
}
}
Note:global
andglobals
are equivalent.
standard
supports the latest ECMAScript features, ES8 (ES2017), including
language feature proposals that are in "Stage 4" of the proposal process.
To support experimental language features,standard
supports specifying a
custom JavaScript parser. Before using a custom parser, consider whether the added
complexity is worth it.
To use a custom parser, first install it from npm:
npm install @babel/eslint-parser --save-dev
Then run:
$ standard --parser @babel/eslint-parser
Or, add this topackage.json
:
{
"standard":{
"parser":"@babel/eslint-parser"
}
}
standard
supports the latest ECMAScript features. However, Flow and TypeScript add new
syntax to the language, so they are not supported out-of-the-box.
For TypeScript, an official variantts-standard
is supported and maintained that provides a very
similar experience tostandard
.
For other JavaScript language variants,standard
supports specifying a custom JavaScript
parser as well as an ESLint plugin to handle the changed syntax. Before using a JavaScript
language variant, consider whether the added complexity is worth it.
ts-standard
is the officially supported variant for
TypeScript.ts-standard
supports all the same rules and options asstandard
and includes
additional TypeScript specific rules.ts-standard
will even lint regularjavascript
files
by setting the configuration intsconfig.json
.
npm install ts-standard --save-dev
Then run (wheretsconfig.json
is located in the working directory):
$ ts-standard
Or, add this topackage.json
:
{
"ts-standard":{
"project":"./tsconfig.json"
}
}
Note: To include additional files in linting such as test files, create atsconfig.eslint.json
file to use instead.
If you really want to configure hundreds of ESLint rules individually, you can always use eslint
directly witheslint-config-standard-with-typescript
to layer your changes on top.
To use Flow, you need to runstandard
with@babel/eslint-parser
as the parser and
eslint-plugin-flowtype
as a plugin.
npm install @babel/eslint-parser eslint-plugin-flowtype --save-dev
Then run:
$ standard --parser @babel/eslint-parser --plugin flowtype
Or, add this topackage.json
:
{
"standard":{
"parser":"@babel/eslint-parser",
"plugins":["flowtype"]
}
}
Note:plugin
andplugins
are equivalent.
To support mocha in test files, add this to the top of the test files:
/* eslint-env mocha */
Or, run:
$ standard --env mocha
Wheremocha
can be one ofjest
,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
globalsnpm
module.
Note:env
andenvs
are equivalent.
Add this to the top of web worker files:
/* eslint-env worker */
This letsstandard
(as well as humans reading the code) know thatself
is a
global in web worker code.
For Service workers, add this instead:
/* eslint-env serviceworker */
standard
treats all rule violations as errors, which means thatstandard
will exit with a non-zero (error) exit code.
However, we may occasionally release a new major version ofstandard
which changes a rule that affects the majority ofstandard
users (for example,
transitioning fromvar
tolet
/const
). We do this only when we think the
advantage is worth the cost and only when the rule is
auto-fixable.
In these situations, we have a "transition period" where the rule change is only
a "warning". Warnings don't causestandard
to return a non-zero (error)
exit code. However, a warning message will still print to the console. During
the transition period,using standard --fix
will update your code so that it's
ready for the next major version.
The slow and careful approach is what we strive for withstandard
.We're
generally extremely conservative in enforcing the usage of new language
features. We want usingstandard
to be light and fun and so we're careful
about making changes that may get in your way. As always, you can
disable a ruleat any time, if necessary.
To check code inside Markdown files, usestandard-markdown
.
Alternatively, there are ESLint plugins that can check code inside Markdown, HTML, and many other types of language files:
To check code inside Markdown files, use an ESLint plugin:
$ npm install eslint-plugin-markdown
Then, to check JS that appears inside code blocks, run:
$ standard --plugin markdown'**/*.md'
To check code inside HTML files, use an ESLint plugin:
$ npm install eslint-plugin-html
Then, to check JS that appears inside<script>
tags, run:
$ standard --plugin html'**/*.html'
Yes! Hooks are great for ensuring that unstyled code never even makes it into your repo. Never give style feedback on a pull request again!
You even have a choice...
#!/bin/bash
#Ensure all JavaScript files staged for commit pass standard code style
functionxargs-r(){
#Portable version of "xargs -r". The -r flag is a GNU extension that
#prevents xargs from running if there are no input files.
ifIFS=read-r -d$'\n'path;then
echo"$path"|cat -|xargs"$@"
fi
}
git diff --name-only --cached --relative|grep'\.jsx\?$'|sed's/[^[:alnum:]]/\\&/g'|xargs-r -E''-t standard
if[[$?-ne0 ]];then
echo'JavaScript Standard Style errors were detected. Aborting commit.'
exit1
fi
Thepre-commitlibrary allows hooks to be declared within a.pre-commit-config.yaml
configuration file in the repo, and therefore more easily maintained across a team.
Users of pre-commit can simply addstandard
to their.pre-commit-config.yaml
file, which will automatically fix.js
,.jsx
,.mjs
and.cjs
files:
-repo:https://github /standard/standard
rev:master
hooks:
-id:standard
Alternatively, for more advanced styling configurations, usestandard
within theeslint hook:
-repo:https://github /pre-commit/mirrors-eslint
rev:master
hooks:
-id:eslint
files:\.[jt]sx?$#*.js, *.jsx, *.ts and *.tsx
types:[file]
additional_dependencies:
-eslint@latest
-eslint-config-standard@latest
#and whatever other plugins...
The built-in output is simple and straightforward, but if you like shiny things, installsnazzy:
$ npm install snazzy
And run:
$ standard|snazzy
There's alsostandard-tap, standard-json, standard-reporter,and standard-summary.
Yes!
Lint the provided sourcetext
.Anopts
object may be provided:
{
// unique to lintText
filename:'',// path of file containing the text being linted
// common to lintText and lintFiles
cwd:'',// current working directory (default: process.cwd())
fix:false,// automatically fix problems
extensions:[],// file extensions to lint (has sane defaults)
globals:[],// custom global variables to declare
plugins:[],// custom eslint plugins
envs:[],// custom eslint environment
parser:'',// custom js parser (e.g. babel-eslint)
usePackageJson:true,// use options from nearest package.json?
useGitIgnore:true// use file ignore patterns from.gitignore?
}
All options are optional, though some ESLint plugins require thefilename
option.
Additional options may be loaded from apackage.json
if it's found for the current working directory. See below for further details.
Returns aPromise
resolving to theresults
or rejected with anError
.
Theresults
object will contain the following properties:
constresults={
results:[
{
filePath:'',
messages:[
{ruleId:'',message:'',line:0,column:0}
],
errorCount:0,
warningCount:0,
output:''// fixed source code (only present with {fix: true} option)
}
],
errorCount:0,
warningCount:0
}
Lint the providedfiles
globs. Anopts
object may be provided:
{
// unique to lintFiles
ignore:[],// file globs to ignore (has sane defaults)
// common to lintText and lintFiles
cwd:'',// current working directory (default: process.cwd())
fix:false,// automatically fix problems
extensions:[],// file extensions to lint (has sane defaults)
globals:[],// custom global variables to declare
plugins:[],// custom eslint plugins
envs:[],// custom eslint environment
parser:'',// custom js parser (e.g. babel-eslint)
usePackageJson:true,// use options from nearest package.json?
useGitIgnore:true// use file ignore patterns from.gitignore?
}
Additional options may be loaded from apackage.json
if it's found for the current working directory. See below for further details.
Bothignore
andfiles
patterns are resolved relative to the current working directory.
Returns aPromise
resolving to theresults
or rejected with anError
(same as above).
Contributions are welcome! Check out theissuesor thePRs,and make your own if you want something that you don't see there.
Want to chat?Join contributors on Discord.
Here are some important packages in thestandard
ecosystem:
- standard- this repo
- standard-engine- cli engine for arbitrary eslint rules
- eslint-config-standard- eslint rules for standard
- eslint-config-standard-jsx- eslint rules for standard (JSX)
- eslint- the linter that powers standard
- snazzy- pretty terminal output for standard
- standard-www- code forhttps://standardjs
- semistandard- standard, with semicolons (if you must)
- standardx- standard, with custom tweaks
There are also manyeditor plugins,a list of
npm packages that usestandard
,
and an awesome list of
packages in thestandard
ecosystem.
Thestandard
team and community take all security bugs instandard
seriously. Please see oursecurity policies and proceduresdocument to learn how to report issues.
MIT.Copyright (c)Feross Aboukhadijeh.