@holic512/slothtool 1.0.1

package/README.md

@@ -0,0 +1,81 @@
+# SlothTool
+
+🐌 A plugin manager and dispatcher for CLI tools.
+
+## Installation
+
+```bash
+npm install -g slothtool
+```
+
+## Usage
+
+```bash
+# Install a plugin
+slothtool install @slothtool/plugin-loc
+
+# List installed plugins
+slothtool list
+
+# Run a plugin
+slothtool loc ./src
+
+# Uninstall a plugin
+slothtool uninstall loc
+
+# Get help
+slothtool --help
+```
+
+## Commands
+
+- `slothtool install <plugin>` - Install a plugin from npm
+- `slothtool uninstall <plugin>` - Uninstall a plugin
+- `slothtool list` - List all installed plugins
+- `slothtool run <plugin> [args]` - Run a plugin with arguments
+- `slothtool <plugin> [args]` - Shorthand for running a plugin
+
+## Features
+
+- **Zero Global Pollution**: Plugins are installed in `~/.slothtool/plugins/`
+- **Plugin Isolation**: Each plugin has its own dependencies
+- **Simple CLI**: Easy-to-use commands
+- **Shorthand Syntax**: Run plugins directly with `slothtool <plugin>`
+
+## How It Works
+
+SlothTool manages CLI tools as plugins:
+
+1. Plugins are npm packages with a `bin` field
+2. When you install a plugin, it's downloaded to `~/.slothtool/plugins/`
+3. SlothTool maintains a registry at `~/.slothtool/registry.json`
+4. When you run a plugin, SlothTool spawns the plugin's executable
+
+## Official Plugins
+
+- [@holic512/plugin-loc](../plugin-loc) - Count lines of code
+
+## Creating Plugins
+
+Any npm package with a `bin` field can be a SlothTool plugin:
+
+```json
+{
+  "name": "@yourscope/plugin-mytool",
+  "version": "1.0.0",
+  "bin": {
+    "mytool": "bin/my-tool.js"
+  }
+}
+```
+
+Publish to npm and users can install it:
+
+```bash
+slothtool install @yourscope/plugin-mytool
+slothtool mytool
+```
+
+## License
+
+ISC

package/bin/slothtool.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+const commands = require('../lib/commands');
+
+const args = process.argv.slice(2);
+const command = args[0];
+
+// 如果没有参数，显示帮助信息
+if (!command) {
+  console.log('🐌 SlothTool - A plugin manager for CLI tools\n');
+  console.log('Usage:');
+  console.log('  slothtool install <plugin>       Install a plugin');
+  console.log('  slothtool uninstall <plugin>     Uninstall a plugin');
+  console.log('  slothtool list                   List installed plugins');
+  console.log('  slothtool run <plugin> [args]    Run a plugin');
+  console.log('  slothtool <plugin> [args]        Run a plugin (shorthand)\n');
+  console.log('Examples:');
+  console.log('  slothtool install @holic512/plugin-loc');
+  console.log('  slothtool loc ./src');
+  console.log('  slothtool list');
+  process.exit(0);
+}
+
+// 内置命令
+if (command === 'install') {
+  commands.install(args.slice(1));
+} else if (command === 'uninstall') {
+  commands.uninstall(args.slice(1));
+} else if (command === 'list') {
+  commands.list();
+} else if (command === 'run') {
+  commands.run(args.slice(1));
+} else if (command === '--help' || command === '-h') {
+  console.log('🐌 SlothTool - A plugin manager for CLI tools\n');
+  console.log('Usage:');
+  console.log('  slothtool install <plugin>       Install a plugin');
+  console.log('  slothtool uninstall <plugin>     Uninstall a plugin');
+  console.log('  slothtool list                   List installed plugins');
+  console.log('  slothtool run <plugin> [args]    Run a plugin');
+  console.log('  slothtool <plugin> [args]        Run a plugin (shorthand)\n');
+  console.log('Examples:');
+  console.log('  slothtool install @holic512/plugin-loc');
+  console.log('  slothtool loc ./src');
+  console.log('  slothtool list');
+  process.exit(0);
+} else {
+  // 简写形式：slothtool <plugin> [...args]
+  // 直接将所有参数传递给 run 命令
+  commands.run(args);
+}

