@averay/codeformat 0.2.0 → 0.2.2

package/eslint.config.js

@@ -1,3 +1,5 @@
+import globals from 'globals';
+
 import makeEslintConfig from './src/makeEslintConfig.ts';
 
 export default [
@@ -5,4 +7,28 @@ export default [
     ignores: ['dist/**/*.*'],
   },
   ...makeEslintConfig({ tsconfigPath: './tsconfig.json' }),
+  {
+    languageOptions: {
+      globals: { Bun: true, ...globals.node },
+    },
+  },
+
+  // Rulesets
+  {
+    files: ['rulesets/**/*.ts'],
+    rules: {
+      'sort-keys': 'error', // Organise rules.
+      'unicorn/no-useless-spread': 'off', // Keep the unprefixed core rules together.
+    },
+  },
+
+  // CLI
+  {
+    files: ['bin/**/*.ts'],
+    rules: {
+      'no-process-env': 'off',
+      'no-process-exit': 'off',
+      'unicorn/no-process-exit': 'off',
+    },
+  },
 ];

package/lib/cssPatterns.ts

@@ -0,0 +1,7 @@
+/* eslint require-unicode-regexp: 'off' -- Expressions are passed to Stylelint as strings so cannot use any flags in order to match their behaviour. */
+export default {
+  bem: /^[a-z]+(?:(?:-|--|__)[a-z]+)*$/.source,
+  bemWithOptionalSingleUnderscorePrefix: /^_?[a-z]+(?:(?:-|--|__)[a-z]+)*$/.source,
+  bemWithOptionalUnderscoresPrefix: /^(?:__)?[a-z]+(?:(?:-|--|__)[a-z]+)*$/.source,
+  kebab: /^[a-z]+(?:-[a-z]+)*$/.source,
+} satisfies Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@averay/codeformat",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "author": "Adam Averay (https://adamaveray.com.au/)",
   "homepage": "https://github.com/adamaveray/codeformat",
   "repository": {
@@ -15,46 +15,50 @@
   },
   "source": "./src/index.ts",
   "bin": {
-    "codeformat": "bin-codeformat.sh"
+    "codeformat": "bin/codeformat.ts"
   },
   "main": "./src/index.ts",
   "scripts": {
     "test": "bun test",
-    "format": "./bin-codeformat.sh fix",
-    "lint": "./bin-codeformat.sh check",
-    "prepare": "bun --bun x husky"
+    "format": "bin/codeformat.ts fix",
+    "lint": "bin/codeformat.ts check",
+    "prepare": "bun --bun x husky",
+    "release": "bun run lint && bun --bun x bumpp && bun publish"
   },
   "dependencies": {
-    "@averay/css-properties-sort-order": "^1.0.1",
-    "@eslint/eslintrc": "3.2.0",
-    "@eslint/js": "9.20.0",
-    "@stylistic/eslint-plugin": "^3.1.0",
-    "@typescript-eslint/eslint-plugin": "8.24.0",
-    "@typescript-eslint/parser": "8.24.0",
-    "eslint-config-prettier": "10.0.1",
-    "eslint-import-resolver-typescript": "^3.8.3",
+    "@averay/css-properties-sort-order": "^1.0.3",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.29.0",
+    "@prettier/plugin-php": "^0.22.4",
+    "@prettier/plugin-xml": "^3.4.1",
+    "@stylistic/eslint-plugin": "^4.4.1",
+    "@typescript-eslint/eslint-plugin": "^8.34.0",
+    "@typescript-eslint/parser": "^8.34.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-import-resolver-typescript": "^4.4.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsdoc": "50.6.3",
-    "eslint-plugin-promise": "7.2.1",
-    "eslint-plugin-regexp": "2.7.0",
-    "eslint-plugin-sonarjs": "3.0.2",
-    "eslint-plugin-unicorn": "56.0.1",
-    "globals": "15.15.0",
+    "eslint-plugin-jsdoc": "^51.0.1",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-regexp": "^2.9.0",
+    "eslint-plugin-sonarjs": "^3.0.2",
+    "eslint-plugin-unicorn": "^59.0.1",
+    "globals": "^16.2.0",
     "postcss-scss": "^4.0.9",
-    "prettier": "3.5.1",
-    "stylelint": "16.14.1",
-    "stylelint-config-recommended": "15.0.0",
-    "stylelint-config-recommended-scss": "14.1.0",
-    "stylelint-config-standard": "37.0.0",
-    "stylelint-config-standard-scss": "14.0.0",
-    "stylelint-order": "^6.0.4",
-    "stylelint-scss": "6.11.0",
-    "typescript-eslint": "^8.25.0"
+    "prettier": "^3.5.3",
+    "stylelint": "^16.20.0",
+    "stylelint-config-recommended": "^16.0.0",
+    "stylelint-config-recommended-scss": "^15.0.1",
+    "stylelint-config-standard": "^38.0.0",
+    "stylelint-config-standard-scss": "^15.0.1",
+    "stylelint-order": "^7.0.0",
+    "stylelint-scss": "^6.12.1",
+    "typescript-eslint": "^8.34.0"
   },
   "devDependencies": {
     "@types/bun": "latest",
-    "husky": "9.1.7",
-    "typescript": "^5.8.2"
+    "bumpp": "^10.1.1",
+    "husky": "^9.1.7",
+    "typescript": "^5.8.3"
   }
 }

