Skip to content

Commit 0c80011

Browse files
authored
Merge pull request #18 from homer0/next
Node v22 support, dependencies update and jsdocExperimentalIgnoreInlineForCommentsWithoutTags
2 parents e29e3be + 3de26a8 commit 0c80011

File tree

16 files changed

+5115
-2765
lines changed

16 files changed

+5115
-2765
lines changed

.github/workflows/release.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@ jobs:
1414
- name: Node.js
1515
uses: actions/setup-node@v3
1616
with:
17-
node-version: '20.8.1'
17+
node-version-file: '.nvmrc'
1818
- uses: pnpm/action-setup@v2
1919
with:
20-
version: 8
20+
version: 9
2121
- name: Install dependencies
2222
env:
2323
HUSKY_SKIP_INSTALL: 1
2424
run: pnpm install --frozen-lockfile
25-
- name: Install semantic-release
26-
run: pnpm add -g semantic-release@^23.0.7 @semantic-release/changelog@^6.0.3 @semantic-release/git@^10.0.1
27-
- run: semantic-release
25+
- run: pnpm exec semantic-release
2826
env:
2927
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3028
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
runs-on: ubuntu-latest
88
strategy:
99
matrix:
10-
node: ['18', '20']
10+
node: ['18', '20', '22']
1111
name: Run jest and ESLint (Node ${{ matrix.node }})
1212
steps:
1313
- uses: actions/checkout@v3
@@ -16,10 +16,10 @@ jobs:
1616
node-version: ${{ matrix.node }}
1717
- uses: pnpm/action-setup@v2
1818
with:
19-
version: 8
19+
version: 9
2020
- run: pnpm install --frozen-lockfile
2121
- run: pnpm run lint:all
2222
- run: pnpm test
2323
- name: Coveralls
24-
if: ${{ matrix.node == '18' }}
24+
if: ${{ matrix.node == '20' }}
2525
uses: coverallsapp/github-action@v2

.husky/commit-msg

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
#!/bin/sh
2-
. "$(dirname "$0")/_/husky.sh"
3-
42
pnpm exec commitlint --edit $1

.husky/post-merge

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
11
#!/bin/sh
2-
. "$(dirname "$0")/_/husky.sh"
3-
42
pnpm i
5-

.husky/pre-commit

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
#!/bin/sh
2-
. "$(dirname "$0")/_/husky.sh"
3-
42
pnpm run lint

.husky/pre-push

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
#!/bin/sh
2-
. "$(dirname "$0")/_/husky.sh"
3-
42
pnpm test

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
18.18
1+
20

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,14 @@ This will prevent the plugin from running from the original package. The idea is
874874

875875
By default, the plugin will only parse comments with tags. Use this option, at your own risk, if you want to format blocks without tags.
876876

877+
##### Ignore inline blocks for comments without tags
878+
879+
| Option | Type | Default |
880+
| ----------------------------------------------------- | ------- | ------- |
881+
| `jsdocExperimentalIgnoreInlineForCommentsWithoutTags` | boolean | `false` |
882+
883+
Whether or not to ignore the `jsdocUseInlineCommentForASingleTagBlock` option for comments without tags (when `jsdocExperimentalFormatCommentsWithoutTags` is enabled).
884+
877885
### 🚫 Ignoring blocks
878886

879887
If you have some blocks where you don't the plugin to make any modification, you can add the `@prettierignore` tag and it/they will be skipped:

package.json

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,29 @@
1818
"type": "commonjs",
1919
"dependencies": {
2020
"comment-parser": "^1.4.1",
21-
"prettier": "^3.2.5",
22-
"ramda": "0.30.0"
21+
"prettier": "^3.3.3",
22+
"ramda": "0.30.1"
2323
},
2424
"devDependencies": {
25-
"@commitlint/cli": "^19.3.0",
26-
"@commitlint/config-conventional": "^19.2.2",
27-
"@homer0/eslint-plugin": "^12.0.5",
25+
"@commitlint/cli": "^19.5.0",
26+
"@commitlint/config-conventional": "^19.5.0",
27+
"@homer0/eslint-plugin": "^12.0.6",
2828
"@homer0/prettier-config": "^1.1.3",
29-
"eslint": "^8.57.0",
30-
"husky": "^9.0.11",
29+
"@semantic-release/changelog": "^6.0.3",
30+
"@semantic-release/git": "^10.0.1",
31+
"eslint": "^8.57.1",
32+
"husky": "^9.1.6",
3133
"is-ci": "^3.0.1",
3234
"jest": "^29.7.0",
3335
"jest-environment-node": "^29.7.0",
34-
"leasot": "^13.3.0",
35-
"lint-staged": "^15.2.5",
36-
"prettier": "^3.2.5"
36+
"leasot": "^14.4.0",
37+
"lint-staged": "^15.2.10",
38+
"prettier": "^3.3.3",
39+
"semantic-release": "^24.2.0"
3740
},
3841
"engine-strict": true,
3942
"engines": {
40-
"node": ">=18.17 <21"
43+
"node": ">=18.17 <23"
4144
},
4245
"main": "src/index.js",
4346
"scripts": {

0 commit comments

Comments
 (0)