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

package/prettier/index.mjs

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,74 @@
+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": [
+		"custom-properties",
+		"dollar-variables",
+		"declarations",
+		"rules",
+		"at-rules",
+	],
+	"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"],
+	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,74 +1 @@
-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": [
-		"custom-properties",
-		"dollar-variables",
-		"declarations",
-		"rules",
-		"at-rules",
-	],
-	"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"],
-	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,
-			},
-		},
-	],
-};
+module.exports = require("./base.cjs");

package/stylelint/base.mjs

@@ -0,0 +1,74 @@
+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": [
+		"custom-properties",
+		"dollar-variables",
+		"declarations",
+		"rules",
+		"at-rules",
+	],
+	"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} */
+export default {
+	reportDescriptionlessDisables: true,
+	reportInvalidScopeDisables: true,
+	reportNeedlessDisables: true,
+	plugins: ["stylelint-order"],
+	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/classic.cjs

@@ -0,0 +1,3 @@
+const baseConfig = require("./base.cjs");
+
+module.exports = baseConfig;

package/stylelint/classic.js

@@ -1,3 +1 @@
-const baseConfig = require("./base");
-
-module.exports = baseConfig;
+module.exports = require("./classic.cjs");

package/stylelint/classic.mjs

@@ -0,0 +1,2 @@
+import config from "./base.mjs";
+export default config;

package/stylelint/index.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+	classic: require("./classic.cjs"),
+	themeJson: require("./theme-json.cjs"),
+};

package/stylelint/index.mjs

@@ -0,0 +1,3 @@
+import { default as classicConfig } from "./classic.mjs";
+import { default as themeJsonConfig } from "./theme-json.mjs";
+export default { classicConfig, themeJsonConfig };

package/stylelint/theme-json.cjs

