@archpublicwebsite/eslint-config 1.0.10 → 1.0.13

package/README.md

@@ -1,53 +1,79 @@
-# eslint-config
+# @archpublicwebsite/eslint-config
 
-Reusable ESLint + Git hooks toolkit for Nuxt/Vue projects.
+Reusable ESLint flat config and git-hook toolkit for Archipelago projects.
 
-## Publish
+## What this package includes
+
+This package ships a ready-to-use flat config plus setup scripts for local project automation:
+
+- `createArchipelagoConfig()` for building an ESLint flat config
+- Git hook scripts for pre-commit and commit-message enforcement
+- Setup automation that bootstraps the consumer project
+- VS Code settings updates for the recommended linting workflow
+
+## Features
+
+- Flat config based on `@antfu/eslint-config`
+- Vue, TypeScript, Tailwind, and Nuxt-friendly defaults
+- Git hooks for consistent formatting and commit validation
+- Automatic project setup on install
+- Works with the Archipelago repo style rules
+
+## Requirements
+
+Consumer projects should have these tools available when using the full setup:
 
 ```bash
-cd packages/eslint-config
-pnpm version patch
-npm publish --access public
+pnpm add -D eslint prettier lint-staged turbo
 ```
 
-Quick checks before publish:
+## Installation
 
-- Ensure `.npmrc` points to public npm registry.
-- Run `npm pack --dry-run` and verify only `eslint.config.mjs`, `tools/`, and `README.md` are included.
+```bash
+pnpm add -D @archpublicwebsite/eslint-config
+```
 
-## Install
+## Usage
 
-```bash
-pnpm add -Dw eslint-config
+Create or update the root `eslint.config.mjs`:
+
+```js
+import { createArchipelagoConfig } from '@archpublicwebsite/eslint-config'
+
+export default createArchipelagoConfig()
 ```
 
-### Required dependencies (consumer project)
+Override rules when your project needs to diverge from the shared defaults:
 
-This toolkit expects these dev dependencies to exist in the project that installs it:
+```js
+import { createArchipelagoConfig } from '@archpublicwebsite/eslint-config'
 
-```bash
-pnpm add -D lint-staged prettier turbo
+export default createArchipelagoConfig({
+  name: 'project/overrides',
+  rules: {
+    'no-console': 'off',
+    'vue/max-attributes-per-line': 'off',
+  },
+})
 ```
 
-- `lint-staged` is used by the generated `pre-commit` hook.
-- `prettier` is used by the `lint:fix` flow.
-- `turbo` is used by the required `lint:check` / `lint:fix` scripts.
+## What the setup does
 
-On install, this package automatically sets up in your project root:
+On install or when you run the setup script manually, the package prepares the consumer project with:
 
 - `.hooks/pre-commit`
 - `.hooks/prepare-commit-msg`
 - `.hooks/commit-msg`
 - `.hooks/post-commit`
-- `eslint.config.mjs` (if not present)
+- `eslint.config.mjs` when one does not already exist
 - `.prettierrc` plugin entry for `prettier-plugin-tailwindcss`
-- `.vscode/settings.json` – ESLint flat-config settings so VS Code reads the config
-- `.vscode/extensions.json` – recommended extensions (ESLint, Prettier, Volar)
-- `git config core.hooksPath .hooks` (when in a git repo)
+- `.vscode/settings.json` with ESLint flat-config settings
+- `.vscode/extensions.json` with recommended extensions
+- `git config core.hooksPath .hooks` when the project is a Git repository
 
-### VS Code integration
+## VS Code integration
 
-On install, `.vscode/settings.json` is created or merged with these settings:
+The setup merges ESLint-related settings into `.vscode/settings.json`:
 
 ```json
 {
@@ -65,100 +91,88 @@ On install, `.vscode/settings.json` is created or merged with these settings:
 }
 ```
 
-If `.vscode/settings.json` already exists, your existing settings are preserved — only the ESLint-related keys are added or updated.
-
-You can also re-run it manually:
+Existing settings are preserved. Only the ESLint-related keys are added or updated.
 
