@alextheman/eslint-plugin 5.8.1 → 5.9.0

package/dist/index.cjs

@@ -4521,8 +4521,8 @@ const sortExports = {
 const sortImports = {
 	customGroups: [
 		{
-			elementNamePattern: ["package.json"],
-			groupName: "package-json"
+			elementNamePattern: [".json"],
+			groupName: "json"
 		},
 		{
 			elementNamePattern: ["^tests/.*"],
@@ -4543,7 +4543,7 @@ const sortImports = {
 		"value-builtin",
 		"value-tests",
 		"value-internal",
-		"package-json"
+		"json"
 	],
 	ignoreCase: true,
 	internalPattern: ["^src/.*"],
@@ -4929,7 +4929,7 @@ function internalTypeScript(plugin) {
 			"@typescript-eslint": typescript_eslint.default.plugin
 		},
 		rules: {
-			"@alextheman/standardise-error-messages": "error",
+			"@alextheman/standardise-error-messages": "off",
 			"@typescript-eslint/array-type": ["error", { default: "array" }],
 			"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "as" }],
 			"@typescript-eslint/consistent-type-definitions": "error",
@@ -5223,6 +5223,45 @@ const consistentTestFunction = createRule({
 	}
 });
 
+//#endregion
+//#region src/rules/has-standards.ts
+const hasStandardsOptionsSchema = zod.default.object({ fixable: zod.default.boolean() }).partial();
+function parseHasStandardsOptions(input) {
+	return (0, _alextheman_utility.parseZodSchema)(hasStandardsOptionsSchema, input);
+}
+const defaultOptions = { fixable: false };
+const targetValue = "I have standards, you'd better have some too!";
+const hasStandards = createRule({
+	name: "no-isolated-tests",
+	meta: {
+		docs: { description: _alextheman_utility.normaliseIndents`
+        Enforces that any string literal must contain the phrase "${targetValue}"
+        This is a very pointless rule in practice, but it helps with the end-to-end tests as a nice trivial rule to test entrypoints with. Please do not actually use this in practice.` },
+		messages: { message: "Set your standards and you'll do great." },
+		type: "suggestion",
+		schema: createRuleSchemaFromZodSchema(hasStandardsOptionsSchema),
+		fixable: "code"
+	},
+	defaultOptions: [defaultOptions],
+	create(context) {
+		const { fixable = false } = parseHasStandardsOptions(context.options[0] ?? defaultOptions);
+		return { Literal(node) {
+			if (node.value !== targetValue) return context.report({
+				node,
+				messageId: "message",
+				data: {
+					source: node,
+					value: node.value
+				},
+				fix: fixOnCondition(fixable, (fixer) => {
+					const [quote] = node.raw;
+					return fixer.replaceText(node, `${quote}${targetValue}${quote}`);
+				})
+			});
+		} };
+	}
+});
+
 //#endregion
 //#region src/rules/no-isolated-tests.ts
 const noIsolatedTests = createRule({
@@ -5505,6 +5544,7 @@ const useObjectShorthand = createRule({
 //#region src/rules/index.ts
 var rules_default = {
 	"consistent-test-function": consistentTestFunction,
+	"has-standards": hasStandards,
 	"no-isolated-tests": noIsolatedTests,
 	"no-namespace-imports": noNamespaceImports,
 	"no-plugin-configs-access-from-src-configs": noPluginConfigAccessFromSrcConfigs,
@@ -5518,7 +5558,7 @@ var rules_default = {
 //#endregion
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "5.8.1";
+var version = "5.9.0";
 
 //#endregion
 //#region src/alexPlugin.ts

package/dist/index.d.cts

@@ -5,8 +5,8 @@ import { PluginOptions } from "typedoc-plugin-markdown";
 import * as vite from "vite";
 import { VitestEnvironment } from "vitest/node";
 import { TSESTree } from "@typescript-eslint/utils";
-import { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
 import z from "zod";
+import { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
 import { RuleContext, RuleFix, RuleFixer } from "@typescript-eslint/utils/ts-eslint";
 
 //#region src/utility/private/camelToKebab.d.ts

package/dist/index.js

@@ -1,4 +1,4 @@
-import { DataError, camelToKebab, deepCopy, deepFreeze, omitProperties } from "@alextheman/utility";
+import { DataError, camelToKebab, deepCopy, deepFreeze, normaliseIndents, omitProperties, parseZodSchema } from "@alextheman/utility";
 import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
 import z from "zod";
 import js from "@eslint/js";
@@ -4505,8 +4505,8 @@ const sortExports = {
 const sortImports = {
 	customGroups: [
 		{
-			elementNamePattern: ["package.json"],
-			groupName: "package-json"
+			elementNamePattern: [".json"],
+			groupName: "json"
 		},
 		{
 			elementNamePattern: ["^tests/.*"],
@@ -4527,7 +4527,7 @@ const sortImports = {
 		"value-builtin",
 		"value-tests",
 		"value-internal",
-		"package-json"
+		"json"
 	],
 	ignoreCase: true,
 	internalPattern: ["^src/.*"],
@@ -4913,7 +4913,7 @@ function internalTypeScript(plugin) {
 			"@typescript-eslint": tseslint.plugin
 		},
 		rules: {
-			"@alextheman/standardise-error-messages": "error",
+			"@alextheman/standardise-error-messages": "off",
 			"@typescript-eslint/array-type": ["error", { default: "array" }],
 			"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "as" }],
 			"@typescript-eslint/consistent-type-definitions": "error",
@@ -5207,6 +5207,45 @@ const consistentTestFunction = createRule({
 	}
 });
 
+//#endregion
+//#region src/rules/has-standards.ts
+const hasStandardsOptionsSchema = z.object({ fixable: z.boolean() }).partial();
+function parseHasStandardsOptions(input) {
+	return parseZodSchema(hasStandardsOptionsSchema, input);
+}
+const defaultOptions = { fixable: false };
+const targetValue = "I have standards, you'd better have some too!";
+const hasStandards = createRule({
+	name: "no-isolated-tests",
+	meta: {
+		docs: { description: normaliseIndents`
+        Enforces that any string literal must contain the phrase "${targetValue}"
+        This is a very pointless rule in practice, but it helps with the end-to-end tests as a nice trivial rule to test entrypoints with. Please do not actually use this in practice.` },
+		messages: { message: "Set your standards and you'll do great." },
+		type: "suggestion",
+		schema: createRuleSchemaFromZodSchema(hasStandardsOptionsSchema),
+		fixable: "code"
+	},
+	defaultOptions: [defaultOptions],
+	create(context) {
+		const { fixable = false } = parseHasStandardsOptions(context.options[0] ?? defaultOptions);
+		return { Literal(node) {
+			if (node.value !== targetValue) return context.report({
+				node,
+				messageId: "message",
+				data: {
+					source: node,
+					value: node.value
+				},
+				fix: fixOnCondition(fixable, (fixer) => {
+					const [quote] = node.raw;
+					return fixer.replaceText(node, `${quote}${targetValue}${quote}`);
+				})
+			});
+		} };
+	}
+});
+
 //#endregion
 //#region src/rules/no-isolated-tests.ts
 const noIsolatedTests = createRule({
@@ -5489,6 +5528,7 @@ const useObjectShorthand = createRule({
 //#region src/rules/index.ts
 var rules_default = {
 	"consistent-test-function": consistentTestFunction,
+	"has-standards": hasStandards,
 	"no-isolated-tests": noIsolatedTests,
 	"no-namespace-imports": noNamespaceImports,
 	"no-plugin-configs-access-from-src-configs": noPluginConfigAccessFromSrcConfigs,
@@ -5502,7 +5542,7 @@ var rules_default = {
 //#endregion
 //#region package.json
 var name = "@alextheman/eslint-plugin";
-var version = "5.8.1";
+var version = "5.9.0";
 
 //#endregion
 //#region src/alexPlugin.ts