@pumpn/eslint-config 11.1.2 → 12.0.0

package/rules/jsdoc.js

@@ -1,57 +1,81 @@
-export default {
-	"jsdoc/check-access": ["warn"],
-	"jsdoc/check-alignment": ["warn", "always"],
-	"jsdoc/check-examples": [
-		"off",
+const jsdocRules = {
+	"jsdoc/check-access": "warn",
+	"jsdoc/check-alignment": "warn",
+	// TODO [eslint-plugin-jsdoc@>=49]: enable when https://github.com/eslint/eslint/issues/14745 is fixed
+	"jsdoc/check-examples": "off",
+	"jsdoc/check-indentation": "warn",
+	"jsdoc/check-line-alignment": "off",
+	"jsdoc/check-param-names": "warn",
+	"jsdoc/check-property-names": "warn",
+	"jsdoc/check-syntax": "warn",
+	"jsdoc/check-tag-names": [
+		"warn",
+		{
+			definedTags: ["category", "component"]
+		}
+	],
+	"jsdoc/check-types": "warn",
+	"jsdoc/check-values": "warn",
+	"jsdoc/empty-tags": "warn",
+	"jsdoc/implements-on-classes": "warn",
+	"jsdoc/imports-as-dependencies": "off",
+	"jsdoc/informative-docs": "warn",
+	"jsdoc/match-description": "off",
+	"jsdoc/match-name": "off",
+	"jsdoc/multiline-blocks": "warn",
+	"jsdoc/no-bad-blocks": ["warn", { preventAllMultiAsteriskBlocks: true }],
+	"jsdoc/no-blank-block-descriptions": "off",
+	"jsdoc/no-blank-blocks": "off",
+	"jsdoc/no-defaults": "warn",
+	"jsdoc/no-missing-syntax": "off",
+	"jsdoc/no-multi-asterisks": "warn",
+	"jsdoc/no-restricted-syntax": "off",
+	"jsdoc/no-types": "off",
+	"jsdoc/no-undefined-types": [
+		"warn",
 		{
-			matchingFileName: "jsdoc-example.js"
+			definedTypes: ["Iterable", "IterableIterator"]
 		}
 	],
-	"jsdoc/check-indentation": [
+	"jsdoc/require-asterisk-prefix": [
 		"warn",
+		"always",
 		{
-			excludeTags: ["description", "example"]
+			tags: {
+				any: ["typedef"]
+			}
 		}
 	],
-	"jsdoc/check-param-names": ["warn"],
-	"jsdoc/check-property-names": ["warn"],
-	"jsdoc/check-syntax": ["warn"],
-	"jsdoc/check-tag-names": ["warn"],
-	"jsdoc/check-types": ["warn"],
-	"jsdoc/check-values": ["warn"],
-	"jsdoc/empty-tags": ["warn"],
-	"jsdoc/implements-on-classes": ["warn"],
-	"jsdoc/match-description": ["warn"],
-	"jsdoc/no-bad-blocks": ["warn"],
-	"jsdoc/no-defaults": ["warn"],
-	"jsdoc/no-undefined-types": ["warn"],
 	"jsdoc/require-description": [
 		"warn",
 		{
-			contexts: [
-				"Program",
-				"ArrowFunctionExpression",
-				"FunctionDeclaration",
-				"FunctionExpression",
-				"VariableDeclaration"
-			]
+			contexts: ["any"],
+			descriptionStyle: "body"
+		}
+	],
+	"jsdoc/require-description-complete-sentence": "warn",
+	"jsdoc/require-example": "warn",
+	"jsdoc/require-file-overview": [
+		"off",
+		{
+			tags: {
+				file: {
+					initialCommentsOnly: true,
+					mustExist: true,
+					preventDuplicates: true
+				},
+				license: {
+					initialCommentsOnly: true,
+					mustExist: true,
+					preventDuplicates: true
+				}
+			}
 		}
 	],
-	"jsdoc/require-description-complete-sentence": ["warn"],
-	"jsdoc/require-example": ["off"],
-	"jsdoc/require-file-overview": ["off"],
-	"jsdoc/require-hyphen-before-param-description": ["warn"],
+	"jsdoc/require-hyphen-before-param-description": ["warn", "always"],
 	"jsdoc/require-jsdoc": [
 		"warn",
 		{
-			contexts: [
-				"ArrowFunctionExpression",
-				"ClassDeclaration",
-				"ClassExpression",
-				"FunctionDeclaration",
-				"FunctionExpression"
-			],
-			publicOnly: true,
 			require: {
 				ArrowFunctionExpression: true,
 				ClassDeclaration: true,
@@ -62,22 +86,199 @@ export default {
 			}
 		}
 	],
-	"jsdoc/require-param": ["warn"],
-	"jsdoc/require-param-description": ["warn"],
-	"jsdoc/require-param-name": ["warn"],
-	"jsdoc/require-param-type": ["warn"],
-	"jsdoc/require-property": ["warn"],
-	"jsdoc/require-property-description": ["warn"],
-	"jsdoc/require-property-name": ["warn"],
-	"jsdoc/require-property-type": ["warn"],
-	"jsdoc/require-returns": ["warn"],
-	"jsdoc/require-returns-check": ["warn"],
-	"jsdoc/require-returns-description": ["warn"],
-	"jsdoc/require-returns-type": ["warn"],
+	"jsdoc/require-param": ["warn", { unnamedRootBase: ["options"] }],
+	"jsdoc/require-param-description": [
+		"warn",
+		{
+			setDefaultDestructuredRootDescription: true
+		}
+	],
+	"jsdoc/require-param-name": "warn",
+	"jsdoc/require-param-type": "warn",
+	"jsdoc/require-property": "warn",
+	"jsdoc/require-property-description": "warn",
+	"jsdoc/require-property-name": "warn",
+	"jsdoc/require-property-type": "warn",
+	"jsdoc/require-returns": "warn",
+	"jsdoc/require-returns-check": "warn",
+	"jsdoc/require-returns-description": "warn",
+	"jsdoc/require-returns-type": "warn",
+	"jsdoc/require-throws": "warn",
+	"jsdoc/require-yields": "warn",
+	"jsdoc/require-yields-check": "warn",
+	"jsdoc/sort-tags": [
+		"warn",
+		{
+			tagSequence: [
+				{
+					tags: [
+						// Brief descriptions
+						"summary",
+						"typeSummary",
+
+						// Module/file-level
+						"module",
+						"exports",
+						"file",
+						"fileoverview",
+						"overview",
+
+						// Identifying (name, type)
+						"template",
+						"typedef",
+						"interface",
+						"record",
+						"name",
+						"kind",
+						"type",
+						"alias",
+						"external",
+						"host",
+						"callback",
+						"func",
+						"function",
+						"method",
+						"class",
+						"constructor",
+
+						// Relationships
+						"modifies",
+						"mixes",
+						"mixin",
+						"mixinClass",
+						"mixinFunction",
+						"namespace",
+						"borrows",
+						"constructs",
+						"lends",
+						"implements",
+						"requires",
+
+						// Long descriptions
+						"desc",
+						"description",
+						"classdesc",
+						"tutorial",
+						"copyright",
+						"license",
+
+						// Simple annotations
+						"const",
+						"constant",
+						"final",
+						"global",
+						"readonly",
+						"abstract",
+						"virtual",
+						"var",
+						"member",
+						"memberof",
+						"memberof!",
+						"inner",
+						"instance",
+						"inheritdoc",
+						"inheritDoc",
+						"override",
+						"hideconstructor",
+						"component",
+
+						// Core function/object info
+						"param",
+						"arg",
+						"argument",
+						"prop",
+						"property",
+						"return",
+						"returns",
+
+						// Important behavior details
+						"async",
+						"generator",
+						"default",
+						"defaultvalue",
+						"enum",
+						"augments",
+						"extends",
+						"throws",
+						"exception",
+						"yield",
+						"yields",
+						"event",
+						"fires",
+						"emits",
+						"listens",
+						"this",
+
+						// Access
+						"static",
+						"private",
+						"protected",
+						"public",
+						"access",
+						"package",
+
+						"-other",
+
+						// Supplementary descriptions
+						"see",
+						"example",
+
+						// METADATA
+
+						// Other Closure (undocumented) metadata
+						"closurePrimitive",
+						"customElement",
+						"expose",
+						"hidden",
+						"idGenerator",
+						"meaning",
+						"ngInject",
+						"owner",
+						"wizaction",
+
+						// Other Closure (documented) metadata
+						"define",
+						"dict",
+						"export",
+						"externs",
+						"implicitCast",
+						"noalias",
+						"nocollapse",
+						"nocompile",
+						"noinline",
+						"nosideeffects",
+						"polymer",
+						"polymerBehavior",
+						"preserve",
+						"struct",
+						"suppress",
+						"unrestricted",
+
+						// @homer0/prettier-plugin-jsdoc metadata
+						"category",
+
+						// Non-Closure metadata
+						"ignore",
+						"author",
+						"version",
+						"variation",
+						"since",
+						"deprecated",
+						"todo"
+					]
+				}
+			]
+		}
+	],
 	"jsdoc/tag-lines": [
 		"warn",
-		"any",
-		{ startLines: 1 }
+		"never",
+		{
+			startLines: 1
+		}
 	],
-	"jsdoc/valid-types": ["warn"]
+	"jsdoc/text-escaping": "off",
+	"jsdoc/valid-types": "off"
 };
+
+export default jsdocRules;

package/rules/jsx-a11y.js

@@ -0,0 +1,139 @@
+const jsxA11yRules = {
+	"jsx-a11y/alt-text": "error",
+	"jsx-a11y/anchor-ambiguous-text": [
+		"error",
+		{
+			words: [
+				"this",
+				"more",
+				"read here",
+				"read more"
+			]
+		}
+	],
+	"jsx-a11y/anchor-has-content": "error",
+	"jsx-a11y/anchor-is-valid": "error",
+	"jsx-a11y/aria-activedescendant-has-tabindex": "error",
+	"jsx-a11y/aria-props": "error",
+	"jsx-a11y/aria-proptypes": "error",
+	"jsx-a11y/aria-role": "error",
+	"jsx-a11y/aria-unsupported-elements": "error",
+	"jsx-a11y/autocomplete-valid": "error",
+	"jsx-a11y/click-events-have-key-events": "error",
+	"jsx-a11y/control-has-associated-label": [
+		"error",
+		{
+			ignoreElements: [
+				"audio",
+				"canvas",
+				"embed",
+				"input",
+				"textarea",
+				"tr",
+				"video"
+			],
+			ignoreRoles: [
+				"grid",
+				"listbox",
+				"menu",
+				"menubar",
+				"radiogroup",
+				"row",
+				"tablist",
+				"toolbar",
+				"tree",
+				"treegrid"
+			],
+			includeRoles: ["alert", "dialog"]
+		}
+	],
+	"jsx-a11y/heading-has-content": "error",
+	"jsx-a11y/html-has-lang": "error",
+	"jsx-a11y/iframe-has-title": "error",
+	"jsx-a11y/img-redundant-alt": "error",
+	"jsx-a11y/interactive-supports-focus": [
+		"error",
+		{
+			tabbable: [
+				"button",
+				"checkbox",
+				"link",
+				"progressbar",
+				"searchbox",
+				"slider",
+				"spinbutton",
+				"switch",
+				"textbox"
+			]
+		}
+	],
+	"jsx-a11y/label-has-associated-control": "error",
+	"jsx-a11y/lang": "error",
+	"jsx-a11y/media-has-caption": "error",
+	"jsx-a11y/mouse-events-have-key-events": "error",
+	"jsx-a11y/no-access-key": "error",
+	"jsx-a11y/no-aria-hidden-on-focusable": "error",
+	"jsx-a11y/no-autofocus": "off",
+	"jsx-a11y/no-distracting-elements": "error",
+	"jsx-a11y/no-interactive-element-to-noninteractive-role": [
+		"error",
+		{
+			canvas: ["img"],
+			td: ["cell"],
+			tr: ["none", "presentation"]
+		}
+	],
+	"jsx-a11y/no-noninteractive-element-interactions": [
+		"error",
+		{
+			body: ["onError", "onLoad"],
+			iframe: ["onError", "onLoad"],
+			img: ["onError", "onLoad"]
+		}
+	],
+	"jsx-a11y/no-noninteractive-element-to-interactive-role": [
+		"error",
+		{
+			fieldset: ["radiogroup", "presentation"],
+			li: [
+				"menuitem",
+				"menuitemradio",
+				"menuitemcheckbox",
+				"option",
+				"row",
+				"tab",
+				"treeitem"
+			],
+			ol: [
+				"listbox",
+				"menu",
+				"menubar",
+				"radiogroup",
+				"tablist",
+				"tree",
+				"treegrid"
+			],
+			table: ["grid"],
+			td: ["gridcell"],
+			ul: [
+				"listbox",
+				"menu",
+				"menubar",
+				"radiogroup",
+				"tablist",
+				"tree",
+				"treegrid"
+			]
+		}
+	],
+	"jsx-a11y/no-noninteractive-tabindex": "error",
+	"jsx-a11y/no-redundant-roles": "error",
+	"jsx-a11y/no-static-element-interactions": "error",
+	"jsx-a11y/prefer-tag-over-role": "error",
+	"jsx-a11y/role-has-required-aria-props": "error",
+	"jsx-a11y/role-supports-aria-props": "error",
+	"jsx-a11y/scope": "error",
+	"jsx-a11y/tabindex-no-positive": "error"
+};
+
+export default jsxA11yRules;