@initx-plugin/core 0.0.23 → 0.0.24

package/dist/index.d.mts

@@ -1,3 +1,47 @@
+type MaybeArray<T> = T | T[];
+type MaybePromise<T> = T | Promise<T>;
+
+interface MatcherCommon {
+    /**
+     * Description of the handler
+     *
+     * If multiple handlers are matched, this description will be displayed
+     */
+    description: string;
+}
+interface MatcherSetup {
+    /**
+     * Matching string or RegExp
+     *
+     * The key that was used to match the handler
+     */
+    matching: MaybeArray<string | RegExp>;
+}
+type Matcher<TMatcher> = TMatcher & MatcherCommon;
+type ResultFunction<TResult, TMatcher> = (matcher: Matcher<TMatcher>, ...others: string[]) => TResult & TMatcher;
+type BaseMatchers<TMatcher> = Matcher<TMatcher> & MatcherSetup;
+type TypeMatchers<TMatcher> = Record<string, BaseMatchers<TMatcher>>;
+type MatcherOthersDefault = Record<any, any>;
+type MatcherOthers<T extends MatcherOthersDefault = MatcherOthersDefault> = T;
+type Matchers<TMatcher extends MatcherOthers = MatcherOthers> = MaybeArray<BaseMatchers<TMatcher>> | TypeMatchers<TMatcher>;
+declare class InitxMatcher<TResult, TMatcher extends Matcher<MatcherOthers>> {
+    private resultFunction;
+    constructor(fn: ResultFunction<TResult, TMatcher>);
+    match(matchers: Matchers, key: string, ...others: string[]): (TResult & TMatcher)[];
+    private matchBaseMatchers;
+    private matchArrayBaseMatchers;
+    private matchTypeMatchers;
+    private isBaseMatchers;
+    private isArrayBaseMatchers;
+    private alwaysArray;
+    private isObject;
+    private isPassed;
+    private omit;
+    private buildResultMatcher;
+    private buildResultFunction;
+}
+declare function useInitxMatcher<TResult, TMatcher extends Matcher<MatcherOthers> = Matcher<MatcherOthers>>(fn: ResultFunction<TResult, TMatcher>): InitxMatcher<TResult, TMatcher>;
+
 interface PackageInfo {
     root: string;
     name: string;
@@ -27,19 +71,6 @@ declare function fetchPlugins(): Promise<InitxPluginInfo[]>;
 declare function loadPlugins(): Promise<LoadPluginResult[]>;
 declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): MatchedPlugin[];
 
