@pumpn/eslint-config 17.2.4 → 18.0.0

package/rules/jsdoc.js

@@ -1,433 +0,0 @@
-/**
- * @import { Linter } from "eslint";
- */
-
-/**
- * @satisfies {Linter.RulesRecord}
- */
-const jsdocRules = {
-	"jsdoc/check-access": "warn",
-	"jsdoc/check-alignment": ["warn", { innerIndent: 1 }],
-	"jsdoc/check-indentation": [
-		"warn",
-		{
-			allowIndentedSections: true,
-			excludeTags: ["example", "typedef"]
-		}
-	],
-	"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"],
-			inlineTags: [
-				"link",
-				"linkcode",
-				"linkplain",
-				"tutorial"
-			]
-		}
-	],
-	"jsdoc/check-template-names": "off",
-	"jsdoc/check-types": "warn",
-	"jsdoc/check-values": "warn",
-	"jsdoc/convert-to-jsdoc-comments": [
-		"warn",
-		{
-			allowedPrefixes: [
-				"@ts-",
-				"istanbul ",
-				"c8 ",
-				"v8 ",
-				"eslint",
-				"prettier-",
-				"TODO",
-				"MARK"
-			],
-			enableFixer: true,
-			enforceJsdocLineStyle: "multi",
-			lineOrBlockStyle: "both"
-		}
-	],
-	"jsdoc/empty-tags": "warn",
-	"jsdoc/escape-inline-tags": [
-		"warn",
-		{
-			allowedInlineTags: [],
-			enableFixer: true,
-			fixType: "backslash"
-		}
-	],
-	"jsdoc/implements-on-classes": "warn",
-	"jsdoc/imports-as-dependencies": "off",
-	"jsdoc/informative-docs": "warn",
-	"jsdoc/lines-before-block": [
-		"warn",
-		{
-			excludedTags: ["type"],
-			ignoreSameLine: true,
-			lines: 1
-		}
-	],
-	"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": [
-		"off",
-		{
-			checkUsedTypedefs: true,
-			definedTypes: ["Iterable", "IterableIterator"]
-		}
-	],
-	"jsdoc/prefer-import-tag": [
-		"warn",
-		{
-			enableFixer: true,
-			exemptTypedefs: false,
-			outputType: "named-import"
-		}
-	],
-	"jsdoc/reject-any-type": "warn",
-	"jsdoc/reject-function-type": "warn",
-	"jsdoc/require-asterisk-prefix": [
-		"warn",
-		"always",
-		{
-			tags: {
-				any: ["typedef"]
-			}
-		}
-	],
-	"jsdoc/require-description": [
-		"off",
-		{
-			contexts: [
-				// "ArrayExpression",
-				"ArrowFunctionExpression",
-				// "AssignmentExpression",
-				// "AwaitExpression",
-				// "BinaryExpression",
-				// "CallExpression",
-				// "ChainExpression",
-				// "Class",
-				"ClassDeclaration",
-				"ClassExpression",
-				// "ClassHasInstanceExpression",
-				// "ConditionalExpression",
-				// "DoExpression",
-				// "ExportAllDeclaration",
-				// "ExportDefaultDeclaration",
-				// "ExportNamedDeclaration",
-				// "Expression"
-				// "ExpressionStatement",
-				"FunctionDeclaration",
-				"FunctionExpression",
-				// "ImportDeclaration",
-				// "ImportExpression",
-				// "LogicalExpression",
-				// "LogicalExpression",
-				// "MemberExpression",
-				"MethodDefinition"
-				// "ModuleDeclarations",
-				// "ModuleExpression",
-				// "NewExpression",
-				// "ObjectExpression"
-				// "PropertyDefinition",
-				// "RecordExpression",
-				// "SequenceExpression",
-				// "SliceExpression",
-				// "StaticBlock",
-				// "TaggedTemplateExpression",
-				// "ThisExpression",
-				// "TupleExpression",
-				// "UnaryExpression",
-				// "VariableDeclaration",
-				// "VariableDeclarator",
-				// "YieldExpression"
-			],
-			descriptionStyle: "body"
-		}
-	],
-	"jsdoc/require-description-complete-sentence": "off",
-	"jsdoc/require-example": "off",
-	"jsdoc/require-file-overview": [
-		"off",
-		{
-			tags: {
-				file: {
-					initialCommentsOnly: true,
-					mustExist: true,
-					preventDuplicates: true
-				},
-				license: {
-					initialCommentsOnly: true,
-					mustExist: true,
-					preventDuplicates: true
-				}
-			}
-		}
-	],
-	"jsdoc/require-hyphen-before-param-description": ["warn", "always"],
-	"jsdoc/require-jsdoc": "off",
-	"jsdoc/require-next-description": "off",
-	"jsdoc/require-next-type": "warn",
-	"jsdoc/require-param": ["warn", { unnamedRootBase: ["options"] }],
-	"jsdoc/require-param-description": [
-		"off",
-		{
-			setDefaultDestructuredRootDescription: true
-		}
-	],
-	"jsdoc/require-param-name": "warn",
-	"jsdoc/require-param-type": "warn",
-	"jsdoc/require-property": "warn",
-	"jsdoc/require-property-description": "off",
-	"jsdoc/require-property-name": "warn",
-	"jsdoc/require-property-type": "warn",
-	"jsdoc/require-rejects": "off",
-	"jsdoc/require-returns": "off",
-	"jsdoc/require-returns-check": "warn",
-	"jsdoc/require-returns-description": "off",
-	"jsdoc/require-returns-type": "warn",
-	"jsdoc/require-template": [
-		"off",
-		{
-			requireSeparateTemplates: true
-		}
-	],
-	"jsdoc/require-template-description": "off",
-	"jsdoc/require-throws": "warn",
-	"jsdoc/require-throws-description": "warn",
-	"jsdoc/require-throws-type": "warn",
-	"jsdoc/require-yields": "warn",
-	"jsdoc/require-yields-check": "warn",
-	"jsdoc/require-yields-description": "off",
-	"jsdoc/require-yields-type": "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
-						"overload",
-						"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",
-		"never",
-		{
-			startLines: 1
-		}
-	],
-	"jsdoc/text-escaping": "off",
-	"jsdoc/ts-method-signature-style": ["warn", "property", { enableFixer: true }],
-	"jsdoc/ts-no-empty-object-type": "warn",
-	"jsdoc/ts-no-unnecessary-template-expression": ["warn", { enableFixer: true }],
-	"jsdoc/ts-prefer-function-type": ["warn", { enableFixer: true }],
-	"jsdoc/type-formatting": [
-		"off",
-		{
-			arrayBrackets: "square",
-			arrowFunctionPostReturnMarkerSpacing: " ",
-			arrowFunctionPreReturnMarkerSpacing: " ",
-			enableFixer: true,
-			functionOrClassParameterSpacing: " ",
-			functionOrClassPostGenericSpacing: "",
-			functionOrClassPostReturnMarkerSpacing: "",
-			functionOrClassPreReturnMarkerSpacing: "",
-			functionOrClassTypeParameterSpacing: " ",
-			genericAndTupleElementSpacing: " ",
-			genericDot: false,
-			keyValuePostColonSpacing: " ",
-			keyValuePostKeySpacing: "",
-			keyValuePostOptionalSpacing: "",
-			keyValuePostVariadicSpacing: "",
-			methodQuotes: "double",
-			objectFieldIndent: "\t",
-			objectFieldQuote: null,
-			objectFieldSeparator: "comma-and-linebreak",
-			objectFieldSeparatorOptionalLinebreak: true,
-			objectFieldSeparatorTrailingPunctuation: false,
-			objectTypeBracketSpacing: "",
-			parameterDefaultValueSpacing: " ",
-			postMethodNameSpacing: "",
-			postNewSpacing: " ",
-			separatorForSingleObjectField: false,
-			stringQuotes: "double",
-			trailingPunctuationMultilineOnly: false,
-			typeBracketSpacing: "",
-			unionSpacing: " "
-		}
-	],
-	"jsdoc/valid-types": "off",
-	"jsodc/require-tags": "off"
-};
-
-export default jsdocRules;

package/rules/no-secrets.js

@@ -1,25 +0,0 @@
-/**
- * @import { Linter } from "eslint";
- */
-
-const tolerance = 5;
-
-/**
- * @satisfies {Linter.RulesRecord}
- */
-const noSecretsRules = {
-	"no-secrets/no-secrets": [
-		"error",
-		{
-			additionalDelimiters: [],
-			additionalRegexes: {},
-			ignoreCase: false,
-			ignoreContent: [],
-			ignoreIdentifiers: [],
-			ignoreModules: true,
-			tolerance
-		}
-	]
-};
-
-export default noSecretsRules;