Skip to content

Commit

Permalink
docs: update README and rule documentation for top-level functions to…
Browse files Browse the repository at this point in the history
… reflect enabled configs
  • Loading branch information
tomerh2001 committed Dec 30, 2024

Verified

This commit was signed with the committer’s verified signature.
kierandrewett Kieran Drewett
1 parent 0bee66f commit db6fad0
Showing 4 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ This repository contains custom ESLint rules to enhance code quality and consist
| [no-comments](docs/rules/no-comments.md) | Disallow comments except for specified allowed patterns. |![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |
| [no-default-export](docs/rules/no-default-export.md) | Convert unnamed default exports to named default exports based on the file name. |![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |
| [no-destructuring](docs/rules/no-destructuring.md) | Disallow destructuring that does not meet certain conditions |![badge-recommended-react][] ![badge-recommended-typescript][] | |
| [top-level-functions](docs/rules/top-level-functions.md) | Require all top-level functions to be named/regular functions. | | 🔧 |
| [top-level-functions](docs/rules/top-level-functions.md) | Require all top-level functions to be named/regular functions. | ![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |

<!-- end auto-generated rules list -->

2 changes: 2 additions & 0 deletions docs/rules/top-level-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Require all top-level functions to be named/regular functions (`th-rules/top-level-functions`)

💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-react`, `recommended-typescript`.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -49,7 +49,7 @@
"eslint-plugin-eslint-plugin": "^6.4.0",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-sonarjs": "^3.0.1",
"eslint-plugin-th-rules": "1.14.1",
"eslint-plugin-th-rules": "1.15.6",
"eslint-plugin-unicorn": "^56.0.1",
"mocha": "^11.0.1",
"npm-run-all": "^4.1.5",
10 changes: 5 additions & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
@@ -4420,9 +4420,9 @@ __metadata:
languageName: node
linkType: hard

"eslint-plugin-th-rules@npm:1.14.1":
version: 1.14.1
resolution: "eslint-plugin-th-rules@npm:1.14.1"
"eslint-plugin-th-rules@npm:1.15.6":
version: 1.15.6
resolution: "eslint-plugin-th-rules@npm:1.15.6"
dependencies:
"@babel/eslint-parser": "npm:^7.25.9"
eslint-config-jsdoc: "npm:^15.4.0"
@@ -4438,7 +4438,7 @@ __metadata:
peerDependencies:
eslint: ">=9.17.0"
typescript: ^5.7.2
checksum: 10c0/1dccd3682fc42f75f1b546220d5f09362ca6e64c11c9adacde12936c4bcb7f17fbae4ccba71a7ef2fe94c895f7989347b0615503b25fcd2000742c7b99f251b2
checksum: 10c0/fa905351da8172e055b38e31a39605c1449c6865b893fa5006c0fca7ecb55358b964f2d49bcd6bb651f8fc7702465fdfcee6f37e066964de35fc202c2093a86b
languageName: node
linkType: hard

@@ -4473,7 +4473,7 @@ __metadata:
eslint-plugin-react-native: "npm:^5.0.0"
eslint-plugin-security: "npm:^3.0.1"
eslint-plugin-sonarjs: "npm:^3.0.1"
eslint-plugin-th-rules: "npm:1.14.1"
eslint-plugin-th-rules: "npm:1.15.6"
eslint-plugin-unicorn: "npm:^56.0.1"
mocha: "npm:^11.0.1"
npm-run-all: "npm:^4.1.5"

0 comments on commit db6fad0

Please sign in to comment.