-```bash
-node node_modules/@archpublicwebsite/eslint-config/tools/setup/install.mjs
-```
+## Public API
 
-## What this package provides
+The package exports:
 
-- `eslint.config.mjs` builder via `createArchipelagoConfig`
-- Reusable git hook handlers in `tools/git-hooks/`
-  - `pre-commit.mjs`
-  - `prepare-commit-msg.mjs`
-  - `commit-msg.mjs`
-  - `post-commit.mjs`
-  - `generate-commit-message.mjs`
-  - `verify-commit-message.mjs`
-  - `tools/setup/install.mjs` automatic project bootstrap
+- `createArchipelagoConfig`
+- setup scripts under `tools/`
 
-## ESLint usage
+## AI Implementation Guide
 
-Auto-generated `eslint.config.mjs` uses this package directly:
+If you are extending or regenerating this package, keep the workflow explicit:
 
-```js
-import { createArchipelagoConfig } from 'eslint-config'
+1. Update `eslint.config.mjs` when shared lint rules change.
+2. Update `tools/setup/install.mjs` when install-time bootstrap behavior changes.
+3. Update `tools/git-hooks/` when hook behavior changes.
+4. Keep the package export map aligned with the public API.
+5. Document any new consumer dependency that the setup expects.
 
-export default createArchipelagoConfig()
-```
+### AI-friendly implementation notes
 
-### Override rules
+- Use `createArchipelagoConfig()` in the consumer project, not the internal setup scripts.
+- Keep root scripts in sync with the hook and lint expectations.
+- Re-run the package setup flow when changing VS Code or hook behavior.
+- Prefer explicit examples that show what the consumer project should add.
 
-You can override any rule in your root `eslint.config.mjs`:
+## Manual setup
 
-```js
-import { createArchipelagoConfig } from 'eslint-config'
-
-export default createArchipelagoConfig({
-  name: 'project/overrides',
-  rules: {
-    'no-console': 'off',
-    'vue/max-attributes-per-line': 'off',
-  },
-})
-```
-
-## Manual setup (optional)
-
-Automatic setup is the default. If needed, you can still run setup manually:
+If you need to rerun the bootstrap manually:
 
 ```bash
-node node_modules/eslint-config/tools/setup/install.mjs
+node node_modules/@archpublicwebsite/eslint-config/tools/setup/install.mjs
 ```
 
 ## Hook wrappers reference
 
-Root `.hooks` scripts should delegate to installed package path:
-
-- `.hooks/pre-commit`
+Root `.hooks` scripts should delegate to the installed package path:
 
 ```bash
 #!/usr/bin/env bash
 set -euo pipefail
 cd "$(git rev-parse --show-toplevel)"
-node node_modules/eslint-config/tools/git-hooks/pre-commit.mjs
+node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/pre-commit.mjs
 ```
 
-- `.hooks/prepare-commit-msg`
-
 ```bash
 #!/usr/bin/env bash
 set -euo pipefail
 cd "$(git rev-parse --show-toplevel)"
-node node_modules/eslint-config/tools/git-hooks/prepare-commit-msg.mjs "$@"
+node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/prepare-commit-msg.mjs "$@"
 ```
 
-- `.hooks/commit-msg`
-
 ```bash
 #!/usr/bin/env bash
 set -euo pipefail
 cd "$(git rev-parse --show-toplevel)"
-node node_modules/eslint-config/tools/git-hooks/commit-msg.mjs "$1"
+node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/commit-msg.mjs "$1"
 ```
 
-- `.hooks/post-commit`
-
 ```bash
 #!/usr/bin/env bash
 set -euo pipefail
 cd "$(git rev-parse --show-toplevel)"
-node node_modules/eslint-config/tools/git-hooks/post-commit.mjs
+node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/post-commit.mjs
 ```
 
