@archpublicwebsite/eslint-config 1.0.7 → 1.0.9

package/README.md

@@ -61,7 +61,7 @@ On install, `.vscode/settings.json` is created or merged with these settings:
     "source.fixAll.eslint": "explicit",
     "source.organizeImports": "never"
   },
-  "editor.formatOnSave": false
+  "editor.formatOnSave": true
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archpublicwebsite/eslint-config",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "author": "Archipelago International",
   "description": "Reusable ESLint flat config and git-hook toolkit for Archipelago projects",
   "type": "module",

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

@@ -7,7 +7,8 @@ const source = process.argv[3] || ''
 if (!messageFile)
   process.exit(0)
 
-if (['merge', 'squash', 'commit', 'message'].includes(source))
+// Skip auto-generation only for flows where Git already supplies a meaningful message.
+if (['merge', 'squash', 'commit'].includes(source))
   process.exit(0)
 
 const currentMessage = readFileSync(messageFile, 'utf-8')

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

@@ -6,9 +6,18 @@ export function isValidCommitMessage(message) {
   return releaseRE.test(message) || commitRE.test(message)
 }
 
+function getCommitSubject(rawMessage) {
+  return rawMessage
+    .split('\n')
+    .map(line => line.trim())
+    .find(line => line && !line.startsWith('#')) || ''
+}
+
 export function verifyCommitMessageFile(messageFilePath) {
-  const message = readFileSync(messageFilePath, 'utf-8').trim()
-  if (isValidCommitMessage(message))
+  const rawMessage = readFileSync(messageFilePath, 'utf-8')
+  const subject = getCommitSubject(rawMessage)
+
+  if (isValidCommitMessage(subject))
     return
 
   const examples = [
@@ -21,7 +30,7 @@ export function verifyCommitMessageFile(messageFilePath) {
   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')
+  console.error('\nSee README.md (Auto commit message flow) for details.\n')
   process.exit(1)
 }
 

package/tools/setup/install.mjs

@@ -3,6 +3,12 @@ import { chmodSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'n
 import { join } from 'node:path'
 import { ensureVscodeSettings } from './vscode.mjs'
 
+const TAG = '[@archpublicwebsite/eslint-config]'
+
+function log(msg) {
+  console.log(`${TAG} ${msg}`)
+}
+
 function getProjectRoot() {
   const root = process.env.INIT_CWD || process.cwd()
   if (!existsSync(join(root, 'package.json')))
@@ -10,18 +16,91 @@ function getProjectRoot() {
   return root
 }
 
-function ensureDir(path) {
-  if (!existsSync(path))
-    mkdirSync(path, { recursive: true })
+function ensureDir(dirPath) {
+  if (!existsSync(dirPath))
+    mkdirSync(dirPath, { recursive: true })
 }
 
-function writeIfMissing(path, content) {
-  if (existsSync(path))
+function writeIfMissing(filePath, content) {
+  if (existsSync(filePath))
     return false
-  writeFileSync(path, content, 'utf8')
+  writeFileSync(filePath, content, 'utf8')
   return true
 }
 
+// ─── .editorconfig ──────────────────────────────────────────────────────────
+
+function ensureEditorConfig(projectRoot) {
+  const editorConfigPath = join(projectRoot, '.editorconfig')
+  const content = `# EditorConfig — consistent coding style across editors
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+`
+  if (writeIfMissing(editorConfigPath, content))
+    log('Created .editorconfig')
+}
+
+// ─── .eslint-user-ignore ────────────────────────────────────────────────────
+
+function ensureEslintUserIgnore(projectRoot) {
+  const ignorePath = join(projectRoot, '.eslint-user-ignore')
+  const content = `# User-overridable ESLint ignore rules
+#
+# Remove a line to include it again, or add your own patterns.
+# Uses standard glob/gitignore-style patterns.
+
+# Ignore document formats
+*.doc
+*.docx
+
+# Ignore markdown files
+*.md
+
+# Optional examples:
+# docs/**
+# *.pdf
+`
+  if (writeIfMissing(ignorePath, content))
+    log('Created .eslint-user-ignore')
+}
+
+// ─── eslint.config.mjs ─────────────────────────────────────────────────────
+
+function ensureEslintConfig(projectRoot) {
+  const eslintConfigPath = join(projectRoot, 'eslint.config.mjs')
+  const content = `import { createArchipelagoConfig } from '@archpublicwebsite/eslint-config'
+
+export default createArchipelagoConfig({
+  name: 'project/overrides',
+  rules: {
+    // Add your project overrides here
+  },
+})
+`
+  if (writeIfMissing(eslintConfigPath, content))
+    log('Created eslint.config.mjs')
+}
+
+// ─── .prettierrc ────────────────────────────────────────────────────────────
+
 function ensurePrettierConfig(projectRoot) {
   const prettierPath = join(projectRoot, '.prettierrc')
   const defaults = {
@@ -36,6 +115,7 @@ function ensurePrettierConfig(projectRoot) {
 
   if (!existsSync(prettierPath)) {
     writeFileSync(prettierPath, `${JSON.stringify(defaults, null, 2)}\n`, 'utf8')
+    log('Created .prettierrc')
     return
   }
 
@@ -49,17 +129,14 @@ function ensurePrettierConfig(projectRoot) {
     if (typeof current.semi !== 'boolean')
       current.semi = false
     writeFileSync(prettierPath, `${JSON.stringify(current, null, 2)}\n`, 'utf8')
+    log('Updated .prettierrc')
   }
   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)
-}
+// ─── .hooks ─────────────────────────────────────────────────────────────────
 
 function ensureHooks(projectRoot) {
   const hooksDir = join(projectRoot, '.hooks')
@@ -70,33 +147,38 @@ function ensureHooks(projectRoot) {
 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
 `,
     '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 "$@"
+node node_modules/@archpublicwebsite/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"
+node node_modules/@archpublicwebsite/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
+node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/post-commit.mjs
 `,
   }
 
+  let created = false
   Object.entries(hooks).forEach(([name, content]) => {
-    const path = join(hooksDir, name)
-    if (writeIfMissing(path, content))
-      chmodSync(path, 0o755)
+    const hookPath = join(hooksDir, name)
+    if (writeIfMissing(hookPath, content)) {
+      chmodSync(hookPath, 0o755)
+      created = true
+    }
   })
+  if (created)
+    log('Created .hooks/ (pre-commit, prepare-commit-msg, commit-msg, post-commit)')
 }
 
 function ensureHooksPath(projectRoot) {
@@ -104,18 +186,20 @@ function ensureHooksPath(projectRoot) {
     return
   try {
     execSync('git config core.hooksPath .hooks', { cwd: projectRoot, stdio: 'ignore' })
+    log('Set git core.hooksPath → .hooks')
   }
   catch {
     // Ignore setup failures in non-git contexts.
   }
 }
 
+// ─── .vscode/extensions.json ────────────────────────────────────────────────
+
 function ensureVscodeExtensions(projectRoot) {
   const vscodeDir = join(projectRoot, '.vscode')
   const extPath = join(vscodeDir, 'extensions.json')
 
-  if (!existsSync(vscodeDir))
-    mkdirSync(vscodeDir, { recursive: true })
+  ensureDir(vscodeDir)
 
   const recommended = [
     'dbaeumer.vscode-eslint',
@@ -138,19 +222,28 @@ function ensureVscodeExtensions(projectRoot) {
   const merged = [...new Set([...current.recommendations, ...recommended])]
   current.recommendations = merged
   writeFileSync(extPath, `${JSON.stringify(current, null, 2)}\n`, 'utf8')
+  log('Created/updated .vscode/extensions.json')
 }
 
+// ─── main ───────────────────────────────────────────────────────────────────
+
 function main() {
   const projectRoot = getProjectRoot()
   if (!projectRoot)
     return
 
-  ensureHooks(projectRoot)
-  ensureHooksPath(projectRoot)
+  log('Setting up project...')
+
+  ensureEditorConfig(projectRoot)
+  ensureEslintUserIgnore(projectRoot)
   ensureEslintConfig(projectRoot)
   ensurePrettierConfig(projectRoot)
+  ensureHooks(projectRoot)
+  ensureHooksPath(projectRoot)
   ensureVscodeSettings(projectRoot)
   ensureVscodeExtensions(projectRoot)
+
+  log('Setup complete ✓')
 }
 
 main()

package/tools/setup/vscode.mjs

@@ -1,6 +1,8 @@
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'
 import { join } from 'node:path'
 
+const TAG = '[@archpublicwebsite/eslint-config]'
+
 /**
  * VS Code settings required for ESLint flat config to work properly.
  * These tell the ESLint extension to use flat config mode and validate
@@ -29,7 +31,7 @@ const VSCODE_ESLINT_SETTINGS = {
   },
 
   // Let ESLint handle formatting instead of the built-in formatter
-  'editor.formatOnSave': false,
+  'editor.formatOnSave': true,
 
   // Disable the default VS Code JSON formatter for files ESLint handles
   '[json]': {
@@ -116,4 +118,5 @@ export function ensureVscodeSettings(projectRoot) {
 
   const merged = deepMerge(current, VSCODE_ESLINT_SETTINGS)
   writeFileSync(settingsPath, `${JSON.stringify(merged, null, 2)}\n`, 'utf8')
+  console.log(`${TAG} Created/updated .vscode/settings.json`)
 }