Feature/add documentation to missing rules
MODIFY
.gitignore
.gitignore
.DS_Store
Profile-*.json
+.vscode
\ No newline at end of file

ADD
.vscode/settings.json
+{
+ "i18n-ally.localesPaths": "internal/messages"
+}
\ No newline at end of file

MODIFY
website/src/docs/lint/rules/js/camelCase.md
website/src/docs/lint/rules/js/camelCase.md
@@ -11,4 +11,7 @@ eleventyNavigation:
# js/camelCase
-MISSING DOCUMENTATION
+* This rule checks for variable definitions and assignments.
+* The variable should be written in camel case.
+eg ``variableName``
+* For more details on the rule. Read the more on this [here](https://eslint.org/docs/rules/camelcase)
\ No newline at end of file

MODIFY
website/src/docs/lint/rules/js/confusingLanguage.md
website/src/docs/lint/rules/js/confusingLanguage.md
@@ -10,7 +10,7 @@ eleventyNavigation:
# js/confusingLanguage
-MISSING DOCUMENTATION
+Be careful not to use language that might be charged with motive.
<!-- GENERATED:START(hash:c982488a5e77e12ec46707352f24b059935e9577,id:main) Everything below is automatically generated. DO NOT MODIFY. Run `./rome run scripts/generated-files/lint-rules-docs` to update. -->
## Examples

MODIFY
website/src/docs/lint/rules/js/doubleEquals.md
website/src/docs/lint/rules/js/doubleEquals.md
@@ -10,7 +10,10 @@ eleventyNavigation:
# js/doubleEquals
-MISSING DOCUMENTATION
+* It is general bad practise to use ``==`` for comparison instead of ``===``
+* Double operators will triger implicit type coersion and are thus not prefered.
+* Using strict equality operators is good practice.
+* Eg. Use ``===`` or ``!==`` instead of ``==`` of ``!=``
<!-- GENERATED:START(hash:80f16cb3ab76f9046016be8e44eedb18221cc939,id:main) Everything below is automatically generated. DO NOT MODIFY. Run `./rome run scripts/generated-files/lint-rules-docs` to update. -->
## Examples

MODIFY
website/src/docs/lint/rules/js/duplicateImportSource.md
website/src/docs/lint/rules/js/duplicateImportSource.md
@@ -10,7 +10,7 @@ eleventyNavigation:
# js/duplicateImportSource
-MISSING DOCUMENTATION
+This rule checks to avoid importing the same source more than once in the same file.
<!-- GENERATED:START(hash:515781eebed073c637f741ef16780eb09a0448cf,id:main) Everything below is automatically generated. DO NOT MODIFY. Run `./rome run scripts/generated-files/lint-rules-docs` to update. -->
## Examples

MODIFY
website/src/docs/lint/rules/js/emptyBlocks.md
website/src/docs/lint/rules/js/emptyBlocks.md
@@ -10,7 +10,9 @@ eleventyNavigation:
# js/emptyBlocks
-MISSING DOCUMENTATION
+* This rule checks that no blocks are left empty.
+* It checks for functions all the way to if/else statements.
+* No blocks should be left empty, for more information read [this](https://eslint.org/docs/rules/no-empty)
<!-- GENERATED:START(hash:70faf58a6208a1aea90b15b8c2b6145fb48ac72a,id:main) Everything below is automatically generated. DO NOT MODIFY. Run `./rome run scripts/generated-files/lint-rules-docs` to update. -->
## Examples

Feature/add documentation to missing rules (#960)