@activatus/code-standards 3.0.2 → 3.0.5

package/static/templates/eslint/nextjs/eslint.config.mjs

@@ -1,4 +1,4 @@
-import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
+import { recommended as eslintCommentsRecommended } from "@eslint-community/eslint-plugin-eslint-comments/configs";
 import prettier from "eslint-config-prettier";
 import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
 import nextVitals from "eslint-config-next/core-web-vitals";
@@ -7,7 +7,54 @@ import { flatConfigs as importX } from "eslint-plugin-import-x";
 import unicorn from "eslint-plugin-unicorn";
 import globals from "globals";
 
-export default [
+// Code patterns that are errors in every file.
+const RESTRICTED_SYNTAX = [
+	{
+		selector: "ClassDeclaration",
+		message: "Use functions, not classes.",
+	},
+	{
+		selector: "ClassExpression",
+		message: "Use functions, not classes.",
+	},
+	{
+		selector: "VariableDeclarator > FunctionExpression",
+		message: "Use an arrow function.",
+	},
+	{
+		selector: "VariableDeclaration[kind='let']",
+		message:
+			"Use const. If this value really must be reassigned, disable this rule on this line with a comment saying why.",
+	},
+];
+
+// Functions take one parameter: a single object when they need more than one value.
+// Route handlers are the exception: see below.
+const SINGLE_OBJECT_PARAMETER = [
+	{
+		selector: "FunctionDeclaration[params.length>1]",
+		message:
+			"Use a single object parameter when a function needs more than one value.",
+	},
+	{
+		selector:
+			"VariableDeclarator > :matches(ArrowFunctionExpression, FunctionExpression)[params.length>1]",
+		message:
+			"Use a single object parameter when a function needs more than one value.",
+	},
+];
+
+// Deeper than this, return early instead.
+const MAXIMUM_NESTING_DEPTH = 3;
+
+// Type a value where it is declared. Story files are the exception: see below.
+const NO_SATISFIES = {
+	selector: "TSSatisfiesExpression",
+	message:
+		"Type a value where it is declared, not with satisfies afterwards.",
+};
+
+const config = [
 	{
 		ignores: [
 			".next/",
@@ -15,12 +62,14 @@ export default [
 			"build/",
 			"coverage/",
 			"next-env.d.ts",
+			// The docs viewer is the standard template, with its own packages and build.
+			"docsSite/",
 			"**/vendor/**",
 		],
 	},
 	...nextVitals,
 	...nextTypescript,
-	comments.recommended,
+	eslintCommentsRecommended,
 	importX.recommended,
 	importX.typescript,
 	unicorn.configs.recommended,
@@ -38,7 +87,7 @@ export default [
 			"@eslint-community/eslint-comments/require-description":
 				"error",
 			"func-style": ["error", "expression"],
-			"max-depth": ["error", 3],
+			"max-depth": ["error", MAXIMUM_NESTING_DEPTH],
 			"max-lines": [
 				"error",
 				{ max: 300, skipBlankLines: true, skipComments: true },
@@ -58,34 +107,9 @@ export default [
 			],
 			"no-restricted-syntax": [
 				"error",
-				{
-					selector: "ClassDeclaration",
-					message: "Use functions, not classes.",
-				},
-				{
-					selector: "ClassExpression",
-					message: "Use functions, not classes.",
-				},
-				{
-					selector: "VariableDeclarator > FunctionExpression",
-					message: "Use an arrow function.",
-				},
-				{
-					selector: "VariableDeclaration[kind='let']",
-					message:
-						"Use const. If this value really must be reassigned, disable this rule on this line with a comment saying why.",
-				},
-				{
-					selector: "FunctionDeclaration[params.length>1]",
-					message:
-						"Use a single object parameter when a function needs more than one value.",
-				},
-				{
-					selector:
-						"VariableDeclarator > :matches(ArrowFunctionExpression, FunctionExpression)[params.length>1]",
-					message:
-						"Use a single object parameter when a function needs more than one value.",
-				},
+				NO_SATISFIES,
+				...RESTRICTED_SYNTAX,
+				...SINGLE_OBJECT_PARAMETER,
 			],
 			"import-x/no-cycle": "error",
 			"import-x/no-default-export": "error",
@@ -177,5 +201,29 @@ export default [
 		files: ["**/*.config.{js,mjs,ts}"],
 		rules: { "unicorn/no-top-level-side-effects": "off" },
 	},
+	{
+		// Storybook's own docs type stories with `satisfies Meta<typeof Component>`, so story files may use it.
+		files: ["**/*.stories.{ts,tsx}"],
+		rules: {
+			"no-restricted-syntax": [
+				"error",
+				...RESTRICTED_SYNTAX,
+				...SINGLE_OBJECT_PARAMETER,
+			],
+		},
+	},
+	{
+		// Next.js calls a route handler with two values, (request, context), so route.ts files may take two parameters.
+		files: ["app/**/route.ts"],
+		rules: {
+			"no-restricted-syntax": [
+				"error",
+				NO_SATISFIES,
+				...RESTRICTED_SYNTAX,
+			],
+		},
+	},
 	prettier,
 ];
+
+export default config;

package/static/templates/eslint/react/eslint.config.mjs

@@ -1,5 +1,5 @@
 import js from "@eslint/js";
-import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
+import { recommended as eslintCommentsRecommended } from "@eslint-community/eslint-plugin-eslint-comments/configs";
 import prettier from "eslint-config-prettier";
 import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
 import { flatConfigs as importX } from "eslint-plugin-import-x";
@@ -9,10 +9,65 @@ import unicorn from "eslint-plugin-unicorn";
 import globals from "globals";
 import { configs as typescript } from "typescript-eslint";
 
-export default [
-	{ ignores: ["dist/", "build/", "coverage/", "**/vendor/**"] },
+// Code patterns that are errors in every file.
+const RESTRICTED_SYNTAX = [
+	{
+		selector: "ClassDeclaration",
+		message: "Use functions, not classes.",
+	},
+	{
+		selector: "ClassExpression",
+		message: "Use functions, not classes.",
+	},
+	{
+		selector: "VariableDeclarator > FunctionExpression",
+		message: "Use an arrow function.",
+	},
+	{
+		selector: "VariableDeclaration[kind='let']",
+		message:
+			"Use const. If this value really must be reassigned, disable this rule on this line with a comment saying why.",
+	},
+];
+
+// Functions take one parameter: a single object when they need more than one value.
+const SINGLE_OBJECT_PARAMETER = [
+	{
+		selector: "FunctionDeclaration[params.length>1]",
+		message:
+			"Use a single object parameter when a function needs more than one value.",
+	},
+	{
+		selector:
+			"VariableDeclarator > :matches(ArrowFunctionExpression, FunctionExpression)[params.length>1]",
+		message:
+			"Use a single object parameter when a function needs more than one value.",
+	},
+];
+
+// Deeper than this, return early instead.
+const MAXIMUM_NESTING_DEPTH = 3;
+
+// Type a value where it is declared. Story files are the exception: see below.
+const NO_SATISFIES = {
+	selector: "TSSatisfiesExpression",
+	message:
+		"Type a value where it is declared, not with satisfies afterwards.",
+};
+
+const config = [
+	{
+		ignores: [
+			"dist/",
+			"build/",
+			"coverage/",
+			// The docs viewer is the standard template, with its own packages and build.
+			"docsSite/",
+			"**/vendor/**",
+		],
+	},
 	js.configs.recommended,
-	comments.recommended,
+	eslintCommentsRecommended,
 	importX.recommended,
 	importX.typescript,
 	unicorn.configs.recommended,
@@ -34,7 +89,7 @@ export default [
 			"@eslint-community/eslint-comments/require-description":
 				"error",
 			"func-style": ["error", "expression"],
-			"max-depth": ["error", 3],
+			"max-depth": ["error", MAXIMUM_NESTING_DEPTH],
 			"max-lines": [
 				"error",
 				{ max: 300, skipBlankLines: true, skipComments: true },
@@ -54,34 +109,9 @@ export default [
 			],
 			"no-restricted-syntax": [
 				"error",
-				{
-					selector: "ClassDeclaration",
-					message: "Use functions, not classes.",
-				},
-				{
-					selector: "ClassExpression",
-					message: "Use functions, not classes.",
-				},
-				{
-					selector: "VariableDeclarator > FunctionExpression",
-					message: "Use an arrow function.",
-				},
-				{
-					selector: "VariableDeclaration[kind='let']",
-					message:
-						"Use const. If this value really must be reassigned, disable this rule on this line with a comment saying why.",
-				},
-				{
-					selector: "FunctionDeclaration[params.length>1]",
-					message:
-						"Use a single object parameter when a function needs more than one value.",
-				},
-				{
-					selector:
-						"VariableDeclarator > :matches(ArrowFunctionExpression, FunctionExpression)[params.length>1]",
-					message:
-						"Use a single object parameter when a function needs more than one value.",
-				},
+				NO_SATISFIES,
+				...RESTRICTED_SYNTAX,
+				...SINGLE_OBJECT_PARAMETER,
 			],
 			"import-x/no-cycle": "error",
 			"import-x/no-default-export": "error",
@@ -169,5 +199,18 @@ export default [
 		files: ["**/*.config.{js,mjs,ts}"],
 		rules: { "unicorn/no-top-level-side-effects": "off" },
 	},
+	{
+		// Storybook's own docs type stories with `satisfies Meta<typeof Component>`, so story files may use it.
+		files: ["**/*.stories.{ts,tsx}"],
+		rules: {
+			"no-restricted-syntax": [
+				"error",
+				...RESTRICTED_SYNTAX,
+				...SINGLE_OBJECT_PARAMETER,
+			],
+		},
+	},
 	prettier,
 ];
+
+export default config;

package/static/templates/eslint/typescript/eslint.config.mjs

@@ -1,5 +1,5 @@
 import js from "@eslint/js";
-import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
+import { recommended as eslintCommentsRecommended } from "@eslint-community/eslint-plugin-eslint-comments/configs";
 import prettier from "eslint-config-prettier";
 import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
 import { flatConfigs as importX } from "eslint-plugin-import-x";
@@ -7,10 +7,65 @@ import unicorn from "eslint-plugin-unicorn";
 import globals from "globals";
 import { configs as typescript } from "typescript-eslint";
 
-export default [
-	{ ignores: ["dist/", "build/", "coverage/", "**/vendor/**"] },
+// Code patterns that are errors in every file.
+const RESTRICTED_SYNTAX = [
+	{
+		selector: "ClassDeclaration",
+		message: "Use functions, not classes.",
+	},
+	{
+		selector: "ClassExpression",
+		message: "Use functions, not classes.",
+	},
+	{
+		selector: "VariableDeclarator > FunctionExpression",
+		message: "Use an arrow function.",
+	},
+	{
+		selector: "VariableDeclaration[kind='let']",
+		message:
+			"Use const. If this value really must be reassigned, disable this rule on this line with a comment saying why.",
+	},
+];
+
+// Functions take one parameter: a single object when they need more than one value.
+const SINGLE_OBJECT_PARAMETER = [
+	{
+		selector: "FunctionDeclaration[params.length>1]",
+		message:
+			"Use a single object parameter when a function needs more than one value.",
+	},
+	{
+		selector:
+			"VariableDeclarator > :matches(ArrowFunctionExpression, FunctionExpression)[params.length>1]",
+		message:
+			"Use a single object parameter when a function needs more than one value.",
+	},
+];
+
+// Deeper than this, return early instead.
+const MAXIMUM_NESTING_DEPTH = 3;
+
+// Type a value where it is declared. Story files are the exception: see below.
+const NO_SATISFIES = {
+	selector: "TSSatisfiesExpression",
+	message:
+		"Type a value where it is declared, not with satisfies afterwards.",
+};
+
+const config = [
+	{
+		ignores: [
+			"dist/",
+			"build/",
+			"coverage/",
+			// The docs viewer is the standard template, with its own packages and build.
+			"docsSite/",
+			"**/vendor/**",
+		],
+	},
 	js.configs.recommended,
-	comments.recommended,
+	eslintCommentsRecommended,
 	importX.recommended,
 	importX.typescript,
 	unicorn.configs.recommended,
@@ -24,7 +79,7 @@ export default [
 			"@eslint-community/eslint-comments/require-description":
 				"error",
 			"func-style": ["error", "expression"],
-			"max-depth": ["error", 3],
+			"max-depth": ["error", MAXIMUM_NESTING_DEPTH],
 			"max-lines": [
 				"error",
 				{ max: 300, skipBlankLines: true, skipComments: true },
@@ -44,34 +99,9 @@ export default [
 			],
 			"no-restricted-syntax": [
 				"error",
-				{
-					selector: "ClassDeclaration",
-					message: "Use functions, not classes.",
-				},
-				{
-					selector: "ClassExpression",
-					message: "Use functions, not classes.",
-				},
-				{
-					selector: "VariableDeclarator > FunctionExpression",
-					message: "Use an arrow function.",
-				},
-				{
-					selector: "VariableDeclaration[kind='let']",
-					message:
-						"Use const. If this value really must be reassigned, disable this rule on this line with a comment saying why.",
-				},
-				{
-					selector: "FunctionDeclaration[params.length>1]",
-					message:
-						"Use a single object parameter when a function needs more than one value.",
-				},
-				{
-					selector:
-						"VariableDeclarator > :matches(ArrowFunctionExpression, FunctionExpression)[params.length>1]",
-					message:
-						"Use a single object parameter when a function needs more than one value.",
-				},
+				NO_SATISFIES,
+				...RESTRICTED_SYNTAX,
+				...SINGLE_OBJECT_PARAMETER,
 			],
 			"import-x/no-cycle": "error",
 			"import-x/no-default-export": "error",
@@ -150,5 +180,18 @@ export default [
 		files: ["**/*.config.{js,mjs,ts}"],
 		rules: { "unicorn/no-top-level-side-effects": "off" },
 	},
+	{
+		// Storybook's own docs type stories with `satisfies Meta<typeof Component>`, so story files may use it.
+		files: ["**/*.stories.{ts,tsx}"],
+		rules: {
+			"no-restricted-syntax": [
+				"error",
+				...RESTRICTED_SYNTAX,
+				...SINGLE_OBJECT_PARAMETER,
+			],
+		},
+	},
 	prettier,
 ];
+
+export default config;