@initx-plugin/manager 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 imba97 <https://github.com/imba97>
+
+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,53 @@
+## @initx-plugin/manager
+
+`initx` plugin manager
+
+## Usage
+
+```bash
+npm i @initx-plugin/manager -g
+```
+
+### List
+
+```bash
+npx initx plugin list
+```
+
+List all installed plugins
+
+### Add
+
+```bash
+# npx initx plugin add <plugin-name>
+npx initx plugin add git
+```
+
+This command will search and install `@initx-plugin/git` or `initx-plugin-git`
+
+If there are multiple, let the user choose
+
+### Update
+
+```bash
+npx initx plugin update
+```
+
+Detect the versions of all plugins and update the plugins that need to be updated
+
+Automatically filter local development plugins
+
+### Remove
+
+```bash
+# npx initx plugin remove <plugin-name>
+npx initx plugin remove git
+```
+
+This command will remove `@initx-plugin/git` or `initx-plugin-git`
+
+If there are multiple, let the user choose
+
+## Documentation
+
+[initx](https://github.com/initx-collective/initx)

package/dist/index.d.mts

@@ -0,0 +1,11 @@
+import { InitxPlugin, InitxContext } from '@initx-plugin/core';
+
+declare class PluginManagerPlugin extends InitxPlugin {
+    matchers: {
+        matching: string;
+        description: string;
+    }[];
+    handle(_ctx: InitxContext, type: string, ...others: string[]): Promise<void>;
+}
+
+export { PluginManagerPlugin as default };

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { InitxPlugin, InitxContext } from '@initx-plugin/core';
+
+declare class PluginManagerPlugin extends InitxPlugin {
+    matchers: {
+        matching: string;
+        description: string;
+    }[];
+    handle(_ctx: InitxContext, type: string, ...others: string[]): Promise<void>;
+}
+
+export { PluginManagerPlugin as default };

package/dist/index.mjs

@@ -0,0 +1,286 @@
+import { fetchPlugins, InitxPlugin } from '@initx-plugin/core';
+import { c, log, inquirer } from '@initx-plugin/utils';
+import { green, blue, reset, dim, gray } from 'picocolors';
+import ora from 'ora';
+import path from 'node:path';
+import fs from 'fs-extra';
+import columnify from 'columnify';
+
+const installedPluginInfo = {
+  once: false,
+  names: []
+};
+const officialName = (targetName) => `@initx-plugin/${targetName}`;
+const communityName = (targetName) => `initx-plugin-${targetName}`;
+function isInitxPlugin(name) {
+  return /^@initx-plugin\/|^initx-plugin-/.test(name);
+}
+function isCompleteMatchName(targetName, searchedName) {
+  return officialName(targetName) === searchedName || communityName(targetName) === searchedName;
+}
+function nameColor(name) {
+  if (/^@initx-plugin\//.test(name)) {
+    return green(name);
+  }
+  return blue(name);
+}
+async function loadingFunction(message, fn) {
+  const spinner = ora(message).start();
+  return fn().finally(() => {
+    spinner.stop();
+  });
+}
+async function getInstalledPluginNames() {
+  if (installedPluginInfo.once) {
+    return installedPluginInfo.names;
+  }
+  const fetchedPlugins = await fetchPlugins();
+  installedPluginInfo.names = fetchedPlugins.map(({ name }) => name);
+  installedPluginInfo.once = true;
+  return installedPluginInfo.names;
+}
+async function isInstalledPlugin(name) {
+  const installedPluginNames = await getInstalledPluginNames();
+  return installedPluginNames.includes(name);
+}
+async function searchPlugin(pluginNames) {
+  const plugins = [];
+  const finedNames = [];
+  for (const name of pluginNames) {
+    const result = await c("npm", ["search", "--json", name]);
+    if (!result.success) {
+      continue;
+    }
+    try {
+      const json = JSON.parse(result.content);
+      if (finedNames.includes(json.name)) {
+        continue;
+      }
+      finedNames.push(json.name);
+      json.forEach((plugin) => {
+        plugins.push({
+          name: plugin.name,
+          version: plugin.version,
+          description: plugin.description
+        });
+      });
+    } catch (e) {
+      return [];
+    }
+  }
+  return plugins;
+}
+
+async function addPlugin(targetPlugin) {
+  const availablePlugins = await loadingFunction("Searching plugin", () => searchAvailablePlugins(targetPlugin));
+  if (availablePlugins.length === 0) {
+    log.error(`Plugin ${nameColor(officialName(targetPlugin))} or ${nameColor(communityName(targetPlugin))} not found`);
+    return;
+  }
+  let index = 0;
+  let needConfirm = true;
+  if (availablePlugins.length === 2) {
+    const displayContnet = [];
+    for (const plugin of availablePlugins) {
+      displayContnet.push(await displayInfo(plugin));
+    }
+    index = await inquirer.select(
+      "Which plugin do you want to install?",
+      displayContnet
+    );
+    needConfirm = false;
+  }
+  const pluginInfo = {
+    name: availablePlugins[index].name,
+    version: availablePlugins[index].version,
+    description: availablePlugins[index].description
+  };
+  if (needConfirm) {
+    const confirm = await inquirer.confirm(
+      `Do you want to install ${await displayInfo(pluginInfo)} ?`
+    );
+    if (!confirm) {
+      log.warn("Installation canceled");
+      return;
+    }
+  }
+  const installResult = await loadingFunction("Installing plugin", () => installPlugin(pluginInfo.name));
+  if (!installResult.success) {
+    log.error(`Failed to install plugin ${nameColor(pluginInfo.name)}`);
+    console.log(installResult.content);
+    return;
+  }
+  log.success(`Plugin ${nameColor(pluginInfo.name)} installed`);
+}
+async function searchAvailablePlugins(targetPlugin) {
+  const searchPluginNames = [
+    officialName(targetPlugin),
+    communityName(targetPlugin)
+  ];
+  const searchResults = await searchPlugin(searchPluginNames);
+  const availablePlugins = searchResults?.filter(
+    (plugin) => isInitxPlugin(plugin.name) && isCompleteMatchName(targetPlugin, plugin.name)
+  );
+  return availablePlugins;
+}
+async function installPlugin(name) {
+  return c("npm", ["install", "-g", name]);
+}
+async function displayInfo({ name, version, description }) {
+  const isInstalled = await isInstalledPlugin(name);
+  const display = {
+    name: nameColor(name),
+    version: reset(dim(gray(`@${version}`))),
+    description: reset(description),
+    installed: isInstalled ? dim(green(" [already]")) : "	"
+  };
+  return `${display.name}${display.version}${display.installed}	${display.description}`;
+}
+
+async function showPluginList() {
+  const plugins = await loadingFunction("Fetching plugins", fetchPlugins);
+  const displayTable = [];
+  plugins.forEach(({ root }) => {
+    const info = fs.readJsonSync(path.join(root, "package.json"));
+    displayTable.push({
+      name: nameColor(info.name),
+      version: gray(info.version),
+      description: gray(info.description)
+    });
+  });
+  console.log(columnify(displayTable));
+}
+
+async function updatePlugin() {
+  const excludedPlugins = await fetchExcludedPlugins();
+  const fetchedPlugins = await fetchPlugins();
+  const pluginNames = [];
+  const pluginRootMap = fetchedPlugins.reduce((acc, { name, root }) => {
+    if (excludedPlugins.includes(name)) {
+      return acc;
+    }
+    pluginNames.push(name);
+    acc[name] = root;
+    return acc;
+  }, {});
+  const searchPluginsInfo = await loadingFunction("Checking plugins", () => searchPlugin(pluginNames));
+  const needUpdatePlugins = [];
+  Object.keys(pluginRootMap).forEach((name) => {
+    const packageInfo = fs.readJsonSync(path.join(pluginRootMap[name], "package.json"));
+    const pluginInfo = searchPluginsInfo.find((plugin) => plugin.name === name);
+    if (!pluginInfo || packageInfo.version === pluginInfo.version) {
+      return;
+    }
+    needUpdatePlugins.push({
+      name,
+      version: packageInfo.version,
+      target: pluginInfo.version
+    });
+  });
+  if (needUpdatePlugins.length === 0) {
+    log.success("All plugins are up to date");
+    return;
+  }
+  log.info("Need update plugins:");
+  needUpdatePlugins.forEach(({ name, version, target }) => {
+    console.log(`${nameColor(name)}	${dim(gray(`${version}	->`))} ${target}`);
+  });
+  const confirm = await inquirer.confirm("Do you want to update these plugins?");
+  if (!confirm) {
+    log.warn("Update canceled");
+    return;
+  }
+  const displayNames = needUpdatePlugins.map(({ name, target }) => `${nameColor(name)}${dim(gray(`@${target}`))}`).join(" ");
+  await loadingFunction(
+    `Updating ${displayNames}`,
+    () => c("npm", ["install", "-g", ...needUpdatePlugins.map(({ name, target }) => `${name}@${target}`)])
+  );
+  log.success(`Plugins updated: ${displayNames}`);
+}
+async function fetchExcludedPlugins() {
+  const npmListResult = await c("npm", ["list", "-g", "--depth=0"]);
+  const excludedPlugins = [];
+  npmListResult.content.split(/\r?\n/).forEach((line) => {
+    const metched = /(?:@initx-plugin\/|initx-plugin-)[^@]+/.exec(line);
+    if (metched && line.includes("->")) {
+      excludedPlugins.push(metched[0]);
+    }
+  });
+  return excludedPlugins;
+}
+
+async function removePlugin(targetName) {
+  const plugins = await fetchPlugins();
+  const removePluginNames = [
+    officialName(targetName),
+    communityName(targetName)
+  ];
+  const removePlugins = plugins.filter(({ name }) => removePluginNames.includes(name));
+  if (removePlugins.length === 0) {
+    const displayNames = removePluginNames.map(nameColor).join(" or ");
+    log.warn(`Plugin ${displayNames} is not installed`);
+    return;
+  }
+  let index = 0;
+  let needConfirm = true;
+  if (removePlugins.length === 2) {
+    index = await inquirer.select("Which plugin do you want to remove?", removePlugins.map(({ name }) => nameColor(name)));
+    needConfirm = false;
+  }
+  const removePlugin2 = removePlugins[index];
+  if (needConfirm) {
+    const confirmResult = await inquirer.confirm(`Are you sure you want to remove ${nameColor(removePlugin2.name)}?`);
+    if (!confirmResult) {
+      return;
+    }
+  }
+  await loadingFunction(
+    `Removing ${nameColor(removePlugin2.name)}...`,
+    () => c("npm", ["uninstall", "-g", removePlugin2.name])
+  );
+  log.success(`Removed ${nameColor(removePlugin2.name)}`);
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class PluginManagerPlugin extends InitxPlugin {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "matchers", [
+      {
+        matching: "plugin",
+        description: "Plugin Manager"
+      }
+    ]);
+  }
+  async handle(_ctx, type, ...others) {
+    const [name] = others;
+    switch (type) {
+      case "list": {
+        showPluginList();
+        break;
+      }
+      case "add": {
+        await addPlugin(name);
+        break;
+      }
+      case "update": {
+        await updatePlugin();
+        break;
+      }
+      case "remove": {
+        await removePlugin(name);
+        break;
+      }
+      default: {
+        log.warn(`Unknown command: ${type}`);
+      }
+    }
+  }
+}
+
+export { PluginManagerPlugin as default };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@initx-plugin/manager",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "initx plugin manager",
+  "author": "imba97",
+  "license": "MIT",
+  "homepage": "https://github.com/initx-collective/initx-plugin-manager#readme",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:initx-collective/initx-plugin-manager.git"
+  },
+  "bugs": {
+    "url": "https://github.com/initx-collective/initx-plugin-manager/issues"
+  },
+  "keywords": [
+    "initx",
+    "initx-plugin"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@initx-plugin/core": "^0.0.23",
+    "@initx-plugin/utils": "^0.0.23",
+    "columnify": "^1.6.0",
+    "fs-extra": "^11.2.0",
+    "ora": "^8.1.1",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@imba97/eslint-config": "^0.0.4",
+    "@types/columnify": "^1.5.4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.9.0",
+    "bumpp": "^9.8.1",
+    "eslint": "^9.14.0",
+    "lint-staged": "^15.2.10",
+    "simple-git-hooks": "^2.11.1",
+    "typescript": "^5.6.3",
+    "unbuild": "^2.0.0"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --cache --flag unstable_ts_config --fix"
+  },
+  "scripts": {
+    "stub": "unbuild --stub",
+    "build": "unbuild",
+    "release": "bumpp",
+    "lint": "eslint --cache --flag unstable_ts_config"
+  }
+}