safeword 0.2.4 → 0.2.5

package/packages/cli/src/commands/setup.ts

@@ -1,325 +0,0 @@
-/**
- * Setup command - Initialize safeword in a project
- */
-
-import { join } from 'node:path';
-import { VERSION } from '../version.js';
-import {
-  exists,
-  ensureDir,
-  writeFile,
-  readJson,
-  writeJson,
-  updateJson,
-  copyDir,
-  copyFile,
-  getTemplatesDir,
-  makeScriptsExecutable,
-} from '../utils/fs.js';
-import { info, success, warn, error, header, listItem } from '../utils/output.js';
-import { isGitRepo, installGitHook } from '../utils/git.js';
-import { detectProjectType } from '../utils/project-detector.js';
-import { filterOutSafewordHooks } from '../utils/hooks.js';
-import { ensureAgentsMdLink } from '../utils/agents-md.js';
-import { PRETTIERRC, getEslintConfig, SETTINGS_HOOKS } from '../templates/index.js';
-
-export interface SetupOptions {
-  yes?: boolean;
-}
-
-interface PackageJson {
-  name?: string;
-  version?: string;
-  scripts?: Record<string, string>;
-  dependencies?: Record<string, string>;
-  devDependencies?: Record<string, string>;
-}
-
-export async function setup(options: SetupOptions): Promise<void> {
-  const cwd = process.cwd();
-  const safewordDir = join(cwd, '.safeword');
-
-  // Check if already configured
-  if (exists(safewordDir)) {
-    error('Already configured. Run `safeword upgrade` to update.');
-    process.exit(1);
-  }
-
-  // Check for package.json
-  const packageJsonPath = join(cwd, 'package.json');
-  if (!exists(packageJsonPath)) {
-    error('No package.json found. Run this command in a Node.js project.');
-    process.exit(1);
-  }
-
-  const isNonInteractive = options.yes || !process.stdin.isTTY;
-
-  header('Safeword Setup');
-  info(`Version: ${VERSION}`);
-
-  // Track created files for summary
-  const created: string[] = [];
-  const modified: string[] = [];
-
-  try {
-    const templatesDir = getTemplatesDir();
-
-    // 1. Create .safeword directory structure and copy templates
-    info('\nCreating .safeword directory...');
-
-    ensureDir(safewordDir);
-    ensureDir(join(safewordDir, 'learnings'));
-    ensureDir(join(safewordDir, 'planning', 'user-stories'));
-    ensureDir(join(safewordDir, 'planning', 'design'));
-    ensureDir(join(safewordDir, 'tickets', 'completed'));
-
-    // Copy full SAFEWORD.md from templates
-    copyFile(join(templatesDir, 'SAFEWORD.md'), join(safewordDir, 'SAFEWORD.md'));
-    writeFile(join(safewordDir, 'version'), VERSION);
-
-    // Copy methodology guides
-    copyDir(join(templatesDir, 'guides'), join(safewordDir, 'guides'));
-
-    // Copy document templates (to 'templates' to match links in SAFEWORD.md)
-    copyDir(join(templatesDir, 'doc-templates'), join(safewordDir, 'templates'));
-
-    // Copy review prompts
-    copyDir(join(templatesDir, 'prompts'), join(safewordDir, 'prompts'));
-
-    // Copy lib scripts and make executable
-    copyDir(join(templatesDir, 'lib'), join(safewordDir, 'lib'));
-    makeScriptsExecutable(join(safewordDir, 'lib'));
-
-    // Copy hook scripts and make executable
-    copyDir(join(templatesDir, 'hooks'), join(safewordDir, 'hooks'));
-    makeScriptsExecutable(join(safewordDir, 'hooks'));
-
-    created.push('.safeword/');
-    success('Created .safeword directory');
-
-    // 2. Handle AGENTS.md
-    info('\nConfiguring AGENTS.md...');
-    const agentsMdResult = ensureAgentsMdLink(cwd);
-    if (agentsMdResult === 'created') {
-      created.push('AGENTS.md');
-      success('Created AGENTS.md');
-    } else if (agentsMdResult === 'modified') {
-      modified.push('AGENTS.md');
-      success('Prepended link to AGENTS.md');
-    } else {
-      info('AGENTS.md already has safeword link');
-    }
-
-    // 3. Register Claude Code hooks
-    info('\nRegistering Claude Code hooks...');
-
-    const claudeDir = join(cwd, '.claude');
-    const settingsPath = join(claudeDir, 'settings.json');
-
-    ensureDir(claudeDir);
-
-    try {
-      updateJson<{ hooks?: Record<string, unknown[]> }>(settingsPath, existing => {
-        const hooks = existing?.hooks ?? {};
-
-        // Merge hooks, preserving existing non-safeword hooks
-        for (const [event, newHooks] of Object.entries(SETTINGS_HOOKS)) {
-          const existingHooks = (hooks[event] as unknown[]) ?? [];
-          const nonSafewordHooks = filterOutSafewordHooks(existingHooks);
-          hooks[event] = [...nonSafewordHooks, ...newHooks];
-        }
-
-        return { ...existing, hooks };
-      });
-
-      if (exists(settingsPath)) {
-        modified.push('.claude/settings.json');
-      } else {
-        created.push('.claude/settings.json');
-      }
-      success('Registered hooks in .claude/settings.json');
-    } catch (err) {
-      error(`Failed to register hooks: ${err instanceof Error ? err.message : 'Unknown error'}`);
-      process.exit(1);
-    }
-
-    // 4. Copy skills
-    info('\nInstalling skills...');
-
-    const skillsDir = join(claudeDir, 'skills');
-    copyDir(join(templatesDir, 'skills'), skillsDir);
-
-    created.push('.claude/skills/safeword-quality-reviewer/');
-    success('Installed skills');
-
-    // 5. Copy slash commands
-    info('\nInstalling slash commands...');
-
-    const commandsDir = join(claudeDir, 'commands');
-    copyDir(join(templatesDir, 'commands'), commandsDir);
-
-    created.push('.claude/commands/');
-    success('Installed slash commands');
-
-    // 6. Setup MCP servers
-    info('\nConfiguring MCP servers...');
-
-    const mcpConfigPath = join(cwd, '.mcp.json');
-
-    updateJson<{ mcpServers?: Record<string, unknown> }>(mcpConfigPath, existing => {
-      const mcpServers = existing?.mcpServers ?? {};
-
-      // Add safeword MCP servers (context7 and playwright)
-      mcpServers.context7 = {
-        command: 'npx',
-        args: ['-y', '@upstash/context7-mcp@latest'],
-      };
-      mcpServers.playwright = {
-        command: 'npx',
-        args: ['@playwright/mcp@latest'],
-      };
-
-      return { ...existing, mcpServers };
-    });
-
-    if (exists(mcpConfigPath)) {
-      modified.push('.mcp.json');
-    } else {
-      created.push('.mcp.json');
-    }
-    success('Configured MCP servers');
-
-    // 7. Setup linting
-    info('\nConfiguring linting...');
-
-    const packageJson = readJson<PackageJson>(packageJsonPath);
-    if (!packageJson) {
-      error('Failed to read package.json');
-      process.exit(1);
-    }
-
-    const projectType = detectProjectType(packageJson);
-
-    // Create ESLint config
-    const eslintConfigPath = join(cwd, 'eslint.config.mjs');
-    if (!exists(eslintConfigPath)) {
-      writeFile(eslintConfigPath, getEslintConfig(projectType));
-      created.push('eslint.config.mjs');
-      success('Created eslint.config.mjs');
-    } else {
-      info('eslint.config.mjs already exists');
-    }
-
-    // Create Prettier config
-    const prettierrcPath = join(cwd, '.prettierrc');
-    if (!exists(prettierrcPath)) {
-      writeFile(prettierrcPath, PRETTIERRC);
-      created.push('.prettierrc');
-      success('Created .prettierrc');
-    } else {
-      info('.prettierrc already exists');
-    }
-
-    // Create markdownlint config
-    const markdownlintPath = join(cwd, '.markdownlint.jsonc');
-    if (!exists(markdownlintPath)) {
-      copyFile(join(templatesDir, 'markdownlint.jsonc'), markdownlintPath);
-      created.push('.markdownlint.jsonc');
-      success('Created .markdownlint.jsonc');
-    } else {
-      info('.markdownlint.jsonc already exists');
-    }
-
-    // Add scripts to package.json
-    try {
-      const scripts = packageJson.scripts ?? {};
-      let scriptsModified = false;
-
-      if (!scripts.lint) {
-        scripts.lint = 'eslint .';
-        scriptsModified = true;
-      }
-
-      if (!scripts['lint:md']) {
-        scripts['lint:md'] = 'markdownlint-cli2 "**/*.md" "#node_modules"';
-        scriptsModified = true;
-      }
-
-      if (!scripts.format) {
-        scripts.format = 'prettier --write .';
-        scriptsModified = true;
-      }
-
-      if (!scripts['format:check']) {
-        scripts['format:check'] = 'prettier --check .';
-        scriptsModified = true;
-      }
-
-      if (scriptsModified) {
-        packageJson.scripts = scripts;
-        writeJson(packageJsonPath, packageJson);
-        modified.push('package.json');
-        success('Added lint and format scripts');
-      }
-    } catch (err) {
-      error(
-        `Failed to update package.json: ${err instanceof Error ? err.message : 'Unknown error'}`,
-      );
-      process.exit(1);
-    }
-
-    // 8. Handle git repository
-    info('\nConfiguring git...');
-
-    if (isGitRepo(cwd)) {
-      installGitHook(cwd);
-      modified.push('.git/hooks/pre-commit');
-      success('Installed git pre-commit hook');
-    } else if (isNonInteractive) {
-      warn('Skipped git initialization (non-interactive mode)');
-      warn('Git hooks not installed (no repository)');
-    } else {
-      // Interactive mode - would prompt here
-      // For now, skip in all cases
-      warn('Skipped git initialization (no .git directory)');
-      warn('Git hooks not installed (no repository)');
-    }
-
-    // 9. Note about dependencies
-    info('\nNote: Install linting dependencies manually:');
-    listItem('npm install -D eslint prettier @eslint/js');
-    if (projectType.typescript) {
-      listItem('npm install -D typescript-eslint');
-    }
-    if (projectType.react) {
-      listItem('npm install -D eslint-plugin-react eslint-plugin-react-hooks');
-    }
-
-    // Print summary
-    header('Setup Complete');
-
-    if (created.length > 0) {
-      info('\nCreated:');
-      for (const file of created) {
-        listItem(file);
-      }
-    }
-
-    if (modified.length > 0) {
-      info('\nModified:');
-      for (const file of modified) {
-        listItem(file);
-      }
-    }
-
-    info('\nNext steps:');
-    listItem('Install linting dependencies (see above)');
-    listItem('Run `safeword check` to verify setup');
-    listItem('Commit the new files to git');
-
-    success(`\nSafeword ${VERSION} installed successfully!`);
-  } catch (err) {
-    error(`Setup failed: ${err instanceof Error ? err.message : 'Unknown error'}`);
-    process.exit(1);
-  }
-}