package/lib/commands/index.js

@@ -0,0 +1,11 @@
+const install = require('./install');
+const uninstall = require('./uninstall');
+const list = require('./list');
+const run = require('./run');
+
+module.exports = {
+  install,
+  uninstall,
+  list,
+  run
+};

package/lib/commands/install.js

@@ -0,0 +1,15 @@
+const { installPlugin } = require('../plugin-manager');
+
+function install(args) {
+  if (args.length === 0) {
+    console.error('Error: Please specify a plugin to install.');
+    console.log('Usage: slothtool install <plugin-name>');
+    console.log('Example: slothtool install @slothtool/plugin-loc');
+    process.exit(1);
+  }
+
+  const packageName = args[0];
+  installPlugin(packageName);
+}
+
+module.exports = install;

package/lib/commands/list.js

@@ -0,0 +1,22 @@
+const registry = require('../registry');
+
+function list() {
+  const plugins = registry.getAllPlugins();
+
+  if (Object.keys(plugins).length === 0) {
+    console.log('No plugins installed.');
+    console.log('\nInstall a plugin with: slothtool install <plugin-name>');
+    return;
+  }
+
+  console.log('Installed plugins:\n');
+  for (const [alias, info] of Object.entries(plugins)) {
+    console.log(`  ${alias}`);
+    console.log(`    Package: ${info.name}`);
+    console.log(`    Version: ${info.version}`);
+    console.log(`    Installed: ${new Date(info.installedAt).toLocaleString()}`);
+    console.log('');
+  }
+}
+
+module.exports = list;

package/lib/commands/run.js

@@ -0,0 +1,41 @@
+const { spawn } = require('child_process');
+const registry = require('../registry');
+
+function run(args) {
+  if (args.length === 0) {
+    console.error('Error: Please specify a plugin to run.');
+    console.log('Usage: slothtool run <plugin-alias> [args...]');
+    console.log('   or: slothtool <plugin-alias> [args...]');
+    console.log('\nExample: slothtool run loc ./src');
+    console.log('     or: slothtool loc ./src');
+    process.exit(1);
+  }
+
+  const pluginAlias = args[0];
+  const pluginArgs = args.slice(1);
+
+  const plugin = registry.getPlugin(pluginAlias);
+
+  if (!plugin) {
+    console.error(`Error: Plugin "${pluginAlias}" not found.`);
+    console.log(`\nRun "slothtool list" to see installed plugins.`);
+    console.log(`Or install it with: slothtool install <plugin-name>`);
+    process.exit(1);
+  }
+
+  // 调用插件
+  const child = spawn('node', [plugin.binPath, ...pluginArgs], {
+    stdio: 'inherit'
+  });
+
+  child.on('error', (error) => {
+    console.error(`Failed to run plugin "${pluginAlias}":`, error.message);
+    process.exit(1);
+  });
+
+  child.on('exit', (code) => {
+    process.exit(code || 0);
+  });
+}
+
+module.exports = run;

package/lib/commands/uninstall.js

@@ -0,0 +1,15 @@
+const { uninstallPlugin } = require('../plugin-manager');
+
+function uninstall(args) {
+  if (args.length === 0) {
+    console.error('Error: Please specify a plugin to uninstall.');
+    console.log('Usage: slothtool uninstall <plugin-alias>');
+    console.log('Example: slothtool uninstall loc');
+    process.exit(1);
+  }
+
+  const alias = args[0];
+  uninstallPlugin(alias);
+}
+
+module.exports = uninstall;

package/lib/plugin-manager.js

