obsidian-plugin-config/scripts/build-npm.ts

Global CLI injection tool for Obsidian plugins

#!/usr/bin/env tsx

import { readFile, writeFile, mkdir } from 'fs/promises';
import path from 'path';
import { execSync } from 'child_process';
import { gitExec, gitOutput, isValidPath } from './utils.ts';

/**
 * Generate bin/obsidian-inject.js from template
 */
async function generateBinFile(): Promise<void> {
  console.log(`\n🔧 Generating bin/obsidian-inject.js...`);

  const binDir = 'bin';
  const binPath = path.join(binDir, 'obsidian-inject.js');

  // Ensure bin directory exists
  if (!(await isValidPath(binDir))) {
    await mkdir(binDir, { recursive: true });
    console.log(`   📁 Created ${binDir} directory`);
  }

  // Read package.json for version info
  const packageJson = JSON.parse(await readFile('package.json', 'utf8'));

  const binContent = `#!/usr/bin/env node

/**
 * Obsidian Plugin Config - CLI Entry Point
 * Global command: obsidian-inject
 * Version: ${packageJson.version}
 */

import { execSync } from 'child_process';
import { fileURLToPath } from 'url';
import { dirname, join, isAbsolute, resolve } from 'path';
import { readFile, access, unlink, rm } from 'fs/promises';

// Get the directory of this script
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
const packageRoot = dirname(__dirname);

// Path to the injection script
const injectScriptPath = join(packageRoot, 'scripts', 'inject-path.ts');

async function pathExists(p) {
  try {
    await access(p);
    return true;
  } catch {
    return false;
  }
}

function showHelp() {
  console.log(\`
Obsidian Plugin Config - Global CLI
Injection system for autonomous Obsidian plugins

USAGE:
  obsidian-inject                    # Inject in current directory (with confirmation)
  obsidian-inject <path>             # Inject by path (with confirmation)
  obsidian-inject <path> --no        # Inject without confirmation
  obsidian-inject --help, -h         # Show this help

OPTIONS:
  --no, -n                           # Skip confirmation prompts (auto-confirm all)
  --dry-run                          # Verification only (no changes)

EXAMPLES:
  cd my-plugin && obsidian-inject
  obsidian-inject ../my-other-plugin
  obsidian-inject ../my-plugin --no
  obsidian-inject "C:\\\\Users\\\\dev\\\\plugins\\\\my-plugin"

WHAT IS INJECTED:
  ✅ Local scripts (esbuild.config.ts, acp.ts, utils.ts, etc.)
  ✅ Package.json configuration (scripts, dependencies)
  ✅ Config files (tsconfig, eslint, prettier, vscode, github)
  ✅ Yarn protection enforced
  ✅ Automatic dependency installation

ARCHITECTURE:
  - Plugin becomes AUTONOMOUS with local scripts
  - No external dependencies required after injection
  - Updates possible via re-injection

More info: https://github.com/3C0D/obsidian-plugin-config
\`);
}

async function main() {
  const args = process.argv.slice(2);

  // Handle help flags
  if (args.includes('--help') || args.includes('-h')) {
    showHelp();
    process.exit(0);
  }

  // Check if injection script exists
  if (!(await pathExists(injectScriptPath))) {
    console.error(\`❌ Error: Injection script not found at \${injectScriptPath}\`);
    console.error(\`   Make sure obsidian-plugin-config is properly installed.\`);
    process.exit(1);
  }

  // Parse arguments
  const noConfirm = args.includes('--no') || args.includes('-n');
  const dryRun = args.includes('--dry-run');
  const pathArg = args.find(arg => !arg.startsWith('-'));

  // Determine target path (resolve relative to user's current directory)
  const userCwd = process.cwd();
  let targetPath = pathArg || userCwd;

  // If relative path, resolve from user's current directory
  if (pathArg && !isAbsolute(pathArg)) {
    targetPath = resolve(userCwd, pathArg);
  }

  console.log(\`🎯 Obsidian Plugin Config - Global Injection\`);
  console.log(\`📁 Target: \${targetPath}\`);
  console.log(\`❓ Confirmation: \${noConfirm ? 'Disabled (auto-confirm)' : 'Enabled'}\`);
  console.log(\`📦 From: \${packageRoot}\\n\`);

  try {
    // Check if target directory has package.json
    const targetPackageJson = join(targetPath, 'package.json');
    if (!(await pathExists(targetPackageJson))) {
      console.error(\`❌ Error: package.json not found in \${targetPath}\`);
      console.error(\`   Make sure this is a valid Node.js project.\`);
      process.exit(1);
    }

    // Prevent injecting into obsidian-plugin-config itself
    const pkg = JSON.parse(await readFile(targetPackageJson, 'utf8'));
    if (pkg.name === 'obsidian-plugin-config') {
      console.error(\`❌ Cannot inject into obsidian-plugin-config itself.\`);
      process.exit(1);
    }

    // Clean NPM artifacts if package-lock.json exists
    const packageLockPath = join(targetPath, 'package-lock.json');
    if (await pathExists(packageLockPath)) {
      console.log(\`🧹 NPM installation detected, cleaning...\`);

      try {
        // Remove package-lock.json
        await unlink(packageLockPath);
        console.log(\`   🗑️  package-lock.json removed\`);

        // Remove node_modules if it exists
        const nodeModulesPath = join(targetPath, 'node_modules');
        if (await pathExists(nodeModulesPath)) {
          await rm(nodeModulesPath, { recursive: true, force: true });
          console.log(\`   🗑️  node_modules removed (will be reinstalled with Yarn)\`);
        }

        console.log(\`   ✅ NPM artifacts cleaned to avoid Yarn conflicts\`);

      } catch (cleanError) {
        console.error(\`   ❌ Cleanup failed:\`, cleanError instanceof Error ? cleanError.message : String(cleanError));
        console.log(\`   💡 Manually remove package-lock.json and node_modules\`);
      }
    }

    // Check if tsx is available locally in target
    try {
      execSync('npx tsx --version', {
        cwd: targetPath,
        stdio: 'pipe'
      });
      console.log(\`✅ tsx available locally\`);
    } catch {
      console.log(\`⚠️  tsx not found, installing...\`);

      // Install tsx locally in target directory
      try {
        execSync('yarn add -D tsx', {
          cwd: targetPath,
          stdio: 'inherit'
        });
        console.log(\`✅ tsx installed successfully\`);
      } catch (installError) {
        console.error(\`❌ tsx installation failed:\`, installError.message);
        console.error(\`   Try installing tsx manually: cd "\${targetPath}" && yarn add -D tsx\`);
        process.exit(1);
      }
    }

    // Execute the injection script with tsx
    const yesOption = noConfirm ? ' --yes' : '';
    const dryRunOption = dryRun ? ' --dry-run' : '';
    const command = \`npx tsx "\${injectScriptPath}" "\${targetPath}"\${yesOption}\${dryRunOption}\`;

    execSync(command, {
      stdio: 'inherit',
      cwd: targetPath  // Use target directory to ensure tsx is available
    });

    console.log(\`\\n✅ Injection completed successfully!\`);

  } catch (error) {
    console.error(\`\\n❌ Injection error:\`, error.message);
    process.exit(1);
  }
}

main().catch(console.error);
`;

  await writeFile(binPath, binContent, 'utf8');
  console.log(`   ✅ Generated ${binPath}`);
}

