@atomicsmash/coding-standards 17.0.3-beta.0 → 18.0.0-beta.10

package/package.json

@@ -1,23 +1,62 @@
 {
 	"name": "@atomicsmash/coding-standards",
 	"type": "module",
-	"version": "17.0.3-beta.0",
+	"version": "18.0.0-beta.10",
 	"description": "A collection of coding standards configurations.",
-	"main": "index.js",
-	"types": "index.d.ts",
+	"files": [
+		"./dist/**/*",
+		"./typescript/**/*",
+		"./beta/**/*",
+		"CHANGELOG.md",
+		"MIGRATING.md",
+		"package.json"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./cspell": {
+			"types": "./dist/cspell/index.d.ts",
+			"default": "./dist/cspell/index.js"
+		},
+		"./eslint": {
+			"types": "./dist/eslint/index.d.ts",
+			"default": "./dist/eslint/index.js"
+		},
+		"./prettier": {
+			"types": "./dist/prettier/index.d.ts",
+			"default": "./dist/prettier/index.js"
+		},
+		"./stylelint/*": {
+			"types": "./dist/stylelint/*.d.ts",
+			"default": "./dist/stylelint/*.js"
+		},
+		"./typescript/*": "./typescript/*.json",
+		"./beta/biome": "./beta/biome/biome.jsonc"
+	},
 	"devDependencies": {
 		"@cspell/cspell-types": "^9.7.0"
 	},
 	"peerDependencies": {
-		"@atomicsmash/browserslist-config": "^17.0.3-beta.0",
-		"@atomicsmash/eslint-config": "^17.0.3-beta.0",
-		"@wordpress/stylelint-config": "^23.32.0",
+		"@atomicsmash/browserslist-config": "^18.0.0-beta.10",
+		"@eslint-community/eslint-plugin-eslint-comments": "^4.7.1",
+		"@eslint/js": "^9.39.4",
+		"@wordpress/stylelint-config": "^23.33.0",
+		"eslint": "^9.0.0",
+		"eslint-import-resolver-typescript": "^4.4.4",
+		"eslint-plugin-import": "^2.32.0",
+		"eslint-plugin-playwright": "^2.10.2",
+		"eslint-plugin-react": "^7.37.5",
+		"eslint-plugin-react-hooks": "^7.1.1",
+		"globals": "^17.6.0",
 		"prettier": "^3.8.1",
 		"stylelint": "^16.26.1",
 		"stylelint-config-standard": "^39.0.1",
 		"stylelint-config-standard-scss": "^16.0.0",
 		"stylelint-no-restricted-syntax": "^2.2.1",
-		"stylelint-order": "^7.0.1"
+		"stylelint-order": "^7.0.1",
+		"typescript-eslint": "^8.59.3"
 	},
 	"keywords": [
 		"atomic",
@@ -39,5 +78,14 @@
 	},
 	"publishConfig": {
 		"access": "public"
+	},
+	"scripts": {
+		"dev": "tsc --build --watch tsconfig.build.json",
+		"build": "npm-run-all clean compile",
+		"clean": "del-cli ./dist/ *.tsbuildinfo",
+		"compile": "tsc --build tsconfig.build.json",
+		"lint": "run-p lint:*",
+		"lint:eslint": "eslint --cache --cache-location ./node_modules/.cache/eslint . --ext .js,.ts,.jsx,.tsx",
+		"lint:types": "tsc"
 	}
 }

package/typescript/base.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "http://json.schemastore.org/tsconfig",
+	"$schema": "https://json.schemastore.org/tsconfig",
 	"compilerOptions": {
 		"esModuleInterop": true,
 		"skipLibCheck": true,
@@ -11,9 +11,12 @@
 		"strict": true,
 		"noUncheckedIndexedAccess": true,
 		"moduleResolution": "Bundler",
-		"module": "ESNext",
+		"module": "Preserve",
 		"noEmit": true,
 		"checkJs": true,
-		"forceConsistentCasingInFileNames": true
+		"forceConsistentCasingInFileNames": true,
+		"verbatimModuleSyntax": true,
+		"noImplicitOverride": true,
+		"strictNullChecks": true
 	}
 }