@@ -0,0 +1,122 @@
+const { execSync } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+const registry = require('./registry');
+const { extractPluginAlias, getPluginDir, ensureDir, getPluginsDir } = require('./utils');
+
+/**
+ * 安装插件
+ * @param {string} packageName - npm 包名 (例如: @slothtool/plugin-loc 或 plugin-loc)
+ */
+function installPlugin(packageName) {
+  console.log(`Installing plugin: ${packageName}...`);
+
+  // 提取插件别名
+  const alias = extractPluginAlias(packageName);
+
+  // 检查是否已安装
+  if (registry.hasPlugin(alias)) {
+    console.log(`Plugin "${alias}" is already installed.`);
+    console.log(`Run "slothtool uninstall ${alias}" first if you want to reinstall.`);
+    return;
+  }
+
+  // 确保插件目录存在
+  ensureDir(getPluginsDir());
+
+  const pluginDir = getPluginDir(alias);
+  ensureDir(pluginDir);
+
+  try {
+    // 使用 npm install 安装插件到指定目录
+    console.log(`Installing to: ${pluginDir}`);
+    execSync(`npm install ${packageName} --prefix "${pluginDir}"`, {
+      stdio: 'inherit',
+      encoding: 'utf8'
+    });
+
+    // 读取插件的 package.json
+    const pkgPath = path.join(pluginDir, 'node_modules', packageName, 'package.json');
+
+    if (!fs.existsSync(pkgPath)) {
+      throw new Error(`Package.json not found at: ${pkgPath}`);
+    }
+
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+
+    // 获取 bin 路径
+    let binPath;
+    if (typeof pkg.bin === 'string') {
+      binPath = path.join(pluginDir, 'node_modules', packageName, pkg.bin);
+    } else if (typeof pkg.bin === 'object') {
+      // 如果 bin 是对象，取第一个值
+      const binKey = Object.keys(pkg.bin)[0];
+      binPath = path.join(pluginDir, 'node_modules', packageName, pkg.bin[binKey]);
+    } else {
+      throw new Error(`No bin field found in package.json for ${packageName}`);
+    }
+
+    // 验证 bin 文件存在
+    if (!fs.existsSync(binPath)) {
+      throw new Error(`Bin file not found at: ${binPath}`);
+    }
+
+    // 添加到注册表
+    registry.addPlugin(alias, {
+      name: packageName,
+      version: pkg.version,
+      binPath: binPath,
+      installedAt: new Date().toISOString()
+    });
+
+    console.log(`\n✓ Plugin "${alias}" installed successfully!`);
+    console.log(`  Run: slothtool ${alias} --help`);
+
+  } catch (error) {
+    console.error(`\n✗ Failed to install plugin "${packageName}":`, error.message);
+
+    // 清理失败的安装
+    if (fs.existsSync(pluginDir)) {
+      fs.rmSync(pluginDir, { recursive: true, force: true });
+    }
+
+    process.exit(1);
+  }
+}
+
+/**
+ * 卸载插件
+ * @param {string} alias - 插件别名
+ */
+function uninstallPlugin(alias) {
+  const plugin = registry.getPlugin(alias);
+
+  if (!plugin) {
+    console.error(`Plugin "${alias}" is not installed.`);
+    process.exit(1);
+  }
+
+  console.log(`Uninstalling plugin: ${alias}...`);
+
+  try {
+    // 删除插件目录
+    const pluginDir = getPluginDir(alias);
+    if (fs.existsSync(pluginDir)) {
+      fs.rmSync(pluginDir, { recursive: true, force: true });
+    }
+
+    // 从注册表移除
+    registry.removePlugin(alias);
+
+    console.log(`✓ Plugin "${alias}" uninstalled successfully!`);
+
+  } catch (error) {
+    console.error(`✗ Failed to uninstall plugin "${alias}":`, error.message);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  installPlugin,
+  uninstallPlugin
+};

package/lib/registry.js

@@ -0,0 +1,104 @@
+const fs = require('fs');
+const { getRegistryPath, ensureDir, getSlothToolHome } = require('./utils');
+
+/**
+ * 读取注册表
+ * @returns {Object} 注册表对象
+ */
+function readRegistry() {
+  const registryPath = getRegistryPath();
+
+  // 确保 .slothtool 目录存在
+  ensureDir(getSlothToolHome());
+
+  // 如果注册表文件不存在，返回空对象
+  if (!fs.existsSync(registryPath)) {
+    return { plugins: {} };
+  }
+
+  try {
+    const content = fs.readFileSync(registryPath, 'utf8');
+    return JSON.parse(content);
+  } catch (error) {
+    console.error('Failed to read registry:', error.message);
+    return { plugins: {} };
+  }
+}
+
+/**
+ * 写入注册表
+ * @param {Object} registry - 注册表对象
+ */
+function writeRegistry(registry) {
+  const registryPath = getRegistryPath();
+
+  // 确保 .slothtool 目录存在
+  ensureDir(getSlothToolHome());
+
+  try {
+    fs.writeFileSync(registryPath, JSON.stringify(registry, null, 2), 'utf8');
+  } catch (error) {
+    console.error('Failed to write registry:', error.message);
+    throw error;
+  }
+}
+
+/**
+ * 添加插件到注册表
+ * @param {string} alias - 插件别名
+ * @param {Object} pluginInfo - 插件信息
+ */
+function addPlugin(alias, pluginInfo) {
+  const registry = readRegistry();
+  registry.plugins[alias] = pluginInfo;
+  writeRegistry(registry);
+}
+
+/**
+ * 从注册表移除插件
+ * @param {string} alias - 插件别名
+ */
+function removePlugin(alias) {
+  const registry = readRegistry();
+  delete registry.plugins[alias];
+  writeRegistry(registry);
+}
+
+/**
+ * 获取插件信息
+ * @param {string} alias - 插件别名
+ * @returns {Object|null} 插件信息，如果不存在返回 null
+ */
+function getPlugin(alias) {
+  const registry = readRegistry();
+  return registry.plugins[alias] || null;
+}
+
+/**
+ * 获取所有插件
+ * @returns {Object} 所有插件的映射
+ */
+function getAllPlugins() {
+  const registry = readRegistry();
+  return registry.plugins;
+}
+
+/**
+ * 检查插件是否已安装
+ * @param {string} alias - 插件别名
+ * @returns {boolean} 是否已安装
+ */
+function hasPlugin(alias) {
+  const registry = readRegistry();
+  return alias in registry.plugins;
+}
+
+module.exports = {
+  readRegistry,
+  writeRegistry,
+  addPlugin,
+  removePlugin,
+  getPlugin,
+  getAllPlugins,
+  hasPlugin
+};

package/lib/utils.js

@@ -0,0 +1,72 @@
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * 获取 slothtool 的主目录
+ * @returns {string} ~/.slothtool
+ */
+function getSlothToolHome() {
+  return path.join(os.homedir(), '.slothtool');
+}
+
+/**
+ * 获取插件安装目录
+ * @returns {string} ~/.slothtool/plugins
+ */
+function getPluginsDir() {
+  return path.join(getSlothToolHome(), 'plugins');
+}
+
+/**
+ * 获取注册表文件路径
+ * @returns {string} ~/.slothtool/registry.json
+ */
+function getRegistryPath() {
+  return path.join(getSlothToolHome(), 'registry.json');
+}
+
+/**
+ * 确保目录存在，如果不存在则创建
+ * @param {string} dir - 目录路径
+ */
+function ensureDir(dir) {
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+}
+
+/**
+ * 从完整的包名中提取插件别名
+ * 例如: @slothtool/plugin-loc -> loc
+ *       plugin-loc -> loc
+ * @param {string} packageName - npm 包名
+ * @returns {string} 插件别名
+ */
+function extractPluginAlias(packageName) {
+  // 移除 scope (如果有)
+  const withoutScope = packageName.replace(/^@[^/]+\//, '');
+
+  // 移除 plugin- 前缀 (如果有)
+  const alias = withoutScope.replace(/^plugin-/, '');
+
+  return alias;
+}
+
+/**
+ * 获取指定插件的安装目录
+ * @param {string} pluginAlias - 插件别名
+ * @returns {string} 插件安装目录路径
+ */
+function getPluginDir(pluginAlias) {
+  return path.join(getPluginsDir(), pluginAlias);
+}
+
+module.exports = {
+  getSlothToolHome,
+  getPluginsDir,
+  getRegistryPath,
+  ensureDir,
+  extractPluginAlias,
+  getPluginDir
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@holic512/slothtool",
+  "version": "1.0.1",
+  "description": "A plugin manager and dispatcher for CLI tools",
+  "main": "lib/index.js",
+  "bin": {
+    "slothtool": "bin/slothtool.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "plugin",
+    "tool",
+    "manager"
+  ],
+  "author": "",
+  "license": "ISC",
+  "files": [
+    "bin",
+    "lib"
+  ]
+}