![\"Standard](\"https://cdn.rawgit.com/standard/standard/master/sticker.svg\")
\n \n JavaScript Standard Style\n
\n
\n
\n \n ![\"discord\"](\"https://img.shields.io/discord/612704110008991783?logo=discord&logoColor=white&label=Discord&color=5865F2\")
![\"External](\"https://github.com/standard/standard/actions/workflows/test-external.yml/badge.svg?branch=master\"){kind=icon}
\n ![\"Internal](\"https://github.com/standard/standard/actions/workflows/test-internal.yml/badge.svg?branch=master\"){kind=icon}
\n ![\"status](\"https://github.com/standard/standard/workflows/Old%20test/badge.svg\"){kind=icon}
\n ![\"npm](\"https://img.shields.io/npm/v/standard.svg\")
\n ![\"npm](\"https://img.shields.io/npm/dm/eslint-config-standard.svg\")
\n ![\"Standard](\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\"){kind=icon}
\n
![\"Socket](\"https://cdn.rawgit.com/standard/standard/master/docs/logos/socket.png\")
![\"Wormhole\"](\"https://cdn.rawgit.com/standard/standard/master/docs/logos/wormhole.png\")
\n\n English •\n Español (Latinoamérica) •\n Français •\n Bahasa Indonesia •\n Italiano (Italian) •\n 日本語 (Japanese) •\n 한국어 (Korean) •\n Português (Brasil) •\n 简体中文 (Simplified Chinese) •\n 繁體中文 (Taiwanese Mandarin)\n
\n\n## JavaScript style guide, linter, and formatter\n\nThis module saves you (and others!) time in three ways:\n\n- **No configuration.** The easiest way to enforce code quality in your\n project. No decisions to make. No `.eslintrc` files to manage. It just works.\n- **Automatically format code.** Just run `standard --fix` and say goodbye to\n messy or inconsistent code.\n- **Catch style issues & programmer errors early.** Save precious code review\n time by eliminating back-and-forth between reviewer & contributor.\n\nGive it a try by running `npx standard --fix` right now!\n\n## Table of Contents\n\n- Quick start\n - [Install](#install)\n - [Usage](#usage)\n - [What you might do if you're clever](#what-you-might-do-if-youre-clever)\n- FAQ\n - [Why should I use JavaScript Standard Style?](#why-should-i-use-javascript-standard-style)\n - [Who uses JavaScript Standard Style?](#who-uses-javascript-standard-style)\n - [Are there text editor plugins?](#are-there-text-editor-plugins)\n - [Is there a readme badge?](#is-there-a-readme-badge)\n - [I disagree with rule X, can you change it?](#i-disagree-with-rule-x-can-you-change-it)\n - [But this isn't a real web standard!](#but-this-isnt-a-real-web-standard)\n - [Is there an automatic formatter?](#is-there-an-automatic-formatter)\n - [How do I ignore files?](#how-do-i-ignore-files)\n - [How do I disable a rule?](#how-do-i-disable-a-rule)\n - [I use a library that pollutes the global namespace. How do I prevent \"variable is not defined\" errors?](#i-use-a-library-that-pollutes-the-global-namespace-how-do-i-prevent-variable-is-not-defined-errors)\n - [How do I use experimental JavaScript (ES Next) features?](#how-do-i-use-experimental-javascript-es-next-features)\n - [Can I use a JavaScript language variant, like Flow or TypeScript?](#can-i-use-a-javascript-language-variant-like-flow-or-typescript)\n - [What about Mocha, Jest, Jasmine, QUnit, etc?](#what-about-mocha-jest-jasmine-qunit-etc)\n - [What about Web Workers and Service Workers?](#what-about-web-workers-and-service-workers)\n - [What is the difference between warnings and errors?](#what-is-the-difference-between-warnings-and-errors)\n - [Can I check code inside of Markdown or HTML files?](#can-i-check-code-inside-of-markdown-or-html-files)\n - [Is there a Git `pre-commit` hook?](#is-there-a-git-pre-commit-hook)\n - [How do I make the output all colorful and pretty?](#how-do-i-make-the-output-all-colorful-and-pretty)\n - [Is there a Node.js API?](#is-there-a-nodejs-api)\n - [How do I contribute to StandardJS?](#how-do-i-contribute-to-standardjs)\n\n## Install\n\nThe easiest way to use JavaScript Standard Style is to install it globally as a\nNode command line program. Run the following command in Terminal:\n\n```bash\n$ npm install standard --global\n```\n\nOr, you can install `standard` locally, for use in a single project:\n\n```bash\n$ npm install standard --save-dev\n```\n\n*Note: To run the preceding commands, [Node.js](http://nodejs.org) and [npm](https://npmjs.com) must be installed.*\n\n## Usage\n\nAfter you've installed `standard`, you should be able to use the `standard` program. The\nsimplest use case would be checking the style of all JavaScript files in the\ncurrent working directory:\n\n```bash\n$ standard\nError: Use JavaScript Standard Style\n lib/torrent.js:950:11: Expected '===' and instead saw '=='.\n```\n\nIf you've installed `standard` locally, run with `npx` instead:\n\n```bash\n$ npx standard\n```\n\nYou can optionally pass in a directory (or directories) using the glob pattern. Be\nsure to quote paths containing glob patterns so that they are expanded by\n`standard` instead of your shell:\n\n```bash\n$ standard \"src/util/**/*.js\" \"test/**/*.js\"\n```\n\n**Note:** by default `standard` will look for all files matching the patterns:\n`**/*.js`, `**/*.jsx`.\n\n## What you might do if you're clever\n\n1. Add it to `package.json`\n\n ```json\n {\n \"name\": \"my-cool-package\",\n \"devDependencies\": {\n \"standard\": \"*\"\n },\n \"scripts\": {\n \"test\": \"standard && node my-tests.js\"\n }\n }\n ```\n\n2. Style is checked automatically when you run `npm test`\n\n ```bash\n $ npm test\n Error: Use JavaScript Standard Style\n lib/torrent.js:950:11: Expected '===' and instead saw '=='.\n ```\n\n3. Never give style feedback on a pull request again!\n\n## Why should I use JavaScript Standard Style?\n\nThe beauty of JavaScript Standard Style is that it's simple. No one wants to\nmaintain multiple hundred-line style configuration files for every module/project\nthey work on. Enough of this madness!\n\nThis module saves you (and others!) time in three ways:\n\n- **No configuration.** The easiest way to enforce consistent style in your\n project. Just drop it in.\n- **Automatically format code.** Just run `standard --fix` and say goodbye to\n messy or inconsistent code.\n- **Catch style issues & programmer errors early.** Save precious code review\n time by eliminating back-and-forth between reviewer & contributor.\n\nAdopting `standard` style means ranking the importance of code clarity and\ncommunity conventions higher than personal style. This might not make sense for\n100% of projects and development cultures, however open source can be a hostile\nplace for newbies. Setting up clear, automated contributor expectations makes a\nproject healthier.\n\nFor more info, see the conference talk [\"Write Perfect Code with Standard and\nESLint\"](https://www.youtube.com/watch?v=kuHfMw8j4xk). In this talk, you'll learn\nabout linting, when to use `standard` versus `eslint`, and how `prettier` compares\nto `standard`.\n\n## Who uses JavaScript Standard Style?\n\n[
](https://nodejs.org) | [
](https://www.npmjs.com) | [
](https://github.com) | [
](https://wormhole.app) |\n|---|---|---|---|\n\n[
](http://expressjs.com) | [
](http://electron.atom.io) | [
](https://nuxtjs.org/) | [
](https://www.elastic.co) |\n|---|---|---|---|\n\n| [
](https://www.mongodb.com) | [
](https://www.zendesk.com) | [
](https://www.brave.com) | [
](https://vercel.com) |\n|---|---|---|---|\n\n| [
](https://socket.dev) | [
](http://www.nearform.com) | [
](https://www.typeform.com) | [
](https://gds.blog.gov.uk) |\n|---|---|---|---|\n\n| [
](https://www.heroku.com) | [
](https://saucelabs.com) | [
](https://automattic.com) | [
](https://www.godaddy.com) |\n|---|---|---|---|\n\n| [
](https://webtorrent.io) | [
](https://ipfs.io) | [
](https://datproject.org) | [
](https://bitcoinjs.org) |\n|---|---|---|---|\n\n| [
](https://voltra.co) | [
](https://www.treasuredata.com) | [
](https://bitmidi.com) | [
](https://www.apstudynotes.org) |\n|---|---|---|---|\n\n| [
](https://www.optiopay.com) | [
](https://www.jlrtechincubator.com/jlrti/) | [
](https://www.bustle.com) | [
](https://www.zentrick.com) |\n|---|---|---|---|\n\n| [
](https://greenkeeper.io) | [
](https://karma-runner.github.io) | [
](https://www.taser.com) | [
](https://www.neo4j.com) |\n|---|---|---|---|\n\n| [
](https://rentograph.com) | [
](https://www.eaze.com) | [
](https://www.ctrlaltdeseat.com) | [
](https://clevertech.biz) |\n|---|---|---|---|\n\n| [
](https://aragon.org) | [
](https://www.flowsent.com) | [
](https://www.pumabrowser.com/) | [
](https://www.jetbrains.com/webstorm/) |\n|---|---|---|---|\n\n| [
](https://www.fastify.io) | [
](https://www.scuttlebutt.nz) | [
](https://solid.inrupt.com) | [
](https://www.grab.com) |\n|---|---|---|---|\n\n| [
](https://jublia.com/) | [
](https://atom.io) | [
](https://www.peek.com) | [
](https://www.dotenv.org) |\n|---|---|---|---|\n\n| [
](https://nodesource.com) | [
](https://www.searchapi.io/) | Your Logo Here | |\n|---|---|---|---|\n\n\nIn addition to companies, many community members use `standard` on packages that\nare [too numerous](https://raw.githubusercontent.com/standard/standard-packages/master/all.json)\nto list here.\n\n`standard` is also the top-starred linter in GitHub's\n[Clean Code Linter](https://github.com/showcases/clean-code-linters) showcase.\n\n## Are there text editor plugins?\n\nFirst, install `standard`. Then, install the appropriate plugin for your editor:\n\n### Sublime Text\n\nUsing **[Package Control][sublime-1]**, install **[SublimeLinter][sublime-2]** and\n**[SublimeLinter-contrib-standard][sublime-3]**.\n\nFor automatic formatting on save, install **[StandardFormat][sublime-4]**.\n\n[sublime-1]: https://packagecontrol.io/\n[sublime-2]: http://www.sublimelinter.com/en/latest/\n[sublime-3]: https://packagecontrol.io/packages/SublimeLinter-contrib-standard\n[sublime-4]: https://packagecontrol.io/packages/StandardFormat\n\n### Atom\n\nInstall **[linter-js-standard][atom-1]**.\n\nAlternatively, you can install **[linter-js-standard-engine][atom-4]**. Instead of\nbundling a version of `standard` it will automatically use the version installed\nin your current project. It will also work out of the box with other linters based\non **[standard-engine][atom-5]**.\n\nFor automatic formatting, install **[standard-formatter][atom-2]**. For snippets,\ninstall **[standardjs-snippets][atom-3]**.\n\n[atom-1]: https://atom.io/packages/linter-js-standard\n[atom-2]: https://atom.io/packages/standard-formatter\n[atom-3]: https://atom.io/packages/standardjs-snippets\n[atom-4]: https://atom.io/packages/linter-js-standard-engine\n[atom-5]: https://github.com/standard/standard-engine\n\n### Visual Studio Code\n\nInstall **[vscode-standard][vscode-1]**. (Includes support for automatic formatting.)\n\nFor JS snippets, install: **[vscode-standardjs-snippets][vscode-2]**. For React snippets, install **[vscode-react-standard][vscode-3]**.\n\n[vscode-1]: https://marketplace.visualstudio.com/items?itemName=standard.vscode-standard\n[vscode-2]: https://marketplace.visualstudio.com/items?itemName=capaj.vscode-standardjs-snippets\n[vscode-3]: https://marketplace.visualstudio.com/items?itemName=TimonVS.ReactSnippetsStandard\n\n### Vim\n\nInstall **[ale][vim-1]**. And add these lines to your `.vimrc` file.\n\n```vim\nlet g:ale_linters = {\n\\ 'javascript': ['standard'],\n\\}\nlet g:ale_fixers = {'javascript': ['standard']}\n```\n\nThis sets standard as your only linter and fixer for javascript files and so prevents conflicts with eslint. For linting and automatic fixing on save, add these lines to `.vimrc`:\n```vim\nlet g:ale_lint_on_save = 1\nlet g:ale_fix_on_save = 1\n```\n\n\nAlternative plugins to consider include [neomake][vim-2] and [syntastic][vim-3], both of which have built-in support for `standard` (though configuration may be necessary).\n\n[vim-1]: https://github.com/w0rp/ale\n[vim-2]: https://github.com/neomake/neomake\n[vim-3]: https://github.com/vim-syntastic/syntastic\n\n### Emacs\n\nInstall **[Flycheck][emacs-1]** and check out the **[manual][emacs-2]** to learn\nhow to enable it in your projects.\n\n[emacs-1]: http://www.flycheck.org\n[emacs-2]: http://www.flycheck.org/en/latest/user/installation.html\n\n### Brackets\n\nSearch the extension registry for **[\"Standard Code Style\"][brackets-1]** and click \"Install\".\n\n[brackets-1]: https://github.com/ishamf/brackets-standard/\n\n### WebStorm (PhpStorm, IntelliJ, RubyMine, JetBrains, etc.)\n\nWebStorm [recently announced native support](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/)\nfor `standard` directly in the IDE.\n\nIf you still prefer to configure `standard` manually, [follow this guide][webstorm-1]. This applies to all JetBrains products, including PhpStorm, IntelliJ, RubyMine, etc.\n\n[webstorm-1]: docs/webstorm.md\n\n## Is there a readme badge?\n\nYes! If you use `standard` in your project, you can include one of these badges in\nyour readme to let people know that your code is using the standard style.\n\n[](https://github.com/standard/standard)\n\n```md\n[](https://github.com/standard/standard)\n```\n\n[](https://standardjs.com)\n\n```md\n[](https://standardjs.com)\n```\n\n## I disagree with rule X, can you change it?\n\nNo. The whole point of `standard` is to save you time by avoiding\n[bikeshedding][bikeshedding] about code style. There are lots of debates online about\ntabs vs. spaces, etc. that will never be resolved. These debates just distract from\ngetting stuff done. At the end of the day you have to 'just pick something', and\nthat's the whole philosophy of `standard` -- its a bunch of sensible 'just pick\nsomething' opinions. Hopefully, users see the value in that over defending their\nown opinions.\n\nThere are a couple of similar packages for anyone who does not want to completely accept `standard`:\n- [semistandard](https://github.com/standard/semistandard) - standard, with semicolons\n- [standardx](https://github.com/standard/standardx) - standard, with custom tweaks\n\nIf you really want to configure hundreds of ESLint rules individually, you can\nalways use `eslint` directly with\n[eslint-config-standard](https://github.com/standard/eslint-config-standard) to\nlayer your changes on top.\n[`standard-eject`](https://github.com/josephfrazier/standard-eject) can help\nyou migrate from `standard` to `eslint` and `eslint-config-standard`.\n\nPro tip: Just use `standard` and move on. There are actual real problems that you\ncould spend your time solving! :P\n\n[bikeshedding]: https://docs.freebsd.org/en/books/faq/#bikeshed-painting\n\n## But this isn't a real web standard!\n\nOf course it's not! The style laid out here is not affiliated with any official web\nstandards groups, which is why this repo is called `standard/standard` and not\n`ECMA/standard`.\n\nThe word \"standard\" has more meanings than just \"web standard\" :-) For example:\n\n- This module helps hold our code to a high *standard of quality*.\n- This module ensures that new contributors follow some basic *style standards*.\n\n## Is there an automatic formatter?\n\nYes! You can use `standard --fix` to fix most issues automatically.\n\n`standard --fix` is built into `standard` for maximum convenience. Most problems\nare fixable, but some errors (like forgetting to handle errors) must be fixed\nmanually.\n\nTo save you time, `standard` outputs the message \"`Run standard --fix to\nautomatically fix some problems`\" when it detects problems that can be fixed\nautomatically.\n\n## How do I ignore files?\n\nCertain paths (`node_modules/`, `coverage/`, `vendor/`, `*.min.js`,\nand files/folders that begin with `.` like `.git/`) are automatically ignored.\n\nPaths in a project's root `.gitignore` file are also automatically ignored.\n\nSometimes you need to ignore additional folders or specific minified files. To do\nthat, add a `standard.ignore` property to `package.json`:\n\n```json\n\"standard\": {\n \"ignore\": [\n \"**/out/\",\n \"/lib/select2/\",\n \"/lib/ckeditor/\",\n \"tmp.js\"\n ]\n}\n```\n\n## How do I disable a rule?\n\nIn rare cases, you'll need to break a rule and hide the error generated by\n`standard`.\n\nJavaScript Standard Style uses [ESLint](http://eslint.org/) under-the-hood and\nyou can hide errors as you normally would if you used ESLint directly.\n\nDisable **all rules** on a specific line:\n\n```js\nfile = 'I know what I am doing' // eslint-disable-line\n```\n\nOr, disable **only** the `\"no-use-before-define\"` rule:\n\n```js\nfile = 'I know what I am doing' // eslint-disable-line no-use-before-define\n```\n\nOr, disable the `\"no-use-before-define\"` rule for **multiple lines**:\n\n```js\n/* eslint-disable no-use-before-define */\nconsole.log('offending code goes here...')\nconsole.log('offending code goes here...')\nconsole.log('offending code goes here...')\n/* eslint-enable no-use-before-define */\n```\n\n## I use a library that pollutes the global namespace. How do I prevent \"variable is not defined\" errors?\n\nSome packages (e.g. `mocha`) put their functions (e.g. `describe`, `it`) on the\nglobal object (poor form!). Since these functions are not defined or `require`'d\nanywhere in your code, `standard` will warn that you're using a variable that is\nnot defined (usually, this rule is really useful for catching typos!). But we want\nto disable it for these global variables.\n\nTo let `standard` (as well as humans reading your code) know that certain variables\nare global in your code, add this to the top of your file:\n\n```js\n/* global myVar1, myVar2 */\n```\n\nIf you have hundreds of files, it may be desirable to avoid adding comments to\nevery file. In this case, run:\n\n```bash\n$ standard --global myVar1 --global myVar2\n```\n\nOr, add this to `package.json`:\n\n```json\n{\n \"standard\": {\n \"globals\": [ \"myVar1\", \"myVar2\" ]\n }\n}\n```\n\n*Note: `global` and `globals` are equivalent.*\n\n## How do I use experimental JavaScript (ES Next) features?\n\n`standard` supports the latest ECMAScript features, ES8 (ES2017), including\nlanguage feature proposals that are in \"Stage 4\" of the proposal process.\n\nTo support experimental language features, `standard` supports specifying a\ncustom JavaScript parser. Before using a custom parser, consider whether the added\ncomplexity is worth it.\n\nTo use a custom parser, first install it from npm:\n\n```bash\nnpm install @babel/eslint-parser --save-dev\n```\n\nThen run:\n\n```bash\n$ standard --parser @babel/eslint-parser\n```\n\nOr, add this to `package.json`:\n\n```json\n{\n \"standard\": {\n \"parser\": \"@babel/eslint-parser\"\n }\n}\n```\n\n## Can I use a JavaScript language variant, like Flow or TypeScript?\n\n`standard` supports the latest ECMAScript features. However, Flow and TypeScript add new\nsyntax to the language, so they are not supported out-of-the-box.\n\nFor TypeScript, an official variant `ts-standard` is supported and maintained that provides a very\nsimilar experience to `standard`.\n\nFor other JavaScript language variants, `standard` supports specifying a custom JavaScript\nparser as well as an ESLint plugin to handle the changed syntax. Before using a JavaScript\nlanguage variant, consider whether the added complexity is worth it.\n\n### TypeScript\n\n[`ts-standard`](https://github.com/standard/ts-standard) is the officially supported variant for\nTypeScript. `ts-standard` supports all the same rules and options as `standard` and includes\nadditional TypeScript specific rules. `ts-standard` will even lint regular `javascript` files\nby setting the configuration in `tsconfig.json`.\n\n```bash\nnpm install ts-standard --save-dev\n```\n\nThen run (where `tsconfig.json` is located in the working directory):\n\n```bash\n$ ts-standard\n```\n\nOr, add this to `package.json`:\n\n```json\n{\n \"ts-standard\": {\n \"project\": \"./tsconfig.json\"\n }\n}\n```\n\n*Note: To include additional files in linting such as test files, create a `tsconfig.eslint.json` file to use instead.*\n\nIf you really want to configure hundreds of ESLint rules individually, you can always use eslint\ndirectly with [`eslint-config-standard-with-typescript`](https://github.com/standard/eslint-config-standard-with-typescript)\nto layer your changes on top.\n\n### Flow\n\nTo use Flow, you need to run `standard` with `@babel/eslint-parser` as the parser and\n`eslint-plugin-flowtype` as a plugin.\n\n```bash\nnpm install @babel/eslint-parser eslint-plugin-flowtype --save-dev\n```\n\nThen run:\n\n```bash\n$ standard --parser @babel/eslint-parser --plugin flowtype\n```\n\nOr, add this to `package.json`:\n\n```json\n{\n \"standard\": {\n \"parser\": \"@babel/eslint-parser\",\n \"plugins\": [ \"flowtype\" ]\n }\n}\n```\n\n*Note: `plugin` and `plugins` are equivalent.*\n\n## What about Mocha, Jest, Jasmine, QUnit, etc?\n\nTo support mocha in test files, add this to the top of the test files:\n\n```js\n/* eslint-env mocha */\n```\n\nOr, run:\n\n```bash\n$ standard --env mocha\n```\n\nWhere `mocha` can be one of `jest`, `jasmine`, `qunit`, `phantomjs`, and so on. To see a\nfull list, check ESLint's\n[specifying environments](https://eslint.org/docs/latest/use/configure/language-options#specifying-environments)\ndocumentation. For a list of what globals are available for these environments,\ncheck the\n[globals](https://github.com/sindresorhus/globals/blob/master/globals.json) npm\nmodule.\n\n*Note: `env` and `envs` are equivalent.*\n\n## What about Web Workers and Service Workers?\n\nAdd this to the top of web worker files:\n\n```js\n/* eslint-env worker */\n```\n\nThis lets `standard` (as well as humans reading the code) know that `self` is a\nglobal in web worker code.\n\nFor Service workers, add this instead:\n\n```js\n/* eslint-env serviceworker */\n```\n\n## What is the difference between warnings and errors?\n\n`standard` treats all rule violations as errors, which means that `standard`\nwill exit with a non-zero (error) exit code.\n\nHowever, we may occasionally release a new major version of `standard`\nwhich changes a rule that affects the majority of `standard` users (for example,\ntransitioning from `var` to `let`/`const`). We do this only when we think the\nadvantage is worth the cost and only when the rule is\n[auto-fixable](#is-there-an-automatic-formatter).\n\nIn these situations, we have a \"transition period\" where the rule change is only\na \"warning\". Warnings don't cause `standard` to return a non-zero (error)\nexit code. However, a warning message will still print to the console. During\nthe transition period, `using standard --fix` will update your code so that it's\nready for the next major version.\n\nThe slow and careful approach is what we strive for with `standard`. We're\ngenerally extremely conservative in enforcing the usage of new language\nfeatures. We want using `standard` to be light and fun and so we're careful\nabout making changes that may get in your way. As always, you can\n[disable a rule](#how-do-i-disable-a-rule) at any time, if necessary.\n\n## Can I check code inside of Markdown or HTML files?\n\nTo check code inside Markdown files, use [`standard-markdown`](https://www.npmjs.com/package/standard-markdown).\n\nAlternatively, there are ESLint plugins that can check code inside Markdown, HTML,\nand many other types of language files:\n\nTo check code inside Markdown files, use an ESLint plugin:\n\n```bash\n$ npm install eslint-plugin-markdown\n```\n\nThen, to check JS that appears inside code blocks, run:\n\n```bash\n$ standard --plugin markdown '**/*.md'\n```\n\nTo check code inside HTML files, use an ESLint plugin:\n\n```bash\n$ npm install eslint-plugin-html\n```\n\nThen, to check JS that appears inside `