+## Publish
+
+```bash
+cd packages/eslint-config
+pnpm version patch
+npm publish --access public
+```
+
+Before publish, run:
+
+```bash
+npm pack --dry-run
+```
+
+Make sure the tarball contains only the intended public files: `eslint.config.mjs`, `tools/`, and `README.md`.
+
 ## Required root scripts
 
 ```json
@@ -173,3 +187,11 @@ node node_modules/eslint-config/tools/git-hooks/post-commit.mjs
   }
 }
 ```
+
+## Verification
+
+After making config changes, validate the package by checking the installed consumer workflow or by running the setup script in a test project.
+
+## License
+
+MIT

package/eslint.config.mjs

@@ -1,15 +1,23 @@
 import antfu from '@antfu/eslint-config'
-import perfectionistNatural from 'eslint-plugin-perfectionist'
 import tailwind from 'eslint-plugin-tailwindcss'
 
 export function createArchipelagoConfig(...overrides) {
   return antfu(
     {
-      formatters: true,
-      stylistic: true,
+      // Disable CSS/HTML/Markdown formatters — we only use @stylistic rules
+      formatters: false,
+      // Canonical style: no semicolons, single quotes, 2-space indent
+      // antfu propagates these to ALL related rules (semi, member-delimiter, etc.)
+      stylistic: {
+        semi: false,
+        quotes: 'single',
+        indent: 2,
+      },
       vue: true,
       typescript: true,
     },
+
+    // ── Global ignores ────────────────────────────────────────────────────────
     {
       name: 'archipelago/ignores',
       ignores: [
@@ -21,43 +29,54 @@ export function createArchipelagoConfig(...overrides) {
         '**/coverage/**',
         '**/.next/**',
         '**/public/**',
+        '**/*.d.ts',
       ],
     },
+
+    // ── Tailwind ──────────────────────────────────────────────────────────────
     ...tailwind.configs['flat/recommended'],
-    {
-      name: 'archipelago/perfectionist',
-      plugins: {
-        perfectionistNatural,
-      },
-      rules: {
-        'import/order': 'off',
-        'sort-imports': 'off',
-        'perfectionist/sort-imports': ['warn', {
-          type: 'alphabetical',
-        }],
-        'perfectionist/sort-exports': ['warn', {
-          type: 'alphabetical',
-        }],
-        'perfectionist/sort-named-imports': ['warn', {
-          type: 'alphabetical',
-        }],
-        'perfectionist/sort-named-exports': ['warn', {
-          type: 'alphabetical',
-        }],
-      },
-    },
+
+    // ── Canonical rules ───────────────────────────────────────────────────────
     {
       name: 'archipelago/rules',
       rules: {
-        'comma-dangle': ['warn', 'always-multiline'],
-        'no-console': 'warn',
-        'max-statements-per-line': 'warn',
-        'tailwindcss/no-custom-classname': 'off',
+        // format/prettier is loaded by antfu internals even with formatters:false.
+        // Configure it to AGREE with our style so it never conflicts with
+        // style/quotes and style/semi → eliminates circular fix warnings.
+        'format/prettier': ['warn', {
+          singleQuote: true,
+          semi: false,
+          printWidth: 120,
+          trailingComma: 'all',
+          arrowParens: 'avoid',
+        }],
+
+        // ── Anti-loop: disable rules that fight @stylistic equivalents ─────────
+        'object-curly-newline': 'off',
+        'style/object-curly-newline': 'off',
+        'style/operator-linebreak': 'off',
+        'style/indent': 'off',
+        'style/indent-binary-ops': 'off',
+        'max-statements-per-line': 'off',
+        'antfu/consistent-list-newline': 'off',
+        'antfu/consistent-chaining': 'off',
+        'antfu/if-newline': 'off',
+        'antfu/no-import-dist': 'off',
+
+        // ── Vue ──────────────────────────────────────────────────────────────
         'vue/multi-word-component-names': 'off',
         'vue/no-required-prop-with-default': 'off',
         'vue/html-self-closing': 'off',
         'vue/html-closing-bracket-spacing': 'off',
         'vue/no-multiple-template-root': 'off',
+        'vue/attributes-order': 'off',
+        'vue/singleline-html-element-content-newline': 'off',
+        'vue/html-closing-bracket-newline': 'off',
+        'vue/html-indent': 'off',
+        'vue/no-useless-v-bind': 'off',
+        'vue/prefer-separate-static-class': 'off',
+        'vue/attribute-hyphenation': 'off',
+        'vue/define-macros-order': 'off',
         'vue/max-attributes-per-line': ['error', {
           singleline: 3,
           multiline: 1,
@@ -72,12 +91,71 @@ export function createArchipelagoConfig(...overrides) {
           ignoreHTMLAttributeValues: true,
           ignoreHTMLTextContents: true,
         }],
-        'object-curly-newline': ['warn', {
-          ImportDeclaration: { multiline: true, minProperties: 3 },
+
+        // ── TypeScript ───────────────────────────────────────────────────────
+        'ts/no-use-before-define': 'off',
+        'ts/no-empty-object-type': 'off',
+        'ts/no-explicit-any': 'warn',
+        'ts/no-var-requires': 'warn',
+        'ts/consistent-type-imports': ['error', {
+          prefer: 'type-imports',
+          fixStyle: 'inline-type-imports',
         }],
-        'format/prettier': 'warn',
+
+        // ── Import ordering ──────────────────────────────────────────────────
+        'import/order': 'off',
+        'import/newline-after-import': 'off',
+        'import/consistent-type-specifier-style': 'off',
+        'perfectionist/sort-imports': 'off',
+        'perfectionist/sort-exports': 'off',
+        'perfectionist/sort-named-imports': 'off',
+        'perfectionist/sort-named-exports': 'off',
+
+        // ── Tailwind ─────────────────────────────────────────────────────────
+        'tailwindcss/no-custom-classname': 'off',
+        'tailwindcss/migration-from-tailwind-2': 'off',
+        'tailwindcss/enforces-shorthand': 'off',
+
+        // ── Misc ─────────────────────────────────────────────────────────────
+        'no-console': 'warn',
+        'no-alert': 'off',
+        'jsonc/sort-keys': 'off',
+        'jsonc/sort-array-values': 'off',
+        'regexp/no-unused-capturing-group': 'off',
+        'regexp/optimal-quantifier-concatenation': 'off',
+        'regexp/no-super-linear-backtracking': 'off',
+        'regexp/negation': 'off',
+        'node/prefer-global/process': 'off',
+        'unicorn/prefer-number-properties': 'off',
+        'unicorn/new-for-builtins': 'off',
+      },
+    },
+
+    // ── Package-level overrides (matches user's packages/** pattern) ──────────
+    {
+      name: 'archipelago/packages',
+      files: ['packages/**/*.{js,ts,vue}'],
+      rules: {
+        'vue/multi-word-component-names': 'off',
+      },
+    },
+
+    // ── Nuxt app overrides ────────────────────────────────────────────────────
+    {
+      name: 'archipelago/nuxt',
+      files: [
+        'apps/nuxt-web/components/**/*.{js,ts,vue}',
+        'apps/nuxt-web/pages/**/*.{js,ts,vue}',
+        'apps/nuxt-web/layouts/**/*.{js,ts,vue}',
+        'apps/nuxt-web/composables/**/*.{js,ts}',
+        'apps/nuxt-web/constants/**/*.{js,ts}',
+      ],
+      rules: {
+        'vue/multi-word-component-names': 'off',
+        'ts/no-explicit-any': 'warn',
       },
     },
+
     ...overrides,
   )
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@archpublicwebsite/eslint-config",
-  "version": "1.0.10",
-  "author": "Archipelago International",
+  "version": "1.0.13",
+  "author": "Archipelago Hotels",
   "description": "Reusable ESLint flat config and git-hook toolkit for Archipelago projects",
   "type": "module",
   "main": "./eslint.config.mjs",
@@ -47,13 +47,15 @@
   "dependencies": {
     "@antfu/eslint-config": "^4.12.0",
     "@unocss/eslint-config": "^66.5.3",
-    "eslint": "^9.0.0",
+    "eslint": "^9.39.4",
+    "prettier": "^3.8.3",
     "eslint-plugin-format": "^1.0.1",
     "eslint-plugin-perfectionist": "^4.10.1",
     "eslint-plugin-tailwindcss": "^3.17.3",
     "prettier-plugin-tailwindcss": "^0.6.14"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": false
   }
 }

package/tools/git-hooks/verify-commit-message.mjs

@@ -2,7 +2,7 @@ import { readFileSync } from 'node:fs'
 
 export function isValidCommitMessage(message) {
   const releaseRE = /^v\d/
-  const commitRE = /^(revert: )?(feat|fix|docs|refactor|perf|test|build|ci|chore|style|types|workflow|release|deps)(\([a-z0-9-]+\))?: \S.{0,49}$/
+  const commitRE = /^(revert: )?(feat|fix|docs|refactor|perf|test|build|ci|chore|style|types|workflow|release|deps)(\([a-z0-9-]+\))?: \S.*$/
   return releaseRE.test(message) || commitRE.test(message)
 }
 
@@ -13,10 +13,17 @@ function getCommitSubject(rawMessage) {
     .find(line => line && !line.startsWith('#')) || ''
 }
 
+function isSkippableCommitSubject(subject) {
+  return !subject || subject.startsWith('Merge ') || subject.startsWith('fixup! ') || subject.startsWith('squash! ')
+}
+
 export function verifyCommitMessageFile(messageFilePath) {
   const rawMessage = readFileSync(messageFilePath, 'utf-8')
   const subject = getCommitSubject(rawMessage)
 
+  if (isSkippableCommitSubject(subject))
+    return
+
   if (isValidCommitMessage(subject))
     return
 
@@ -25,13 +32,12 @@ export function verifyCommitMessageFile(messageFilePath) {
     'fix: handle events on blur (close #28)',
   ]
 
-  console.error('\nERROR: invalid commit message format.\n')
-  console.error('Required format: <type>(optional-scope): <description>')
-  console.error('Description max length: 50 characters\n')
-  console.error('Examples:')
-  examples.forEach(example => console.error(`  - ${example}`))
-  console.error('\nSee README.md (Auto commit message flow) for details.\n')
-  process.exit(1)
+  console.warn('\nSUGGESTION: conventional commit format is recommended.\n')
+  console.warn('Required format: <type>(optional-scope): <description>')
+  console.warn('Suggested subject length: around 100 characters\n')
+  console.warn('Examples:')
+  examples.forEach(example => console.warn(`  - ${example}`))
+  console.warn('\nSee README.md (Auto commit message flow) for details.\n')
 }
 
 if (import.meta.url === `file://${process.argv[1]}`) {

package/tools/setup/vscode.mjs

@@ -41,23 +41,23 @@ const VSCODE_ESLINT_SETTINGS = {
     'editor.defaultFormatter': 'dbaeumer.vscode-eslint',
   },
 
-  // Git commit message validation (50/72 formatting)
-  'git.inputValidation': true,
-  'git.inputValidationSubjectLength': 50,
-  'git.inputValidationLength': 72,
+  // Keep commit message rules as guidance only, not strict blocking.
+  'git.inputValidation': false,
+  'git.inputValidationSubjectLength': 100,
+  'git.inputValidationLength': 120,
 
   // Editor rules for git commit editor
   '[git-commit]': {
-    'editor.rulers': [50, 72],
+    'editor.rulers': [100, 120],
     'editor.wordWrap': 'wordWrapColumn',
-    'editor.wordWrapColumn': 72,
+    'editor.wordWrapColumn': 120,
   },
 
   // Editor rules for SCM input box (VS Code 1.86+)
   '[scminput]': {
-    'editor.rulers': [50, 72],
+    'editor.rulers': [100, 120],
     'editor.wordWrap': 'wordWrapColumn',
-    'editor.wordWrapColumn': 72,
+    'editor.wordWrapColumn': 120,
   },
 }