Skip to content

Commit

Permalink
rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
cedeber committed Sep 8, 2024
1 parent 2248a39 commit 907a127
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# eslint-plugin-throw
# eslint-plugin-throw-aware

ESLint plugin to enforce function naming and JSDoc annotations for functions that throw

## Rules

| Name | Description |
| :------------------ | :------------------------------------------------------------ |
| throw-documentation | Enforce JSDoc @throws tag for functions that throw exceptions |
| Name | Description |
| :----------------- | :------------------------------------------------------------ |
| require-throws-doc | Enforce JSDoc @throws tag for functions that throw exceptions |
7 changes: 4 additions & 3 deletions lib/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ const plugin = {
},
configs: {},
rules: {
"throw-documentation": throwDocumentation,
"require-throws-doc": throwDocumentation,
// "throw-function-naming": ,
},
processors: {},
};
Expand All @@ -24,10 +25,10 @@ Object.assign(plugin.configs, {
recommended: [
{
plugins: {
"eslint-plugin-throw": plugin,
"throw-aware": plugin,
},
rules: {
"eslint-plugin-throw/throw-documentation": "error",
"throw-aware/require-throws-doc": "error",
},
languageOptions: {
globals: {
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-throw",
"version": "1.0.0-beta.3",
"name": "eslint-plugin-throw-aware",
"version": "1.0.0-beta.1",
"description": "An ESLint plugin to enforce naming conventions and JSDoc annotations for functions that throw exceptions.",
"type": "module",
"main": "lib/index.mjs",
Expand All @@ -9,7 +9,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/cedeber/eslint-plugin-throw.git"
"url": "git+https://github.com/cedeber/eslint-plugin-throw-aware.git"
},
"keywords": [
"eslint",
Expand All @@ -19,9 +19,9 @@
"author": "Cédric Eberhardt <hello+code@cedeber.fr>",
"license": "Unlicense",
"bugs": {
"url": "https://github.com/cedeber/eslint-plugin-throw/issues"
"url": "https://github.com/cedeber/eslint-plugin-throw-aware/issues"
},
"homepage": "https://github.com/cedeber/eslint-plugin-throw#readme",
"homepage": "https://github.com/cedeber/eslint-plugin-throw-aware#readme",
"peerDependencies": {
"eslint": ">=9.0.0"
},
Expand Down

0 comments on commit 907a127

Please sign in to comment.