mcp-searchable 1.0.2

package/.npx-install/README.md

@@ -0,0 +1,188 @@
+# Bootstrap Script
+
+This directory contains the bootstrap script for setting up new projects from this template.
+
+## Usage
+
+### Quick Start
+
+Bootstrap a new project in the current directory:
+
+```bash
+npx --yes --package=github:templ-project/typescript bootstrap
+```
+
+### Options
+
+#### `--part-of-monorepo`
+
+Use this flag when adding this template as part of a monorepo. This will:
+
+- Remove `.husky` directory (git hooks)
+- Remove `.github` directory (CI/CD workflows)
+- Remove `husky` and `lint-staged` from dependencies
+- Remove `prepare` script from package.json
+- Remove `lint-staged` configuration
+
+```bash
+npx --yes --package=github:templ-project/typescript bootstrap --part-of-monorepo
+```
+
+#### `--target <targets>`
+
+Specify which build targets to keep. By default, all build targets are kept.
+
+Available targets:
+
+- `all` - Keep all build targets (default)
+- `esm` - ES Modules build
+- `cjs` - CommonJS build
+- `browser` - Browser-specific ESM build
+- `iife` - Immediately Invoked Function Expression build for browsers
+
+Multiple targets can be specified as comma-separated values:
+
+```bash
+# Keep only ESM and CJS builds
+npx --yes --package=github:templ-project/typescript bootstrap --target esm,cjs
+
+# Keep only browser builds
+npx --yes --package=github:templ-project/typescript bootstrap --target browser,iife
+```
+
+#### Target Directory
+
+Specify a target directory as the last argument:
+
+```bash
+npx --yes --package=github:templ-project/typescript bootstrap ./my-project
+```
+
+### Complete Examples
+
+**Standard project in current directory:**
+
+```bash
+npx --yes --package=github:templ-project/typescript bootstrap
+```
+
+**Monorepo package with only ESM and CJS:**
+
+```bash
+npx --yes --package=github:templ-project/typescript bootstrap \
+  --part-of-monorepo \
+  --target esm,cjs \
+  ./packages/my-lib
+```
+
+**Browser-only library:**
+
+```bash
+npx --yes --package=github:templ-project/typescript bootstrap \
+  --target browser,iife \
+  ./my-browser-lib
+```
+
+## What the Bootstrap Script Does
+
+The bootstrap script performs the following actions:
+
+1. **Clones the Template Repository**
+   - Clones from `https://github.com/templ-project/typescript`
+   - Uses `--depth 1` for faster cloning
+
+2. **Removes Git History**
+   - Deletes `.git` directory to start fresh
+
+3. **Cleans Build Configuration** (if `--target` specified)
+   - Removes unwanted build scripts from package.json
+   - Keeps only the specified build targets
+
+4. **Removes Bootstrap Artifacts**
+   - Deletes `.npx-install` directory (this directory!)
+   - Removes `bin` field from package.json
+
+5. **Updates Package Metadata**
+   - Resets package name to `my-typescript-project`
+   - Resets version to `0.1.0`
+   - Clears repository, bugs, and homepage URLs
+
+6. **Monorepo Cleanup** (if `--part-of-monorepo` specified)
+   - Removes `.husky` directory
+   - Removes `.github` directory
+   - Removes git hook dependencies
+   - Removes related scripts
+
+## After Bootstrap
+
+After running the bootstrap script, follow these steps:
+
+1. **Update package.json**
+
+   ```bash
+   # Edit package.json and update:
+   # - name
+   # - description
+   # - author
+   # - repository
+   # - homepage
+   # - bugs
+   ```
+
+2. **Install dependencies**
+
+   ```bash
+   npm install
+   ```
+
+3. **Initialize git** (if not part of monorepo)
+
+   ```bash
+   git init
+   git add .
+   git commit -m "Initial commit from template"
+   ```
+
+4. **Run tests**
+
+   ```bash
+   npm test
+   ```
+
+5. **Start developing!**
+   ```bash
+   npm run start
+   ```
+
+## Development
+
+If you need to modify the bootstrap script:
+
+1. Edit `.npx-install/bootstrap.js`
+2. Test locally by running:
+   ```bash
+   node .npx-install/bootstrap.js [options]
+   ```
+3. Commit and push changes to the template repository
+
+## Troubleshooting
+
+### Script Not Found
+
+If you get "script not found" errors, ensure:
+
+1. You're using Node.js 20 or higher
+2. The package was installed correctly
+3. The `.npx-install/bootstrap.js` file has execute permissions
+
+### Package.json Not Found
+
+The bootstrap script clones the template repository first, then modifies it. If you see this error, there may be network issues preventing the clone.
+
+### Permission Errors
+
+On Unix-like systems, ensure the bootstrap script is executable:
+
+```bash
+chmod +x .npx-install/bootstrap.js
+```