package/rulesets/eslint/ruleset-shared.ts

@@ -1,5 +1,3 @@
-/* eslint sort-keys: 'error' -- Organise rules. */
-/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
 /* eslint import/no-named-as-default-member: "off" -- All plugins follow the same naming conventions. */
 
 import stylisticPlugin from '@stylistic/eslint-plugin';
@@ -21,6 +19,7 @@ export default {
     'consistent-return': 'error',
     'consistent-this': ['error', '_this'],
     'constructor-super': 'error',
+    curly: ['error', 'all'],
     'default-case': 'error',
     'default-case-last': 'error',
     'default-param-last': 'error',
@@ -239,7 +238,7 @@ export default {
   ],
   'import/no-commonjs': 'error',
   'import/no-cycle': ['error', { ignoreExternal: true }],
-  'import/no-duplicates': ['error', { 'prefer-inline': true }],
+  'import/no-duplicates': 'error',
   'import/no-dynamic-require': 'error',
   'import/no-empty-named-blocks': 'error',
   'import/no-extraneous-dependencies': 'error',
@@ -259,7 +258,7 @@ export default {
       'newlines-between': 'always',
     },
   ],
-  'import/prefer-default-export': 'error',
+  'import/prefer-default-export': 'off', // Causes friction when creating a utilities file with a single export in advance of adding additional exports.
 
   ...jsdocPlugin.configs.recommended.rules,
   'jsdoc/check-indentation': 'error',
