@archpublicwebsite/eslint-config 1.0.5

package/README.md

@@ -0,0 +1,145 @@
+# eslint-config
+
+Reusable ESLint + Git hooks toolkit for Nuxt/Vue projects.
+
+## Publish
+
+```bash
+cd packages/eslint-config
+pnpm version patch
+npm publish --access public
+```
+
+Quick checks before publish:
+
+- Ensure `.npmrc` points to public npm registry.
+- Run `npm pack --dry-run` and verify only `eslint.config.mjs`, `tools/`, and `README.md` are included.
+
+## Install
+
+```bash
+pnpm add -Dw eslint-config
+```
+
+### Required dependencies (consumer project)
+
+This toolkit expects these dev dependencies to exist in the project that installs it:
+
+```bash
+pnpm add -D lint-staged prettier turbo
+```
+
+- `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.
+
+On install, this package automatically sets up in your project root:
+
+- `.hooks/pre-commit`
+- `.hooks/prepare-commit-msg`
+- `.hooks/commit-msg`
+- `.hooks/post-commit`
+- `eslint.config.mjs` (if not present)
+- `.prettierrc` plugin entry for `prettier-plugin-tailwindcss`
+- `git config core.hooksPath .hooks` (when in a git repo)
+
+## What this package provides
+
+- `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
+
+## ESLint usage
+
+Auto-generated `eslint.config.mjs` uses this package directly:
+
+```js
+import { createArchipelagoConfig } from 'eslint-config'
+
+export default createArchipelagoConfig()
+```
+
+### Override rules
+
+You can override any rule in your root `eslint.config.mjs`:
+
+```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:
+
+```bash
+node node_modules/eslint-config/tools/setup/install.mjs
+```
+
+## Hook wrappers reference
+
+Root `.hooks` scripts should delegate to installed package path:
+
+- `.hooks/pre-commit`
+
+```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
+```
+
+- `.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 "$@"
+```
+
+- `.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"
+```
+
+- `.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
+```
+
+## Required root scripts
+
+```json
+{
+  "scripts": {
+    "lint": "pnpm lint:fix",
+    "lint:check": "turbo run lint",
+    "lint:fix": "((pnpm format || true) && turbo run lint --continue=always -- --fix) || true"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx,vue}": ["eslint --fix"]
+  }
+}
+```

package/eslint.config.mjs

@@ -0,0 +1,83 @@
+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,
+      vue: true,
+      typescript: true,
+    },
+    {
+      name: 'archipelago/ignores',
+      ignores: [
+        '**/node_modules/**',
+        '**/.nuxt/**',
+        '**/.output/**',
+        '**/.turbo/**',
+        '**/dist/**',
+        '**/coverage/**',
+        '**/.next/**',
+        '**/public/**',
+      ],
+    },
+    ...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',
+        }],
+      },
+    },
+    {
+      name: 'archipelago/rules',
+      rules: {
+        'comma-dangle': ['warn', 'always-multiline'],
+        'no-console': 'warn',
+        'max-statements-per-line': 'warn',
+        'tailwindcss/no-custom-classname': 'off',
+        '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/max-attributes-per-line': ['error', {
+          singleline: 3,
+          multiline: 1,
+        }],
+        'vue/max-len': ['warn', {
+          code: 120,
+          ignoreComments: true,
+          ignoreUrls: true,
+          ignoreStrings: true,
+          ignoreTemplateLiterals: true,
+          ignoreRegExpLiterals: true,
+          ignoreHTMLAttributeValues: true,
+          ignoreHTMLTextContents: true,
+        }],
+        'object-curly-newline': ['warn', {
+          ImportDeclaration: { multiline: true, minProperties: 3 },
+        }],
+        'format/prettier': 'warn',
+      },
+    },
+    ...overrides,
+  )
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@archpublicwebsite/eslint-config",
+  "version": "1.0.5",
+  "author": "Archipelago International",
+  "description": "Reusable ESLint flat config and git-hook toolkit for Archipelago projects",
+  "type": "module",
+  "main": "./eslint.config.mjs",
+  "module": "./eslint.config.mjs",
+  "exports": {
+    ".": {
+      "import": "./eslint.config.mjs",
+      "default": "./eslint.config.mjs"
+    },
+    "./tools/*": "./tools/*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ArchipelagoInternational/archi-ui.git",
+    "directory": "packages/eslint-config"
+  },
+  "files": [
+    "eslint.config.mjs",
+    "tools",
+    "README.md"
+  ],
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "flat-config",
+    "vue",
+    "git-hooks"
+  ],
+  "private": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "postinstall": "node ./tools/setup/install.mjs",
+    "setup": "node ./tools/setup/install.mjs",
+    "prepublishOnly": "npm pack --dry-run",
+    "version:patch": "node ../../scripts/bump-version.mjs patch",
+    "version:minor": "node ../../scripts/bump-version.mjs minor",
+    "version:major": "node ../../scripts/bump-version.mjs major"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@antfu/eslint-config": "^4.12.0",
+    "@unocss/eslint-config": "^66.5.3",
+    "eslint": "^9.0.0",
+    "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"
+  }
+}

package/tools/git-hooks/commit-msg.mjs

@@ -0,0 +1,7 @@
+import { verifyCommitMessageFile } from './verify-commit-message.mjs'
+
+const messageFilePath = process.argv[2]
+if (!messageFilePath)
+  process.exit(0)
+
+verifyCommitMessageFile(messageFilePath)

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

@@ -0,0 +1,127 @@
+import { getStagedDiffSnippet, getStagedNameStatus } from './shared.mjs'
+
+function inferType(paths, addedCount, source) {
+  const isDocsOnly = paths.every(path => path.startsWith('docs/') || path.endsWith('.md'))
+  if (isDocsOnly)
+    return 'docs'
+
+  const isTestOnly = paths.every(path => /(__tests__|\.test\.|\.spec\.)/.test(path))
+  if (isTestOnly)
+    return 'test'
+
+  const isInfraOnly = paths.every(path =>
+    path.startsWith('.hooks/')
+    || path.startsWith('scripts/')
+    || path.endsWith('package.json')
+    || path.endsWith('pnpm-lock.yaml')
+    || path.endsWith('pnpm-workspace.yaml'),
+  )
+  if (isInfraOnly)
+    return 'chore'
+
+  if (/(fix|bug|broken|regression|error)/.test(source))
+    return 'fix'
+
+  if (/(button|modal|offer|gallery|room|feature|ui)/.test(source))
+    return 'feat'
+
+  return addedCount > 0 ? 'chore' : 'chore'
+}
+
+function inferVerb(addedCount, modifiedCount) {
+  if (addedCount > 0 && modifiedCount === 0)
+    return 'add'
+
+  if (addedCount === 0 && modifiedCount > 0)
+    return 'update'
+
+  return 'update'
+}
+
+function inferAreas(paths) {
+  const mapArea = (path) => {
+    if (path.startsWith('packages/ui/'))
+      return 'ui'
+    if (path.startsWith('apps/nuxt/'))
+      return 'nuxt'
+    if (path.startsWith('docs/'))
+      return 'docs'
+    if (path.startsWith('scripts/'))
+      return 'scripts'
+
+    const [first] = path.split('/')
+    return first || 'repo'
+  }
+
+  return [...new Set(paths.map(mapArea))]
+}
+
+function inferSubject(paths, source) {
+  const pathsSource = paths.join(' ').toLowerCase()
+  const fullSource = `${pathsSource} ${source}`
+
+  const topicRules = [
+    { test: /(offers?).*(modal)|(modal).*(offers?)/, label: 'offers modal' },
+    { test: /(prepare-commit-msg|commit-msg|verifycommit|generatecommitmessage)/, label: 'commit message flow' },
+    { test: /(\.hooks\/|pre-commit|post-commit|lint-staged)/, label: 'git hooks' },
+    { test: /buttons?/, label: 'buttons' },
+    { test: /modal/, label: 'modal behavior' },
+    { test: /lint/, label: 'lint workflow' },
+    { test: /tailwind|scss|css/, label: 'styles' },
+    { test: /gallery/, label: 'gallery section' },
+    { test: /offers?/, label: 'offers section' },
+    { test: /rooms?/, label: 'rooms section' },
+    { test: /contact[\s-]?us/, label: 'contact us section' },
+  ]
+
+  const hit = topicRules.find(rule => rule.test.test(fullSource))
+  return hit ? hit.label : ''
+}
+
+function makeDescription(verb, fileCount, areas, subject) {
+  if (subject)
+    return `${verb} ${subject}`
+
+  const filesPart = `${fileCount} file${fileCount > 1 ? 's' : ''}`
+
+  if (areas.length === 0)
+    return `${verb} ${filesPart}`
+
+  if (areas.length === 1)
+    return `${verb} ${filesPart} in ${areas[0]}`
+
+  if (areas.length === 2)
+    return `${verb} ${filesPart} in ${areas[0]} and ${areas[1]}`
+
+  return `${verb} ${filesPart} across ${areas[0]}, ${areas[1]}, and more`
+}
+
+function normalizeDescription(description) {
+  const maxLength = 50
+  if (description.length <= maxLength)
+    return description
+
+  return description.slice(0, maxLength).trim().replace(/[.,;:-]$/, '')
+}
+
+export function generateCommitMessage() {
+  const changed = getStagedNameStatus()
+  if (changed.length === 0)
+    return 'chore: update repository files'
+
+  const source = getStagedDiffSnippet()
+  const paths = changed.map(item => item.path)
+  const addedCount = changed.filter(item => item.status === 'A').length
+  const modifiedCount = changed.filter(item => item.status === 'M' || item.status === 'R').length
+
+  const type = inferType(paths, addedCount, source)
+  const verb = inferVerb(addedCount, modifiedCount)
+  const areas = inferAreas(paths)
+  const subject = inferSubject(paths, source)
+  const description = normalizeDescription(makeDescription(verb, changed.length, areas, subject))
+
+  return `${type}: ${description}`
+}
+
+if (import.meta.url === `file://${process.argv[1]}`)
+  console.log(generateCommitMessage())