package/.npx-install/bootstrap.js

@@ -0,0 +1,341 @@
+#!/usr/bin/env node
+
+/**
+ * @fileoverview Bootstrap script for TypeScript template project.
+ * Clones the template and prepares it for use as a new project.
+ */
+
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+
+/**
+ * Parses command line arguments.
+ * @return {{
+ *   targetPath: string,
+ *   partOfMultiRepo: boolean,
+ *   buildTargets: !Array<string>,
+ *   help: boolean
+ * }} Parsed arguments.
+ */
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const config = {
+    targetPath: process.cwd(),
+    partOfMultiRepo: false,
+    buildTargets: ['all'],
+    help: false,
+  };
+
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+
+    if (arg === '--help' || arg === '-h') {
+      config.help = true;
+    } else if (arg === '--part-of-monorepo') {
+      config.partOfMultiRepo = true;
+    } else if (arg === '--target' && i + 1 < args.length) {
+      config.buildTargets = args[++i].split(',');
+    } else if (!arg.startsWith('--')) {
+      config.targetPath = path.resolve(arg);
+    }
+  }
+
+  return config;
+}
+
+/**
+ * Displays help information.
+ */
+function showHelp() {
+  console.log(`
+TypeScript Template Bootstrap Tool
+
+Usage:
+  npx --yes --package=github:templ-project/typescript bootstrap [options] [path]
+
+Options:
+  --part-of-monorepo        Remove .husky, .github folders and related packages
+  --target <targets>        Specify build targets (comma-separated)
+                           Values: all|esm|cjs|browser
+                           Default: all
+  -h, --help               Show this help message
+
+Arguments:
+  path                     Target directory (default: current directory)
+
+Examples:
+  # Bootstrap in current directory with all build targets
+  npx --yes --package=github:templ-project/typescript bootstrap
+
+  # Bootstrap in specific directory
+  npx --yes --package=github:templ-project/typescript bootstrap ./my-project
+
+  # Bootstrap as part of monorepo (removes git hooks)
+  npx --yes --package=github:templ-project/typescript bootstrap --part-of-monorepo
+
+  # Bootstrap with only ESM and CJS builds
+  npx --yes --package=github:templ-project/typescript bootstrap --target esm,cjs
+
+  # Combine options
+  npx --yes --package=github:templ-project/typescript bootstrap --part-of-monorepo --target esm ./my-lib
+`);
+}
+
+/**
+ * Removes a directory or file if it exists.
+ * @param {string} targetPath Path to remove.
+ */
+function removeIfExists(targetPath) {
+  if (fs.existsSync(targetPath)) {
+    fs.rmSync(targetPath, { recursive: true, force: true });
+    console.log(`  ✓ Removed: ${path.basename(targetPath)}`);
+  }
+}
+
+/**
+ * Reads and parses package.json.
+ * @param {string} packagePath Path to package.json.
+ * @return {!Object} Parsed package.json.
+ */
+function readPackageJson(packagePath) {
+  const content = fs.readFileSync(packagePath, 'utf8');
+  return JSON.parse(content);
+}
+
+/**
+ * Writes package.json.
+ * @param {string} packagePath Path to package.json.
+ * @param {!Object} data Package data.
+ */
+function writePackageJson(packagePath, data) {
+  fs.writeFileSync(packagePath, JSON.stringify(data, null, 2) + '\n');
+}
+
+/**
+ * Cleans build scripts based on target configuration.
+ * @param {!Object} pkg Package.json object.
+ * @param {!Array<string>} buildTargets Target build types.
+ * @return {!Object} Modified package.json object.
+ */
+function cleanBuildScripts(pkg, buildTargets) {
+  if (buildTargets.includes('all')) {
+    return pkg;
+  }
+
+  const buildScriptMap = {
+    esm: 'build:esm',
+    cjs: 'build:cjs',
+    browser: 'build:browser',
+    iife: 'build:iife',
+  };
+
+  const scriptsToKeep = buildTargets.map((target) => buildScriptMap[target]).filter(Boolean);
+
+  // Remove unwanted build scripts
+  for (const key of Object.keys(pkg.scripts)) {
+    if (key.startsWith('build:') && !scriptsToKeep.includes(key)) {
+      delete pkg.scripts[key];
+      console.log(`  ✓ Removed script: ${key}`);
+    }
+  }
+
+  return pkg;
+}
+
+/**
+ * Removes monorepo-related dependencies.
+ * @param {!Object} pkg Package.json object.
+ * @return {!Object} Modified package.json object.
+ */
+function removeMonorepoDependencies(pkg) {
+  const monorepoDeps = ['husky', 'lint-staged'];
+
+  for (const dep of monorepoDeps) {
+    if (pkg.devDependencies && pkg.devDependencies[dep]) {
+      delete pkg.devDependencies[dep];
+      console.log(`  ✓ Removed dependency: ${dep}`);
+    }
+  }
+
+  // Remove lint-staged configuration
+  if (pkg['lint-staged']) {
+    delete pkg['lint-staged'];
+    console.log(`  ✓ Removed lint-staged configuration`);
+  }
+
+  // Remove prepare script (used by husky)
+  if (pkg.scripts && pkg.scripts.prepare) {
+    delete pkg.scripts.prepare;
+    console.log(`  ✓ Removed prepare script`);
+  }
+
+  return pkg;
+}
+
+/**
+ * Removes bootstrap-related files and dependencies.
+ * @param {!Object} pkg Package.json object.
+ * @param {string} targetPath Target directory path.
+ * @return {!Object} Modified package.json object.
+ */
+function removeBootstrapArtifacts(pkg, targetPath) {
+  // Remove .npx-install directory
+  const installDir = path.join(targetPath, '.npx-install');
+  removeIfExists(installDir);
+
+  // Remove bin field if it exists
+  if (pkg.bin) {
+    delete pkg.bin;
+    console.log(`  ✓ Removed bin configuration`);
+  }
+
+  return pkg;
+}
+
+/**
+ * Updates package.json metadata for new project.
+ * @param {!Object} pkg Package.json object.
+ * @return {!Object} Modified package.json object.
+ */
+function updatePackageMetadata(pkg) {
+  // Reset name to a placeholder
+  pkg.name = 'my-typescript-project';
+
+  // Reset version
+  pkg.version = '0.1.0';
+
+  // Clear repository information
+  if (pkg.repository) {
+    pkg.repository = {
+      type: 'git',
+      url: '',
+    };
+  }
+
+  // Clear bugs URL
+  if (pkg.bugs) {
+    pkg.bugs = {
+      url: '',
+    };
+  }
+
+  // Clear homepage
+  if (pkg.homepage) {
+    pkg.homepage = '';
+  }
+
+  console.log(`  ✓ Updated package metadata`);
+  return pkg;
+}
+
+/**
+ * Clones the template repository to target directory.
+ * @param {string} targetPath Target directory.
+ */
+function cloneTemplate(targetPath) {
+  console.log('📁 Cloning template repository...\n');
+
+  // Ensure target directory exists
+  if (!fs.existsSync(targetPath)) {
+    fs.mkdirSync(targetPath, { recursive: true });
+  }
+
+  // Check if directory is empty
+  const files = fs.readdirSync(targetPath);
+  if (files.length > 0) {
+    console.error('❌ Error: Target directory is not empty');
+    console.error(`   Directory: ${targetPath}`);
+    console.error('   Please use an empty directory or remove existing files.');
+    process.exit(1);
+  }
+
+  try {
+    // Clone the repository
+    console.log('  Cloning from https://github.com/templ-project/typescript...');
+    execSync(`git clone --depth 1 https://github.com/templ-project/typescript.git "${targetPath}"`, {
+      stdio: 'pipe',
+    });
+    console.log(`  ✓ Template cloned to ${targetPath}`);
+  } catch (error) {
+    console.error('❌ Error: Failed to clone repository');
+    console.error(`   ${error.message}`);
+    console.error('\nPlease ensure:');
+    console.error('  1. Git is installed and available in PATH');
+    console.error('  2. You have internet connectivity');
+    console.error('  3. You have access to https://github.com/templ-project/typescript');
+    process.exit(1);
+  }
+}
+
+/**
+ * Main bootstrap function.
+ * @param {{
+ *   targetPath: string,
+ *   partOfMultiRepo: boolean,
+ *   buildTargets: !Array<string>,
+ *   help: boolean
+ * }} config Configuration object.
+ */
+function bootstrap(config) {
+  if (config.help) {
+    showHelp();
+    return;
+  }
+
+  console.log('\n🚀 TypeScript Template Bootstrap\n');
+
+  const targetPath = config.targetPath;
+
+  // Clone template repository to target directory
+  cloneTemplate(targetPath);
+
+  const packagePath = path.join(targetPath, 'package.json');
+
+  // Now verify package.json exists (it should after copying)
+  if (!fs.existsSync(packagePath)) {
+    console.error('❌ Error: Failed to copy template files');
+    console.error(`   Expected package.json at: ${packagePath}`);
+    process.exit(1);
+  }
+
+  console.log('📦 Cleaning up template artifacts...\n');
+
+  // Remove .git directory
+  const gitDir = path.join(targetPath, '.git');
+  removeIfExists(gitDir);
+
+  // Handle monorepo-specific cleanup
+  if (config.partOfMultiRepo) {
+    console.log('\n🏢 Monorepo mode: removing git hooks and CI...\n');
+    const huskyDir = path.join(targetPath, '.husky');
+    const githubDir = path.join(targetPath, '.github');
+    removeIfExists(huskyDir);
+    removeIfExists(githubDir);
+  }
+
+  // Update package.json
+  console.log('\n📝 Updating package.json...\n');
+  let pkg = readPackageJson(packagePath);
+
+  pkg = cleanBuildScripts(pkg, config.buildTargets);
+  pkg = removeBootstrapArtifacts(pkg, targetPath);
+  pkg = updatePackageMetadata(pkg);
+
+  if (config.partOfMultiRepo) {
+    pkg = removeMonorepoDependencies(pkg);
+  }
+
+  writePackageJson(packagePath, pkg);
+
+  console.log('\n✨ Bootstrap complete!\n');
+  console.log('Next steps:');
+  console.log('  1. Update package.json name, description, and repository');
+  console.log('  2. Run: npm install');
+  console.log('  3. Run: npm test');
+  console.log('  4. Start coding!\n');
+}
+
+// Run the bootstrap
+const config = parseArgs();
+bootstrap(config);

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Templ Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.