@initx-plugin/core 0.0.26 → 0.0.28

package/dist/index.d.mts

@@ -1,35 +1,6 @@
-type MaybeArray<T> = T | T[];
-type MaybePromise<T> = T | Promise<T>;
+import { MatcherRules } from 'matchinitx';
 
-interface MatcherSetup {
-    /**
-     * Matching string or RegExp
-     *
-     * The key that was used to match the handler
-     */
-    matching: MaybeArray<string | RegExp>;
-}
-type BaseMatchers<TMatcher> = TMatcher & MatcherSetup;
-type TypeMatchers<TMatcher> = Record<string, BaseMatchers<TMatcher>>;
-type ResultFunction<TResult, TMatcher> = (matcher: TMatcher, ...others: string[]) => TResult;
-type Matchers<TMatcher extends object = object> = MaybeArray<BaseMatchers<TMatcher>> | TypeMatchers<TMatcher>;
-declare class InitxMatcher$1<TResult, TMatcher extends object> {
-    private resultFunction;
-    constructor(fn: ResultFunction<TResult, TMatcher>);
-    match(matchers: Matchers<TMatcher>, key: string, ...others: string[]): TResult[];
-    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 object = object>(fn: ResultFunction<TResult, TMatcher>): InitxMatcher$1<TResult, TMatcher>;
+type MaybePromise<T> = T | Promise<T>;
 
 interface PackageInfo {
     root: string;
@@ -60,7 +31,7 @@ declare function fetchPlugins(): Promise<InitxPluginInfo[]>;
 declare function loadPlugins(): Promise<LoadPluginResult[]>;
 declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): MatchedPlugin[];
 
-type InitxMatcher<TMatcher extends object = object> = TMatcher & {
+type InitxRuleFields<TRule extends object = object> = TRule & {
     /**
      * Description of the handler
      *
@@ -68,7 +39,7 @@ type InitxMatcher<TMatcher extends object = object> = TMatcher & {
      */
     description: string;
 };
-type InitxMatchers<TMatcher extends object = object> = Matchers<InitxMatcher<TMatcher>>;
+type InitxMatcherRules<TRule extends object = object> = MatcherRules<InitxRuleFields<TRule>>;
 interface HandlerInfo {
     handler: () => MaybePromise<void>;
     description: string;
@@ -100,7 +71,7 @@ interface InitxRunContext extends InitxBaseContext {
      */
     packageInfo: PackageInfo;
 }
-interface InitxContext<TStore extends object = object, TMatcher extends object = object> extends InitxRunContext {
+interface InitxContext<TStore extends object = object, TRule extends object = object> extends InitxRunContext {
     /**
      * Store
      *
@@ -108,14 +79,14 @@ interface InitxContext<TStore extends object = object, TMatcher extends object =
      */
     store: TStore;
     /**
-     * Matcher
+     * Rule
      *
-     * Matched matcher object, you can get custom fields, excluded `matching`
+     * Matched rule object, you can get custom fields, excluded `matching`
      */
-    matcher: InitxMatcher<TMatcher>;
+    rule: InitxRuleFields<TRule>;
 }
 declare abstract class InitxPlugin<TStore extends object = object> {
-    abstract matchers: InitxMatchers;
+    abstract rules: InitxMatcherRules;
     abstract handle(context: InitxContext, ...others: string[]): MaybePromise<void>;
     defaultStore?: TStore;
     run(context: InitxRunContext, ...others: string[]): HandlerInfo[];
@@ -125,4 +96,4 @@ declare abstract class InitxPlugin<TStore extends object = object> {
 declare function createStore(name: string, defaultStore?: Record<string, any>): any;
 declare function writeStore(name: string): void;
 
-export { type HandlerInfo, type InitxBaseContext, type InitxContext, type InitxMatchers, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type Matchers, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, useInitxMatcher, writeStore };
+export { type HandlerInfo, type InitxBaseContext, type InitxContext, type InitxMatcherRules as InitxMatchers, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };

package/dist/index.d.ts

@@ -1,35 +1,6 @@
-type MaybeArray<T> = T | T[];
-type MaybePromise<T> = T | Promise<T>;
+import { MatcherRules } from 'matchinitx';
 
-interface MatcherSetup {
-    /**
-     * Matching string or RegExp
-     *
-     * The key that was used to match the handler
-     */
-    matching: MaybeArray<string | RegExp>;
-}
-type BaseMatchers<TMatcher> = TMatcher & MatcherSetup;
-type TypeMatchers<TMatcher> = Record<string, BaseMatchers<TMatcher>>;
-type ResultFunction<TResult, TMatcher> = (matcher: TMatcher, ...others: string[]) => TResult;
-type Matchers<TMatcher extends object = object> = MaybeArray<BaseMatchers<TMatcher>> | TypeMatchers<TMatcher>;
-declare class InitxMatcher$1<TResult, TMatcher extends object> {
-    private resultFunction;
-    constructor(fn: ResultFunction<TResult, TMatcher>);
-    match(matchers: Matchers<TMatcher>, key: string, ...others: string[]): TResult[];
-    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 object = object>(fn: ResultFunction<TResult, TMatcher>): InitxMatcher$1<TResult, TMatcher>;
+type MaybePromise<T> = T | Promise<T>;
 
 interface PackageInfo {
     root: string;
@@ -60,7 +31,7 @@ declare function fetchPlugins(): Promise<InitxPluginInfo[]>;
 declare function loadPlugins(): Promise<LoadPluginResult[]>;
 declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): MatchedPlugin[];
 
-type InitxMatcher<TMatcher extends object = object> = TMatcher & {
+type InitxRuleFields<TRule extends object = object> = TRule & {
     /**
      * Description of the handler
      *
@@ -68,7 +39,7 @@ type InitxMatcher<TMatcher extends object = object> = TMatcher & {
      */
     description: string;
 };
-type InitxMatchers<TMatcher extends object = object> = Matchers<InitxMatcher<TMatcher>>;
+type InitxMatcherRules<TRule extends object = object> = MatcherRules<InitxRuleFields<TRule>>;
 interface HandlerInfo {
     handler: () => MaybePromise<void>;
     description: string;
@@ -100,7 +71,7 @@ interface InitxRunContext extends InitxBaseContext {
      */
     packageInfo: PackageInfo;
 }
-interface InitxContext<TStore extends object = object, TMatcher extends object = object> extends InitxRunContext {
+interface InitxContext<TStore extends object = object, TRule extends object = object> extends InitxRunContext {
     /**
      * Store
      *
@@ -108,14 +79,14 @@ interface InitxContext<TStore extends object = object, TMatcher extends object =
      */
     store: TStore;
     /**
-     * Matcher
+     * Rule
      *
-     * Matched matcher object, you can get custom fields, excluded `matching`
+     * Matched rule object, you can get custom fields, excluded `matching`
      */
-    matcher: InitxMatcher<TMatcher>;
+    rule: InitxRuleFields<TRule>;
 }
 declare abstract class InitxPlugin<TStore extends object = object> {
-    abstract matchers: InitxMatchers;
+    abstract rules: InitxMatcherRules;
     abstract handle(context: InitxContext, ...others: string[]): MaybePromise<void>;
     defaultStore?: TStore;
     run(context: InitxRunContext, ...others: string[]): HandlerInfo[];
@@ -125,4 +96,4 @@ declare abstract class InitxPlugin<TStore extends object = object> {
 declare function createStore(name: string, defaultStore?: Record<string, any>): any;
 declare function writeStore(name: string): void;
 
-export { type HandlerInfo, type InitxBaseContext, type InitxContext, type InitxMatchers, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type Matchers, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, useInitxMatcher, writeStore };
+export { type HandlerInfo, type InitxBaseContext, type InitxContext, type InitxMatcherRules as InitxMatchers, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };

package/dist/index.mjs

@@ -1,259 +1 @@
-import { homedir } from 'node:os';
-import path from 'node:path';
-import { defu } from 'defu';
-import fs from 'fs-extra';
-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"];
-    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 = {}) {
-  fs.ensureDirSync(path.resolve(INITX_DIR, name));
-  const storePath = resolveStore(name);
-  const generateResult = (resultData) => {
-    writeJson(storePath, resultData);
-    return useProxy(resultData);
-  };
-  if (!fs.existsSync(storePath)) {
-    return generateResult(defaultStore);
-  }
-  let json;
-  try {
-    const fileJson = fs.readJsonSync(storePath);
-    json = defu(fileJson, defaultStore);
-  } catch (e) {
-    json = defaultStore;
-  }
-  return generateResult(json);
-}
-function writeStore(name) {
-  if (!rewritedCache) {
-    return;
-  }
-  writeJson(resolveStore(name), rewritedCache);
-}
-function writeJson(path2, data) {
-  fs.writeJsonSync(path2, data, {
-    spaces: 2
-  });
-}
-function useProxy(obj = {}) {
-  const isPlainObject = (value) => {
-    return Object.prototype.toString.call(value) === "[object Object]";
-  };
-  const createDeepProxy = (target) => {
-    return new Proxy(target, {
-      get(target2, key) {
-        const value = Reflect.get(target2, key);
-        if (isPlainObject(value)) {
-          return createDeepProxy(value);
-        }
-        return value;
-      },
-      set(target2, key, value) {
-        const success = Reflect.set(target2, key, value);
-        rewritedCache = target2;
-        return success;
-      }
-    });
-  };
-  return createDeepProxy(obj);
-}
-
-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 InitxPlugin {
-  constructor() {
-    __publicField(this, "defaultStore");
-  }
-  run(context, ...others) {
-    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, matcher, ...others) {
-    const store = createStore(context.packageInfo.name, this.defaultStore);
-    await this.handle({ ...context, matcher, store }, ...others);
-    writeStore(context.packageInfo.name);
-  }
-}
-
-async function fetchPlugins() {
-  const { content: nodeModules } = await c("npm", ["root", "-g"]);
-  const communityPlugins = fs.readdirSync(nodeModules);
-  const officialPluginPath = path.join(nodeModules, "@initx-plugin");
-  const officialPlugins = fs.existsSync(officialPluginPath) ? fs.readdirSync(officialPluginPath).map((name) => `@initx-plugin/${name}`) : [];
-  const regexps = {
-    plugin: /^(?:@initx-plugin\/|initx-plugin-)/,
-    exclude: /@initx-plugin\/(?:core|utils)$/
-  };
-  return [
-    ...officialPlugins,
-    ...communityPlugins
-  ].filter(
-    (name) => regexps.plugin.test(name) && !regexps.exclude.test(name)
-  ).map((name) => ({
-    name,
-    root: path.join(nodeModules, name)
-  }));
-}
-async function loadPlugins() {
-  const pluginsInfo = await fetchPlugins();
-  const x = await import('importx');
-  return Promise.all(pluginsInfo.map(async ({ root }) => {
-    const InitxPluginClass = await x.import(root, import.meta.url).then((x2) => x2.default);
-    const packageAll = fs.readJsonSync(path.join(root, "package.json"));
-    const packageInfo = {
-      root,
-      name: packageAll.name,
-      version: packageAll.version,
-      description: packageAll.description,
-      author: packageAll.author,
-      homepage: packageAll.homepage
-    };
-    return {
-      packageInfo,
-      instance: new InitxPluginClass()
-    };
-  }));
-}
-function matchPlugins(plugins, { key, cliOptions }, ...others) {
-  const matchedHandlers = [];
-  for (const plugin of plugins) {
-    const { instance, packageInfo } = plugin;
-    const matched = instance.run({
-      key,
-      cliOptions,
-      packageInfo,
-      optionsList: Object.keys(cliOptions).filter((key2) => cliOptions[key2] === true).map((key2) => `--${key2}`)
-    }, ...others);
-    matchedHandlers.push(...matched.map((item) => ({
-      handler: item.handler,
-      description: item.description,
-      packageInfo
-    })));
-  }
-  return matchedHandlers;
-}
-
-export { InitxPlugin, createStore, fetchPlugins, loadPlugins, matchPlugins, useInitxMatcher, writeStore };
+import{useInitxMatcher as S}from"matchinitx";import{homedir as k}from"node:os";import u from"node:path";import{defu as j}from"defu";import c from"fs-extra";import{c as w}from"@initx-plugin/utils";let p=null;const m=u.resolve(k(),".initx"),I="store.json",f=r=>u.resolve(m,r,I);function d(r,e={}){c.ensureDirSync(u.resolve(m,r));const n=f(r),i=o=>(h(n,o),P(o));if(!c.existsSync(n))return i(e);let t;try{const o=c.readJsonSync(n);t=j(o,e)}catch{t=e}return i(t)}function g(r){p&&h(f(r),p)}function h(r,e){c.writeJsonSync(r,e,{spaces:2})}function P(r={}){const e=i=>Object.prototype.toString.call(i)==="[object Object]",n=i=>new Proxy(i,{get(t,o){const a=Reflect.get(t,o);return e(a)?n(a):a},set(t,o,a){const l=Reflect.set(t,o,a);return p=t,l}});return n(r)}class v{defaultStore;run(e,...n){return S((i,...t)=>({handler:()=>this.executeHandle(e,i,...t),description:i.description})).match(this.rules,e.key,...n)}async executeHandle(e,n,...i){const t=d(e.packageInfo.name,this.defaultStore);await this.handle({...e,rule:n,store:t},...i),g(e.packageInfo.name)}}async function y(){const{content:r}=await w("npm",["root","-g"]),e=c.readdirSync(r),n=u.join(r,"@initx-plugin"),i=c.existsSync(n)?c.readdirSync(n).map(o=>`@initx-plugin/${o}`):[],t={plugin:/^(?:@initx-plugin\/|initx-plugin-)/,exclude:/@initx-plugin\/(?:core|utils)$/};return[...i,...e].filter(o=>t.plugin.test(o)&&!t.exclude.test(o)).map(o=>({name:o,root:u.join(r,o)}))}async function O(){const r=await y(),e=await import("importx");return Promise.all(r.map(async({root:n})=>{const i=await e.import(n,import.meta.url).then(o=>o.default),t=c.readJsonSync(u.join(n,"package.json"));return{packageInfo:{root:n,name:t.name,version:t.version,description:t.description,author:t.author,homepage:t.homepage},instance:new i}}))}function b(r,{key:e,cliOptions:n},...i){const t=[];for(const o of r){const{instance:a,packageInfo:l}=o,x=a.run({key:e,cliOptions:n,packageInfo:l,optionsList:Object.keys(n).filter(s=>n[s]===!0).map(s=>`--${s}`)},...i);t.push(...x.map(s=>({handler:s.handler,description:s.description,packageInfo:l})))}return t}export{v as InitxPlugin,d as createStore,y as fetchPlugins,O as loadPlugins,b as matchPlugins,g as writeStore};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@initx-plugin/core",
   "type": "module",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "core module for initx plugins",
   "license": "MIT",
   "homepage": "https://github.com/initx-collective/initx#readme",
@@ -24,8 +24,9 @@
   "dependencies": {
     "defu": "^6.1.4",
     "fs-extra": "^11.2.0",
-    "importx": "^0.5.0",
-    "@initx-plugin/utils": "0.0.26"
+    "importx": "^0.5.1",
+    "matchinitx": "^0.0.2",
+    "@initx-plugin/utils": "0.0.28"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4"