@@ -0,0 +1,189 @@
+const baseConfig = require("./base.cjs");
+
+/**
+ *
+ * @param {({property: string|RegExp, varInfo: {type: "custom"|"preset", slug:string},shorthand?: 1 | 2 | 3 | 4 , additionalAllowedValues?: (string|RegExp)[]})[]} values
+ */
+function createAllowedPropertyList(values) {
+	/**
+	 * @type {Record<string,string[]>}
+	 */
+	const allowedPropertyList = {};
+	for (const {
+		property,
+		varInfo,
+		shorthand = 1,
+		additionalAllowedValues = [],
+	} of values) {
+		const isRegexProperty = property instanceof RegExp;
+		const possibleValues = [];
+		const possibleVars = [
+			...additionalAllowedValues.map((value) =>
+				value instanceof RegExp ? value.toString() : value,
+			),
+			`(var\\([\\s]*--wp--${varInfo.type}--${varInfo.slug}--([a-z-0-9]+[\\s]*)\\))`,
+		];
+		if (isRegexProperty) {
+			possibleVars.push(
+				`(var\\([\\s]*--[a-z-0-9]*${property.toString().slice(1, -1)}[a-z-0-9]*[\\s]*\\))`,
+			);
+		} else if (property) {
+			possibleVars.push(
+				`(var\\([\\s]*--[a-z-0-9]*${property}[a-z-0-9]*[\\s]*\\))`,
+			);
+		}
+		possibleValues.push(
+			// For each shorthand value, allow one of the possible values followed by a space, or allow it to be blank
+			`/^${shorthand > 1 ? `((${possibleVars.join("|")})[\\s]*){0,${shorthand - 1}}` : ""}(${possibleVars.join("|")})$/`,
+		);
+		allowedPropertyList[property.toString()] = possibleValues;
+		if (!isRegexProperty) {
+			allowedPropertyList[`/--[a-z-0-9]*${property}[a-z-0-9]*/`] =
+				possibleValues;
+		}
+	}
+	return allowedPropertyList;
+}
+
+const rules = {
+	"declaration-property-value-allowed-list": [
+		createAllowedPropertyList([
+			{
+				property: /border((-top|-bottom)(-left|-right))?-radius/,
+				varInfo: {
+					type: "custom",
+					slug: "radius",
+				},
+			},
+			{
+				property: "border-radius",
+				varInfo: {
+					type: "custom",
+					slug: "radius",
+				},
+				shorthand: 4,
+			},
+			{
+				property: "box-shadow",
+				varInfo: {
+					type: "preset",
+					slug: "shadow",
+				},
+				additionalAllowedValues: ["none", "unset"],
+			},
+			{
+				property: /color/,
+				varInfo: {
+					type: "preset",
+					slug: "color",
+				},
+				additionalAllowedValues: ["inherit", "currentcolor"],
+			},
+			{
+				property: "background-color",
+				varInfo: {
+					type: "preset",
+					slug: "color",
+				},
+				additionalAllowedValues: ["transparent"],
+			},
+			{
+				property: "font-family",
+				varInfo: {
+					type: "preset",
+					slug: "font-family",
+				},
+				additionalAllowedValues: ["inherit"],
+			},
+			{
+				property: "font-size",
+				varInfo: {
+					type: "preset",
+					slug: "font-size",
+				},
+				additionalAllowedValues: ["inherit"],
+			},
+			{
+				property: /(?<!scroll-)margin/,
+				varInfo: {
+					type: "preset",
+					slug: "spacing",
+				},
+				shorthand: 4,
+				additionalAllowedValues: ["auto", "var\\(--wp--style--block-gap\\)"],
+			},
+			{
+				property: /padding/,
+				varInfo: {
+					type: "preset",
+					slug: "spacing",
+				},
+				shorthand: 4,
+			},
+			{
+				property: "z-index",
+				varInfo: {
+					type: "custom",
+					slug: "z-index",
+				},
+			},
+		]),
+		{
+			severity: "warning",
+			message: (property, value) => {
+				// Until updated, property and value will always return undefined.
+				return `Most values for this type of property should be defined in theme.json. (declaration-property-value-allowed-list)`;
+				// The following code is not complete, it has been left to show how this function could provide more helpful error
+				// messages once an update to stylelint is possible.
+				/* eslint-disable no-unreachable -- See above */
+				let message = `Invalid property provided for ${property}.`;
+				let ruleKey;
+				if (new RegExp(/color/).test(property)) {
+					ruleKey = "/color/";
+				} else if (new RegExp(/margin/).test(property)) {
+					ruleKey = "/margin/";
+				} else if (new RegExp(/padding/).test(property)) {
+					ruleKey = "/padding/";
+				} else {
+					ruleKey = property;
+				}
+				switch (ruleKey) {
+					case "z-index": {
+						message = `z-index must use one of the values specified in the theme.json file under \`settings.custom.z-index\`.`;
+						break;
+					}
+					case "/color/": {
+						message = `Colour values must use one of the values specified in the theme.json file under \`settings.color.palette\`.`;
+						break;
+					}
+					case "/margin/": {
+						message = `Margin values must use one of the values specified in the theme.json file under \`settings.spacing.spacingSizes\`.`;
+						break;
+					}
+					case "/padding/": {
+						message = `Padding values must use one of the values specified in the theme.json file under \`settings.spacing.spacingSizes\`.`;
+						break;
+					}
+					case "font-size": {
+						message = `Font size values must use one of the values specified in the theme.json file under \`settings.typography.fontSizes\`.`;
+						break;
+					}
+					case "font-family": {
+						message = `Font family values must use one of the values specified in the theme.json file under \`settings.typography.fontFamilies\`.`;
+						break;
+					}
+				}
+				return `${message} Value provided: ${value} (declaration-property-value-allowed-list)`;
+				/* eslint-enable no-unreachable */
+			},
+		},
+	],
+};
+
+module.exports = {
+	...baseConfig,
+	rules: {
+		...baseConfig.rules,
+		...rules,
+	},
+};

package/stylelint/theme-json.js

