eslint-plugin-jsdoc 39.2.7 → 39.2.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +12 -12
- package/package.json +4 -4
package/CONTRIBUTING.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Testing changes locally
|
|
4
4
|
|
|
5
5
|
You might try a TDD approach and add tests within the `test` directory,
|
|
6
|
-
to try different configs
|
|
6
|
+
to try different configs you may find it easier to try out changes in
|
|
7
7
|
a separate local directory.
|
|
8
8
|
|
|
9
9
|
You can run [`npm link`](https://docs.npmjs.com/cli/link) for this purpose,
|
|
@@ -18,7 +18,7 @@ npm link ../eslint-plugin-jsdoc
|
|
|
18
18
|
|
|
19
19
|
After running `npm install` to get the latest dependencies and devDependencies,
|
|
20
20
|
you can run the following command to update the `dist` files, with `dist/index.js`
|
|
21
|
-
being the `main`
|
|
21
|
+
being the `main` entry point from `package.json`:
|
|
22
22
|
|
|
23
23
|
```shell
|
|
24
24
|
npm run build
|
|
@@ -33,22 +33,22 @@ items needing fixing.
|
|
|
33
33
|
|
|
34
34
|
## Documentation building
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
To make changes that are reflected in the README, you will need to
|
|
37
37
|
modify files within the `.README` directory. `.README/README.md` contains the
|
|
38
38
|
main README skeleton and details on the project, its global `settings`, etc.,
|
|
39
|
-
while the documentation for specific rules (that will
|
|
39
|
+
while the documentation for specific rules (that will be pulled into the
|
|
40
40
|
README) ought to be modified within the relevant file within `.README/rules`.
|
|
41
41
|
Once these files are modified, you can run `npm run create-readme` to have
|
|
42
42
|
these files integrated into the main `/README.md`. While you should include
|
|
43
|
-
the built file in your PR, you will
|
|
44
|
-
directly to this file as they will be overwritten.
|
|
43
|
+
the built file in your PR, you will not want to make manual changes
|
|
44
|
+
directly to this file, as they will be overwritten.
|
|
45
45
|
|
|
46
46
|
## Testing
|
|
47
47
|
|
|
48
48
|
Tests are expected. Each rule file should be in CamelCase (despite the rule names themselves being hyphenated) and should be added within `test/assertions` and then imported/required by
|
|
49
49
|
`test/rules/index.js`.
|
|
50
50
|
|
|
51
|
-
Each rule file should be an ESM default export of an object
|
|
51
|
+
Each rule file should be an ESM default export of an object that has `valid` and `invalid` array properties containing the tests. Tests of each type should be provided.
|
|
52
52
|
|
|
53
53
|
`parserOptions` will be `ecmaVersion: 6` by default, but tests can override `parserOptions`
|
|
54
54
|
with their own.
|
|
@@ -57,8 +57,8 @@ See ESLint's [RuleTester](https://eslint.org/docs/developer-guide/nodejs-api#rul
|
|
|
57
57
|
for more on the allowable properties (e.g., `code`, `errors` (for invalid rules),
|
|
58
58
|
`options`, `settings`, etc.).
|
|
59
59
|
|
|
60
|
-
Note that besides `npm test
|
|
61
|
-
detailed information
|
|
60
|
+
Note that besides `npm test` there is `npm run test-cov`, which shows more
|
|
61
|
+
detailed coverage information. Coverage should be maintained at 100%, and
|
|
62
62
|
if there are a few guards in place for future use, the code block in question
|
|
63
63
|
can be ignored by being preceded by `/* istanbul ignore next */` (including
|
|
64
64
|
for warnings where the block is never passed over (i.e., the block is always
|
|
@@ -75,7 +75,7 @@ You can further limit this by providing `--invalid` and/or `--valid` flags
|
|
|
75
75
|
with a comma-separated list of 0-based indexes that you wish to include (also
|
|
76
76
|
accepts negative offsets from the end, e.g., `-1` for the last item). For
|
|
77
77
|
example, to check the first and third invalid tests of `check-examples`
|
|
78
|
-
|
|
78
|
+
along with the second valid test, you can run:
|
|
79
79
|
|
|
80
80
|
`npm run --rule=check-examples --invalid=0,2 --valid=1 test-index`.
|
|
81
81
|
|
|
@@ -84,7 +84,7 @@ alon with the second valid test, you can run:
|
|
|
84
84
|
PRs should be mergeable, [rebasing](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
|
|
85
85
|
first against the latest `master`.
|
|
86
86
|
|
|
87
|
-
The number of commits will ideally be limited
|
|
87
|
+
The number of commits will ideally be limited unless extra commits
|
|
88
88
|
can better show a progression of features.
|
|
89
89
|
|
|
90
90
|
Commit messages should be worded clearly and the reason for any PR made clear
|
|
@@ -96,5 +96,5 @@ We use [semantic-release](https://github.com/semantic-release/semantic-release)
|
|
|
96
96
|
for preparing releases, so the commit messages (or at least the merge that
|
|
97
97
|
brings them into `master`) must follow the
|
|
98
98
|
[AngularJS commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) with a special format such as `feat: describe new feature`
|
|
99
|
-
|
|
99
|
+
for releases to occur and for the described items to be added
|
|
100
100
|
to the release notes.
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"url": "http://gajus.com"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@es-joy/jsdoccomment": "~0.
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.29.0",
|
|
9
9
|
"comment-parser": "1.3.1",
|
|
10
10
|
"debug": "^4.3.4",
|
|
11
11
|
"escape-string-regexp": "^4.0.0",
|
|
@@ -32,13 +32,13 @@
|
|
|
32
32
|
"chai": "^4.3.6",
|
|
33
33
|
"cross-env": "^7.0.3",
|
|
34
34
|
"decamelize": "^5.0.1",
|
|
35
|
-
"eslint": "^8.
|
|
35
|
+
"eslint": "^8.14.0",
|
|
36
36
|
"eslint-config-canonical": "~33.0.1",
|
|
37
37
|
"gitdown": "^3.1.5",
|
|
38
38
|
"glob": "^8.0.1",
|
|
39
39
|
"husky": "^7.0.4",
|
|
40
40
|
"jsdoc-type-pratt-parser": "^3.0.1",
|
|
41
|
-
"lint-staged": "^12.
|
|
41
|
+
"lint-staged": "^12.4.0",
|
|
42
42
|
"lodash.defaultsdeep": "^4.6.1",
|
|
43
43
|
"mocha": "^9.2.2",
|
|
44
44
|
"nyc": "^15.1.0",
|
|
@@ -117,5 +117,5 @@
|
|
|
117
117
|
"test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
|
|
118
118
|
"test-index": "npm run test-no-cov -- test/rules/index.js"
|
|
119
119
|
},
|
|
120
|
-
"version": "39.2.
|
|
120
|
+
"version": "39.2.8"
|
|
121
121
|
}
|