package/tools/git-hooks/post-commit.mjs

@@ -0,0 +1,15 @@
+import { existsSync } from 'node:fs'
+import { getCommittedCodeFiles, runSafe } from './shared.mjs'
+
+const committedFiles = getCommittedCodeFiles().filter(file => existsSync(file))
+
+if (committedFiles.length === 0)
+  process.exit(0)
+
+console.log(`\nRunning post-commit lint auto-fix on ${committedFiles.length} file(s)...`)
+const quotedFiles = committedFiles.map(file => `'${file.replace(/'/g, "'\\''")}'`).join(' ')
+runSafe(`pnpm exec eslint --fix ${quotedFiles}`)
+
+const changedAfterFix = runSafe(`git diff -- ${quotedFiles}`)
+if (changedAfterFix)
+  console.log('\nLINT FIXES APPLIED. Review and commit follow-up changes if needed.\n')

package/tools/git-hooks/pre-commit.mjs

@@ -0,0 +1,10 @@
+import { hasCommand, run } from './shared.mjs'
+
+if (!hasCommand('pnpm')) {
+  console.error('\nCOMMIT FAILED: pnpm is required but not found.\n')
+  process.exit(1)
+}
+
+console.log('\nRunning lint-staged (auto-fix staged files)...')
+run('pnpm lint-staged', { stdio: 'inherit' })
+console.log('\nCOMMIT CHECKS PASSED\n')