@@ -1,189 +1 @@
-const baseConfig = require("./base");
-
-/**
- *
- * @param {({property: string|RegExp, varInfo: {type: "custom"|"preset", slug:string},shorthand?: 1 | 2 | 3 | 4 , additionalAllowedValues?: (string|RegExp)[]})[]} values
- */
-function createAllowedPropertyList(values) {
-	/**
-	 * @type {Record<string,string[]>}
-	 */
-	const allowedPropertyList = {};
-	for (const {
-		property,
-		varInfo,
-		shorthand = 1,
-		additionalAllowedValues = [],
-	} of values) {
-		const isRegexProperty = property instanceof RegExp;
-		const possibleValues = [];
-		const possibleVars = [
-			...additionalAllowedValues.map((value) =>
-				value instanceof RegExp ? value.toString() : value,
-			),
-			`(var\\([\\s]*--wp--${varInfo.type}--${varInfo.slug}--([a-z-0-9]+[\\s]*)\\))`,
-		];
-		if (isRegexProperty) {
-			possibleVars.push(
-				`(var\\([\\s]*--[a-z-0-9]*${property.toString().slice(1, -1)}[a-z-0-9]*[\\s]*\\))`,
-			);
-		} else if (property) {
-			possibleVars.push(
-				`(var\\([\\s]*--[a-z-0-9]*${property}[a-z-0-9]*[\\s]*\\))`,
-			);
-		}
-		possibleValues.push(
-			// For each shorthand value, allow one of the possible values followed by a space, or allow it to be blank
-			`/^${shorthand > 1 ? `((${possibleVars.join("|")})[\\s]*){0,${shorthand - 1}}` : ""}(${possibleVars.join("|")})$/`,
-		);
-		allowedPropertyList[property.toString()] = possibleValues;
-		if (!isRegexProperty) {
-			allowedPropertyList[`/--[a-z-0-9]*${property}[a-z-0-9]*/`] =
-				possibleValues;
-		}
-	}
-	return allowedPropertyList;
-}
-
-const rules = {
-	"declaration-property-value-allowed-list": [
-		createAllowedPropertyList([
-			{
-				property: /border((-top|-bottom)(-left|-right))?-radius/,
-				varInfo: {
-					type: "custom",
-					slug: "radius",
-				},
-			},
-			{
-				property: "border-radius",
-				varInfo: {
-					type: "custom",
-					slug: "radius",
-				},
-				shorthand: 4,
-			},
-			{
-				property: "box-shadow",
-				varInfo: {
-					type: "preset",
-					slug: "shadow",
-				},
-				additionalAllowedValues: ["none", "unset"],
-			},
-			{
-				property: /color/,
-				varInfo: {
-					type: "preset",
-					slug: "color",
-				},
-				additionalAllowedValues: ["inherit", "currentcolor"],
-			},
-			{
-				property: "background-color",
-				varInfo: {
-					type: "preset",
-					slug: "color",
-				},
-				additionalAllowedValues: ["transparent"],
-			},
-			{
-				property: "font-family",
-				varInfo: {
-					type: "preset",
-					slug: "font-family",
-				},
-				additionalAllowedValues: ["inherit"],
-			},
-			{
-				property: "font-size",
-				varInfo: {
-					type: "preset",
-					slug: "font-size",
-				},
-				additionalAllowedValues: ["inherit"],
-			},
-			{
-				property: /(?<!scroll-)margin/,
-				varInfo: {
-					type: "preset",
-					slug: "spacing",
-				},
-				shorthand: 4,
-				additionalAllowedValues: ["auto", "var\\(--wp--style--block-gap\\)"],
-			},
-			{
-				property: /padding/,
-				varInfo: {
-					type: "preset",
-					slug: "spacing",
-				},
-				shorthand: 4,
-			},
-			{
-				property: "z-index",
-				varInfo: {
-					type: "custom",
-					slug: "z-index",
-				},
-			},
-		]),
-		{
-			severity: "warning",
-			message: (property, value) => {
-				// Until updated, property and value will always return undefined.
-				return `Most values for this type of property should be defined in theme.json. (declaration-property-value-allowed-list)`;
-				// The following code is not complete, it has been left to show how this function could provide more helpful error
-				// messages once an update to stylelint is possible.
-				/* eslint-disable no-unreachable -- See above */
-				let message = `Invalid property provided for ${property}.`;
-				let ruleKey;
-				if (new RegExp(/color/).test(property)) {
-					ruleKey = "/color/";
-				} else if (new RegExp(/margin/).test(property)) {
-					ruleKey = "/margin/";
-				} else if (new RegExp(/padding/).test(property)) {
-					ruleKey = "/padding/";
-				} else {
-					ruleKey = property;
-				}
-				switch (ruleKey) {
-					case "z-index": {
-						message = `z-index must use one of the values specified in the theme.json file under \`settings.custom.z-index\`.`;
-						break;
-					}
-					case "/color/": {
-						message = `Colour values must use one of the values specified in the theme.json file under \`settings.color.palette\`.`;
-						break;
-					}
-					case "/margin/": {
-						message = `Margin values must use one of the values specified in the theme.json file under \`settings.spacing.spacingSizes\`.`;
-						break;
-					}
-					case "/padding/": {
-						message = `Padding values must use one of the values specified in the theme.json file under \`settings.spacing.spacingSizes\`.`;
-						break;
-					}
-					case "font-size": {
-						message = `Font size values must use one of the values specified in the theme.json file under \`settings.typography.fontSizes\`.`;
-						break;
-					}
-					case "font-family": {
-						message = `Font family values must use one of the values specified in the theme.json file under \`settings.typography.fontFamilies\`.`;
-						break;
-					}
-				}
-				return `${message} Value provided: ${value} (declaration-property-value-allowed-list)`;
-				/* eslint-enable no-unreachable */
-			},
-		},
-	],
-};
-
-module.exports = {
-	...baseConfig,
-	rules: {
-		...baseConfig.rules,
-		...rules,
-	},
-};
+module.exports = require("./theme-json.cjs");