Skip to content

A platform for community discussion. Free, open, simple.

DEV: Prepare core for TSDoc syntax linting (#42533)

Sérgio Saquetim3bcc19a5d2df
diff --git a/docs/developer-guides/package.json b/docs/developer-guides/package.json
index 29225de52bd..46dbd371d5c 100644
--- a/docs/developer-guides/package.json
+++ b/docs/developer-guides/package.json
@@ -6,7 +6,7 @@
"lint:fix": "prettier --write '**/*.{md,json,mjs,yml}'"
},
"devDependencies": {
- "@discourse/lint-configs": "^3.1.2",
+ "@discourse/lint-configs": "^3.3.0",
"prettier": "3.8.1"
}
}
diff --git a/frontend/discourse/app/ui-kit/modifiers/d-swipe.ts b/frontend/discourse/app/ui-kit/modifiers/d-swipe.ts
index 52390ebe3e9..99101e0bca2 100644
--- a/frontend/discourse/app/ui-kit/modifiers/d-swipe.ts
+++ b/frontend/discourse/app/ui-kit/modifiers/d-swipe.ts
@@ -99,6 +99,7 @@ interface DSwipeSignature {
* with the current state of the swipe, including its direction, orientation, and delta values.
*
* @example
+ * ```hbs
* <div {{swipe
* onDidStartSwipe=this.onDidStartSwipe
* onDidSwipe=this.onDidSwipe
@@ -108,6 +109,7 @@ interface DSwipeSignature {
* >
* Swipe here
* </div>
+ * ```
*/
export default class DSwipeModifier extends Modifier<DSwipeSignature> {
@service declare site: Site;
diff --git a/lefthook.yml b/lefthook.yml
index 16e514c14c7..4ad3ffc1b19 100644
--- a/lefthook.yml
+++ b/lefthook.yml
@@ -40,7 +40,7 @@ pre-commit:
- "frontend/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs}"
- "plugins/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs}"
- "themes/**/*.{js,gjs,ts,gts,mts,cts,cjs,mjs}"
- run: pnpm eslint --max-warnings 0 {staged_files}
+ run: pnpm eslint --max-warnings 0 --no-warn-ignored {staged_files}
yaml-syntax:
glob: &yaml_glob "**/*.{yaml,yml}"
# database.yml is an erb file not a yaml file
@@ -64,7 +64,7 @@ fix-staged:
run: pnpm pprettier --write {staged_files}
eslint:
glob: *eslint_glob
- run: pnpm eslint --fix {staged_files}
+ run: pnpm eslint --fix --no-warn-ignored {staged_files}
stylelint:
glob: *stylelint_glob
run: pnpm stylelint --fix {staged_files}
@@ -104,7 +104,7 @@ lint-files:
eslint:
files: *working_tree_files
glob: *eslint_glob
- run: pnpm eslint --max-warnings 0 {files}
+ run: pnpm eslint --max-warnings 0 --no-warn-ignored {files}
yaml-syntax:
files: *working_tree_files
glob: *yaml_glob
diff --git a/package.json b/package.json
index 878e5d43612..dcabe27ea2a 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,7 @@
"author": "Discourse",
"license": "GPL-2.0-only",
"devDependencies": {
- "@discourse/lint-configs": "^3.2.0",
+ "@discourse/lint-configs": "^3.3.0",
"@discourse/moment-timezone-names-translations": "^1.0.0",
"@fortawesome/fontawesome-free": "7.2.0",
"@glint/ember-tsc": "^1.8.11",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index ee1485ec499..ae4c13ce058 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -46,8 +46,8 @@ importers:
.:
devDependencies:
'@discourse/lint-configs':
- specifier: ^3.2.0
+ specifier: ^3.3.0
'@discourse/moment-timezone-names-translations':
specifier: ^1.0.0
version: 1.0.0
@@ -106,8 +106,8 @@ importers:
docs/developer-guides:
devDependencies:
'@discourse/lint-configs':
- specifier: ^3.1.2
+ specifier: ^3.3.0
prettier:
specifier: 3.8.1
version: 3.8.1
@@ -1818,8 +1818,8 @@ packages:
'@discourse/[email protected]':
resolution: {integrity: sha512-Veu75DEDC7uKsCCsD94UIjFwvHE73+AATBQbBWb83QyJV34wmyxl2Ji+fiiM234mlNn4cpo3DUl0QFrXgRTcfA==}
- '@discourse/[email protected]':
- resolution: {integrity: sha512-mEZYPNlGyf+Jq6i6QKzi2mXw9ofgcEh1XARoQKQS1Y+SsclJgGHT33MUxn5QwWEaGpSYA67/0hdPVL+HEW29gw==}
+ '@discourse/[email protected]':
+ resolution: {integrity: sha512-BrC17IVjBacD72sdfEz1kJpqCeDp54aTIXXHYjm4uxQuK9VsftZFHfwn2ntg2NwhCk3LqrprAS/11QMxzAk27w==}
peerDependencies:
eslint: 10.6.0
prettier: 3.8.1
@@ -2386,6 +2386,12 @@ packages:
'@messageformat/[email protected]':
resolution: {integrity: sha512-dkIPDCjXcfhSHgNE1/qV6TeczQZR59Yx0xXeafVKgK3QVWoxc38ljwpksUpnzCGvN151KUbCJTDZVmahtf1YZw==}
+ '@microsoft/[email protected]':
+ resolution: {integrity: sha512-9brPoVdfN9k9g0dcWkFeA7IH9bbcttzDJlXvkf8b2OBzd5MueR1V2wkKBL0abn0otvmkHJC6aapBOTJDDeMCZg==}
+
+ '@microsoft/[email protected]':
+ resolution: {integrity: sha512-xgAyonlVVS+q7Vc7qLW0UrJU7rSFcETRWsqdXZtjzRU8dF+6CkozTK4V4y1LwOX7j8r/vHphjDeMeGI4tNGeGA==}
+
'@napi-rs/[email protected]':
resolution: {integrity: sha512-AWPoBRJ9tsnVhor4sjO7rkni+7p+2IAEFj6cx06UgP10jkQHqay/36uRV/bFkgrh18D9vb4cr8Q0Pthskgzy+Q==}
peerDependencies:
@@ -2993,16 +2999,32 @@ packages:
eslint: ^8.57.0 || ^9.0.0 || ^10.0.0
typescript: '>=4.8.4 <6.1.0'
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-TAdqQTzHNNvlVFfR+hu2PDJrURiwKsUvxFn1M0h95BB8ah5jejas08jUWG4dBA68jDMI988IvtfdAI53JzEHOQ==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+ peerDependencies:
+ typescript: '>=4.8.4 <6.0.0'
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-yQ3RgY5RkSBpsNS1Bx/JQEcA24FOSdfGktoyprAr5u18390UQdtVcfnEv4nIrIshNnavlVyZBKxQwT1fIAE6cg==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
peerDependencies:
typescript: '>=4.8.4 <6.1.0'
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-YAi4VDKcIZp0O4tz/haYKhmIDZFEUPOreKbfdAN3SzUDMcPhJ8QI99xQXqX+HoUVq8cs85eRKnD+rne2UAnj2w==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-r4d249KbQ1SFdpeStvob8Ih6aPPIzfqllPVOtvhve6ZcpuVcYo5/7zUWckKpHE7StASX4kTKZTLf0WQm/wPkcg==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-qOtCYzKEeyr3aR9f28mPJqBty7+DBqsdd63eO0yyDwc6vgThj2UjWfJIcsFeSucYydqcuudMOprZ+x1SpF3ZuQ==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+ peerDependencies:
+ typescript: '>=4.8.4 <6.0.0'
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-xadytJqX9vJVQ2fdQjkcIVigwaOJNWkpjdLt6cEQ+xPnrI1fkp+/jZE/I97k9KUjqtpd25i0HeyZf3T6dutv2g==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
@@ -3022,16 +3044,33 @@ packages:
eslint: ^8.57.0 || ^9.0.0 || ^10.0.0
typescript: '>=4.8.4 <6.1.0'
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-dbMkdIUkIkchgGDIv7KLUpa0Mda4IYjo4IAMJUZ+3xNoUXxMsk9YtKpTHSChRS85o+H9ftm51gsK1dZReY9CVw==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-ooCzJFaf+Hg+uG6fA3NRFGuFjlfNlDhBthbv4ZPU/0elCAFUfnyXUvf/WOpHz/jYwSmvU2GkR2LtyUfy1AxZ1Q==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-qzUL1qgalIvKWAf9C1HpvBjif+Vm6rcT5wZd4VoMb9+Km3iS3Cv9DY6dMRMDtPnwRAFyAi7YXJpTIEXLvdfPxg==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+ peerDependencies:
+ typescript: '>=4.8.4 <6.0.0'
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-xMcW9oP9u7fAMXYs9A65CVmtLQe2r//oXINHfi8HV+oiqhih17sbLdhXr4540YWlgpDKQdY854OL5ZrdCiQsAA==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
peerDependencies:
typescript: '>=4.8.4 <6.1.0'
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-HPAVNIME3tABJ61siYlHzSWCGtOoeP2RTIaHXFMPqjrQKCGB9OgUVdiNgH7TJS2JNIQ5qQ4RsAUDuGaGme/KOA==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+ peerDependencies:
+ eslint: ^8.57.0 || ^9.0.0 || ^10.0.0
+ typescript: '>=4.8.4 <6.0.0'
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-sHtbPfuKNZCG+ih8SyjjucqRntSVmp8XgL5u6o9mAhiSn8ds5o/M/XdM0abweme2Tln3szOstOrZ9OXitvPh0g==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
@@ -3039,6 +3078,10 @@ packages:
eslint: ^8.57.0 || ^9.0.0 || ^10.0.0
typescript: '>=4.8.4 <6.1.0'
+ '@typescript-eslint/[email protected]':
+ resolution: {integrity: sha512-KiROIzYdEV85YygXw6BI/Dx4fnBlFQu6Mq4QE4MOH9fFnhohw6wX/OAvDY2/C+ut0I3RSPKenvZJIVYqJNkhEw==}
+ engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
+
'@typescript-eslint/[email protected]':
resolution: {integrity: sha512-4g3BLxfdTMy8iZG0MaBkadnlRrCJ74cQiFbyEVMrkwIoqdyaXXQM22cotDvrl4x28wgIZ9rEJRoM+mmhSJpJ1g==}
engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0}
@@ -3186,6 +3229,9 @@ packages:
resolution: {integrity: sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==}
+ resolution: {integrity: sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==}
+
resolution: {integrity: sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==}
@@ -4608,6 +4654,9 @@ packages:
peerDependencies:
eslint: '>=0.8.0'
+ resolution: {integrity: sha512-BlvqjWZdBJDIPO/YU3zcPCF23CvjYT3gyu63yo6b609NNV3D1b6zceAREy2xnweuBoDpZcLNuPyAUq9cvx6bbQ==}
+
resolution: {integrity: sha512-xS90H51cKw0jltxmvmHy2Iai1LIqrfbw57b79w/J7MfvDfkIkFZ+kj6zC3BjtUwh150HsSSdxXZcsuv72miDFQ==}
engines: {node: ^20.19.0 || ^22.13.0 || >=24}
@@ -5638,6 +5687,9 @@ packages:
resolution: {integrity: sha512-ekilCSN1jwRvIbgeg/57YFh8qQDNbwDb9xT/qu2DAHbFFZUicIl4ygVaAvzveMhMVr3LnpSKTNnwt8PoOfmKhQ==}
hasBin: true
+ resolution: {integrity: sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==}
+
resolution: {integrity: sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==}
@@ -9461,7 +9513,7 @@ snapshots:
dependencies:
wasm-feature-detect: 1.8.0
dependencies:
'@babel/core': 8.0.1
'@babel/eslint-parser': 8.0.1(@babel/[email protected])([email protected]([email protected]))
@@ -9474,6 +9526,7 @@ snapshots:
eslint-plugin-qunit: 8.2.6([email protected]([email protected]))
eslint-plugin-simple-import-sort: 13.0.0([email protected]([email protected]))
eslint-plugin-sort-class-members: 1.22.1([email protected]([email protected]))
globals: 17.7.0
prettier: 3.8.1
prettier-plugin-ember-template-tag: 2.1.7([email protected])
@@ -10317,6 +10370,15 @@ snapshots:
dependencies:
make-plural: 7.5.0
+ '@microsoft/[email protected]':
+ dependencies:
+ '@microsoft/tsdoc': 0.16.0
+ ajv: 8.18.0
+ jju: 1.4.0
+ resolve: 1.22.12
+
+ '@microsoft/[email protected]': {}
+
dependencies:
'@emnapi/core': 1.10.0
@@ -10878,6 +10940,15 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ '@typescript-eslint/[email protected]([email protected])':
+ dependencies:
+ '@typescript-eslint/tsconfig-utils': 8.63.0([email protected])
+ '@typescript-eslint/types': 8.62.1
+ debug: 4.4.3
+ typescript: 5.9.3
+ transitivePeerDependencies:
+ - supports-color
+
'@typescript-eslint/[email protected]([email protected])':
dependencies:
'@typescript-eslint/tsconfig-utils': 8.63.0([email protected])
@@ -10887,11 +10958,20 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ '@typescript-eslint/[email protected]':
+ dependencies:
+ '@typescript-eslint/types': 8.56.1
+ '@typescript-eslint/visitor-keys': 8.56.1
+
'@typescript-eslint/[email protected]':
dependencies:
'@typescript-eslint/types': 8.62.1
'@typescript-eslint/visitor-keys': 8.62.1
+ '@typescript-eslint/[email protected]([email protected])':
+ dependencies:
+ typescript: 5.9.3
+
'@typescript-eslint/[email protected]([email protected])':
dependencies:
typescript: 5.9.3
@@ -10912,8 +10992,25 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ '@typescript-eslint/[email protected]': {}
+
'@typescript-eslint/[email protected]': {}
+ '@typescript-eslint/[email protected]([email protected])':
+ dependencies:
+ '@typescript-eslint/project-service': 8.56.1([email protected])
+ '@typescript-eslint/tsconfig-utils': 8.56.1([email protected])
+ '@typescript-eslint/types': 8.56.1
+ '@typescript-eslint/visitor-keys': 8.56.1
+ debug: 4.4.3
+ minimatch: 10.2.5
+ semver: 7.8.4
+ tinyglobby: 0.2.17
+ ts-api-utils: 2.5.0([email protected])
+ typescript: 5.9.3
+ transitivePeerDependencies:
+ - supports-color
+
'@typescript-eslint/[email protected]([email protected])':
dependencies:
'@typescript-eslint/project-service': 8.62.1([email protected])
@@ -10929,6 +11026,17 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ '@eslint-community/eslint-utils': 4.9.1([email protected]([email protected]))
+ '@typescript-eslint/scope-manager': 8.56.1
+ '@typescript-eslint/types': 8.56.1
+ '@typescript-eslint/typescript-estree': 8.56.1([email protected])
+ eslint: 10.6.0([email protected])
+ typescript: 5.9.3
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@eslint-community/eslint-utils': 4.9.1([email protected]([email protected]))
@@ -10940,6 +11048,11 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ '@typescript-eslint/[email protected]':
+ dependencies:
+ '@typescript-eslint/types': 8.56.1
+ eslint-visitor-keys: 5.0.1
+
'@typescript-eslint/[email protected]':
dependencies:
'@typescript-eslint/types': 8.62.1
@@ -11132,6 +11245,13 @@ snapshots:
json-schema-traverse: 0.4.1
uri-js: 4.4.1
+ dependencies:
+ fast-deep-equal: 3.1.3
+ fast-uri: 3.1.2
+ json-schema-traverse: 1.0.0
+ require-from-string: 2.0.2
+
dependencies:
fast-deep-equal: 3.1.3
@@ -13079,6 +13199,16 @@ snapshots:
dependencies:
eslint: 10.6.0([email protected])
+ dependencies:
+ '@microsoft/tsdoc': 0.16.0
+ '@microsoft/tsdoc-config': 0.18.1
+ '@typescript-eslint/utils': 8.56.1([email protected]([email protected]))([email protected])
+ transitivePeerDependencies:
+ - eslint
+ - supports-color
+ - typescript
+
dependencies:
'@types/esrecurse': 4.3.1
@@ -14242,6 +14372,8 @@ snapshots:
+