@momsfriendlydevco/eslint-config 2.0.1 → 2.0.3

package/index.js

@@ -4,17 +4,46 @@ import pluginVue from 'eslint-plugin-vue';
 
 // Rules shared by both .doop + .vue files
 let jsCommonRules = {
+	// Generic rules
 	'html-closing-bracket-spacing': ['off'], // Annoying doesn't allow <this-kind-of-thing/>
-	'jsdoc/check-alignment': ['off'],  // Disable the JSDoc parser insisting on correct indents
-	'jsdoc/check-types': ['off'], // Disable the JSDoc parser being fussy about `@param {String}` vs `@param {string}`
-	'jsdoc/tag-lines': ['off'], // Disable the JSDoc parser being fussy about new-line spacing
 	'no-debugger': ['warn'], // Debuggers are fine, just warn
 	'no-useless-escape': ['off'], // ESlint frequently gets what should and shouldn't be escaped wrong
 	'no-unused-vars': ['warn'], // Dont make unused vars the end of the world
+
+	// JSDoc
+	'jsdoc/check-alignment': ['off'],  // Disable the JSDoc parser insisting on correct indents
+	'jsdoc/check-tag-names': ['warn', { // Extend JSDoc allowed tags
+		definedTags: ['date', 'slot', 'url'],
+	}],
+	'jsdoc/check-types': ['off'], // Disable the JSDoc parser being fussy about `@param {String}` vs `@param {string}`
+	'jsdoc/no-defaults': ['off'], // Disable the JSDoc parser that complains about optional params as its just silly
+	'jsdoc/no-undefined-types': ['warn', {disableReporting: true}], // Disable the JSDoc parser for "undefined" types which it usually gets wrong. Ask eslint to still mark these as used though
+	'jsdoc/require-returns-description': ['off'], // Disable the JSDoc parse being fussy about return descriptions
+	'jsdoc/tag-lines': ['off'], // Disable the JSDoc parser being fussy about new-line spacing
+
+	// Vue
+	'vue/no-v-html': ['off'], // Disable Vue complaining about v-html being used
 };
 
 export default [
-	pluginJSDoc.configs['flat/recommended'],
+	// eslint-plugin-jsdoc (with custom settings)
+	{
+		...pluginJSDoc.configs['flat/recommended'],
+		settings: {
+			jsdoc: {
+				// NOTE that some specs - like vue - can add to this config
+				mode: 'jsdoc',
+				tagNamePreference: {
+					// Prefer 'emits' over 'fires' to match Vue terminology {{{
+					emits: 'emits',
+					fires: 'emits',
+					// }}}
+				},
+			},
+		},
+	},
+
+	// eslint-plugin-vue
 	...pluginVue.configs['flat/recommended'],
 
 	// .doop backend Files {{{
@@ -59,6 +88,14 @@ export default [
 				},
 			},
 		},
+		settings: {
+			jsdoc: {
+				tagNamePreference: {
+					// Allow 'prop' in Vue mode to match Vue terminology
+					prop: 'prop',
+				},
+			},
+		},
 		rules: {
 			'vue/attributes-order': ['warn', {
 				'order': [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@momsfriendlydevco/eslint-config",
   "description": "ESLint plugin for @MomsFriendlyDevCo projects",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "type": "module",
   "scripts": {
     "test": "eslint --config index.js test/data"
@@ -24,9 +24,9 @@
   },
   "homepage": "https://github.com/MomsFriendlyDevCo/eslint#readme",
   "dependencies": {
-    "eslint-plugin-jsdoc": "^48.2.3",
-    "eslint-plugin-vue": "^9.25.0",
-    "vue-eslint-parser": "^9.4.2"
+    "eslint-plugin-jsdoc": "^48.8.3",
+    "eslint-plugin-vue": "^9.27.0",
+    "vue-eslint-parser": "^9.4.3"
   },
   "peerDependencies": {
     "eslint": ">=9.2.0"