-type MaybeArray<T> = T | T[];
-type MaybePromise<T> = T | Promise<T>;
-interface BaseMatchers {
-    matching: MaybeArray<string | RegExp>;
-    /**
-     * Description of the handler
-     *
-     * If multiple handlers are matched, this description will be displayed
-     */
-    description: string;
-}
-type TypeMatchers = Record<string, BaseMatchers>;
-type Matchers = MaybeArray<BaseMatchers> | TypeMatchers;
 type PluginStore = Record<string, any>;
 interface HandlerInfo {
     handler: () => MaybePromise<void>;
@@ -72,30 +103,29 @@ interface InitxRunContext extends InitxBaseContext {
      */
     packageInfo: PackageInfo;
 }
-interface InitxContext<TStore extends PluginStore = PluginStore> extends InitxRunContext {
+interface InitxContext<TStore extends PluginStore = PluginStore, TMatcher extends MatcherOthers<MatcherOthersDefault> = MatcherOthers<MatcherOthersDefault>> extends InitxRunContext {
     /**
      * Store
      *
      * Store data in memory, and write to disk when the program exits
      */
     store: TStore;
+    /**
+     * Matcher
+     *
+     * Matched matcher object, you can get custom fields, excluded `matching`
+     */
+    matcher: Matcher<TMatcher>;
 }
-declare abstract class InitxPlugin<TStore extends PluginStore = PluginStore> {
+declare abstract class InitxPlugin<TStore extends PluginStore = PluginStore, TMatcher extends MatcherOthers = MatcherOthers> {
     abstract matchers: Matchers;
-    abstract handle(options: InitxContext<TStore>, ...others: string[]): MaybePromise<void>;
+    abstract handle(context: InitxContext<TStore, TMatcher>, ...others: string[]): MaybePromise<void>;
     defaultStore?: TStore;
     run(context: InitxRunContext, ...others: string[]): HandlerInfo[];
-    private matchBaseMatchers;
-    private matchArrayBaseMatchers;
-    private matchTypeMatchers;
-    private isBaseMatchers;
-    private isArrayBaseMatchers;
-    private isObject;
-    private isPassed;
     private executeHandle;
 }
 
-declare function createStore({ name }: PackageInfo, defaultStore?: Record<string, any>): any;
-declare function writeStore({ name }: PackageInfo): void;
+declare function createStore(name: string, defaultStore?: Record<string, any>): any;
+declare function writeStore(name: string): void;
 
-export { type HandlerInfo, type InitxBaseContext, type InitxContext, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };
+export { type HandlerInfo, type InitxBaseContext, type InitxContext, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type Matcher, type MatcherOthers, type MatcherOthersDefault, type Matchers, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, useInitxMatcher, writeStore };

package/dist/index.d.ts

@@ -1,3 +1,47 @@
+type MaybeArray<T> = T | T[];
+type MaybePromise<T> = T | Promise<T>;
+
+interface MatcherCommon {
+    /**
+     * Description of the handler
+     *
+     * If multiple handlers are matched, this description will be displayed
+     */
+    description: string;
+}
+interface MatcherSetup {
+    /**
+     * Matching string or RegExp
+     *
+     * The key that was used to match the handler
+     */
+    matching: MaybeArray<string | RegExp>;
+}
+type Matcher<TMatcher> = TMatcher & MatcherCommon;
+type ResultFunction<TResult, TMatcher> = (matcher: Matcher<TMatcher>, ...others: string[]) => TResult & TMatcher;
+type BaseMatchers<TMatcher> = Matcher<TMatcher> & MatcherSetup;
+type TypeMatchers<TMatcher> = Record<string, BaseMatchers<TMatcher>>;
+type MatcherOthersDefault = Record<any, any>;
+type MatcherOthers<T extends MatcherOthersDefault = MatcherOthersDefault> = T;
+type Matchers<TMatcher extends MatcherOthers = MatcherOthers> = MaybeArray<BaseMatchers<TMatcher>> | TypeMatchers<TMatcher>;
+declare class InitxMatcher<TResult, TMatcher extends Matcher<MatcherOthers>> {
+    private resultFunction;
+    constructor(fn: ResultFunction<TResult, TMatcher>);
+    match(matchers: Matchers, key: string, ...others: string[]): (TResult & TMatcher)[];
+    private matchBaseMatchers;
+    private matchArrayBaseMatchers;
+    private matchTypeMatchers;
+    private isBaseMatchers;
+    private isArrayBaseMatchers;
+    private alwaysArray;
+    private isObject;
+    private isPassed;
+    private omit;
+    private buildResultMatcher;
+    private buildResultFunction;
+}
+declare function useInitxMatcher<TResult, TMatcher extends Matcher<MatcherOthers> = Matcher<MatcherOthers>>(fn: ResultFunction<TResult, TMatcher>): InitxMatcher<TResult, TMatcher>;
+
 interface PackageInfo {
     root: string;
     name: string;
@@ -27,19 +71,6 @@ declare function fetchPlugins(): Promise<InitxPluginInfo[]>;
 declare function loadPlugins(): Promise<LoadPluginResult[]>;
 declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): MatchedPlugin[];
 
-type MaybeArray<T> = T | T[];
-type MaybePromise<T> = T | Promise<T>;
-interface BaseMatchers {
-    matching: MaybeArray<string | RegExp>;
-    /**
-     * Description of the handler
-     *
-     * If multiple handlers are matched, this description will be displayed
-     */
-    description: string;
-}
-type TypeMatchers = Record<string, BaseMatchers>;
-type Matchers = MaybeArray<BaseMatchers> | TypeMatchers;
 type PluginStore = Record<string, any>;
 interface HandlerInfo {
     handler: () => MaybePromise<void>;
@@ -72,30 +103,29 @@ interface InitxRunContext extends InitxBaseContext {
      */
     packageInfo: PackageInfo;
 }
-interface InitxContext<TStore extends PluginStore = PluginStore> extends InitxRunContext {
+interface InitxContext<TStore extends PluginStore = PluginStore, TMatcher extends MatcherOthers<MatcherOthersDefault> = MatcherOthers<MatcherOthersDefault>> extends InitxRunContext {
     /**
      * Store
      *
      * Store data in memory, and write to disk when the program exits
      */
     store: TStore;
+    /**
+     * Matcher
+     *
+     * Matched matcher object, you can get custom fields, excluded `matching`
+     */
+    matcher: Matcher<TMatcher>;
 }
-declare abstract class InitxPlugin<TStore extends PluginStore = PluginStore> {
+declare abstract class InitxPlugin<TStore extends PluginStore = PluginStore, TMatcher extends MatcherOthers = MatcherOthers> {
     abstract matchers: Matchers;
-    abstract handle(options: InitxContext<TStore>, ...others: string[]): MaybePromise<void>;
+    abstract handle(context: InitxContext<TStore, TMatcher>, ...others: string[]): MaybePromise<void>;
     defaultStore?: TStore;
     run(context: InitxRunContext, ...others: string[]): HandlerInfo[];
-    private matchBaseMatchers;
-    private matchArrayBaseMatchers;
-    private matchTypeMatchers;
-    private isBaseMatchers;
-    private isArrayBaseMatchers;
-    private isObject;
-    private isPassed;
     private executeHandle;
 }
 
-declare function createStore({ name }: PackageInfo, defaultStore?: Record<string, any>): any;
-declare function writeStore({ name }: PackageInfo): void;
+declare function createStore(name: string, defaultStore?: Record<string, any>): any;
+declare function writeStore(name: string): void;
 
-export { type HandlerInfo, type InitxBaseContext, type InitxContext, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };
+export { type HandlerInfo, type InitxBaseContext, type InitxContext, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type Matcher, type MatcherOthers, type MatcherOthersDefault, type Matchers, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, useInitxMatcher, writeStore };

package/dist/index.mjs

@@ -4,11 +4,117 @@ import fs from 'fs-extra';
 import { defu } from 'defu';
 import { c } from '@initx-plugin/utils';
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class InitxMatcher {
+  constructor(fn) {
+    __publicField$1(this, "resultFunction");
+    this.resultFunction = fn;
+  }
+  match(matchers, key, ...others) {
+    if (this.isBaseMatchers(matchers)) {
+      return this.matchBaseMatchers(matchers, key, ...others);
+    }
+    if (this.isArrayBaseMatchers(matchers)) {
+      return this.matchArrayBaseMatchers(matchers, key, ...others);
+    }
+    if (this.isObject(matchers)) {
+      return this.matchTypeMatchers(matchers, key, ...others);
+    }
+    return [];
+  }
+  // BaseMatchers
+  matchBaseMatchers(matchers, key, ...others) {
+    if (!this.isPassed(matchers.matching, key)) {
+      return [];
+    }
+    return this.alwaysArray(
+      this.buildResultFunction(matchers, ...others)
+    );
+  }
+  matchArrayBaseMatchers(matchers, key, ...others) {
+    const handlers = [];
+    for (let i = 0; i < matchers.length; i++) {
+      const matcher = matchers[i];
+      const isPassed = this.isPassed(matcher.matching, key);
+      if (isPassed) {
+        handlers.push(
+          this.buildResultFunction(matcher, ...others)
+        );
+      }
+    }
+    return handlers;
+  }
+  matchTypeMatchers(matchers, key, ...others) {
+    const handlers = [];
+    const keys = Object.keys(matchers);
+    for (let i = 0; i < keys.length; i++) {
+      const matcher = matchers[keys[i]];
+      const isPassed = this.isPassed(matcher.matching, key);
+      if (isPassed) {
+        handlers.push(
+          this.buildResultFunction(matcher, keys[i], ...others)
+        );
+      }
+    }
+    return handlers;
+  }
+  isBaseMatchers(matchers) {
+    const keys = Object.keys(matchers);
+    const requiredKeys = ["matching", "description"];
+    return this.isObject(matchers) && keys.length >= 2 && requiredKeys.every((key) => keys.includes(key));
+  }
+  isArrayBaseMatchers(matchers) {
+    return Array.isArray(matchers) && matchers.every(this.isBaseMatchers.bind(this));
+  }
+  alwaysArray(value) {
+    return Array.isArray(value) ? value : [value];
+  }
+  isObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+  }
+  isPassed(matchers, key) {
+    const tests = Array.isArray(matchers) ? matchers : [matchers];
+    return tests.some((test) => {
+      if (typeof test === "string") {
+        return test === key;
+      }
+      return test.test(key);
+    });
+  }
+  omit(obj, keys) {
+    const result = {};
+    for (const key in obj) {
+      if (!keys.includes(key)) {
+        result[key] = obj[key];
+      }
+    }
+    return result;
+  }
+  buildResultMatcher(matcher) {
+    return this.omit(matcher, ["matching"]);
+  }
+  buildResultFunction(matcher, ...others) {
+    const buildedMatcher = this.buildResultMatcher(matcher);
+    return this.resultFunction(
+      buildedMatcher,
+      ...others
+    );
+  }
+}
+function useInitxMatcher(fn) {
+  return new InitxMatcher(fn);
+}
+
 let rewritedCache = null;
 const INITX_DIR = path.resolve(homedir(), ".initx");
 const STORE_FILE_NAME = "store.json";
 const resolveStore = (name) => path.resolve(INITX_DIR, name, STORE_FILE_NAME);
-function createStore({ name }, defaultStore = {}) {
+function createStore(name, defaultStore = {}) {
   fs.ensureDirSync(path.resolve(INITX_DIR, name));
   const storePath = resolveStore(name);
   const generateResult = (resultData) => {
@@ -27,7 +133,7 @@ function createStore({ name }, defaultStore = {}) {
   }
   return generateResult(json);
 }
-function writeStore({ name }) {
+function writeStore(name) {
   if (!rewritedCache) {
     return;
   }
@@ -72,81 +178,23 @@ class InitxPlugin {
     __publicField(this, "defaultStore");
   }
   run(context, ...others) {
-    if (this.isBaseMatchers(this.matchers)) {
-      return this.matchBaseMatchers(this.matchers, context, ...others);
-    }
-    if (this.isArrayBaseMatchers(this.matchers)) {
-      return this.matchArrayBaseMatchers(this.matchers, context, ...others);
-    }
-    if (this.isObject(this.matchers)) {
-      return this.matchTypeMatchers(this.matchers, context, ...others);
-    }
-    return [];
-  }
-  // BaseMatchers
-  matchBaseMatchers(matchers, context, ...others) {
-    if (!this.isPassed(matchers.matching, context.key)) {
-      return [];
-    }
-    return [
-      {
-        handler: () => this.executeHandle(context, ...others),
-        description: matchers.description
-      }
-    ];
-  }
-  matchArrayBaseMatchers(matchers, context, ...others) {
-    const handlers = [];
-    for (let i = 0; i < matchers.length; i++) {
-      const matcher = matchers[i];
-      const isPassed = this.isPassed(matcher.matching, context.key);
-      if (isPassed) {
-        handlers.push({
-          handler: () => this.executeHandle(context, ...others),
-          description: matcher.description
-        });
-      }
-    }
-    return handlers;
-  }
-  matchTypeMatchers(matchers, context, ...others) {
-    const handlers = [];
-    const keys = Object.keys(matchers);
-    for (let i = 0; i < keys.length; i++) {
-      const matcher = matchers[keys[i]];
-      const isPassed = this.isPassed(matcher.matching, context.key);
-      if (isPassed) {
-        handlers.push({
-          handler: () => this.executeHandle(context, keys[i], ...others),
-          description: matcher.description
-        });
-      }
-    }
-    return handlers;
-  }
-  isBaseMatchers(matchers) {
-    const keys = Object.keys(matchers);
-    return this.isObject(matchers) && keys.length === 2 && keys.every((key) => key === "matching" || key === "description");
-  }
-  isArrayBaseMatchers(matchers) {
-    return Array.isArray(matchers) && matchers.every(this.isBaseMatchers.bind(this));
-  }
-  isObject(value) {
-    return typeof value === "object" && value !== null && !Array.isArray(value);
-  }
-  isPassed(matchers, key) {
-    const tests = Array.isArray(matchers) ? matchers : [matchers];
-    return tests.some((test) => {
-      if (typeof test === "string") {
-        return test === key;
-      }
-      return test.test(key);
-    });
+    const initxMatcher = useInitxMatcher(
+      (matcher, ...others2) => ({
+        handler: () => this.executeHandle(context, matcher, ...others2),
+        description: matcher.description
+      })
+    );
+    const matchedHandlers = initxMatcher.match(
+      this.matchers,
+      context.key,
+      ...others
+    );
+    return matchedHandlers;
   }
-  async executeHandle(context, ...others) {
-    const store = createStore(context.packageInfo, this.defaultStore);
-    await this.handle({ ...context, store }, ...others);
-    writeStore(context.packageInfo);
+  async executeHandle(context, matcher, ...others) {
+    const store = createStore(context.packageInfo.name, this.defaultStore);
+    await this.handle({ ...context, matcher, store }, ...others);
+    writeStore(context.packageInfo.name);
   }
 }
 
@@ -209,4 +257,4 @@ function matchPlugins(plugins, { key, cliOptions }, ...others) {
   return matchedHandlers;
 }
 
-export { InitxPlugin, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };
+export { InitxPlugin, createStore, fetchPlugins, loadPlugins, matchPlugins, useInitxMatcher, writeStore };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@initx-plugin/core",
   "type": "module",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "core module for initx plugins",
   "license": "MIT",
   "homepage": "https://github.com/initx-collective/initx#readme",
@@ -25,7 +25,7 @@
     "defu": "^6.1.4",
     "fs-extra": "^11.2.0",
     "importx": "^0.5.0",
-    "@initx-plugin/utils": "0.0.23"
+    "@initx-plugin/utils": "0.0.24"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4"