WIP: impl PluginService

packages/app/src/interfaces/plugin.ts

@@ -0,0 +1,25 @@
+export const GrowiPluginResourceType = {
+  Template: 'Template',
+  Style: 'Style',
+  Script: 'Script',
+} as const;
+export type GrowiPluginResourceType = typeof GrowiPluginResourceType[keyof typeof GrowiPluginResourceType];
+
+export type GrowiPluginOrigin = {
+  url: string,
+  ghBranch?: string,
+  ghTag?: string,
+}
+
+export type GrowiPlugin = {
+  isEnabled: boolean,
+  installedPath: string,
+  origin: GrowiPluginOrigin,
+  meta: GrowiPluginMeta,
+}
+
+export type GrowiPluginMeta = {
+  name: string,
+  type: GrowiPluginResourceType[],
+  author?: string,
+}

packages/app/src/server/service/plugin.ts

@@ -1,76 +1,108 @@
+import fs from 'fs';
+import path from 'path';
+
+import { GrowiPlugin, GrowiPluginOrigin } from '~/interfaces/plugin';
 import loggerFactory from '~/utils/logger';
 import { resolveFromRoot } from '~/utils/project-dir-utils';
 
-// import { PluginUtilsV4 } from './plugin-utils-v4';
+const logger = loggerFactory('growi:plugins:plugin-utils');
+
 
-const fs = require('graceful-fs');
+const pluginStoringPath = path.resolve(__dirname, '../../../tmp/plugins');
 
-const logger = loggerFactory('growi:plugins:plugin-utils');
+export class PluginService {
 
-class PluginUtils {
-
-  /**
-   * list plugin module objects
-   *  that starts with 'growi-plugin-' or 'crowi-plugin-'
-   * borrowing from: https://github.com/hexojs/hexo/blob/d1db459c92a4765620343b95789361cbbc6414c5/lib/hexo/load_plugins.js#L17
-   *
-   * @returns array of objects
-   *   [
-   *     { name: 'growi-plugin-...', requiredVersion: '^1.0.0', installedVersion: '1.0.0' },
-   *     { name: 'growi-plugin-...', requiredVersion: '^1.0.0', installedVersion: '1.0.0' },
-   *     ...
-   *   ]
-   *
-   * @memberOf PluginService
-   */
-  listPlugins() {
-    const packagePath = resolveFromRoot('package.json');
-
-    // Make sure package.json exists
-    if (!fs.existsSync(packagePath)) {
-      return [];
-    }
-
-    // Read package.json and find dependencies
-    const content = fs.readFileSync(packagePath);
-    const json = JSON.parse(content);
-    const deps = json.dependencies || {};
-
-    const pluginNames = Object.keys(deps).filter((name) => {
-      return /^@growi\/plugin-/.test(name);
-    });
-
-    return pluginNames.map((name) => {
-      return {
-        name,
-        requiredVersion: deps[name],
-        installedVersion: this.getVersion(name),
-      };
-    });
+  static async install(origin: GrowiPluginOrigin): Promise<void> {
+    return;
   }
 
-  /**
-   * list plugin module names that starts with 'crowi-plugin-'
-   *
-   * @returns array of plugin names
-   *
-   * @memberOf PluginService
-   */
-  listPluginNames() {
-    const plugins = this.listPlugins();
-    return plugins.map((plugin) => { return plugin.name });
+  static detectPlugins(origin: GrowiPluginOrigin, installedPath: string): GrowiPlugin[] {
+    return [];
   }
 
-  getVersion(packageName) {
-    const packagePath = resolveFromRoot(`../../node_modules/${packageName}/package.json`);
+  // listPlugins() {
+  //   const scopedPackages: string[] = [];
 
-    // Read package.json and find version
-    const content = fs.readFileSync(packagePath);
-    const json = JSON.parse(content);
-    return json.version || '';
-  }
+  //   fs.readdirSync(nodeModulesPath)
+  //     .filter(name => scopes.includes(name))
+  //     .forEach((scope) => {
+  //       fs.readdirSync(path.resolve(nodeModulesPath, scope))
+  //         .filter(name => !name.startsWith('.'))
+  //         .forEach((folderName) => {
+  //           const { name } = require(path.resolve(
+  //             nodeModulesPath,
+  //             scope,
+  //             folderName,
+  //             'package.json',
+  //           ));
+  //           if (!opts.ignorePackageNames.includes(name)) {
+  //             scopedPackages.push(name);
+  //           }
+  //         });
+  //     });
 
-}
+  //   return scopedPackages;
+  // }
+
+  // /**
+  //  * list plugin module objects
+  //  *  that starts with 'growi-plugin-' or 'crowi-plugin-'
+  //  * borrowing from: https://github.com/hexojs/hexo/blob/d1db459c92a4765620343b95789361cbbc6414c5/lib/hexo/load_plugins.js#L17
+  //  *
+  //  * @returns array of objects
+  //  *   [
+  //  *     { name: 'growi-plugin-...', requiredVersion: '^1.0.0', installedVersion: '1.0.0' },
+  //  *     { name: 'growi-plugin-...', requiredVersion: '^1.0.0', installedVersion: '1.0.0' },
+  //  *     ...
+  //  *   ]
+  //  *
+  //  * @memberOf PluginService
+  //  */
+  // listPlugins() {
+  //   const packagePath = resolveFromRoot('package.json');
+
+  //   // Make sure package.json exists
+  //   if (!fs.existsSync(packagePath)) {
+  //     return [];
+  //   }
 
-module.exports = PluginUtils;
-export default PluginUtils;
+  //   // Read package.json and find dependencies
+  //   const content = fs.readFileSync(packagePath);
+  //   const json = JSON.parse(content);
+  //   const deps = json.dependencies || {};
+
+  //   const pluginNames = Object.keys(deps).filter((name) => {
+  //     return /^@growi\/plugin-/.test(name);
+  //   });
+
+  //   return pluginNames.map((name) => {
+  //     return {
+  //       name,
+  //       requiredVersion: deps[name],
+  //       installedVersion: this.getVersion(name),
+  //     };
+  //   });
+  // }
+
+  // /**
+  //  * list plugin module names that starts with 'crowi-plugin-'
+  //  *
+  //  * @returns array of plugin names
+  //  *
+  //  * @memberOf PluginService
+  //  */
+  // listPluginNames() {
+  //   const plugins = this.listPlugins();
+  //   return plugins.map((plugin) => { return plugin.name });
+  // }
+
+  // getVersion(packageName) {
+  //   const packagePath = resolveFromRoot(`../../node_modules/${packageName}/package.json`);
+
+  //   // Read package.json and find version
+  //   const content = fs.readFileSync(packagePath);
+  //   const json = JSON.parse(content);
+  //   return json.version || '';
+  // }
+
+}