@atomicsmash/coding-standards 13.0.0-beta.2 → 13.0.0-beta.4

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @atomicsmash/coding-standards
 
+## 13.0.0-beta.4
+
+### Minor Changes
+
+- [#284](https://github.com/AtomicSmash/packages/pull/284) [`32b0b32`](https://github.com/AtomicSmash/packages/commit/32b0b327c8accfc5e4974d81218580ac1bc9b773) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Add ESM versions of all coding standards js files, deprecate CJS versions
+
+- [#284](https://github.com/AtomicSmash/packages/pull/284) [`9aba864`](https://github.com/AtomicSmash/packages/commit/9aba864489becfcc1c43d0a25bc414d19350dc96) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Revert "Install PHP CS rules via npm" in favour of composer package, deprecate PHP config.
+
+- [#284](https://github.com/AtomicSmash/packages/pull/284) [`8a0d915`](https://github.com/AtomicSmash/packages/commit/8a0d9153b4fab6f4fc3aa2b10e7ad301706c4578) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Deprecate commitlint config
+
+### Patch Changes
+
+- Updated dependencies [[`451112c`](https://github.com/AtomicSmash/packages/commit/451112c2a03605f856aa04f7a681565b1d0c2c2b)]:
+  - @atomicsmash/eslint-config@13.0.0-beta.4
+  - @atomicsmash/browserslist-config@13.0.0-beta.4
+
+## 13.0.0-beta.3
+
+### Minor Changes
+
+- [#280](https://github.com/AtomicSmash/packages/pull/280) [`46e983b`](https://github.com/AtomicSmash/packages/commit/46e983bdf437f385200dfed23b2500209434416e) Thanks [@steve-brett](https://github.com/steve-brett)! - Install PHP CS rules via npm
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atomicsmash/eslint-config@13.0.0-beta.3
+  - @atomicsmash/browserslist-config@13.0.0-beta.3
+
 ## 13.0.0-beta.2
 
 ### Minor Changes

package/MIGRATING.md

@@ -2,41 +2,91 @@
 
 This document contains information on how to migrate from one version to the next version.
 
-## v8 --> v9
+## v12 --> v13
 
-All dependencies were changed to peer dependencies. You may need to explicitly install the packages if they are not installed automatically for you:
+### Stabilise stylelint config
 
-```sh
-npm install --save-dev @atomicsmash/eslint-config @atomicsmash/browserslist-config prettier @commitlint/cli @commitlint/config-conventional
+- If you were previously using the stylelint beta config, this has now been stabilised. You must update the beta file reference to the stable one.
+
+```ts
+const stylelintConfig = require("@atomicsmash/coding-standards/beta/stylelint/classic");
+// becomes
+const stylelintConfig = require("@atomicsmash/coding-standards/stylelint/classic");
+// or
+const stylelintConfig = require("@atomicsmash/coding-standards").stylelintConfig
+	.classic;
 ```
 
-Please note that the peer dependency for the ESLint config and Browserslist config is strict. You must install the same version number as the coding standards package.
+### PHP coding standards have moved to another package, so the config in this package is deprecated.
 
-## v9 --> v10
+- To ensure that all dependencies are managed correctly and efficiently, the php coding standards have been moved to a composer package.
+- Keep this package installed unless you are only using it for the PHP standards
+- Remove all php coding standards dependencies:
 
-We have stabilised the PHPCS config. If you were previously referencing this file, you must target the new stable config.
-
-```
-<rule ref="./node_modules/@atomicsmash/coding-standards/beta/phpcs/phpcs.xml"/>
+```sh
+composer remove --dev squizlabs/php_codesniffer wp-coding-standards/wpcs dealerdirect/phpcodesniffer-composer-installer sirbrillig/phpcs-variable-analysis phpcompatibility/phpcompatibility-wp slevomat/coding-standard
 ```
 
-becomes:
+- Install the new composer package as a dev dependency `composer require --dev atomicsmash/php-coding-standards`
+- Update the import path of the xml file from the node package to the composer package:
 
-```
+```xml
 <rule ref="./node_modules/@atomicsmash/coding-standards/phpcs/phpcs.xml"/>
+<!-- Becomes -->
+<rule ref="./vendor/atomicsmash/php-coding-standards/phpcs.xml"/>
 ```
 
-## v10 --> v11
+### Commitlint config is now deprecated and will be removed in a future version.
 
-No breaking changes (this shouldn't have been a major release).
+- With our move to changesets internally, it's no longer required to lint commits.
+- You should remove commitlint from your project, at which point this config is no longer needed.
+- The config will be removed in the next version
+
+### ESM versions of all scripts have been added, and CJS versions are now deprecated.
+
+- The scripts will continue to work in this version as is
+- In the next version, the .js files will be updated to point to the ESM versions instead of the commonjs version.
+- If you can't migrate to ESM, update the imports to pull directly from the cjs versions. This will only be a temporary fix for now, as they will be removed in later versions, but all the packages we export configs for support ESM configs.
+- This is done in an effort to make updating ESLint to the new config easier.
+- An ESM import of commitlint has not been added because it's planned to be removed.
 
 ## v11 --> v12
 
-Remove usage of vitest typescript config
+### Remove usage of vitest typescript config
 
 - This config was only adding vitest global types, however, in practice, this caused more errors in some cases. It’s better to import functions when needed instead of using globals, so this config is removed. If you are using this, simply remove the config from your tsconfig and switch to using imports for your test functions.
 
-Add comments to your eslint disables
+### Add comments to your eslint disables
 
 - We added linting for ESLint comments. It helps avoid things like unnecessary disables, and requires every disable to have a message explaining why you’ve disabled the rule.
 - Marked as breaking as this will likely add new errors to your code, especially if you have used eslint-disables.
+
+## v10 --> v11
+
+No breaking changes (this shouldn't have been a major release).
+
+## v9 --> v10
+
+### We have stabilised the PHPCS config. 
+- If you were previously referencing this file, you must target the new stable config.
+
+```
+<rule ref="./node_modules/@atomicsmash/coding-standards/beta/phpcs/phpcs.xml"/>
+```
+
+becomes:
+
+```
+<rule ref="./node_modules/@atomicsmash/coding-standards/phpcs/phpcs.xml"/>
+```
+
+## v8 --> v9
+
+### All dependencies were changed to peer dependencies. 
+- You may need to explicitly install the packages if they are not installed automatically for you:
+
+```sh
+npm install --save-dev @atomicsmash/eslint-config @atomicsmash/browserslist-config prettier @commitlint/cli @commitlint/config-conventional
+```
+
+Please note that the peer dependency for the ESLint config and Browserslist config is strict. You must install the same version number as the coding standards package.

package/cspell/index.cjs

@@ -0,0 +1,142 @@
+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,142 +1 @@
-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;
+module.exports = require("./index.cjs");

package/cspell/index.mjs

@@ -0,0 +1,142 @@
+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.js

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

package/index.mjs

@@ -0,0 +1,4 @@
+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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atomicsmash/coding-standards",
-	"version": "13.0.0-beta.2",
+	"version": "13.0.0-beta.4",
 	"description": "A collection of coding standards configurations.",
 	"main": "index.js",
 	"types": "index.d.ts",
@@ -8,8 +8,8 @@
 		"@cspell/cspell-types": "^8.15.4"
 	},
 	"peerDependencies": {
-		"@atomicsmash/browserslist-config": "^13.0.0-beta.2",
-		"@atomicsmash/eslint-config": "^13.0.0-beta.2",
+		"@atomicsmash/browserslist-config": "^13.0.0-beta.4",
+		"@atomicsmash/eslint-config": "^13.0.0-beta.4",
 		"@commitlint/cli": "^19.5.0",
 		"@commitlint/config-conventional": "^19.5.0",
 		"@wordpress/stylelint-config": "^23.2.0",

package/prettier/index.cjs

@@ -0,0 +1,35 @@
+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,35 +1 @@
-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,
-			},
-		},
-	],
-};
+module.exports = require("./index.cjs");