Note that 🔧 indicates the rule is auto-fixable.
Rule | Description |
---|---|
comment |
enforce starting a single-line comment with either TODO: , HACK: , See {url} , or a first-capitalized word |
consecutive-block-new-line 🔧 |
enforce having a new line at the end of a non-last block and the other way around |
export-name-after-file-name |
enforce naming a default exported identifier after the file name |
import-convention |
enforce naming imported identifiers after the user-defined list |
import-name-after-file-name |
enforce naming a default imported identifier after the file or the directory name (for an index file) |
import-path-from-closest-index |
enforce writing an import path pointing to the closest index file |
import-path-without-mentioning-index 🔧 |
enforce writing an import path to an index file without mentioning "index.js" |
no-shortened-identifier |
enforce naming an identifier without the user-defined abbreviations |
no-top-level-require |
enforce writing no top-level require |
parameter-new-line 🔧 |
enforce having consistent new lines between parameters |
promise-all-with-static-array |
enforce passing a static array to Promise.all() |
react-export-default 🔧 |
enforce writing React components consistently |
react-new-line 🔧 |
enforce having an additional empty line between two React elements if both of them occupy multiple lines |
react-prop-type |
enforce writing type definition for React props |
react-sort-props 🔧 |
enforce consistent React props sorting |
require-name-after-file-name |
enforce naming an identifier after the file name of its require statement |
require-name-after-predefined-name 🔧 |
enforce naming an identifier after the user-defined list of its require statement |
sort-imports 🔧 |
enforce sorting import statements. By default, this will sort according to Renke |
test-case-group 🔧 |
enforce using a function reference as a test case description |
test-case-new-line 🔧 |
enforce having a new line between it , test , describe and before expect function calls; this applies to *.{test,spec} files only |
test-case-title |
enforce writing consistent test case titles for it and test function calls; the allowed pattern of the test case title is "(does not) return/render/call/fetch/set/throw(s) ... (, given ...)" ; this also disallows writing some vague words, such proper, correct, appropriate, accurate, perfect |
typescript-enum-name |
enforce naming enumerations consistently; the possible options are "PascalCase" (default), "camelCase" , "UPPERCASE" , "SNAKE_CASE" |
typescript-explicit-return-type |
enforce functions to have explicit function return types |
typescript-exported-interface |
enforce exporting an interface , unless it is inside a declare block |
typescript-method-type 🔧 |
enforce writing function types using arrow notation |