/**
 * Ensure NPM authentication, prompting login if needed, then verifying success.
 */
async function ensureNpmAuth(): Promise<void> {
  console.log(`🔐 Checking NPM authentication...`);

  const checkWhoami = (): string | null => {
    try {
      return execSync('npm whoami --registry https://registry.npmjs.org/', {
        stdio: 'pipe',
        encoding: 'utf8'
      }).trim();
    } catch {
      return null;
    }
  };

  const whoami = checkWhoami();
  if (whoami) {
    console.log(`   ✅ Logged in as: ${whoami}\n`);
    return;
  }

  console.log(`   ⚠️  Not logged in to NPM`);
  console.log(`🔑 Please login to NPM to publish the package`);
  console.log(`   Opening browser for authentication...\n`);

  try {
    execSync('npm login --auth-type=web --registry https://registry.npmjs.org/', {
      stdio: 'inherit'
    });
  } catch {
    console.error(`\n   ❌ NPM login failed`);
    console.error(`   Please run 'npm login' manually and try again`);
    throw new Error('NPM authentication required');
  }

  // Verify login actually succeeded
  const whoamiAfter = checkWhoami();
  if (!whoamiAfter) {
    console.error(
      `\n   ❌ Login appeared to complete but authentication could not be verified`
    );
    throw new Error('NPM authentication required');
  }

  console.log(`\n   ✅ Successfully logged in as: ${whoamiAfter}\n`);
}

