jsdoc: add @ignore, @internal and @stable as definedTags

This will be used to indicate the stability of JS methods, following the introduction of the frontend stable interface policy: https://w.wiki/87wa See https://www.mediawiki.org/wiki/Topic:Xrs17s867zgd9j7b
wikimedia · Nov 13, 2023 · 68561c5 · 68561c5
1 parent 732cd55
commit 68561c5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/jsdoc.json b/jsdoc.json
@@ -39,6 +39,16 @@
 	},
 	"rules": {
 		"jsdoc/check-param-names": [ "warn", { "allowExtraTrailingParamDocs": true } ],
+		"jsdoc/check-tag-names": [
+			"warn",
+			{
+				"definedTags": [
+					"ignore",
+					"internal",
+					"stable"
+				]
+			}
+		],
 		"jsdoc/check-values": "off",
 		"jsdoc/empty-tags": "off",
 		"jsdoc/no-multi-asterisks": [ "error", { "allowWhitespace": true } ],

diff --git a/test/fixtures/jsdoc/valid.js b/test/fixtures/jsdoc/valid.js
@@ -155,6 +155,9 @@
 	 *                 line
 	 * @yield {number} Multi-
 	 *                 line
+	 * @ignore
+	 * @internal
+	 * @stable
 	 */
 	APP.JSDocTags = function ( a, b ) {
 		return a || b;