@pumpn/eslint-config 17.2.4 → 18.0.0

package/config/rules/jsdoc.js

@@ -0,0 +1,464 @@
+import addPrefixToRules from "../_common/add-prefix-to-rules.js";
+
+/**
+ * @import { Linter } from "eslint";
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
+const jsdocRules = addPrefixToRules(
+	"jsdoc",
+	{
+		"check-access": "warn",
+		"check-alignment": [
+			"warn",
+			{
+				ignoreEmptyLines: false,
+				innerIndent: 1
+			}
+		],
+		"check-indentation": [
+			"warn",
+			{
+				allowIndentedSections: true,
+				allowNoSpaceAfterAsterisk: false,
+				excludeTags: ["example", "typedef"]
+			}
+		],
+		"check-line-alignment": "off",
+		"check-param-names": "warn",
+		"check-property-names": "warn",
+		"check-syntax": ["warn", { enableFixer: true }],
+		"check-tag-names": [
+			"warn",
+			{
+				definedTags: ["category", "component"],
+				inlineTags: [
+					"link",
+					"linkcode",
+					"linkplain",
+					"tutorial"
+				]
+			}
+		],
+		"check-template-names": "off",
+		"check-types": "warn",
+		"check-values": "warn",
+		"convert-to-jsdoc-comments": [
+			"warn",
+			{
+				allowedPrefixes: [
+					"@ts-",
+					"istanbul ",
+					"c8 ",
+					"v8 ",
+					"eslint",
+					"prettier-",
+					"TODO",
+					"MARK"
+				],
+				enableFixer: true,
+				enforceJsdocLineStyle: "multi",
+				lineOrBlockStyle: "both"
+			}
+		],
+		"empty-tags": "warn",
+		"escape-inline-tags": [
+			"warn",
+			{
+				allowedInlineTags: [],
+				enableFixer: true,
+				fixType: "backslash"
+			}
+		],
+		"implements-on-classes": "warn",
+		"imports-as-dependencies": "off",
+		"informative-docs": "warn",
+		"lines-before-block": [
+			"warn",
+			{
+				excludedTags: ["type"],
+				ignoreSameLine: true,
+				lines: 1
+			}
+		],
+		"match-description": "off",
+		"match-name": "off",
+		"multiline-blocks": "warn",
+		"no-bad-blocks": ["warn", { preventAllMultiAsteriskBlocks: true }],
+		"no-blank-block-descriptions": "off",
+		"no-blank-blocks": "off",
+		"no-defaults": "warn",
+		"no-missing-syntax": "off",
+		"no-multi-asterisks": "warn",
+		"no-restricted-syntax": "off",
+		"no-types": "off",
+		"no-undefined-types": [
+			"off",
+			{
+				checkUsedTypedefs: true,
+				definedTypes: ["Iterable", "IterableIterator"]
+			}
+		],
+		"no-unnecessary-type-assertion": [
+			"error",
+			{
+				checkLiteralConstAssertions: false,
+				enableFixer: true,
+				fixTypeChangingCasts: true,
+				preferConstToLiteralTuples: true,
+				treatAnyAsRedundant: false,
+				typesToIgnore: []
+			}
+		],
+		"normalize-see-links": [
+			"warn",
+			{
+				canonicalForm: "pipe",
+				enableFixer: true,
+				wrapBareUrls: true
+			}
+		],
+		"prefer-import-tag": [
+			"warn",
+			{
+				enableFixer: true,
+				exemptTypedefs: false,
+				outputType: "named-import"
+			}
+		],
+		"reject-any-type": "warn",
+		"reject-function-type": "warn",
+		"require-asterisk-prefix": [
+			"warn",
+			"always",
+			{
+				tags: {
+					any: ["typedef"]
+				}
+			}
+		],
+		"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"
+			}
+		],
+		"require-description-complete-sentence": "off",
+		"require-example": "off",
+		"require-file-overview": [
+			"off",
+			{
+				tags: {
+					file: {
+						initialCommentsOnly: true,
+						mustExist: true,
+						preventDuplicates: true
+					},
+					license: {
+						initialCommentsOnly: true,
+						mustExist: true,
+						preventDuplicates: true
+					}
+				}
+			}
+		],
+		"require-hyphen-before-param-description": ["warn", "always"],
+		"require-jsdoc": "off",
+		"require-next-description": "off",
+		"require-next-type": "warn",
+		"require-param": ["warn", { unnamedRootBase: ["options"] }],
+		"require-param-description": [
+			"off",
+			{
+				setDefaultDestructuredRootDescription: true
+			}
+		],
+		"require-param-name": "warn",
+		"require-param-type": "warn",
+		"require-property": "warn",
+		"require-property-description": "off",
+		"require-property-name": "warn",
+		"require-property-type": "warn",
+		"require-rejects": "off",
+		"require-returns": "off",
+		"require-returns-check": "warn",
+		"require-returns-description": "off",
+		"require-returns-type": "warn",
+		"require-tags": "off",
+		"require-template": [
+			"off",
+			{
+				requireSeparateTemplates: true
+			}
+		],
+		"require-template-description": "off",
+		"require-throws": "warn",
+		"require-throws-description": "warn",
+		"require-throws-type": "warn",
+		"require-yields": "warn",
+		"require-yields-check": "warn",
+		"require-yields-description": "off",
+		"require-yields-type": "warn",
+		"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"
+						]
+					}
+				]
+			}
+		],
+		"tag-lines": [
+			"warn",
+			"never",
+			{
+				startLines: 1
+			}
+		],
+		"text-escaping": "off",
+		"ts-method-signature-style": ["warn", "property", { enableFixer: true }],
+		"ts-no-empty-object-type": "warn",
+		"ts-no-unnecessary-template-expression": ["warn", { enableFixer: true }],
+		"ts-prefer-function-type": ["warn", { enableFixer: true }],
+		"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: " "
+			}
+		],
+		"valid-types": "off"
+	}
+);
+
+export default jsdocRules;

package/config/rules/no-secrets/_exports.js

@@ -0,0 +1 @@
+export { default as tolerance } from "./tolerance.js";

package/config/rules/no-secrets/tolerance.js

@@ -0,0 +1,3 @@
+const tolerance = 5;
+
+export default tolerance;

package/config/rules/no-secrets.js

@@ -0,0 +1,30 @@
+import addPrefixToRules from "../_common/add-prefix-to-rules.js";
+
+import { tolerance } from "./no-secrets/_exports.js";
+
+/**
+ * @import { Linter } from "eslint";
+ */
+
+/**
+ * @satisfies {Linter.RulesRecord}
+ */
+const noSecretsRules = addPrefixToRules(
+	"no-secrets",
+	{
+		"no-secrets": [
+			"error",
+			{
+				additionalDelimiters: [],
+				additionalRegexes: {},
+				ignoreCase: false,
+				ignoreContent: [],
+				ignoreIdentifiers: [],
+				ignoreModules: true,
+				tolerance
+			}
+		]
+	}
+);
+
+export default noSecretsRules;