package/tools/git-hooks/prepare-commit-msg.mjs

@@ -0,0 +1,23 @@
+import { readFileSync, writeFileSync } from 'node:fs'
+import { generateCommitMessage } from './generate-commit-message.mjs'
+
+const messageFile = process.argv[2]
+const source = process.argv[3] || ''
+
+if (!messageFile)
+  process.exit(0)
+
+if (['merge', 'squash', 'commit', 'message'].includes(source))
+  process.exit(0)
+
+const currentMessage = readFileSync(messageFile, 'utf-8')
+const hasMessage = currentMessage
+  .split('\n')
+  .some(line => line.trim() && !line.trim().startsWith('#'))
+
+if (hasMessage)
+  process.exit(0)
+
+const autoMessage = generateCommitMessage()
+if (autoMessage)
+  writeFileSync(messageFile, `${autoMessage}\n`, 'utf-8')

package/tools/git-hooks/shared.mjs

@@ -0,0 +1,71 @@
+import { execSync } from 'node:child_process'
+
+export function run(command, options = {}) {
+  const output = execSync(command, {
+    encoding: 'utf8',
+    stdio: 'pipe',
+    ...options,
+  })
+
+  if (output == null) {
+    return ''
+  }
+
+  if (typeof output === 'string') {
+    return output.trim()
+  }
+
+  return String(output).trim()
+}
+
+export function runSafe(command) {
+  try {
+    return run(command)
+  } catch {
+    return ''
+  }
+}
+
+export function getRepoRoot() {
+  return run('git rev-parse --show-toplevel')
+}
+
+export function hasCommand(name) {
+  try {
+    run(`command -v ${name}`)
+    return true
+  } catch {
+    return false
+  }
+}
+
+export function getStagedNameStatus() {
+  const output = runSafe('git diff --cached --name-status --diff-filter=ACMR')
+  if (!output)
+    return []
+
+  return output
+    .split('\n')
+    .map((line) => {
+      const [status = '', ...rest] = line.split(/\s+/)
+      return {
+        status,
+        path: rest.join(' '),
+      }
+    })
+    .filter(item => item.path)
+}
+
+export function getStagedDiffSnippet() {
+  return runSafe('git diff --cached -- .').slice(0, 15000).toLowerCase()
+}
+
+export function getCommittedCodeFiles() {
+  const output = runSafe('git diff-tree --no-commit-id --name-only -r HEAD')
+  if (!output)
+    return []
+
+  return output
+    .split('\n')
+    .filter(file => /\.(js|jsx|ts|tsx|vue)$/.test(file))
+}

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