@@ -283,6 +282,7 @@ export default {
   'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
 
   ...promisePlugin.configs.recommended.rules,
+  'promise/always-return': ['error', { ignoreAssignmentVariable: ['globalThis', 'window'], ignoreLastCallback: true }],
   'promise/no-multiple-resolved': 'error',
 
   ...regexpPlugin.configs.recommended.rules,
@@ -305,11 +305,14 @@ export default {
 
   ...sonarjsPlugin.configs.recommended.rules,
   'sonarjs/cognitive-complexity': 'off',
+  'sonarjs/function-return-type': 'off', // Overly restrictive.
   'sonarjs/max-switch-cases': 'off',
   'sonarjs/no-inverted-boolean-check': 'error',
   'sonarjs/no-nested-template-literals': 'off',
+  'sonarjs/no-selector-parameter': 'off', // Overly restrictive.
   'sonarjs/no-small-switch': 'off',
   'sonarjs/prefer-immediate-return': 'off',
+  'sonarjs/prefer-regexp-exec': 'off',
   'sonarjs/prefer-single-boolean-return': 'off',
 
   ...stylisticPlugin.configs['recommended-flat'].rules,
@@ -336,9 +339,10 @@ export default {
   '@stylistic/semi': 'off',
 
   ...unicornPlugin.configs.recommended.rules,
+  'unicorn/consistent-function-scoping': ['error', { checkArrowFunctions: false }],
   'unicorn/filename-case': 'off',
   'unicorn/no-null': 'off',
-  'unicorn/no-unsafe-regex': 'error',
+  'unicorn/no-useless-undefined': 'off', // Conflicts with `consistent-return`.
   'unicorn/prefer-event-target': 'error',
   'unicorn/prefer-query-selector': 'off',
   'unicorn/prevent-abbreviations': 'off',

package/rulesets/eslint/ruleset-typescript.ts

@@ -1,6 +1,3 @@
-/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
-/* eslint sort-keys: "error" -- Organise rules */
-
 import js from '@eslint/js';
 import typescriptPlugin from '@typescript-eslint/eslint-plugin';
 import { type TSESLint } from '@typescript-eslint/utils';
@@ -32,6 +29,7 @@ export default {
     'no-magic-numbers': 'off',
     'no-redeclare': 'off',
     'no-restricted-imports': 'off',
+    'no-restricted-syntax': ['error', 'WithStatement'],
     'no-return-await': 'off',
     'no-shadow': 'off',
     'no-throw-literal': 'off',
@@ -67,57 +65,61 @@ export default {
     /* eslint-disable sort-keys -- Logically ordered */
     {
       selector: 'default',
-      format: ['camelCase'],
+      format: ['strictCamelCase'],
+    },
+    {
+      selector: 'import',
+      format: ['strictCamelCase', 'StrictPascalCase', 'UPPER_CASE'],
     },
     {
       selector: 'variable',
       modifiers: ['const'],
-      format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+      format: ['strictCamelCase', 'StrictPascalCase', 'UPPER_CASE'],
     },
     {
       selector: 'variable',
       modifiers: ['const'],
       filter: { regex: /^_(static|\d+)?$/u.source, match: true },
-      format: ['camelCase'],
+      format: ['strictCamelCase'],
       leadingUnderscore: 'allow',
     },
     {
       selector: 'parameter',
-      format: ['camelCase'],
+      format: ['strictCamelCase'],
       leadingUnderscore: 'allow',
     },
     {
       selector: 'property',
-      format: ['camelCase', 'UPPER_CASE'],
+      format: ['strictCamelCase', 'UPPER_CASE'],
     },
     {
       selector: 'classProperty',
       modifiers: ['static'],
-      format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+      format: ['strictCamelCase', 'StrictPascalCase', 'UPPER_CASE'],
     },
     {
       selector: 'enumMember',
-      format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+      format: ['strictCamelCase', 'StrictPascalCase', 'UPPER_CASE'],
     },
     {
       selector: 'function',
-      format: ['camelCase', 'PascalCase'],
+      format: ['strictCamelCase', 'StrictPascalCase'],
     },
     {
       selector: 'typeLike',
-      format: ['PascalCase'],
+      format: ['StrictPascalCase'],
     },
     {
       selector: ['objectLiteralProperty'],
-      format: [],
+      format: null,
     },
     {
       selector: ['classProperty', 'objectLiteralMethod'],
-      format: ['camelCase', 'UPPER_CASE'],
+      format: ['strictCamelCase', 'UPPER_CASE'],
     },
     {
       selector: 'typeParameter',
-      format: ['PascalCase'],
+      format: null,
       custom: { regex: /^([A-Z]|T[A-Z][a-zA-Z]+|key)$/u.source, match: true },
     },
     /* eslint-enable sort-keys -- Logically ordered */
@@ -146,7 +148,7 @@ export default {
     {
       detectObjects: true,
       enforceConst: true,
-      ignore: [-1, 0, 1],
+      ignore: [-1, 0, 1, 2, 100, '0n'],
       ignoreArrayIndexes: true,
       ignoreClassFieldInitialValues: true,
       ignoreDefaultValues: true,
@@ -211,14 +213,25 @@ export default {
     'error',
     { allowNullableObject: false, allowNullableString: false, allowNumber: false, allowString: false },
   ],
-  '@typescript-eslint/switch-exhaustiveness-check': 'error',
+  '@typescript-eslint/switch-exhaustiveness-check': [
+    'error',
+    {
+      allowDefaultCaseForExhaustiveSwitch: false,
+      considerDefaultExhaustiveForUnions: true,
+      requireDefaultForNonUnion: true,
+    },
+  ],
   '@typescript-eslint/triple-slash-reference': 'error',
   '@typescript-eslint/unbound-method': 'off', // Does not support @autobind nor recognise binding in constructors
   '@typescript-eslint/unified-signatures': 'off',
 
+  'import/no-duplicates': 'off', // Breaks if importing both default and named exports as types (https://github.com/import-js/eslint-plugin-import/issues/2007).
+
   'jsdoc/no-types': 'error',
   'jsdoc/require-param-type': 'off',
   'jsdoc/require-returns-type': 'off',
+
+  'sonarjs/super-invocation': 'off', // Causes issues and is enforced by TypeScript already.
 } satisfies TSESLint.FlatConfig.Rules;
 
 export const moduleDeclarations = {

package/rulesets/php/ruleset-php-cs-fixer.php

@@ -0,0 +1,93 @@
+<?php
+declare(strict_types=1);
+
+$base = [
+  '@PhpCsFixer' => true,
+  '@Symfony' => true,
+];
+
+$prettier = [
+  'array_indentation' => false,
+  'array_syntax' => false,
+  'blank_line_before_statement' => false,
+  'braces_position' => false,
+  'cast_spaces' => false,
+  'class_definition' => false,
+  'compact_nullable_type_declaration' => false,
+  'concat_space' => false,
+  'constant_case' => false,
+  'control_structure_braces' => false,
+  'control_structure_continuation_position' => false,
+  'declare_parentheses' => false,
+  'function_declaration' => ['closure_fn_spacing' => 'none'],
+  'heredoc_indentation' => ['indentation' => 'same_as_start'],
+  'indentation_type' => false,
+  'line_ending' => false,
+  'lowercase_cast' => false,
+  'lowercase_keywords' => false,
+  'lowercase_static_reference' => false,
+  'magic_constant_casing' => false,
+  'method_chaining_indentation' => false,
+  'multiline_whitespace_before_semicolons' => false,
+  'native_type_declaration_casing' => false,
+  'new_with_parentheses' => false,
+  'no_blank_lines_after_class_opening' => false,
+  'no_extra_blank_lines' => false,
+  'no_multiline_whitespace_around_double_arrow' => false,
+  'no_multiple_statements_per_line' => false,
+  'no_spaces_around_offset' => false,
+  'no_trailing_comma_in_singleline' => false,
+  'no_trailing_whitespace' => false,
+  'no_unneeded_control_parentheses' => [
+    'statements' => ['break', 'clone', 'continue', 'echo_print', 'return', 'switch_case', 'yield', 'yield_from'],
+  ],
+  'no_whitespace_before_comma_in_array' => false,
+  'no_whitespace_in_blank_line' => false,
+  'operator_linebreak' => false,
+  'single_blank_line_at_eof' => false,
+  'single_line_empty_body' => false,
+  'single_line_throw' => false,
+  'single_space_around_construct' => false,
+  'spaces_inside_parentheses' => false,
+  'statement_indentation' => false,
+  'trim_array_spaces' => false,
+  'types_spaces' => false,
+  'type_declaration_spaces' => false,
+  'whitespace_after_comma_in_array' => false,
+];
+
+$custom = [
+  'blank_line_after_opening_tag' => false,
+  'combine_consecutive_issets' => false,
+  'combine_consecutive_unsets' => false,
+  'fully_qualified_strict_types' => ['leading_backslash_in_global_namespace' => true],
+  'increment_style' => ['style' => 'post'],
+  'native_function_invocation' => ['include' => ['@internal']],
+  'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
+  'no_useless_else' => false,
+  'phpdoc_align' => false,
+  'phpdoc_annotation_without_dot' => false,
+  'phpdoc_tag_casing' => true,
+  'phpdoc_to_comment' => ['ignored_tags' => ['lang', 'noinspection', 'psalm-suppress', 'psalm-type', 'var']],
+  'return_assignment' => false,
+  'string_implicit_backslashes' => ['single_quoted' => 'escape', 'double_quoted' => 'escape', 'heredoc' => 'escape'],
+  'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
+
+  'ordered_class_elements' => [
+    'order' => [
+      'use_trait',
+      'case',
+      'constant_public',
+      'constant_protected',
+      'constant_private',
+      'property_static',
+      'property',
+      'construct',
+      'destruct',
+      // 'method',
+      // 'method_static',
+    ],
+  ],
+];
+
+return $base + $prettier + $custom;

package/rulesets/stylelint/ruleset-css.ts

@@ -1,22 +1,38 @@
-/* eslint sort-keys: "error" -- Organise rules. */
-/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
-
 import propertiesOrder from '@averay/css-properties-sort-order';
 import recommended from 'stylelint-config-recommended';
 import standard from 'stylelint-config-standard';
 
+import patterns from '../../lib/cssPatterns.ts';
+
 export default {
   ...recommended.rules,
   ...standard.rules,
 
+  // Core rules
   ...{
-    'at-rule-empty-line-before': null,
     'color-named': 'never',
-    'comment-empty-line-before': null,
     'function-url-no-scheme-relative': true,
+  },
+
+  // Disable Prettier conflicts
+  ...{
+    'at-rule-empty-line-before': null,
+    'comment-empty-line-before': null,
     'rule-empty-line-before': null,
   },
 
+  // Patterns
+  ...{
+    'container-name-pattern': patterns.bem,
+    'custom-media-pattern': patterns.bem,
+    'custom-property-pattern': patterns.bem,
+    'keyframes-name-pattern': patterns.bem,
+    'layer-name-pattern': patterns.bem,
+    'selector-class-pattern': patterns.bemWithOptionalUnderscoresPrefix,
+    'selector-id-pattern': patterns.kebab,
+  },
+
+  // Extensions
   'order/order': ['custom-properties', 'declarations'],
   'order/properties-order': [propertiesOrder, { unspecified: 'bottomAlphabetical' }],
 };

package/rulesets/stylelint/ruleset-scss.ts

@@ -1,16 +1,13 @@
-/* eslint sort-keys: "error" -- Organise rules. */
-/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
-
 import recommended from 'stylelint-config-recommended-scss';
 import standard from 'stylelint-config-standard-scss';
 
-const CUSTOM_KEYWORD_PATTERN = /^_?[a-z][\da-z]*((-|--|__)[\da-z]+)*$/u;
+import patterns from '../../lib/cssPatterns.ts';
 
 export default {
   ...recommended.rules,
   ...standard.rules,
 
-  // Disable Prettier-conflicting legacy rules.
+  // Disable Prettier conflicts
   ...{
     'scss/at-else-closing-brace-newline-after': null,
     'scss/at-else-closing-brace-space-after': null,
@@ -27,7 +24,9 @@ export default {
     'scss/operator-no-newline-before': null,
     'scss/operator-no-unspaced': null,
   },
-  'scss/at-function-pattern': CUSTOM_KEYWORD_PATTERN.source,
-  'scss/at-mixin-pattern': CUSTOM_KEYWORD_PATTERN.source,
-  'scss/dollar-variable-pattern': CUSTOM_KEYWORD_PATTERN.source,
+
+  'scss/at-function-pattern': patterns.bemWithOptionalSingleUnderscorePrefix,
+  'scss/at-mixin-pattern': patterns.bemWithOptionalSingleUnderscorePrefix,
+  'scss/dollar-variable-pattern': patterns.bemWithOptionalSingleUnderscorePrefix,
+  'scss/percent-placeholder-pattern': patterns.bemWithOptionalSingleUnderscorePrefix,
 };

package/src/makeStylelintConfig.ts

@@ -1,7 +1,7 @@
 /* eslint sort-keys: "error" -- Organise rules */
 
 import postcssScss from 'postcss-scss';
-import { type Config } from 'stylelint';
+import { type Config, type CustomSyntax } from 'stylelint';
 import orderPlugin from 'stylelint-order';
 import scssPlugin from 'stylelint-scss';
 
@@ -10,11 +10,13 @@ import rulesetStylelintScss from '../rulesets/stylelint/ruleset-scss.ts';
 
 import extensions from './extensions.ts';
 
+type ConfigRules = Config['rules'];
+
 /**
  * @returns The complete Stylelint config.
  */
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type,@typescript-eslint/explicit-module-boundary-types -- Preserve specific object shape.
-export default function makeStylelintConfig() {
+export default function makeStylelintConfig(cssRules: ConfigRules = {}, scssRules: ConfigRules = {}) {
   return {
     defaultSeverity: 'error',
     ignoreFiles: ['**/*.min.*'],
@@ -22,15 +24,21 @@ export default function makeStylelintConfig() {
     reportDescriptionlessDisables: true,
     reportInvalidScopeDisables: true,
     reportNeedlessDisables: true,
-    rules: rulesetStylelintCss,
+    rules: {
+      ...rulesetStylelintCss,
+      ...cssRules,
+    },
 
     // eslint-disable-next-line sort-keys -- Logically positioned.
     overrides: [
       {
-        customSyntax: postcssScss,
+        customSyntax: postcssScss as unknown as CustomSyntax,
         files: extensions.scss.map((ext) => `**/*.${ext}`), // Does not support glob braces
         plugins: [scssPlugin],
-        rules: rulesetStylelintScss,
+        rules: {
+          ...rulesetStylelintScss,
+          ...scssRules,
+        },
       },
     ],
   } satisfies Config;

package/src/php/PhpCsFixerConfig.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+use PhpCsFixer\Config as BaseConfig;
+use PhpCsFixer\Finder;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+class PhpCsFixerConfig extends BaseConfig
+{
+  protected static function loadRules(): array
+  {
+    return require __DIR__ . '/../../rulesets/php/ruleset-php-cs-fixer.php';
+  }
+
+  public static function default(?Finder $finder = null): self
+  {
+    $config = new self();
+
+    $config->setParallelConfig(ParallelConfigFactory::detect())->setRiskyAllowed(true)->setRules(static::loadRules());
+
+    if ($finder !== null) {
+      $config->setFinder($finder);
+    }
+
+    return $config;
+  }
+}

package/{stylelint.config.cjs → stylelint.config.js}

@@ -1,7 +1,7 @@
 /* eslint import/no-commonjs: "off" -- Unsupported by Stylelint */
 
-const { makeStylelintConfig } = require('./src/index.ts');
+import { makeStylelintConfig } from './src/index.ts';
 
-module.exports = {
+export default {
   ...makeStylelintConfig(),
 };

package/vendor/autoload.php

@@ -0,0 +1,22 @@
+<?php
+
+// autoload.php @generated by Composer
+
+if (PHP_VERSION_ID < 50600) {
+    if (!headers_sent()) {
+        header('HTTP/1.1 500 Internal Server Error');
+    }
+    $err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
+    if (!ini_get('display_errors')) {
+        if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
+            fwrite(STDERR, $err);
+        } elseif (!headers_sent()) {
+            echo $err;
+        }
+    }
+    throw new RuntimeException($err);
+}
+
+require_once __DIR__ . '/composer/autoload_real.php';
+
+return ComposerAutoloaderInit5cf0c9c544b3b2c6a2f08a9f80894035::getLoader();