Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: add notice about function keyword in keyword-spacing #12524

Merged
merged 2 commits into from Nov 5, 2019
Merged

Docs: add notice about function keyword in keyword-spacing #12524

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c04254
Docs: add notice about `function` keyword in keyword-spacing
g-plane Nov 3, 2019
a095fa1
Docs: publish
g-plane Nov 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/rules/keyword-spacing.md
View file
Open in desktop
@@ -1,7 +1,7 @@
# enforce consistent spacing before and after keywords (keyword-spacing)

Keywords are syntax elements of JavaScript, such as `function` and `if`.
These identifiers have special meaning to the language and so often appear in a different color in code editors.
Keywords are syntax elements of JavaScript, such as `try` and `if`.
These keywords have special meaning to the language and so often appear in a different color in code editors.
As an important part of the language, style guides often refer to the spacing that should be used around keywords.
For example, you might have a style guide that says keywords should be always surrounded by spaces, which would mean `if-else` statements must look like this:

Expand All @@ -15,6 +15,8 @@ if (foo) {

Of course, you could also have a style guide that disallows spaces around keywords.

However, if you want to enforce the style of spacing between `function` keyword and parenthesis, please refer to [space-before-function-paren](space-before-function-paren.md).
g-plane marked this conversation as resolved.
Show resolved Hide resolved

## Rule Details

This rule enforces consistent spacing around keywords and keyword-like tokens: `as` (in module declarations), `async` (of async functions), `await` (of await expressions), `break`, `case`, `catch`, `class`, `const`, `continue`, `debugger`, `default`, `delete`, `do`, `else`, `export`, `extends`, `finally`, `for`, `from` (in module declarations), `function`, `get` (of getters), `if`, `import`, `in`, `instanceof`, `let`, `new`, `of` (in for-of statements), `return`, `set` (of setters), `static`, `super`, `switch`, `this`, `throw`, `try`, `typeof`, `var`, `void`, `while`, `with`, and `yield`. This rule is designed carefully not to conflict with other spacing rules: it does not apply to spacing where other rules report problems.
Expand Down