package/typescript/cypress.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "http://json.schemastore.org/tsconfig",
+	"$schema": "https://json.schemastore.org/tsconfig",
 	"exclude": [
 		"../node_modules/@types/jest",
 		"../node_modules/@testing-library/jest-dom"

package/.eslintrc.cjs

@@ -1,8 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-module.exports = {
-	extends: ["@atomicsmash/eslint-config"],
-	parserOptions: {
-		sourceType: "module",
-	},
-	ignorePatterns: ["**/*.d.ts"],
-};

package/beta/README.md

@@ -1,3 +0,0 @@
-# Beta files
-
-Config files added to this folder are not stable. They are added here to avoid keeping a separate branch up to date with other configs, and also enable multiple beta configs in a single project.

package/cspell/index.cjs

@@ -1,142 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-/**
- * Search for `package.json`
- * @param {string} from - search `from` directory.
- * @returns {string|void} - path to package.json
- */
-function findNearestPackageJson(from) {
-	from = path.resolve(from);
-	const parent = path.dirname(from);
-	if (!from || parent === from) {
-		return;
-	}
-
-	const pkg = path.join(from, "package.json");
-	if (fs.existsSync(pkg)) {
-		return pkg;
-	}
-	return findNearestPackageJson(parent);
-}
-
-/**
- * Load the nearest package.json
- * @param {string} cwd
- * @returns
- */
-function loadPackageJson(cwd) {
-	const pkgFile = findNearestPackageJson(cwd);
-	if (!pkgFile) return;
-	return JSON.parse(fs.readFileSync(pkgFile, "utf-8"));
-}
-
-function determinePackageNamesAndMethods(cwd = process.cwd()) {
-	const packageImport = loadPackageJson(cwd) || {};
-	const packageNames = Object.keys(packageImport.dependencies || {}).concat(
-		Object.keys(packageImport.devDependencies || {}),
-	);
-	return { packageNames };
-}
-
-/**
- * Search for `composer.json`
- * @param {string} from - search `from` directory.
- * @returns {string|void} - path to composer.json
- */
-function findNearestComposerJson(from) {
-	from = path.resolve(from);
-	const parent = path.dirname(from);
-	if (!from || parent === from) {
-		return;
-	}
-
-	const composerJsonPath = path.join(from, "composer.json");
-	if (fs.existsSync(composerJsonPath)) {
-		return composerJsonPath;
-	}
-	return findNearestComposerJson(parent);
-}
-
-/**
- * Load the nearest composer.json
- * @param {string} cwd
- * @returns
- */
-function loadComposer(cwd) {
-	const composerJsonFile = findNearestComposerJson(cwd);
-	if (!composerJsonFile) return;
-	return JSON.parse(fs.readFileSync(composerJsonFile, "utf-8"));
-}
-
-function determineComposerPackageNamesAndMethods(cwd = process.cwd()) {
-	const packageImport = loadComposer(cwd) || {};
-	const packageNames = Object.keys(packageImport.require || {})
-		.concat(Object.keys(packageImport["require-dev"] || {}))
-		.reduce((allowedWords, packageName) => {
-			return [...allowedWords, ...packageName.split("/")];
-		}, []);
-	return { packageNames };
-}
-
-/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
-const config = {
-	language: "en-GB",
-	words: [
-		...[
-			...determinePackageNamesAndMethods().packageNames,
-			...determineComposerPackageNamesAndMethods().packageNames,
-			"commitlint",
-			"sass",
-			"Userback",
-			"phpcs",
-			"phpcbf",
-		], // package and language names
-		...["tsbuildinfo", "svgs"], // filenames
-		...["combobox", "spinbutton"], // accessible roles
-		...["popover", "dialog"], // custom element names
-		...["atomicsmash"], // company all lowercase
-		...["unstringified", "formattable", "keyof", "nonnullable", "hidable"], // coding actions
-		...[
-			"alignfull",
-			"alignleft",
-			"alignright",
-			"muplugin",
-			"textdomain",
-			"color", // For in theme.json
-			"gfield", // Gravity Forms field class
-			"phpmailer",
-			"WPMDB", // WP Migrate DB
-			"shortcode",
-			"wp_kses",
-			"sprintf", // For @wordpress/i18n
-		], // WordPress stuff
-	],
-	languageSettings: [
-		{
-			languageId: "*",
-			locale: "en-GB",
-		},
-		{
-			languageId: "css, less, scss, sass",
-			locale: "en-US",
-			dictionaries: ["css"],
-		},
-		{
-			languageId: "javascript,typescript,javascriptreact,typescriptreact",
-			locale: "en-GB",
-			dictionaries: ["typescript"],
-		},
-		{
-			languageId: "php",
-			locale: "en-GB",
-			dictionaries: ["php", "html"],
-		},
-		{
-			languageId: "html,vue-html,javascriptreact,typescriptreact",
-			locale: "en-GB",
-			dictionaries: ["html"],
-		},
-	],
-};
-module.exports = config;

package/cspell/index.js

@@ -1 +0,0 @@
-export { default } from "./index.mjs";

package/cspell/index.mjs

@@ -1,142 +0,0 @@
-import { existsSync, readFileSync } from "fs";
-import { resolve, dirname, join } from "path";
-
-/**
- * Search for `package.json`
- * @param {string} from - search `from` directory.
- * @returns {string|void} - path to package.json
- */
-function findNearestPackageJson(from) {
-	from = resolve(from);
-	const parent = dirname(from);
-	if (!from || parent === from) {
-		return;
-	}
-
-	const pkg = join(from, "package.json");
-	if (existsSync(pkg)) {
-		return pkg;
-	}
-	return findNearestPackageJson(parent);
-}
-
-/**
- * Load the nearest package.json
- * @param {string} cwd
- * @returns
- */
-function loadPackageJson(cwd) {
-	const pkgFile = findNearestPackageJson(cwd);
-	if (!pkgFile) return;
-	return JSON.parse(readFileSync(pkgFile, "utf-8"));
-}
-
-function determinePackageNamesAndMethods(cwd = process.cwd()) {
-	const packageImport = loadPackageJson(cwd) || {};
-	const packageNames = Object.keys(packageImport.dependencies || {}).concat(
-		Object.keys(packageImport.devDependencies || {}),
-	);
-	return { packageNames };
-}
-
-/**
- * Search for `composer.json`
- * @param {string} from - search `from` directory.
- * @returns {string|void} - path to composer.json
- */
-function findNearestComposerJson(from) {
-	from = resolve(from);
-	const parent = dirname(from);
-	if (!from || parent === from) {
-		return;
-	}
-
-	const composerJsonPath = join(from, "composer.json");
-	if (existsSync(composerJsonPath)) {
-		return composerJsonPath;
-	}
-	return findNearestComposerJson(parent);
-}
-
-/**
- * Load the nearest composer.json
- * @param {string} cwd
- * @returns
- */
-function loadComposer(cwd) {
-	const composerJsonFile = findNearestComposerJson(cwd);
-	if (!composerJsonFile) return;
-	return JSON.parse(readFileSync(composerJsonFile, "utf-8"));
-}
-
-function determineComposerPackageNamesAndMethods(cwd = process.cwd()) {
-	const packageImport = loadComposer(cwd) || {};
-	const packageNames = Object.keys(packageImport.require || {})
-		.concat(Object.keys(packageImport["require-dev"] || {}))
-		.reduce((allowedWords, packageName) => {
-			return [...allowedWords, ...packageName.split("/")];
-		}, []);
-	return { packageNames };
-}
-
-/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
-const config = {
-	language: "en-GB",
-	words: [
-		...[
-			...determinePackageNamesAndMethods().packageNames,
-			...determineComposerPackageNamesAndMethods().packageNames,
-			"commitlint",
-			"sass",
-			"Userback",
-			"phpcs",
-			"phpcbf",
-		], // package and language names
-		...["tsbuildinfo", "svgs"], // filenames
-		...["combobox", "spinbutton"], // accessible roles
-		...["popover", "dialog"], // custom element names
-		...["atomicsmash"], // company all lowercase
-		...["unstringified", "formattable", "keyof", "nonnullable", "hidable"], // coding actions
-		...[
-			"alignfull",
-			"alignleft",
-			"alignright",
-			"muplugin",
-			"textdomain",
-			"color", // For in theme.json
-			"gfield", // Gravity Forms field class
-			"phpmailer",
-			"WPMDB", // WP Migrate DB
-			"shortcode",
-			"wp_kses",
-			"sprintf", // For @wordpress/i18n
-		], // WordPress stuff
-	],
-	languageSettings: [
-		{
-			languageId: "*",
-			locale: "en-GB",
-		},
-		{
-			languageId: "css, less, scss, sass",
-			locale: "en-US",
-			dictionaries: ["css"],
-		},
-		{
-			languageId: "javascript,typescript,javascriptreact,typescriptreact",
-			locale: "en-GB",
-			dictionaries: ["typescript"],
-		},
-		{
-			languageId: "php",
-			locale: "en-GB",
-			dictionaries: ["php", "html"],
-		},
-		{
-			languageId: "html,vue-html,javascriptreact,typescriptreact",
-			locale: "en-GB",
-			dictionaries: ["html"],
-		},
-	],
-};
-export default config;

package/index.d.ts

@@ -1,7 +0,0 @@
-export const cspellConfig: import("@cspell/cspell-types").CSpellUserSettings;
-export const prettierConfig: import("prettier").Config;
-export const stylelintConfig: {
-	classic: import("stylelint").Config;
-	themeJson: import("stylelint").Config;
-	tailwind: import("stylelint").Config;
-};

package/index.js

@@ -1,5 +0,0 @@
-module.exports = {
-	cspellConfig: require("./cspell/index.cjs"),
-	prettierConfig: require("./prettier/index.cjs"),
-	stylelintConfig: require("./stylelint/index.cjs"),
-};

package/index.mjs

@@ -1,4 +0,0 @@
-import { default as cspellConfig } from "./cspell/index.mjs";
-import { default as prettierConfig } from "./prettier/index.mjs";
-import { default as stylelintConfig } from "./stylelint/index.mjs";
-export { cspellConfig, prettierConfig, stylelintConfig };

package/prettier/index.cjs

@@ -1,35 +0,0 @@
-module.exports = {
-	/* Expected defaults:
-	Prettier recommendation
-	printWidth: 80,
-
-	Single quotes are more often found in text strings (used for apostrophes) so using double quotes prevents lots of escaping characters.
-	singleQuote: false,
-
-	Keep very nested indentation near the left to prevent lots of horizontal scrolling.
-	tabWidth: 2,
-
-	Semicolons prevent AST errors and are more explicit where a line ends
-	semi: true,
-	
-	Consistent line endings for MacOS and Windows
-	endOfLine: "lf",
-	*/
-
-	// Tabs are better for visually impaired coders https://www.reddit.com/r/javascript/comments/c8drjo/nobody_talks_about_the_real_reason_to_use_tabs/
-	useTabs: true,
-
-	// Helps clean up git diffs by removing changes of a single comma on a line if adding a new line to the bottom
-	trailingComma: "all",
-
-	overrides: [
-		{
-			// yml files require specific indentation rules
-			files: ["*.yml", "*.yaml"],
-			options: {
-				useTabs: false,
-				tabWidth: 2,
-			},
-		},
-	],
-};

package/prettier/index.js

@@ -1 +0,0 @@
-export { default } from "./index.mjs";

package/prettier/index.mjs

@@ -1,35 +0,0 @@
-export default {
-	/* Expected defaults:
-	Prettier recommendation
-	printWidth: 80,
-
-	Single quotes are more often found in text strings (used for apostrophes) so using double quotes prevents lots of escaping characters.
-	singleQuote: false,
-
-	Keep very nested indentation near the left to prevent lots of horizontal scrolling.
-	tabWidth: 2,
-
-	Semicolons prevent AST errors and are more explicit where a line ends
-	semi: true,
-	
-	Consistent line endings for MacOS and Windows
-	endOfLine: "lf",
-	*/
-
-	// Tabs are better for visually impaired coders https://www.reddit.com/r/javascript/comments/c8drjo/nobody_talks_about_the_real_reason_to_use_tabs/
-	useTabs: true,
-
-	// Helps clean up git diffs by removing changes of a single comma on a line if adding a new line to the bottom
-	trailingComma: "all",
-
-	overrides: [
-		{
-			// yml files require specific indentation rules
-			files: ["*.yml", "*.yaml"],
-			options: {
-				useTabs: false,
-				tabWidth: 2,
-			},
-		},
-	],
-};

package/stylelint/base.cjs

@@ -1,91 +0,0 @@
-const commonRules = {
-	"custom-property-pattern": null,
-	"function-url-quotes": ["always"],
-	"rule-empty-line-before": [
-		"always",
-		{
-			except: ["first-nested"],
-			ignore: ["after-comment"],
-		},
-	],
-	"comment-empty-line-before": [
-		"always",
-		{
-			except: ["first-nested"],
-			ignore: ["stylelint-commands"],
-		},
-	],
-	"order/order": [
-		{
-			type: "at-rule",
-			hasBlock: false,
-		},
-		"custom-properties",
-		"dollar-variables",
-		"declarations",
-		{
-			type: "at-rule",
-			hasBlock: true,
-		},
-		"rules",
-	],
-	"plugin/no-restricted-syntax": [
-		[
-			{
-				selector:
-					"rule :matches(atrule[name=media], atrule[name=container]) rule",
-				message:
-					"Don't nest rules inside of media/container blocks. Instead, nest the rule and use the at rule within that.",
-			},
-		],
-	],
-	"selector-class-pattern": [
-		"^([a-z][a-z0-9]*)([_-]+[a-z0-9]+)*$",
-		{
-			message:
-				"Selector should use lowercase and separate words with hyphens or underscores (selector-class-pattern)",
-		},
-	],
-	"at-rule-empty-line-before": [
-		"always",
-		{
-			ignore: ["blockless-after-blockless", "first-nested", "after-comment"],
-		},
-	],
-};
-
-/** @type {import('stylelint').Config} */
-module.exports = {
-	reportDescriptionlessDisables: true,
-	reportInvalidScopeDisables: true,
-	reportNeedlessDisables: true,
-	plugins: ["stylelint-order", "stylelint-no-restricted-syntax"],
-	rules: commonRules,
-	overrides: [
-		{
-			files: ["*.css", "**/*.css"],
-			extends: ["stylelint-config-standard", "@wordpress/stylelint-config"],
-			rules: {
-				"at-rule-no-unknown": [true, { ignoreAtRules: "context" }],
-			},
-		},
-		{
-			files: ["*.scss", "**/*.scss"],
-			extends: [
-				"stylelint-config-standard-scss",
-				"@wordpress/stylelint-config/scss",
-			],
-			rules: {
-				"scss/operator-no-newline-after": null,
-				"no-descending-specificity": null,
-				"scss/at-rule-no-unknown": [true, { ignoreAtRules: "context" }],
-			},
-		},
-		{
-			files: ["**/editor-style?(s).?(s)css"],
-			rules: {
-				"declaration-property-value-allowed-list": null,
-			},
-		},
-	],
-};

package/stylelint/base.js

@@ -1 +0,0 @@
-export { default } from "./base.mjs";