package/packages/cli/src/commands/upgrade.ts

@@ -1,163 +0,0 @@
-/**
- * Upgrade command - Update safeword configuration to latest version
- */
-
-import { join } from 'node:path';
-import { VERSION } from '../version.js';
-import {
-  exists,
-  ensureDir,
-  writeFile,
-  readFileSafe,
-  updateJson,
-  copyDir,
-  copyFile,
-  getTemplatesDir,
-  makeScriptsExecutable,
-} from '../utils/fs.js';
-import { info, success, error, header, listItem } from '../utils/output.js';
-import { isGitRepo, installGitHook } from '../utils/git.js';
-import { compareVersions } from '../utils/version.js';
-import { filterOutSafewordHooks } from '../utils/hooks.js';
-import { ensureAgentsMdLink } from '../utils/agents-md.js';
-import { SETTINGS_HOOKS } from '../templates/index.js';
-
-export async function upgrade(): Promise<void> {
-  const cwd = process.cwd();
-  const safewordDir = join(cwd, '.safeword');
-
-  // Check if configured
-  if (!exists(safewordDir)) {
-    error('Not configured. Run `safeword setup` first.');
-    process.exit(1);
-  }
-
-  // Read project version
-  const versionPath = join(safewordDir, 'version');
-  const projectVersion = readFileSafe(versionPath)?.trim() ?? '0.0.0';
-
-  // Check for downgrade
-  if (compareVersions(VERSION, projectVersion) < 0) {
-    error(`CLI v${VERSION} is older than project v${projectVersion}.`);
-    error('Update the CLI first: npm install -g safeword');
-    process.exit(1);
-  }
-
-  header('Safeword Upgrade');
-  info(`Upgrading from v${projectVersion} to v${VERSION}`);
-
-  const updated: string[] = [];
-  const unchanged: string[] = [];
-
-  try {
-    const templatesDir = getTemplatesDir();
-
-    // 1. Update .safeword directory
-    info('\nUpdating .safeword directory...');
-
-    // Update core files from templates
-    copyFile(join(templatesDir, 'SAFEWORD.md'), join(safewordDir, 'SAFEWORD.md'));
-    writeFile(join(safewordDir, 'version'), VERSION);
-    updated.push('.safeword/SAFEWORD.md');
-    updated.push('.safeword/version');
-
-    // Update guides, templates, prompts from templates
-    copyDir(join(templatesDir, 'guides'), join(safewordDir, 'guides'));
-    copyDir(join(templatesDir, 'doc-templates'), join(safewordDir, 'templates'));
-    copyDir(join(templatesDir, 'prompts'), join(safewordDir, 'prompts'));
-
-    // Update lib scripts and make executable
-    copyDir(join(templatesDir, 'lib'), join(safewordDir, 'lib'));
-    makeScriptsExecutable(join(safewordDir, 'lib'));
-
-    // Update hook scripts and make executable
-    copyDir(join(templatesDir, 'hooks'), join(safewordDir, 'hooks'));
-    makeScriptsExecutable(join(safewordDir, 'hooks'));
-
-    updated.push('.safeword/guides/');
-    updated.push('.safeword/templates/');
-    updated.push('.safeword/prompts/');
-    updated.push('.safeword/hooks/');
-    success('Updated .safeword directory');
-
-    // 2. Verify AGENTS.md link
-    info('\nVerifying AGENTS.md...');
-    const agentsMdResult = ensureAgentsMdLink(cwd);
-    if (agentsMdResult === 'created') {
-      updated.push('AGENTS.md');
-      success('Created AGENTS.md');
-    } else if (agentsMdResult === 'modified') {
-      updated.push('AGENTS.md');
-      success('Restored link to AGENTS.md');
-    } else {
-      unchanged.push('AGENTS.md');
-      info('AGENTS.md link is present');
-    }
-
-    // 3. Update Claude Code hooks
-    info('\nUpdating Claude Code hooks...');
-
-    const claudeDir = join(cwd, '.claude');
-    const settingsPath = join(claudeDir, 'settings.json');
-
-    ensureDir(claudeDir);
-
-    updateJson<{ hooks?: Record<string, unknown[]> }>(settingsPath, existing => {
-      const hooks = existing?.hooks ?? {};
-
-      // Merge hooks, preserving existing non-safeword hooks
-      for (const [event, newHooks] of Object.entries(SETTINGS_HOOKS)) {
-        const existingHooks = (hooks[event] as unknown[]) ?? [];
-        const nonSafewordHooks = filterOutSafewordHooks(existingHooks);
-        hooks[event] = [...nonSafewordHooks, ...newHooks];
-      }
-
-      return { ...existing, hooks };
-    });
-
-    updated.push('.claude/settings.json');
-    success('Updated hooks in .claude/settings.json');
-
-    // 4. Update skills and commands
-    info('\nUpdating skills and commands...');
-
-    copyDir(join(templatesDir, 'skills'), join(claudeDir, 'skills'));
-    copyDir(join(templatesDir, 'commands'), join(claudeDir, 'commands'));
-
-    updated.push('.claude/skills/');
-    updated.push('.claude/commands/');
-    success('Updated skills and commands');
-
-    // 5. Update git hooks if repo exists
-    if (isGitRepo(cwd)) {
-      info('\nUpdating git hooks...');
-      installGitHook(cwd);
-      updated.push('.git/hooks/pre-commit');
-      success('Updated git pre-commit hook');
-    }
-
-    // Print summary
-    header('Upgrade Complete');
-
-    info(`\nVersion: v${projectVersion} → v${VERSION}`);
-
-    if (updated.length > 0) {
-      info('\nUpdated:');
-      for (const file of updated) {
-        listItem(file);
-      }
-    }
-
-    if (unchanged.length > 0) {
-      info('\nUnchanged:');
-      for (const file of unchanged) {
-        listItem(file);
-      }
-    }
-
-    success(`\nSafeword upgraded to v${VERSION}`);
-  } catch (err) {
-    error(`Upgrade failed: ${err instanceof Error ? err.message : 'Unknown error'}`);
-    process.exit(1);
-  }
-}