/**
 * Complete NPM workflow - Version, Commit, Push, Publish
 */
async function buildAndPublishNpm(): Promise<void> {
  console.log(`🚀 Obsidian Plugin Config - NPM Publish Workflow`);
  console.log(`Automation: version → bin → verify → commit → publish\n`);

  try {
    // Step 0: Check NPM authentication
    await ensureNpmAuth();

    // Step 1: Update version
    console.log(`📋 Step 1/5: Updating version...`);
    gitExec('npx tsx scripts/update-version-config.ts');

    // Step 2: Generate bin file
    console.log(`\n🔧 Step 2/5: Generating bin/obsidian-inject.js...`);
    await generateBinFile();

    // Step 3: Verify package
    console.log(`\n📋 Step 3/5: Verifying package...`);
    await verifyPackage();

    // Step 4: Commit and push
    console.log(`\n📤 Step 4/5: Committing and pushing changes...`);
    try {
      // Add all changes
      gitExec('git add -A');

      // Check if there are changes to commit
      const status = gitOutput('git status --porcelain');
      if (status.trim()) {
        const packageJson = JSON.parse(await readFile('package.json', 'utf8'));
        gitExec(`git commit -m "Publish NPM package v${packageJson.version}"`);

        // Get current branch and push
        const currentBranch = gitOutput('git rev-parse --abbrev-ref HEAD');
        gitExec(`git push origin ${currentBranch}`);
        console.log(`   ✅ Changes committed and pushed`);
      } else {
        console.log(`   ℹ️  No changes to commit`);
      }
    } catch (error) {
      console.error(
        `   ❌ Commit/push failed: ${error instanceof Error ? error.message : String(error)}`
      );
      throw error;
    }

    // Step 5: Publish to NPM
    console.log(`\n📤 Step 5/5: Publishing to NPM...`);
    gitExec('npm publish --registry https://registry.npmjs.org/');

    // Optional: Update global CLI automatically
    console.log(`\n🌍 Updating global CLI...`);
    console.log(`   ⏳ Waiting 30s for NPM registry propagation...`);
    await new Promise((resolve) => setTimeout(resolve, 30000));
    try {
      gitExec(
        'npm install -g obsidian-plugin-config@latest --force --engine-strict=false'
      );
      console.log(`   ✅ Global CLI updated`);
    } catch {
      console.log(`   ⚠️  Global CLI update failed (NPM registry may need more time)`);
      console.log(
        `   💡 Run manually in a few minutes: npm install -g obsidian-plugin-config@latest --force`
      );
    }
    console.log(`\n🎉 Complete workflow successful!`);
    console.log(`   Test: cd any-plugin && obsidian-inject`);
  } catch (error) {
    console.error(
      `\n❌ Workflow failed: ${error instanceof Error ? error.message : String(error)}`
    );
    process.exit(1);
  }
}

/**
 * Verify package is ready for publication
 */
async function verifyPackage(): Promise<void> {
  // Check required scripts
  const requiredScripts = [
    'scripts/inject-path.ts',
    'scripts/inject-prompt.ts',
    'scripts/inject-core.ts',
    'scripts/utils.ts',
    'scripts/acp.ts',
    'scripts/update-version-config.ts',
    'scripts/help.ts'
  ];

  for (const script of requiredScripts) {
    if (!(await isValidPath(script))) {
      throw new Error(`Missing required script: ${script}`);
    }
  }
  console.log(`   ✅ All required scripts present`);

  // Check package.json
  const packageJson = JSON.parse(await readFile('package.json', 'utf8'));
  const requiredFields = [
    'name',
    'version',
    'description',
    'bin',
    'repository',
    'author'
  ];

  for (const field of requiredFields) {
    if (!packageJson[field]) {
      throw new Error(`Missing required package.json field: ${field}`);
    }
  }
  console.log(`   ✅ Package.json valid (v${packageJson.version})`);

  // Check bin file exists
  if (!(await isValidPath('bin/obsidian-inject.js'))) {
    throw new Error(`Missing bin file: bin/obsidian-inject.js`);
  }
  console.log(`   ✅ Bin file ready`);

  // Quick build test (suppress tsc output, only show pass/fail)
  gitExec('npx tsc --noEmit', undefined, true);
  console.log(`   ✅ TypeScript check passed`);
}

// Run the script
await buildAndPublishNpm();