Skip to content

Commit 4c33fc7

Browse files
Enable ignoreOverloadsWithDifferentJSDoc option for unified-signatures (#111)
* Add ignoreOverloadsWithDifferentJSDoc option * Change files * Update deps for audit * Update change/@itwin-eslint-plugin-bccb514b-a007-48e6-a8d5-2ebb6d92416c.json Co-authored-by: Anmol Shrestha <98850418+anmolshres98@users.noreply.github.com> * Remove comments from package json * Add js-yaml version override * audit level moderate --------- Co-authored-by: Anmol Shrestha <98850418+anmolshres98@users.noreply.github.com> Co-authored-by: anmolshres98 <anmolshres98@users.noreply.github.com>
1 parent 62fb823 commit 4c33fc7

5 files changed

Lines changed: 612 additions & 55 deletions

File tree

.github/workflows/ci-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
run: pnpm install
2828

2929
- name: Security audit
30-
run: pnpm audit
30+
run: pnpm audit --audit-level moderate
3131

3232
- name: Run Tests
3333
run: pnpm run cover
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "patch",
3+
"comment": "enable ignoreOverloadsWithDifferentJSDoc for @typescript-eslint/unified-signatures rule",
4+
"packageName": "@itwin/eslint-plugin",
5+
"email": "108895074+MichaelSwigerAtBentley@users.noreply.github.com",
6+
"dependentChangeType": "patch"
7+
}

dist/configs/itwinjs-recommended.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,12 @@ module.exports =
184184
"@typescript-eslint/triple-slash-reference": "error",
185185
"@typescript-eslint/typedef": "off",
186186
"@typescript-eslint/unbound-method": "error",
187-
"@typescript-eslint/unified-signatures": "error",
187+
"@typescript-eslint/unified-signatures": [
188+
"error",
189+
{
190+
"ignoreOverloadsWithDifferentJSDoc": true,
191+
},
192+
],
188193
"arrow-body-style": "off",
189194
"camelcase": "off", // Using @typescript-eslint/naming-convention instead
190195
"complexity": "off",

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
},
5555
"devDependencies": {
5656
"@types/node": "20.11.16",
57-
"beachball": "^2.54.0",
57+
"beachball": "^2.62.0",
5858
"eslint": "^9.31.0",
5959
"husky": "^9.1.7",
6060
"mocha": "^10.8.2",
@@ -63,5 +63,11 @@
6363
"engines": {
6464
"node": "^20.11.0 || ^22.0.0"
6565
},
66+
"pnpm": {
67+
"overrides": {
68+
"tar": ">=7.5.4",
69+
"js-yaml": ">=4.1.1"
70+
}
71+
},
6672
"packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39"
6773
}

0 commit comments

Comments
 (0)