@@ -0,0 +1,33 @@
+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}$/
+  return releaseRE.test(message) || commitRE.test(message)
+}
+
+export function verifyCommitMessageFile(messageFilePath) {
+  const message = readFileSync(messageFilePath, 'utf-8').trim()
+  if (isValidCommitMessage(message))
+    return
+
+  const examples = [
+    "feat: add 'comments' option",
+    '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 .github/commit-convention.md for details.\n')
+  process.exit(1)
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  const messageFilePath = process.argv[2]
+  if (!messageFilePath)
+    process.exit(0)
+  verifyCommitMessageFile(messageFilePath)
+}

package/tools/setup/install.mjs

@@ -0,0 +1,123 @@
+import { execSync } from 'node:child_process'
+import { chmodSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+
+function getProjectRoot() {
+  const root = process.env.INIT_CWD || process.cwd()
+  if (!existsSync(join(root, 'package.json')))
+    return null
+  return root
+}
+
+function ensureDir(path) {
+  if (!existsSync(path))
+    mkdirSync(path, { recursive: true })
+}
+
+function writeIfMissing(path, content) {
+  if (existsSync(path))
+    return false
+  writeFileSync(path, content, 'utf8')
+  return true
+}
+
+function ensurePrettierConfig(projectRoot) {
+  const prettierPath = join(projectRoot, '.prettierrc')
+  const defaults = {
+    plugins: ['prettier-plugin-tailwindcss'],
+    singleQuote: true,
+    printWidth: 120,
+    semi: false,
+    tabWidth: 2,
+    trailingComma: 'es5',
+    arrowParens: 'avoid',
+  }
+
+  if (!existsSync(prettierPath)) {
+    writeFileSync(prettierPath, `${JSON.stringify(defaults, null, 2)}\n`, 'utf8')
+    return
+  }
+
+  try {
+    const current = JSON.parse(readFileSync(prettierPath, 'utf8'))
+    const plugins = Array.isArray(current.plugins) ? current.plugins : []
+    const deduped = [...new Set([...plugins, 'prettier-plugin-tailwindcss'])]
+    current.plugins = deduped
+    if (typeof current.singleQuote !== 'boolean')
+      current.singleQuote = true
+    if (typeof current.semi !== 'boolean')
+      current.semi = false
+    writeFileSync(prettierPath, `${JSON.stringify(current, null, 2)}\n`, 'utf8')
+  }
+  catch {
+    // Keep existing file untouched if it is not JSON.
+  }
+}
+
+function ensureEslintConfig(projectRoot) {
+  const eslintConfigPath = join(projectRoot, 'eslint.config.mjs')
+  const content = `import { createArchipelagoConfig } from 'eslint-config'\n\nexport default createArchipelagoConfig({\n  name: 'project/overrides',\n  rules: {\n    // Add your project overrides here\n  },\n})\n`
+  writeIfMissing(eslintConfigPath, content)
+}
+
+function ensureHooks(projectRoot) {
+  const hooksDir = join(projectRoot, '.hooks')
+  ensureDir(hooksDir)
+
+  const hooks = {
+    'pre-commit': `#!/usr/bin/env bash
+set -euo pipefail
+
+cd "$(git rev-parse --show-toplevel)"
+node node_modules/eslint-config/tools/git-hooks/pre-commit.mjs
+`,
+    'prepare-commit-msg': `#!/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 "$@"
+`,
+    'commit-msg': `#!/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"
+`,
+    'post-commit': `#!/usr/bin/env bash
+set -euo pipefail
+
+cd "$(git rev-parse --show-toplevel)"
+node node_modules/eslint-config/tools/git-hooks/post-commit.mjs
+`,
+  }
+
+  Object.entries(hooks).forEach(([name, content]) => {
+    const path = join(hooksDir, name)
+    if (writeIfMissing(path, content))
+      chmodSync(path, 0o755)
+  })
+}
+
+function ensureHooksPath(projectRoot) {
+  if (!existsSync(join(projectRoot, '.git')))
+    return
+  try {
+    execSync('git config core.hooksPath .hooks', { cwd: projectRoot, stdio: 'ignore' })
+  }
+  catch {
+    // Ignore setup failures in non-git contexts.
+  }
+}
+
+function main() {
+  const projectRoot = getProjectRoot()
+  if (!projectRoot)
+    return
+
+  ensureHooks(projectRoot)
+  ensureHooksPath(projectRoot)
+  ensureEslintConfig(projectRoot)
+  ensurePrettierConfig(projectRoot)
+}
+
+main()