@cluerise/tools 3.0.1 → 4.0.0

package/README.md

@@ -6,8 +6,9 @@ _Tools for maintaining TypeScript projects_
 
 ### Init
 
-```
-npx @cluerise/tools init [all|name]
+```sh
+pnpm add -DE @cluerise/tools
+pnpm exec @cluerise/tools init [all|name]
 ```
 
 Before you run the `init` command, make sure your `package.json` contains
@@ -17,36 +18,36 @@ Before you run the `init` command, make sure your `package.json` contains
 
 ### Lint
 
-```
-cluerise-tools lint [all|code|staged|commit]
+```sh
+cluerise-tools lint [all|fix|staged|commit]
 ```
 
 ### Release
 
-```
+```sh
 cluerise-tools release [create|extract-changelog]
 ```
 
 ### Update Node.js versions
 
-```
+```sh
 cluerise-tools update-node-versions
 ```
 
 ### Create Commit Message
 
-```
+```sh
 cluerise-tools create-commit-message
 ```
 
 ### Format Commit Message
 
-```
+```sh
 cluerise-tools format-commit-message
 ```
 
 ### Check Heroku Node.js Version
 
-```
+```sh
 cluerise-tools check-heroku-node-version
 ```

package/dist/configs/.nvmrc

@@ -1 +1 @@
-v22.1.0
+v24.1.0

package/dist/configs/.prettierignore

@@ -23,15 +23,22 @@ hooks/*
 !hooks/*.ts
 
 # Lock files
+pnpm-lock.yaml
 package-lock.json
 yarn.lock
 
 # Misc
 etc/
+.DS_Store
 
 # Sample of .env file
 .env.example
 .env.sample
+.envrc.example
+.envrc.sample
+
+# Stryker
+.stryker-tmp/
 
 # Tests coverage
 coverage/

package/dist/configs/commitlint.config.ts

@@ -1,7 +1,7 @@
 import { RuleConfigSeverity, UserConfig } from '@commitlint/types';
 
 const commitlintConfig: UserConfig = {
-  parserPreset: 'conventional-changelog-conventionalcommits',
+  extends: ['@commitlint/config-conventional'],
   rules: {
     'body-full-stop': [RuleConfigSeverity.Error, 'always', '.'],
     'body-leading-blank': [RuleConfigSeverity.Error, 'always'],

package/dist/configs/eslint-markdown.config.js

@@ -0,0 +1,8 @@
+import eslintMarkdown from '@eslint/markdown';
+
+export default [
+  {
+    ignores: ['**/*.(j|t)sx?']
+  },
+  ...eslintMarkdown.configs.recommended
+];

package/dist/configs/eslint.config.js

@@ -0,0 +1,329 @@
+import eslintJs from '@eslint/js';
+import eslintJson from '@eslint/json';
+import eslintMarkdown from '@eslint/markdown';
+import eslintPluginHtml from '@html-eslint/eslint-plugin';
+import { defineConfig } from 'eslint/config';
+import eslintPluginImport from 'eslint-plugin-import';
+import eslintPluginPrettier from 'eslint-plugin-prettier/recommended';
+import eslintPluginSimpleImportSort from 'eslint-plugin-simple-import-sort';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+import eslintPluginYml from 'eslint-plugin-yml';
+import globals from 'globals';
+import typescriptEslint from 'typescript-eslint';
+
+export default defineConfig([
+  // JavaScript
+  {
+    ...eslintJs.configs.recommended,
+    name: 'cluerise: eslint/js'
+  },
+  {
+    name: 'cluerise: eslint/js/rules',
+    rules: {
+      'no-irregular-whitespace': 'off',
+      'no-restricted-globals': ['error', 'JSON'],
+      'no-undef-init': 'error',
+      'no-unused-vars': 'off',
+      'object-shorthand': 'error',
+      'sort-imports': 'off'
+    }
+  },
+  // TypeScript
+  ...typescriptEslint.configs.recommendedTypeChecked.map((config) => ({
+    ...config,
+    name: `cluerise: ${config.name ?? 'typescript-eslint'}`
+  })),
+  {
+    name: 'cluerise: typescript-eslint/language-options',
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node
+      },
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: ['*.md/*']
+        },
+        tsconfigRootDir: import.meta.dirname
+      }
+    }
+  },
+  {
+    name: 'cluerise: typescript-eslint/disable-type-checked',
+    files: ['**/*.js', '**/*.json', '**/*.yaml'],
+    extends: [typescriptEslint.configs.disableTypeChecked]
+  },
+  {
+    name: 'cluerise: typescript-eslint/rules',
+    rules: {
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-import-type-side-effects': 'error',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          caughtErrors: 'all',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+          varsIgnorePattern: '^_'
+        }
+      ]
+    }
+  },
+  {
+    name: 'cluerise: typescript-eslint/rules',
+    files: ['**/*.tsx?'],
+    rules: {
+      '@typescript-eslint/consistent-type-imports': ['error', { fixStyle: 'inline-type-imports' }]
+    }
+  },
+  // JSON
+  {
+    name: 'cluerise: eslint/json',
+    files: ['**/*.json'],
+    plugins: { json: eslintJson },
+    language: 'json/json',
+    extends: ['json/recommended']
+  },
+  {
+    name: 'cluerise: eslint/jsonc',
+    files: ['**/*.jsonc'],
+    plugins: { json: eslintJson },
+    language: 'json/jsonc',
+    extends: ['json/recommended']
+  },
+  // Markdown
+  {
+    name: 'cluerise: eslint/markdown',
+    files: ['**/*.md'],
+    plugins: { markdown: eslintMarkdown },
+    processor: 'markdown/markdown',
+    extends: ['markdown/recommended']
+  },
+  // YAML
+  ...eslintPluginYml.configs['flat/recommended'].map((config) => ({
+    ...config,
+    name: `cluerise: ${config.name ?? 'eslint/yaml'}`
+  })),
+  {
+    name: 'cluerise: eslint/yaml/rules',
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+      'yml/quotes': ['error', { prefer: 'single' }]
+    }
+  },
+  // Import
+  {
+    name: 'cluerise: eslint/import/js',
+    files: ['**/*.js'],
+    extends: [eslintPluginImport.flatConfigs.recommended],
+    rules: {
+      'import/first': 'error',
+      'import/namespace': 'off',
+      'import/newline-after-import': 'error',
+      'import/no-amd': 'error',
+      'import/no-commonjs': 'error',
+      'import/no-default-export': 'error',
+      'import/no-duplicates': 'error',
+      'import/no-mutable-exports': 'error',
+      'import/no-unassigned-import': ['error', { allow: ['reset-css'] }],
+      'import/order': 'off'
+    }
+  },
+  {
+    name: 'cluerise: eslint/import/ts',
+    files: ['**/*.tsx?'],
+    extends: [eslintPluginImport.flatConfigs.recommended, eslintPluginImport.flatConfigs.typescript],
+    rules: {
+      'import/first': 'error',
+      'import/namespace': 'off',
+      'import/newline-after-import': 'error',
+      'import/no-amd': 'error',
+      'import/no-commonjs': 'error',
+      'import/no-default-export': 'error',
+      'import/no-duplicates': 'error',
+      'import/no-mutable-exports': 'error',
+      'import/no-unassigned-import': ['error', { allow: ['reset-css'] }],
+      'import/order': 'off'
+    }
+  },
+  {
+    name: 'cluerise: eslint/import/rules/config.js',
+    files: ['*.config.js'],
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+      'import/no-commonjs': 'off'
+    }
+  },
+  {
+    name: 'cluerise: eslint/import/rules/config.js,ts',
+    files: ['*.config.js', '*.config.ts'],
+    rules: {
+      'import/no-default-export': 'off'
+    }
+  },
+  {
+    name: 'cluerise: eslint/import/rules/routes',
+    files: ['*-route.tsx'],
+    rules: {
+      'import/no-default-export': 'off'
+    }
+  },
+  {
+    name: 'cluerise: settings/eslint/import',
+    settings: {
+      'import/resolver': {
+        typescript: {}
+      }
+    }
+  },
+  // Simple Import Sort
+  {
+    name: 'cluerise: eslint/simple-import-sort',
+    plugins: {
+      'simple-import-sort': eslintPluginSimpleImportSort
+    },
+    rules: {
+      'simple-import-sort/exports': 'error',
+      'simple-import-sort/imports': 'error'
+    }
+  },
+  // Unicorn
+  {
+    ...eslintPluginUnicorn.configs.recommended,
+    name: 'cluerise: eslint/unicorn'
+  },
+  {
+    name: 'cluerise: eslint/unicorn/rules',
+    rules: {
+      'unicorn/expiring-todo-comments': 'off',
+      'unicorn/no-null': 'off',
+      'unicorn/no-static-only-class': 'off',
+      'unicorn/prevent-abbreviations': [
+        'error',
+        {
+          replacements: {
+            arg: false,
+            args: false,
+            dist: false,
+            params: false,
+            utils: false
+          }
+        }
+      ],
+      'unicorn/switch-case-braces': ['error', 'avoid'],
+      'unicorn/filename-case': ['error', { case: 'kebabCase', ignore: [String.raw`\.md$`] }]
+    }
+  },
+  // HTML
+  {
+    ...eslintPluginHtml.configs['flat/recommended'],
+    name: 'cluerise: html-eslint',
+    files: ['**/*.html']
+  },
+  {
+    name: 'cluerise: html-eslint/rules',
+    files: ['**/*.html'],
+    rules: {
+      '@html-eslint/indent': ['error', 2],
+      '@html-eslint/no-extra-spacing-attrs': ['error', { enforceBeforeSelfClose: true }],
+      '@html-eslint/require-closing-tags': ['error', { selfClosing: 'always' }],
+      '@html-eslint/require-title': 'off'
+    }
+  },
+  // Ignore
+  {
+    name: 'cluerise: ignore',
+    ignores: [
+      // All hidden files and directories
+      '.*',
+
+      // Enable hidden files with extensions
+      '!.*.*',
+
+      // Enable all hidden directories
+      '!.*/',
+
+      // Archives
+      '*.zip',
+      '*.gz',
+      '*.tgz',
+
+      // Build
+      'build/',
+      'dist/',
+
+      // CSS
+      '*.css',
+
+      // Dependencies
+      'node_modules/',
+
+      // Fonts
+      '*.ttf',
+      '*.woff2',
+
+      // Generated files
+      '__generated__/',
+      'patches/',
+
+      // Git
+      '.git/',
+
+      // Git hooks
+      'hooks/*',
+      '!hooks/*.js',
+      '!hooks/*.ts',
+
+      // I18n
+      '*.po',
+
+      // Images
+      '*.ico',
+      '*.png',
+      '*.svg',
+      '*.webp',
+
+      // Lock files
+      'pnpm-lock.yaml',
+      'package-lock.json',
+      'yarn.lock',
+
+      // Lua scripts
+      '*.lua',
+
+      // Misc
+      'etc/',
+      '.DS_Store',
+
+      // Sample of .env and .envrc files
+      '.env.example',
+      '.env.sample',
+      '.envrc.example',
+      '.envrc.sample',
+
+      // Shell scripts
+      '*.sh',
+
+      // Stryker
+      '.stryker-tmp/',
+
+      // Tests coverage
+      'coverage/',
+
+      // Texts
+      '*.txt',
+
+      // XML
+      '*.xml'
+    ]
+  },
+  // Prettier
+  {
+    ...eslintPluginPrettier,
+    name: 'cluerise: eslint/prettier'
+  }
+]);

package/dist/configs/hooks/commit-msg

@@ -1 +1 @@
-npm run __git-hook:commit-msg --if-present "$@"
+pnpm run --if-present __git-hook:commit-msg "$@"

package/dist/configs/hooks/post-commit

@@ -1 +1 @@
-npm run __git-hook:post-commit --if-present "$@"
+pnpm run --if-present __git-hook:post-commit "$@"

package/dist/configs/hooks/pre-commit

@@ -1 +1 @@
-npm run __git-hook:pre-commit --if-present "$@"
+pnpm run --if-present __git-hook:pre-commit "$@"

package/dist/configs/hooks/prepare-commit-msg

@@ -1 +1 @@
-npm run __git-hook:prepare-commit-msg --if-present "$@"
+pnpm run --if-present __git-hook:prepare-commit-msg "$@"

package/dist/configs/lint-staged.config.js

@@ -1,10 +1,9 @@
-import FileSystem from 'fs';
-import Path from 'path';
+import FileSystem from 'node:fs';
+import Path from 'node:path';
 
 const tsconfigPath = '.lint-staged-temp-tsconfig.json';
 
-const toRelative = (filename) => Path.relative('.', filename);
-const mapToRelative = (filenames) => filenames.map(toRelative);
+const mapToRelative = (filenames) => filenames.map((filename) => Path.relative('.', filename));
 
 export default {
   '**': (filenames) => {
@@ -23,6 +22,7 @@ export default {
         files: relativeFilenames
       };
 
+      // eslint-disable-next-line no-restricted-globals
       FileSystem.writeFileSync(tsconfigPath, JSON.stringify(tsconfig));
     }
 

package/dist/configs/pnpm-workspace.yaml

@@ -0,0 +1 @@
+engineStrict: true

package/dist/configs/release.config.js

@@ -79,7 +79,7 @@ export const createReleaseConfig = ({
 {{#if noteGroups}}
 {{#each noteGroups}}
 
-### ⚠ {{title}} !!
+### ⚠ {{title}}!
 
 {{#each notes}}
 * {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{text}}

package/dist/configs/tsconfig.json

@@ -8,20 +8,15 @@
     "jsx": "preserve",
     "lib": ["dom", "esnext"],
     "module": "esnext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "noEmit": true,
     "noUncheckedIndexedAccess": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "baseUrl": "./",
-    "paths": {
-      ":/*": ["./src/*/index"]
-    },
     "resolveJsonModule": true,
     "skipLibCheck": true,
     "strict": true,
-    "target": "esnext",
-    "types": ["node", "vite/client"]
+    "target": "esnext"
   },
   "exclude": ["node_modules"]
 }