@consilioweb/spellcheck 0.10.1

package/scripts/install.mjs

@@ -0,0 +1,236 @@
+#!/usr/bin/env node
+
+/**
+ * Post-install setup for @consilioweb/spellcheck
+ * Automatically adds the plugin to the Payload config.
+ *
+ * Usage: npx spellcheck-install
+ *   or:  npx spellcheck-install --collections pages,posts --language fr
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { execSync } from 'node:child_process'
+
+const PACKAGE_NAME = '@consilioweb/spellcheck'
+
+// ── Helpers ──────────────────────────────────────────────
+
+function detectPackageManager(dir) {
+  if (fs.existsSync(path.join(dir, 'pnpm-lock.yaml'))) return 'pnpm'
+  if (fs.existsSync(path.join(dir, 'yarn.lock'))) return 'yarn'
+  if (fs.existsSync(path.join(dir, 'bun.lockb')) || fs.existsSync(path.join(dir, 'bun.lock'))) return 'bun'
+  return 'npm'
+}
+
+function run(cmd, cwd) {
+  console.log(`  \x1b[90m$ ${cmd}\x1b[0m`)
+  try {
+    execSync(cmd, { cwd, stdio: 'inherit' })
+    return true
+  } catch {
+    return false
+  }
+}
+
+function findSourceFiles(dir) {
+  const results = []
+  if (!fs.existsSync(dir)) return results
+  const entries = fs.readdirSync(dir, { withFileTypes: true })
+  for (const entry of entries) {
+    const fullPath = path.join(dir, entry.name)
+    if (entry.isDirectory()) {
+      if (entry.name === 'node_modules' || entry.name.startsWith('.')) continue
+      results.push(...findSourceFiles(fullPath))
+    } else if (/\.(ts|tsx)$/.test(entry.name)) {
+      results.push(fullPath)
+    }
+  }
+  return results
+}
+
+/**
+ * Find the plugins file (src/plugins/index.ts or similar)
+ */
+function findPluginsFile(srcDir) {
+  // Common locations
+  const candidates = [
+    path.join(srcDir, 'plugins', 'index.ts'),
+    path.join(srcDir, 'plugins.ts'),
+  ]
+
+  for (const candidate of candidates) {
+    if (fs.existsSync(candidate)) return candidate
+  }
+
+  // Search for a file containing `Plugin[]` or `plugins:`
+  const files = findSourceFiles(srcDir)
+  for (const file of files) {
+    const content = fs.readFileSync(file, 'utf-8')
+    if (content.includes('export const plugins') && content.includes('Plugin[]')) {
+      return file
+    }
+  }
+
+  return null
+}
+
+/**
+ * Check if the plugin is already imported/used
+ */
+function isAlreadyInstalled(content) {
+  return content.includes(PACKAGE_NAME)
+}
+
+/**
+ * Parse CLI args for --collections and --language
+ */
+function parseArgs() {
+  const args = process.argv.slice(2)
+  const config = {
+    collections: ['pages', 'posts'],
+    language: 'fr',
+  }
+
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === '--collections' && args[i + 1]) {
+      config.collections = args[++i].split(',').map(s => s.trim())
+    }
+    if (args[i] === '--language' && args[i + 1]) {
+      config.language = args[++i].trim()
+    }
+  }
+
+  return config
+}
+
+// ── Main ──────────────────────────────────────────────
+
+function main() {
+  const projectDir = process.env.INIT_CWD || process.cwd()
+  const srcDir = path.join(projectDir, 'src')
+  const pm = detectPackageManager(projectDir)
+  const config = parseArgs()
+
+  console.log('')
+  console.log('  \x1b[36m@consilioweb/spellcheck\x1b[0m — Install')
+  console.log('  ─────────────────────────────────────────────')
+  console.log(`  Project: \x1b[33m${projectDir}\x1b[0m`)
+  console.log(`  Package manager: \x1b[33m${pm}\x1b[0m`)
+  console.log(`  Collections: \x1b[33m${config.collections.join(', ')}\x1b[0m`)
+  console.log(`  Language: \x1b[33m${config.language}\x1b[0m`)
+  console.log('')
+
+  // ── Step 1: Find plugins file ──
+  console.log('  \x1b[36m[1/3]\x1b[0m Finding plugins configuration...')
+
+  const pluginsFile = findPluginsFile(srcDir)
+  if (!pluginsFile) {
+    console.log('  \x1b[33m⚠\x1b[0m  No plugins file found in src/.')
+    console.log('  \x1b[33m⚠\x1b[0m  You need to manually add the plugin to your Payload config:')
+    console.log('')
+    console.log(`  \x1b[90mimport { spellcheckPlugin } from '${PACKAGE_NAME}'\x1b[0m`)
+    console.log(`  \x1b[90mspellcheckPlugin({ collections: ${JSON.stringify(config.collections)}, language: '${config.language}' })\x1b[0m`)
+    console.log('')
+  } else {
+    const relPath = path.relative(projectDir, pluginsFile)
+    console.log(`  \x1b[32m✓\x1b[0m  Found: ${relPath}`)
+
+    const content = fs.readFileSync(pluginsFile, 'utf-8')
+
+    if (isAlreadyInstalled(content)) {
+      console.log(`  \x1b[32m✓\x1b[0m  Plugin already configured — skipping.`)
+    } else {
+      // Add import at the top (after last import line)
+      const importLine = `import { spellcheckPlugin } from '${PACKAGE_NAME}'`
+      const lines = content.split('\n')
+      let lastImportIndex = -1
+
+      for (let i = 0; i < lines.length; i++) {
+        if (lines[i].trim().startsWith('import ')) {
+          lastImportIndex = i
+        }
+      }
+
+      if (lastImportIndex >= 0) {
+        lines.splice(lastImportIndex + 1, 0, importLine)
+      } else {
+        lines.unshift(importLine)
+      }
+
+      // Add plugin call before the closing bracket of the plugins array
+      let joined = lines.join('\n')
+
+      // Build plugin config string
+      const collectionsStr = config.collections.map(c => `'${c}'`).join(', ')
+      const pluginCall = `  spellcheckPlugin({
+    collections: [${collectionsStr}],
+    language: '${config.language}',
+    checkOnSave: true,
+    addSidebarField: true,
+    addDashboardView: true,
+    skipRules: ['FR_SPELLING_RULE', 'WHITESPACE_RULE'],
+    skipCategories: ['TYPOGRAPHY', 'STYLE'],
+    customDictionary: ['Next.js', 'Payload', 'TypeScript', 'SEO'],
+  }),`
+
+      // Find the plugins array closing bracket and insert before it
+      const pluginsArrayMatch = joined.match(/export\s+const\s+plugins\s*:\s*Plugin\[\]\s*=\s*\[/)
+      if (pluginsArrayMatch) {
+        // Find the last `]` that closes this array
+        const arrayStart = joined.indexOf(pluginsArrayMatch[0])
+        const afterStart = joined.indexOf('[', arrayStart + pluginsArrayMatch[0].length - 1)
+
+        // Find matching closing bracket
+        let depth = 0
+        let closingIdx = -1
+        for (let i = afterStart; i < joined.length; i++) {
+          if (joined[i] === '[') depth++
+          else if (joined[i] === ']') {
+            depth--
+            if (depth === 0) {
+              closingIdx = i
+              break
+            }
+          }
+        }
+
+        if (closingIdx > 0) {
+          joined = joined.slice(0, closingIdx) + pluginCall + '\n' + joined.slice(closingIdx)
+        }
+      }
+
+      fs.writeFileSync(pluginsFile, joined, 'utf-8')
+      console.log(`  \x1b[32m✓\x1b[0m  Plugin added to ${relPath}`)
+    }
+  }
+
+  console.log('')
+
+  // ── Step 2: Regenerate importmap ──
+  console.log('  \x1b[36m[2/3]\x1b[0m Regenerating importmap...')
+  const importmapCmd = pm === 'npm' ? 'npx payload' : `${pm} payload`
+  run(`${importmapCmd} generate:importmap`, projectDir)
+
+  console.log('')
+
+  // ── Step 3: Summary ──
+  console.log('  \x1b[36m[3/3]\x1b[0m Post-install checks...')
+  console.log('  \x1b[32m✓\x1b[0m  Collection \x1b[33mspellcheck-results\x1b[0m will be auto-created on first boot')
+  console.log('  \x1b[32m✓\x1b[0m  Endpoints registered: /api/spellcheck/validate, /api/spellcheck/fix, /api/spellcheck/bulk')
+  console.log('  \x1b[32m✓\x1b[0m  Sidebar field added to editor')
+  console.log('  \x1b[32m✓\x1b[0m  Dashboard view at /admin/spellcheck')
+
+  console.log('')
+  console.log('  \x1b[32m✓ Install complete!\x1b[0m')
+  console.log('')
+  console.log('  \x1b[36mNext steps:\x1b[0m')
+  console.log('  1. Start your dev server to create the DB table')
+  console.log('  2. Visit /admin/spellcheck to scan your content')
+  console.log('  3. (Optional) Add "Correcteur" to your admin nav')
+  console.log('')
+  console.log('  \x1b[36mTo uninstall:\x1b[0m npx spellcheck-uninstall')
+  console.log('')
+}
+
+main()

package/scripts/uninstall.mjs

@@ -0,0 +1,350 @@
+#!/usr/bin/env node
+
+/**
+ * Full uninstall for @consilioweb/spellcheck
+ * Removes all imports, plugin calls, DB tables, and the package itself.
+ *
+ * Usage: npx spellcheck-uninstall
+ *   or:  npx spellcheck-uninstall --keep-data  (skip DB cleanup)
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { execSync } from 'node:child_process'
+
+const PACKAGE_NAME = '@consilioweb/spellcheck'
+
+// Tables and indexes created by the plugin
+const DB_TABLES = ['spellcheck_results', 'spellcheck_dictionary']
+const DB_INDEXES = [
+  'spellcheck_results_doc_id_idx',
+  'spellcheck_results_collection_idx',
+  'spellcheck_results_last_checked_idx',
+  'spellcheck_dictionary_word_idx',
+]
+
+// Regex to match any import line from @consilioweb/spellcheck
+const IMPORT_RE = /^\s*import\s+(?:type\s+)?(?:\{[^}]*\}|[\w]+)\s+from\s+['"]@consilioweb\/spellcheck(?:\/[^'"]*)?['"]\s*;?\s*$/gm
+
+// ── Helpers ──────────────────────────────────────────────
+
+function detectPackageManager(dir) {
+  if (fs.existsSync(path.join(dir, 'pnpm-lock.yaml'))) return 'pnpm'
+  if (fs.existsSync(path.join(dir, 'yarn.lock'))) return 'yarn'
+  if (fs.existsSync(path.join(dir, 'bun.lockb')) || fs.existsSync(path.join(dir, 'bun.lock'))) return 'bun'
+  return 'npm'
+}
+
+function run(cmd, cwd) {
+  console.log(`  \x1b[90m$ ${cmd}\x1b[0m`)
+  try {
+    execSync(cmd, { cwd, stdio: 'inherit' })
+    return true
+  } catch {
+    return false
+  }
+}
+
+function runSilent(cmd, cwd) {
+  try {
+    return execSync(cmd, { cwd, encoding: 'utf-8' }).trim()
+  } catch {
+    return ''
+  }
+}
+
+function findSourceFiles(dir) {
+  const results = []
+  if (!fs.existsSync(dir)) return results
+  const entries = fs.readdirSync(dir, { withFileTypes: true })
+  for (const entry of entries) {
+    const fullPath = path.join(dir, entry.name)
+    if (entry.isDirectory()) {
+      if (entry.name === 'node_modules' || entry.name.startsWith('.')) continue
+      results.push(...findSourceFiles(fullPath))
+    } else if (/\.(ts|tsx)$/.test(entry.name)) {
+      results.push(fullPath)
+    }
+  }
+  return results
+}
+
+/**
+ * Extract imported names from @consilioweb/spellcheck imports
+ */
+function extractImportedNames(content) {
+  const names = []
+  const re = /^\s*import\s+(?:type\s+)?\{([^}]*)\}\s+from\s+['"]@consilioweb\/spellcheck(?:\/[^'"]*)?['"]\s*;?\s*$/gm
+  let match
+  while ((match = re.exec(content)) !== null) {
+    for (const spec of match[1].split(',')) {
+      const trimmed = spec.trim()
+      if (!trimmed) continue
+      const asParts = trimmed.split(/\s+as\s+/)
+      names.push(asParts.length > 1 ? asParts[1].trim() : trimmed)
+    }
+  }
+  return names
+}
+
+/**
+ * Remove plugin calls (handles nested braces/parens across multiple lines)
+ */
+function removePluginCalls(content, callNames) {
+  let modified = content
+
+  for (const fnName of callNames) {
+    let searchFrom = 0
+    while (true) {
+      const callIndex = modified.indexOf(`${fnName}(`, searchFrom)
+      if (callIndex === -1) break
+
+      // Verify not part of a larger identifier
+      if (callIndex > 0 && /[\w$]/.test(modified[callIndex - 1])) {
+        searchFrom = callIndex + fnName.length
+        continue
+      }
+
+      // Find line start
+      let lineStart = callIndex
+      while (lineStart > 0 && modified[lineStart - 1] !== '\n') lineStart--
+
+      // Find matching closing paren
+      const openParen = callIndex + fnName.length
+      let depth = 0
+      let endIndex = openParen
+      for (let i = openParen; i < modified.length; i++) {
+        if (modified[i] === '(') depth++
+        else if (modified[i] === ')') {
+          depth--
+          if (depth === 0) {
+            endIndex = i + 1
+            break
+          }
+        }
+      }
+
+      // Handle trailing comma
+      let removeEnd = endIndex
+      const afterCall = modified.slice(endIndex)
+      const trailingMatch = afterCall.match(/^\s*,/)
+      if (trailingMatch) {
+        removeEnd = endIndex + trailingMatch[0].length
+      }
+
+      // Determine full range
+      let removeStart = lineStart
+      if (removeStart > 0 && modified[removeStart - 1] === '\n') removeStart--
+
+      // If no trailing comma, try removing leading comma
+      if (!trailingMatch) {
+        let lookBack = removeStart
+        while (lookBack > 0 && /[\s\n]/.test(modified[lookBack - 1])) lookBack--
+        if (lookBack > 0 && modified[lookBack - 1] === ',') removeStart = lookBack - 1
+      }
+
+      modified = modified.slice(0, removeStart) + modified.slice(removeEnd)
+    }
+  }
+
+  return modified
+}
+
+function cleanEmptyLines(content) {
+  return content.replace(/\n{3,}/g, '\n\n')
+}
+
+function cleanOrphanCommas(content) {
+  return content.replace(/,(\s*\n\s*[)\]])/g, '$1')
+}
+
+/**
+ * Process a single source file: remove imports and plugin calls
+ */
+function processFile(filePath) {
+  const original = fs.readFileSync(filePath, 'utf-8')
+  if (!original.includes(PACKAGE_NAME)) return null
+
+  let content = original
+
+  // Extract names before removing imports
+  const importedNames = extractImportedNames(content)
+
+  // Remove import lines
+  content = content.replace(IMPORT_RE, '')
+
+  // Remove plugin calls
+  if (importedNames.length > 0) {
+    content = removePluginCalls(content, importedNames)
+  }
+
+  // Also remove any admin-nav items referencing /admin/spellcheck
+  content = content.replace(/\s*\{[^}]*href:\s*['"]\/admin\/spellcheck['"][^}]*\},?\s*/g, '')
+
+  // Clean up
+  content = cleanOrphanCommas(content)
+  content = cleanEmptyLines(content)
+
+  return content === original ? null : content
+}
+
+/**
+ * Find SQLite DB files in the project
+ */
+function findDatabaseFiles(projectDir) {
+  const dbFiles = []
+  const entries = fs.readdirSync(projectDir, { withFileTypes: true })
+  for (const entry of entries) {
+    if (entry.isFile() && entry.name.endsWith('.db')) {
+      dbFiles.push(path.join(projectDir, entry.name))
+    }
+  }
+  // Also check data/ subdirectory
+  const dataDir = path.join(projectDir, 'data')
+  if (fs.existsSync(dataDir)) {
+    const dataEntries = fs.readdirSync(dataDir, { withFileTypes: true })
+    for (const entry of dataEntries) {
+      if (entry.isFile() && entry.name.endsWith('.db')) {
+        dbFiles.push(path.join(dataDir, entry.name))
+      }
+    }
+  }
+  return dbFiles
+}
+
+/**
+ * Drop spellcheck tables and indexes from a SQLite database
+ */
+function cleanDatabase(dbPath) {
+  const statements = []
+
+  // Drop indexes first
+  for (const idx of DB_INDEXES) {
+    statements.push(`DROP INDEX IF EXISTS \`${idx}\`;`)
+  }
+
+  // Drop tables
+  for (const table of DB_TABLES) {
+    statements.push(`DROP TABLE IF EXISTS \`${table}\`;`)
+  }
+
+  // Also clean up payload_locked_documents_rels
+  statements.push(
+    `DELETE FROM \`payload_locked_documents_rels\` WHERE \`spellcheck_results_id\` IS NOT NULL;`,
+    `DELETE FROM \`payload_locked_documents_rels\` WHERE \`spellcheck_dictionary_id\` IS NOT NULL;`,
+  )
+
+  // Remove the column from payload_locked_documents_rels (SQLite doesn't support DROP COLUMN easily)
+  // Just log it as manual step
+
+  const sql = statements.join('\n')
+  const result = runSilent(`sqlite3 "${dbPath}" "${sql}"`, path.dirname(dbPath))
+  return result !== undefined
+}
+
+// ── Main ──────────────────────────────────────────────
+
+function main() {
+  const projectDir = process.env.INIT_CWD || process.cwd()
+  const srcDir = path.join(projectDir, 'src')
+  const pm = detectPackageManager(projectDir)
+  const keepData = process.argv.includes('--keep-data')
+
+  console.log('')
+  console.log('  \x1b[36m@consilioweb/spellcheck\x1b[0m — Full Uninstall')
+  console.log('  ─────────────────────────────────────────────')
+  console.log(`  Project: \x1b[33m${projectDir}\x1b[0m`)
+  console.log(`  Package manager: \x1b[33m${pm}\x1b[0m`)
+  if (keepData) console.log(`  \x1b[33m--keep-data: DB tables will NOT be dropped\x1b[0m`)
+  console.log('')
+
+  // ── Step 1: Clean source files ──
+  console.log('  \x1b[36m[1/4]\x1b[0m Cleaning source files...')
+
+  if (!fs.existsSync(srcDir)) {
+    console.log('  \x1b[33m⚠\x1b[0m  No src/ directory found. Skipping code cleanup.')
+  } else {
+    const files = findSourceFiles(srcDir)
+    const modified = []
+
+    for (const filePath of files) {
+      const result = processFile(filePath)
+      if (result !== null) {
+        fs.writeFileSync(filePath, result, 'utf-8')
+        const rel = path.relative(projectDir, filePath)
+        modified.push(rel)
+        console.log(`  \x1b[32m✓\x1b[0m  Cleaned: ${rel}`)
+      }
+    }
+
+    if (modified.length === 0) {
+      console.log('  \x1b[32m✓\x1b[0m  No references found in source files.')
+    } else {
+      console.log(`  \x1b[32m✓\x1b[0m  ${modified.length} file(s) cleaned.`)
+    }
+  }
+
+  console.log('')
+
+  // ── Step 2: Clean database ──
+  if (!keepData) {
+    console.log('  \x1b[36m[2/4]\x1b[0m Cleaning database...')
+
+    const dbFiles = findDatabaseFiles(projectDir)
+    if (dbFiles.length === 0) {
+      console.log('  \x1b[33m⚠\x1b[0m  No .db files found. Skipping DB cleanup.')
+    } else {
+      for (const dbFile of dbFiles) {
+        const rel = path.relative(projectDir, dbFile)
+        const success = cleanDatabase(dbFile)
+        if (success) {
+          console.log(`  \x1b[32m✓\x1b[0m  Cleaned: ${rel}`)
+          for (const table of DB_TABLES) {
+            console.log(`     \x1b[90m- Dropped table: ${table}\x1b[0m`)
+          }
+          for (const idx of DB_INDEXES) {
+            console.log(`     \x1b[90m- Dropped index: ${idx}\x1b[0m`)
+          }
+        } else {
+          console.log(`  \x1b[33m⚠\x1b[0m  Could not clean ${rel} (sqlite3 not found or DB locked)`)
+        }
+      }
+    }
+  } else {
+    console.log('  \x1b[36m[2/4]\x1b[0m Skipping database cleanup (--keep-data)')
+  }
+
+  console.log('')
+
+  // ── Step 3: Remove the package ──
+  console.log('  \x1b[36m[3/4]\x1b[0m Removing package...')
+  const removeCmd = pm === 'npm' ? 'npm uninstall' : `${pm} remove`
+  run(`${removeCmd} ${PACKAGE_NAME}`, projectDir)
+
+  console.log('')
+
+  // ── Step 4: Regenerate importmap ──
+  console.log('  \x1b[36m[4/4]\x1b[0m Regenerating importmap...')
+  const importmapCmd = pm === 'npm' ? 'npx payload' : `${pm} payload`
+  run(`${importmapCmd} generate:importmap`, projectDir)
+
+  console.log('')
+
+  // ── Done ──
+  console.log('  \x1b[32m✓ Uninstall complete!\x1b[0m')
+  console.log('')
+
+  if (keepData) {
+    console.log('  \x1b[36mNote:\x1b[0m Database tables were preserved (--keep-data).')
+    console.log('  To manually drop them:')
+    console.log('  \x1b[90m  sqlite3 your.db "DROP TABLE IF EXISTS spellcheck_results; DROP TABLE IF EXISTS spellcheck_dictionary;"\x1b[0m')
+  } else {
+    console.log('  \x1b[36mNote:\x1b[0m If columns \x1b[33mspellcheck_results_id\x1b[0m or \x1b[33mspellcheck_dictionary_id\x1b[0m')
+    console.log('  remain in \x1b[33mpayload_locked_documents_rels\x1b[0m, they will be ignored by Payload.')
+    console.log('  SQLite does not support DROP COLUMN natively.')
+  }
+
+  console.log('')
+}
+
+main()