package/packages/cli/src/index.ts

@@ -1,3 +0,0 @@
-// Public API exports
-export { VERSION } from './version.js';
-export type { ProjectType } from './utils/project-detector.js';

package/packages/cli/src/templates/config.ts

@@ -1,58 +0,0 @@
-/**
- * Configuration templates - ESLint config generation and hook settings
- */
-
-export function getEslintConfig(options: {
-  typescript?: boolean;
-  react?: boolean;
-  nextjs?: boolean;
-}): string {
-  const imports: string[] = ['import js from "@eslint/js";'];
-  const configs: string[] = ['js.configs.recommended'];
-
-  if (options.typescript) {
-    imports.push('import tseslint from "typescript-eslint";');
-    configs.push('...tseslint.configs.recommended');
-  }
-
-  if (options.react || options.nextjs) {
-    imports.push('import react from "eslint-plugin-react";');
-    imports.push('import reactHooks from "eslint-plugin-react-hooks";');
-    configs.push('react.configs.flat.recommended');
-    configs.push('react.configs.flat["jsx-runtime"]');
-    configs.push(
-      '{ plugins: { "react-hooks": reactHooks }, rules: reactHooks.configs.recommended.rules }',
-    );
-  }
-
-  return `${imports.join('\n')}
-
-export default [
-  ${configs.join(',\n  ')},
-  {
-    ignores: ["node_modules/", "dist/", ".next/", "build/"],
-  },
-];
-`;
-}
-
-export const SETTINGS_HOOKS = {
-  SessionStart: [
-    {
-      command: 'bash .safeword/hooks/agents-md-check.sh',
-      description: 'Safeword: Verify AGENTS.md link',
-    },
-  ],
-  UserPromptSubmit: [
-    {
-      command: 'bash .safeword/hooks/inject-timestamp.sh',
-      description: 'Safeword: Inject current timestamp',
-    },
-  ],
-  PostToolUse: [
-    {
-      command: 'bash .safeword/hooks/post-tool.sh 2>/dev/null || true',
-      description: 'Safeword: Post-tool validation',
-    },
-  ],
-};

