@atomicsmash/coding-standards 18.0.0-beta.6 → 18.0.0-beta.7

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atomicsmash/coding-standards
 
+## 18.0.0-beta.7
+
+### Major Changes
+
+- [#548](https://github.com/AtomicSmash/packages/pull/548) [`3cbb8b8`](https://github.com/AtomicSmash/packages/commit/3cbb8b8b7b1e588a30786cae9f4675ebcf143492) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Remove AS ESLint config package as an automatic peer dependency to avoid conflicts with new config
+
+- [#548](https://github.com/AtomicSmash/packages/pull/548) [`3cbb8b8`](https://github.com/AtomicSmash/packages/commit/3cbb8b8b7b1e588a30786cae9f4675ebcf143492) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Convert configs to typescript and use proper exports setup
+
+### Patch Changes
+
+- [#548](https://github.com/AtomicSmash/packages/pull/548) [`3cbb8b8`](https://github.com/AtomicSmash/packages/commit/3cbb8b8b7b1e588a30786cae9f4675ebcf143492) Thanks [@mikeybinns](https://github.com/mikeybinns)! - Update deps
+
+- Updated dependencies []:
+  - @atomicsmash/browserslist-config@18.0.0-beta.7
+
 ## 18.0.0-beta.6
 
 ### Patch Changes

package/dist/cspell/index.d.ts

@@ -0,0 +1,15 @@
+declare const config: {
+    language: string;
+    words: string[];
+    languageSettings: ({
+        languageId: string;
+        locale: string;
+        dictionaries?: undefined;
+    } | {
+        languageId: string;
+        locale: string;
+        dictionaries: string[];
+    })[];
+};
+export default config;
+//# sourceMappingURL=index.d.ts.map

package/dist/cspell/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cspell/index.ts"],"names":[],"mappings":"AA+FA,QAAA,MAAM,MAAM;;;;;;;;;;;;CA0DkB,CAAC;AAC/B,eAAe,MAAM,CAAC"}

package/dist/cspell/index.js

@@ -0,0 +1,133 @@
+import { existsSync, readFileSync } from "fs";
+import { resolve, dirname, join } from "path";
+/**
+ * Search for `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
+ */
+function loadPackageJson(cwd) {
+    const pkgFile = findNearestPackageJson(cwd);
+    if (!pkgFile)
+        return null;
+    const packageJson = JSON.parse(readFileSync(pkgFile, "utf-8"));
+    if (typeof packageJson === "object" && packageJson !== null) {
+        return packageJson;
+    }
+    return null;
+}
+function determinePackageNamesAndMethods(cwd = process.cwd()) {
+    const packageImport = loadPackageJson(cwd) ?? {};
+    const packageNames = Object.keys(("dependencies" in packageImport && packageImport.dependencies) ?? {}).concat(Object.keys(("devDependencies" in packageImport && packageImport.devDependencies) ??
+        {}));
+    return { packageNames };
+}
+/**
+ * Search for `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
+ */
+function loadComposer(cwd) {
+    const composerJsonFile = findNearestComposerJson(cwd);
+    if (!composerJsonFile)
+        return;
+    const composerJson = JSON.parse(readFileSync(composerJsonFile, "utf-8"));
+    if (typeof composerJson === "object" && composerJson !== null) {
+        return composerJson;
+    }
+    return null;
+}
+function determineComposerPackageNamesAndMethods(cwd = process.cwd()) {
+    const packageImport = loadComposer(cwd) ?? {};
+    const packageNames = Object.keys(("require" in packageImport && packageImport.require) ?? {})
+        .concat(Object.keys(("require-dev" in packageImport && packageImport["require-dev"]) ?? {}))
+        .reduce((allowedWords, packageName) => {
+        return [...allowedWords, ...packageName.split("/")];
+    }, []);
+    return { packageNames };
+}
+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/dist/eslint/index.d.ts

@@ -0,0 +1,4 @@
+import type { Config } from "@eslint/config-helpers";
+export declare const playwrightConfig: Config[];
+export declare const recommendedConfig: Config[];
+//# sourceMappingURL=index.d.ts.map

package/dist/eslint/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/eslint/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAkB,MAAM,EAAE,MAAM,wBAAwB,CAAC;AA2LrE,eAAO,MAAM,gBAAgB,UAe3B,CAAC;AAEH,eAAO,MAAM,iBAAiB,UAK5B,CAAC"}

package/dist/eslint/index.js

@@ -0,0 +1,198 @@
+const OFF = 0;
+const WARN = 1;
+const ERROR = 2;
+import { defineConfig } from "@eslint/config-helpers";
+import js from "@eslint/js";
+import esLintComments from "@eslint-community/eslint-plugin-eslint-comments/configs";
+import importPlugin from "eslint-plugin-import";
+import { default as playwrightPlugin } from "eslint-plugin-playwright";
+import reactPlugin from "eslint-plugin-react";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+const baseConfig = defineConfig({
+    name: "@atomicsmash/coding-standards/base-config",
+    files: ["**/*.js", "**/*.cjs", "**/*.mjs"],
+    extends: [
+        js.configs.recommended,
+        esLintComments.recommended,
+        importPlugin.flatConfigs.recommended,
+    ],
+    languageOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+        globals: {
+            ...globals.browser,
+            ...globals.node,
+        },
+    },
+    rules: {
+        "no-case-declarations": [OFF],
+        "import/order": [
+            ERROR,
+            {
+                alphabetize: {
+                    order: "asc",
+                },
+                groups: [
+                    "type",
+                    "builtin",
+                    "external",
+                    "internal",
+                    "parent",
+                    ["sibling", "index"],
+                ],
+                "newlines-between": "ignore",
+                pathGroups: [],
+                pathGroupsExcludedImportTypes: [],
+            },
+        ],
+        "prefer-const": [ERROR],
+        "no-var": [ERROR],
+        "import/no-duplicates": WARN,
+        "@eslint-community/eslint-comments/no-unused-disable": [ERROR],
+        "@eslint-community/eslint-comments/require-description": [
+            ERROR,
+            { ignore: ["eslint-enable"] },
+        ],
+    },
+    settings: {
+        "import/resolver": {
+            node: true,
+        },
+    },
+});
+const typescriptConfig = defineConfig([
+    {
+        name: "@atomicsmash/coding-standards/typescript-config",
+        files: ["**/*.ts", "**/*.cts", "**/*.mts"],
+        extends: [
+            baseConfig,
+            tseslint.configs.strictTypeChecked,
+            tseslint.configs.stylisticTypeChecked,
+            importPlugin.flatConfigs.typescript,
+        ],
+        plugins: {
+            "@typescript-eslint": tseslint.plugin,
+        },
+        languageOptions: {
+            parser: tseslint.parser,
+            parserOptions: {
+                projectService: true,
+            },
+        },
+        rules: {
+            "@typescript-eslint/naming-convention": [
+                ERROR,
+                {
+                    selector: "variableLike",
+                    format: ["camelCase", "PascalCase", "UPPER_CASE"],
+                    leadingUnderscore: "allow",
+                },
+                { selector: "function", format: ["camelCase", "PascalCase"] },
+                { selector: "typeLike", format: ["PascalCase"] },
+                {
+                    selector: "variable",
+                    types: ["boolean"],
+                    format: ["PascalCase"],
+                    prefix: ["is", "should", "has", "can", "did", "will", "are"],
+                    leadingUnderscore: "allow",
+                },
+            ],
+            "@typescript-eslint/consistent-type-definitions": [ERROR, "type"],
+            "@typescript-eslint/non-nullable-type-assertion-style": OFF,
+            "@typescript-eslint/no-unused-vars": [
+                ERROR,
+                {
+                    args: "all",
+                    argsIgnorePattern: "^_",
+                    caughtErrors: "all",
+                    caughtErrorsIgnorePattern: "^_",
+                    destructuredArrayIgnorePattern: "^_",
+                    varsIgnorePattern: "^_",
+                    ignoreRestSiblings: true,
+                },
+            ],
+        },
+        settings: {
+            "import/resolver": {
+                typescript: true,
+                node: true,
+            },
+        },
+    },
+]);
+if (reactPlugin.configs.flat.recommended === undefined ||
+    reactPlugin.configs.flat["jsx-runtime"] === undefined) {
+    // Throw is needed to fix types correctly
+    // This should never happen so if it does, it's an error worthy of breaking all eslint configs.
+    throw new Error("Failed to get config from eslint-plugin-react.");
+}
+const sharedReactRulesAndSettings = {
+    extends: [
+        reactPlugin.configs.flat.recommended,
+        reactPlugin.configs.flat["jsx-runtime"],
+        reactHooksPlugin.configs.flat.recommended,
+    ],
+    settings: {
+        react: {
+            version: "detect",
+        },
+    },
+    rules: {
+        "react-hooks/exhaustive-deps": [
+            WARN,
+            {
+                additionalHooks: "(useSelect|useSuspenseSelect)",
+            },
+        ],
+    },
+};
+const reactConfig = defineConfig([
+    {
+        name: "@atomicsmash/coding-standards/react-config",
+        files: ["**/*.jsx"],
+        extends: [baseConfig, ...sharedReactRulesAndSettings.extends],
+        settings: {
+            ...sharedReactRulesAndSettings.settings,
+        },
+        rules: {
+            ...sharedReactRulesAndSettings.rules,
+        },
+    },
+]);
+const reactTypescriptConfig = defineConfig([
+    {
+        name: "@atomicsmash/coding-standards/react-typescript-config",
+        files: ["**/*.tsx"],
+        extends: [typescriptConfig, ...sharedReactRulesAndSettings.extends],
+        settings: {
+            ...sharedReactRulesAndSettings.settings,
+        },
+        rules: {
+            ...sharedReactRulesAndSettings.rules,
+        },
+    },
+]);
+export const playwrightConfig = defineConfig([
+    {
+        name: "@atomicsmash/coding-standards/playwright-config",
+        extends: [playwrightPlugin.configs["flat/recommended"]],
+        rules: {
+            "playwright/expect-expect": [
+                ERROR,
+                {
+                    assertFunctionNames: [
+                        "playAudit", // This is the lighthouse playwright test, which contains threshold assertions.
+                    ],
+                },
+            ],
+        },
+    },
+]);
+export const recommendedConfig = defineConfig([
+    baseConfig,
+    typescriptConfig,
+    reactConfig,
+    reactTypescriptConfig,
+]);

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { default as cspellConfig } from "./cspell/index.js";
+import { default as prettierConfig } from "./prettier/index.js";
+import { default as stylelintConfig } from "./stylelint/index.js";
+export { cspellConfig, prettierConfig, stylelintConfig };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC"}

package/dist/index.js

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

package/dist/prettier/index.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    useTabs: true;
+    trailingComma: "all";
+    overrides: {
+        files: string[];
+        options: {
+            useTabs: false;
+            tabWidth: number;
+        };
+    }[];
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/prettier/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/prettier/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,wBAkCmB"}

package/dist/prettier/index.js

@@ -0,0 +1,32 @@
+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/dist/stylelint/base.d.ts

@@ -0,0 +1,69 @@
+declare const _default: {
+    reportDescriptionlessDisables: true;
+    reportInvalidScopeDisables: true;
+    reportNeedlessDisables: true;
+    plugins: string[];
+    rules: {
+        "custom-property-pattern": null;
+        "function-url-quotes": string[];
+        "rule-empty-line-before": (string | {
+            except: string[];
+            ignore: string[];
+        })[];
+        "comment-empty-line-before": (string | {
+            except: string[];
+            ignore: string[];
+        })[];
+        "order/order": (string | {
+            type: string;
+            hasBlock: boolean;
+        })[];
+        "plugin/no-restricted-syntax": {
+            selector: string;
+            message: string;
+        }[][];
+        "selector-class-pattern": (string | {
+            message: string;
+        })[];
+        "at-rule-empty-line-before": (string | {
+            ignore: string[];
+        })[];
+    };
+    overrides: ({
+        files: string[];
+        extends: string[];
+        rules: {
+            "at-rule-no-unknown": (boolean | {
+                ignoreAtRules: string;
+            })[];
+            "scss/operator-no-newline-after"?: undefined;
+            "no-descending-specificity"?: undefined;
+            "scss/at-rule-no-unknown"?: undefined;
+            "declaration-property-value-allowed-list"?: undefined;
+        };
+    } | {
+        files: string[];
+        extends: string[];
+        rules: {
+            "scss/operator-no-newline-after": null;
+            "no-descending-specificity": null;
+            "scss/at-rule-no-unknown": (boolean | {
+                ignoreAtRules: string;
+            })[];
+            "at-rule-no-unknown"?: undefined;
+            "declaration-property-value-allowed-list"?: undefined;
+        };
+    } | {
+        files: string[];
+        rules: {
+            "declaration-property-value-allowed-list": null;
+            "at-rule-no-unknown"?: undefined;
+            "scss/operator-no-newline-after"?: undefined;
+            "no-descending-specificity"?: undefined;
+            "scss/at-rule-no-unknown"?: undefined;
+        };
+        extends?: undefined;
+    })[];
+};
+export default _default;
+//# sourceMappingURL=base.d.ts.map

package/dist/stylelint/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/stylelint/base.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,wBAiCmB"}

package/dist/stylelint/base.js

@@ -0,0 +1,86 @@
+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"],
+        },
+    ],
+};
+export default {
+    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/dist/stylelint/classic.d.ts

@@ -0,0 +1,69 @@
+declare const _default: {
+    reportDescriptionlessDisables: true;
+    reportInvalidScopeDisables: true;
+    reportNeedlessDisables: true;
+    plugins: string[];
+    rules: {
+        "custom-property-pattern": null;
+        "function-url-quotes": string[];
+        "rule-empty-line-before": (string | {
+            except: string[];
+            ignore: string[];
+        })[];
+        "comment-empty-line-before": (string | {
+            except: string[];
+            ignore: string[];
+        })[];
+        "order/order": (string | {
+            type: string;
+            hasBlock: boolean;
+        })[];
+        "plugin/no-restricted-syntax": {
+            selector: string;
+            message: string;
+        }[][];
+        "selector-class-pattern": (string | {
+            message: string;
+        })[];
+        "at-rule-empty-line-before": (string | {
+            ignore: string[];
+        })[];
+    };
+    overrides: ({
+        files: string[];
+        extends: string[];
+        rules: {
+            "at-rule-no-unknown": (boolean | {
+                ignoreAtRules: string;
+            })[];
+            "scss/operator-no-newline-after"?: undefined;
+            "no-descending-specificity"?: undefined;
+            "scss/at-rule-no-unknown"?: undefined;
+            "declaration-property-value-allowed-list"?: undefined;
+        };
+    } | {
+        files: string[];
+        extends: string[];
+        rules: {
+            "scss/operator-no-newline-after": null;
+            "no-descending-specificity": null;
+            "scss/at-rule-no-unknown": (boolean | {
+                ignoreAtRules: string;
+            })[];
+            "at-rule-no-unknown"?: undefined;
+            "declaration-property-value-allowed-list"?: undefined;
+        };
+    } | {
+        files: string[];
+        rules: {
+            "declaration-property-value-allowed-list": null;
+            "at-rule-no-unknown"?: undefined;
+            "scss/operator-no-newline-after"?: undefined;
+            "no-descending-specificity"?: undefined;
+            "scss/at-rule-no-unknown"?: undefined;
+        };
+        extends?: undefined;
+    })[];
+};
+export default _default;
+//# sourceMappingURL=classic.d.ts.map

package/dist/stylelint/classic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classic.d.ts","sourceRoot":"","sources":["../../src/stylelint/classic.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,wBAAuC"}