@atomicsmash/coding-standards 16.0.1 → 17.0.0-beta.0

package/.eslintrc.cjs

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

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atomicsmash/coding-standards
 
+## 17.0.0-beta.0
+
+### Major Changes
+
+- [#472](https://github.com/AtomicSmash/packages/pull/472) [`3f656e0`](https://github.com/AtomicSmash/packages/commit/3f656e02f88f88bbdc2b538b1cb23a959479bf99) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Remove PHPCS config
+
+- [#472](https://github.com/AtomicSmash/packages/pull/472) [`521823e`](https://github.com/AtomicSmash/packages/commit/521823e0a6100f8d46ce2c86e8491101ed8beffc) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Migrate to ESM first imports
+
+- [#472](https://github.com/AtomicSmash/packages/pull/472) [`7f3f4cc`](https://github.com/AtomicSmash/packages/commit/7f3f4cc582492c8b83bf889747a5d91eb1f01983) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Remove commitlint
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atomicsmash/eslint-config@17.0.0-beta.0
+  - @atomicsmash/browserslist-config@17.0.0-beta.0
+
 ## 16.0.1
 
 ### Patch Changes

package/MIGRATING.md

@@ -2,6 +2,94 @@
 
 This document contains information on how to migrate from one version to the next version.
 
+## v16 --> v17
+
+### Removal of commitlint.
+
+We no longer use commitlint after moving to changesets. If your project still uses the commitlint config, you should remove it from the project and uninstall all commitlint dependencies.
+
+### Removal of PHPCS config.
+
+We migrated the PHPCS config to a composer package in v13 of this package, this config was only kept around for legacy projects, but it's now been removed.
+
+To install the new package, use the following instructions:
+
+1. Install the new package
+
+```sh
+composer require --dev atomicsmash/php-coding-standards
+```
+
+2. Update the existing `phpcs.xml` file to the new package location
+
+```xml
+<rule ref="./vendor/atomicsmash/php-coding-standards/phpcs.xml"/>
+```
+
+### Migration of coding standards configs to ESM - Part 1
+
+In v13 we added ESM versions of our config scripts with the goal of migrating to modern ESM. This is being done to assist with updating ESLint which is now EOL for the version we're stuck on.
+
+We are now making the next step which is to migrate the plain .js files to point to the new ESM files instead of the old config files. At this point, the old configs are still kept around in case of issues, however it's highly recommended to migrate your configs to the new ESM imports instead.
+
+In a future version, the old CJS files WILL be removed, so if you don't migrate now, you will have to do it later.
+
+Here's some specific examples for the tools you need to update:
+
+#### CSpell
+
+No change needed if using .js extension. If using .mjs or .cjs, migrate to using the .js extension. If you're using the .mjs extension you'll use the right file, but it will still break as the .mjs files will be removed in the future as well to avoid clutter.
+
+```js
+{
+	"import": ["@atomicsmash/coding-standards/cspell/index.js"]
+}
+```
+
+#### Prettier
+
+You likely have a `prettier.config.cjs` file which looks like this:
+
+```js
+module.exports = {
+	...require("@atomicsmash/coding-standards").prettierConfig,
+};
+```
+
+Rename the file to `prettier.config.mjs` and use this instead:
+
+```js
+import { prettierConfig } from "@atomicsmash/coding-standards";
+export default prettierConfig;
+```
+
+#### Stylelint
+
+You likely have a `.stylelintrc.cjs` file which looks like this:
+
+```js
+const stylelintConfig = require("@atomicsmash/coding-standards/stylelint/classic");
+
+/** @type {import('stylelint').Config} */
+module.exports = stylelintConfig;
+```
+
+OR
+
+```js
+module.exports = {
+	extends: ["@atomicsmash/coding-standards/stylelint/classic"],
+};
+```
+
+Rename the file to `.stylelintrc.mjs` and use this instead:
+
+```js
+export default {
+	extends: ["@atomicsmash/coding-standards/stylelint/classic"],
+};
+```
+
 ## v15 --> v16
 
 Browserslist query has been updated to exclude Chrome versions older than 120.

package/cspell/index.js

@@ -1 +1 @@
-module.exports = require("./index.cjs");
+export { default } from "./index.mjs";

package/index.d.ts

@@ -1,3 +1,7 @@
-export const commitlintConfig: import("@commitlint/types").UserConfig;
 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 +1,4 @@
 module.exports = {
-	commitlintConfig: require("./commitlint"),
 	cspellConfig: require("./cspell/index.cjs"),
 	prettierConfig: require("./prettier/index.cjs"),
 	stylelintConfig: require("./stylelint/index.cjs"),

package/package.json

@@ -1,6 +1,7 @@
 {
 	"name": "@atomicsmash/coding-standards",
-	"version": "16.0.1",
+	"type": "module",
+	"version": "17.0.0-beta.0",
 	"description": "A collection of coding standards configurations.",
 	"main": "index.js",
 	"types": "index.d.ts",
@@ -8,10 +9,8 @@
 		"@cspell/cspell-types": "^8.19.4"
 	},
 	"peerDependencies": {
-		"@atomicsmash/browserslist-config": "^16.0.1",
-		"@atomicsmash/eslint-config": "^16.0.1",
-		"@commitlint/cli": "^19.8.1",
-		"@commitlint/config-conventional": "^19.8.1",
+		"@atomicsmash/browserslist-config": "^17.0.0-beta.0",
+		"@atomicsmash/eslint-config": "^17.0.0-beta.0",
 		"@wordpress/stylelint-config": "^23.27.0",
 		"prettier": "^3.6.2",
 		"stylelint": "^16.25.0",

package/prettier/index.js

@@ -1 +1 @@
-module.exports = require("./index.cjs");
+export { default } from "./index.mjs";

package/stylelint/base.js

@@ -1 +1 @@
-module.exports = require("./base.cjs");
+export { default } from "./base.mjs";

package/stylelint/classic.js

@@ -1 +1 @@
-module.exports = require("./classic.cjs");
+export { default } from "./classic.mjs";

package/stylelint/index.mjs

@@ -1,4 +1,4 @@
 import { default as classic } from "./classic.mjs";
-import { default as themeJson } from "./theme-json.mjs";
 import { default as tailwind } from "./tailwind.mjs";
+import { default as themeJson } from "./theme-json.mjs";
 export default { classic, themeJson, tailwind };

package/stylelint/tailwind.js

@@ -1 +1 @@
-module.exports = require("./tailwind.cjs");
+export { default } from "./tailwind.mjs";

package/stylelint/theme-json.js

@@ -1 +1 @@
-module.exports = require("./theme-json.cjs");
+export { default } from "./theme-json.mjs";

package/commitlint/index.js

@@ -1 +0,0 @@
-module.exports = { extends: ["@commitlint/config-conventional"] };

package/phpcs/phpcs.xml

@@ -1,56 +0,0 @@
-<?xml version="1.0"?>
-<ruleset name="Atomic Smash's Rules">
-	<exclude-pattern>*/node_modules/*</exclude-pattern>
-	<exclude-pattern>*/vendor/*</exclude-pattern>
-	<arg name="extensions" value="php" />
-	<arg value="sp"/>
-	<arg name="parallel" value="20"/>
-	<arg name="cache"/>
-	<arg name="report" value="summary"/>
-	<ini name="memory_limit" value="256M"/>
-	<rule ref="WordPress">
-		<exclude name="Generic.Formatting.MultipleStatementAlignment"/>
-		<exclude name="WordPress.Arrays.MultipleStatementAlignment"/>
-		<exclude name="Squiz.Commenting.FileComment.MissingPackageTag"/>
-		<exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound"/>
-		<exclude name="Squiz.Commenting.InlineComment.InvalidEndChar"/>
-	</rule>
-	<rule ref="Generic.CodeAnalysis.UnusedFunctionParameter"/>
-	<rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>
-	<rule ref="WordPress.Files.FileName">
-		<properties>
-			<property name="is_theme" value="true"/>
-		</properties>
-	</rule>
-	<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
-		<properties>
-			<property name="ignoreBlankLines" value="true"/>
-		</properties>
-	</rule>
-	<rule ref="Generic.Files.LineEndings">
-		<properties>
-		<property name="eolChar" value="\n"/>
-		</properties>
-	</rule>
-	<config name="testVersion" value="8.2-"/>
-	<rule ref="PHPCompatibilityWP">
-		<include-pattern>*\.php$</include-pattern>
-	</rule>
-	<rule ref="VariableAnalysis"/>
-	<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
-		<exclude-pattern>*/lib/*</exclude-pattern>
-		<exclude-pattern>*/classes/*</exclude-pattern>
-	</rule>
-	<rule ref="WordPress.Files.FileName.InvalidClassFileName">
-		<exclude-pattern>*/lib/*</exclude-pattern>
-		<exclude-pattern>*/classes/*</exclude-pattern>
-	</rule>
-	<rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
-	<rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
-</ruleset>