@docmd/plugin-installer 0.5.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 docmd.io
+
+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.

package/README.md

@@ -0,0 +1,41 @@
+# @docmd/plugin-installer
+
+The cross-platform engine powering `docmd add` and `docmd remove`.
+
+Automatically downloads, resolves, and injects plugin schemas directly into your `docmd.config.js` with built-in AST-like regex parsing and elegant structural fallbacks.
+
+## Usage
+
+You do not need to configure this package manually. It is bundled directly into `@docmd/core` and runs natively through the CLI.
+
+```bash
+docmd add search
+docmd add analytics --verbose
+docmd remove search
+```
+
+## The `docmd` Ecosystem
+
+`docmd` is a modular system. Here are the official packages:
+
+**The Engine**
+*   [**@docmd/core**](https://www.npmjs.com/package/@docmd/core) - The CLI runner and build orchestrator.
+*   [**@docmd/parser**](https://www.npmjs.com/package/@docmd/parser) - The pure Markdown-to-HTML logic.
+*   [**@docmd/live**](https://www.npmjs.com/package/@docmd/live) - The browser-based Live Editor bundle.
+
+**Interface & Design**
+*   [**@docmd/ui**](https://www.npmjs.com/package/@docmd/ui) - Base EJS templates and assets.
+*   [**@docmd/themes**](https://www.npmjs.com/package/@docmd/themes) - Official themes (Sky, Ruby, Retro).
+
+**Plugins**
+*   [**@docmd/plugin-search**](https://www.npmjs.com/package/@docmd/plugin-search) - Offline full-text search.
+*   [**@docmd/plugin-pwa**](https://www.npmjs.com/package/@docmd/plugin-pwa) - Progressive Web App support.
+*   [**@docmd/plugin-mermaid**](https://www.npmjs.com/package/@docmd/plugin-mermaid) - Diagrams and flowcharts.
+*   [**@docmd/plugin-seo**](https://www.npmjs.com/package/@docmd/plugin-seo) - Meta tags and Open Graph data.
+*   [**@docmd/plugin-sitemap**](https://www.npmjs.com/package/@docmd/plugin-sitemap) - Automatic sitemap generation.
+*   [**@docmd/plugin-llms**](https://www.npmjs.com/package/@docmd/plugin-llms) - AI context generation.
+*   [**@docmd/plugin-analytics**](https://www.npmjs.com/package/@docmd/plugin-analytics) - Google Analytics integration.
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.

package/index.js

@@ -0,0 +1,229 @@
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+const chalk = require('chalk');
+
+// Load the official plugins registry
+const pluginsRegistry = require('./registry/plugins.json');
+
+/**
+ * Detects the package manager used in the current project by looking for lockfiles upwards.
+ * Defaults to 'npm' if no lockfile is found.
+ */
+function getPackageManager(cwd) {
+  let dir = cwd;
+  while (dir !== path.parse(dir).root) {
+    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'))) return 'bun';
+    if (fs.existsSync(path.join(dir, 'package-lock.json'))) return 'npm';
+    dir = path.dirname(dir);
+  }
+  return 'npm';
+}
+
+/**
+ * Resolves plugin metadata from the registry, or builds a fallback object.
+ */
+function resolvePluginMeta(name) {
+  if (pluginsRegistry[name]) {
+    return pluginsRegistry[name];
+  }
+  
+  // Fallback for unofficial/custom plugins
+  return {
+    package: name,
+    description: "Custom community plugin",
+    configKey: name.replace('@docmd/plugin-', ''), // Best effort guess
+    defaultConfig: "{}"
+  };
+}
+
+/**
+ * Reads config and safely injects the plugin to the `plugins` object.
+ */
+function injectPluginToConfig(configPath, meta) {
+  let content = '';
+  if (fs.existsSync(configPath)) {
+    content = fs.readFileSync(configPath, 'utf8');
+  } else {
+    // Scaffold minimal config if missing
+    content = `module.exports = {\n  plugins: {}\n};\n`;
+  }
+
+  // Strip comments to avoid false positives (e.g., `// analytics: {}`)
+  const strippedContent = content.replace(/\/\/.*$/gm, '').replace(/\/\*[\s\S]*?\*\//g, '');
+
+  const configKey = meta.configKey;
+
+  // Check if plugin is already inside
+  if (strippedContent.includes(`'${configKey}'`) || strippedContent.includes(`"${configKey}"`) || strippedContent.includes(`\`${configKey}\``) || strippedContent.includes(`${configKey}:`)) {
+    return false; // Already installed
+  }
+
+  // Look for `plugins: {`
+  const pluginsRegex = /plugins\s*:\s*\{/;
+  const match = content.match(pluginsRegex);
+
+  // Dynamically format multi-line configs to match indentation
+  const formattedConfig = meta.defaultConfig.replace(/\n/g, '\n    ');
+  const injectStr = `'${configKey}': ${formattedConfig}`;
+
+  if (match) {
+    content = content.replace(pluginsRegex, `plugins: {\n    ${injectStr},`);
+  } else {
+    // If there's no plugins object, we can try to inject it before the last closing brace
+    const moduleExportsRegex = /module\.exports\s*=\s*(?:defineConfig\()?\{([\s\S]*?)\}(?:\))?;?/g;
+    let matchE;
+    let lastMatch;
+    while ((matchE = moduleExportsRegex.exec(content)) !== null) {
+      lastMatch = matchE;
+    }
+    if (lastMatch) {
+      const closingBraceIndex = lastMatch.index + lastMatch[0].lastIndexOf('}');
+      const prefix = content.substring(0, closingBraceIndex);
+      const suffix = content.substring(closingBraceIndex);
+      
+      const insert = prefix.trim().endsWith(',') || prefix.trim().endsWith('{') ? 
+        `\n  plugins: {\n    ${injectStr}\n  }\n` : 
+        `,\n  plugins: {\n    ${injectStr}\n  }\n`;
+        
+      content = prefix + insert + suffix;
+    } else {
+      console.warn(chalk.yellow(`Could not automatically inject plugin into config file. Please add '${configKey}': ${meta.defaultConfig} manually to the plugins object.`));
+      return false;
+    }
+  }
+
+  fs.writeFileSync(configPath, content, 'utf8');
+  return true;
+}
+
+/**
+ * Removes the plugin from the config file.
+ */
+function removePluginFromConfig(configPath, meta) {
+  if (!fs.existsSync(configPath)) return false;
+
+  let content = fs.readFileSync(configPath, 'utf8');
+  const configKey = meta.configKey;
+
+  if (!content.includes(configKey)) {
+    return false;
+  }
+
+  // This regex handles both multiline well-formatted configs, and poorly formatted tight inline configs 
+  // generated by the scaffolding fallback e.g. `'search': {},}`
+  const re1 = new RegExp(`\\s*['"\`]?${configKey}['"\`]?\\s*:\\s*\\{[^}]*\\}\\s*,?\\s*`, 'gm');
+  
+  // Replace active entries with empty string
+  const newContent = content.replace(re1, '');
+
+  if (content === newContent) {
+    return false; // Regex didn't match (e.g. config differs from expected format)
+  }
+
+  fs.writeFileSync(configPath, newContent, 'utf8');
+  return true;
+}
+
+
+async function installPlugin(pluginInput, opts = {}) {
+  const cwd = process.cwd();
+  const pkgManager = getPackageManager(cwd);
+  const meta = resolvePluginMeta(pluginInput);
+  const packageName = meta.package;
+
+  if (opts.verbose) {
+    console.log(chalk.cyan(`Installing ${packageName} using ${pkgManager}...`));
+  } else {
+    process.stdout.write(chalk.cyan(`Installing ${packageName}... `));
+  }
+
+  let installCmd = '';
+  if (pkgManager === 'npm') installCmd = `npm install ${packageName}`;
+  else if (pkgManager === 'yarn') installCmd = `yarn add ${packageName}`;
+  else if (pkgManager === 'pnpm') installCmd = `pnpm add ${packageName}`;
+  else if (pkgManager === 'bun') installCmd = `bun add ${packageName}`;
+
+  // Use `--no-save` fallback for global / raw directories gracefully if it's npm
+  if (pkgManager === 'npm' && !fs.existsSync(path.join(cwd, 'package.json'))) {
+    installCmd += ' --no-save';
+  }
+
+  try {
+    const stdioMode = opts.verbose ? 'inherit' : 'pipe';
+    execSync(installCmd, { stdio: stdioMode, cwd });
+    
+    if (!opts.verbose) process.stdout.write(chalk.green(`Done\n`));
+    else console.log(chalk.green(`Successfully installed ${packageName}.`));
+    
+    const configPath = path.join(cwd, 'docmd.config.js');
+    console.log(chalk.cyan(`Injecting '${meta.configKey}' into docmd.config.js...`));
+
+    const injected = injectPluginToConfig(configPath, meta);
+    if (injected) {
+      console.log(chalk.green(`Successfully activated '${meta.configKey}' in config.`));
+    } else {
+      console.log(chalk.yellow(`Plugin '${meta.configKey}' was already in config or could not be injected.`));
+    }
+  } catch (err) {
+    if (!opts.verbose) process.stdout.write(chalk.red(`Failed\n`));
+    console.error(chalk.red(`❌ Could not install plugin '${packageName}'.`));
+    if (opts.verbose) {
+      console.error(chalk.dim(err.message));
+      if (err.stdout) console.error(err.stdout.toString());
+      if (err.stderr) console.error(err.stderr.toString());
+    } else {
+      console.error(chalk.yellow(`Run with --verbose to see detailed logs.`));
+    }
+  }
+}
+
+async function removePlugin(pluginInput, opts = {}) {
+  const cwd = process.cwd();
+  const pkgManager = getPackageManager(cwd);
+  const meta = resolvePluginMeta(pluginInput);
+  const packageName = meta.package;
+
+  if (opts.verbose) {
+    console.log(chalk.cyan(`Removing ${packageName} using ${pkgManager}...`));
+  } else {
+    process.stdout.write(chalk.cyan(`Removing ${packageName}... `));
+  }
+
+  let uninstallCmd = '';
+  if (pkgManager === 'npm') uninstallCmd = `npm uninstall ${packageName}`;
+  else if (pkgManager === 'yarn') uninstallCmd = `yarn remove ${packageName}`;
+  else if (pkgManager === 'pnpm') uninstallCmd = `pnpm remove ${packageName}`;
+  else if (pkgManager === 'bun') uninstallCmd = `bun remove ${packageName}`;
+
+  try {
+    const stdioMode = opts.verbose ? 'inherit' : 'pipe';
+    execSync(uninstallCmd, { stdio: stdioMode, cwd });
+    
+    if (!opts.verbose) process.stdout.write(chalk.green(`Done\n`));
+    else console.log(chalk.green(`Successfully uninstalled ${packageName}.`));
+    
+    const configPath = path.join(cwd, 'docmd.config.js');
+    console.log(chalk.cyan(`Removing '${meta.configKey}' from docmd.config.js...`));
+
+    const removed = removePluginFromConfig(configPath, meta);
+    if (removed) {
+      console.log(chalk.green(`Successfully deactivated '${meta.configKey}' in config.`));
+    } else {
+      console.log(chalk.yellow(`Plugin '${meta.configKey}' was not found in config or could not be removed automatically.`));
+    }
+  } catch (err) {
+    if (!opts.verbose) process.stdout.write(chalk.red(`Failed\n`));
+    console.error(chalk.red(`❌ Could not remove plugin '${packageName}'.`));
+    if (opts.verbose) {
+      console.error(chalk.dim(err.message));
+    }
+  }
+}
+
+module.exports = {
+  installPlugin,
+  removePlugin
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@docmd/plugin-installer",
+  "version": "0.5.3",
+  "description": "Installer utility to add and remove plugins for docmd.",
+  "main": "index.js",
+  "dependencies": {
+    "chalk": "^4.1.2"
+  },
+  "keywords": [
+    "docmd",
+    "plugin",
+    "installer",
+    "cli",
+    "add",
+    "remove",
+    "markdown",
+    "minimalist",
+    "zero-config",
+    "site-generator",
+    "static-site-generator",
+    "docs"
+  ],
+  "author": {
+    "name": "Ghazi",
+    "url": "https://mgks.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/docmd-io/docmd.git"
+  },
+  "bugs": {
+    "url": "https://github.com/docmd-io/docmd/issues"
+  },
+  "homepage": "https://docmd.io",
+  "funding": "https://github.com/sponsors/mgks",
+  "license": "MIT"
+}

package/registry/plugins.json

@@ -0,0 +1,44 @@
+{
+  "analytics": {
+    "package": "@docmd/plugin-analytics",
+    "description": "Analytics injection plugin for docmd",
+    "configKey": "analytics",
+    "defaultConfig": "{}"
+  },
+  "search": {
+    "package": "@docmd/plugin-search",
+    "description": "Local search implementation for docmd",
+    "configKey": "search",
+    "defaultConfig": "{}"
+  },
+  "seo": {
+    "package": "@docmd/plugin-seo",
+    "description": "SEO meta tag generator for docmd",
+    "configKey": "seo",
+    "defaultConfig": "{}"
+  },
+  "sitemap": {
+    "package": "@docmd/plugin-sitemap",
+    "description": "Sitemap generator for docmd",
+    "configKey": "sitemap",
+    "defaultConfig": "{}"
+  },
+  "mermaid": {
+    "package": "@docmd/plugin-mermaid",
+    "description": "Mermaid.js diagram support for docmd",
+    "configKey": "mermaid",
+    "defaultConfig": "{}"
+  },
+  "llms": {
+    "package": "@docmd/plugin-llms",
+    "description": "LLM integration plugin for docmd",
+    "configKey": "llms",
+    "defaultConfig": "{}"
+  },
+  "pwa": {
+    "package": "@docmd/plugin-pwa",
+    "description": "Progressive Web App support for docmd",
+    "configKey": "pwa",
+    "defaultConfig": "{}"
+  }
+}