package/packages/cli/src/templates/content.ts

@@ -1,18 +0,0 @@
-/**
- * Content templates - static string content
- *
- * Note: Most templates (SAFEWORD.md, hooks, skills, guides, etc.) are now
- * file-based in the templates/ directory. This file contains only small
- * string constants that are used inline.
- */
-
-export const AGENTS_MD_LINK = '**⚠️ ALWAYS READ FIRST: @./.safeword/SAFEWORD.md**';
-
-export const PRETTIERRC = `{
-  "semi": true,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "es5",
-  "printWidth": 100
-}
-`;

package/packages/cli/src/templates/index.ts

@@ -1,12 +0,0 @@
-/**
- * Bundled templates for safeword setup
- *
- * Re-exports all templates from organized modules.
- */
-
-// Content templates (static string constants)
-// Note: Most templates are now file-based in templates/ directory
-export { AGENTS_MD_LINK, PRETTIERRC } from './content.js';
-
-// Configuration templates (ESLint, hooks settings)
-export { getEslintConfig, SETTINGS_HOOKS } from './config.js';

package/packages/cli/src/utils/agents-md.ts

@@ -1,66 +0,0 @@
-/**
- * AGENTS.md file utilities
- */
-
-import { join } from 'node:path';
-import { exists, readFile, writeFile } from './fs.js';
-import { AGENTS_MD_LINK } from '../templates/index.js';
-
-const SAFEWORD_LINK_MARKER = '@./.safeword/SAFEWORD.md';
-
-/**
- * Check if AGENTS.md has the safeword link
- */
-export function hasAgentsMdLink(cwd: string): boolean {
-  const agentsMdPath = join(cwd, 'AGENTS.md');
-  if (!exists(agentsMdPath)) return false;
-  const content = readFile(agentsMdPath);
-  return content.includes(SAFEWORD_LINK_MARKER);
-}
-
-/**
- * Ensure AGENTS.md exists and has the safeword link.
- * Returns 'created' | 'modified' | 'unchanged'
- */
-export function ensureAgentsMdLink(cwd: string): 'created' | 'modified' | 'unchanged' {
-  const agentsMdPath = join(cwd, 'AGENTS.md');
-
-  if (!exists(agentsMdPath)) {
-    writeFile(agentsMdPath, `${AGENTS_MD_LINK}\n`);
-    return 'created';
-  }
-
-  const content = readFile(agentsMdPath);
-  if (!content.includes(SAFEWORD_LINK_MARKER)) {
-    writeFile(agentsMdPath, `${AGENTS_MD_LINK}\n\n${content}`);
-    return 'modified';
-  }
-
-  return 'unchanged';
-}
-
-/**
- * Remove safeword link from AGENTS.md.
- * Returns true if link was removed.
- */
-export function removeAgentsMdLink(cwd: string): boolean {
-  const agentsMdPath = join(cwd, 'AGENTS.md');
-  if (!exists(agentsMdPath)) return false;
-
-  const content = readFile(agentsMdPath);
-  const lines = content.split('\n');
-  const filteredLines = lines.filter((line) => !line.includes(SAFEWORD_LINK_MARKER));
-
-  // Remove extra blank lines at the start
-  while (filteredLines.length > 0 && filteredLines[0].trim() === '') {
-    filteredLines.shift();
-  }
-
-  const newContent = filteredLines.join('\n');
-  if (newContent !== content) {
-    writeFile(agentsMdPath, newContent);
-    return true;
-  }
-
-  return false;
-}