@initx-plugin/core 0.0.29 → 0.0.30

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { MatcherRules } from 'matchinitx';
 
 type MaybePromise<T> = T | Promise<T>;
+type OptionalValue = string | RegExp | undefined;
 
 interface PackageInfo {
     root: string;
@@ -29,7 +30,7 @@ type MatchedPlugin = HandlerInfo & {
 };
 declare function fetchPlugins(): Promise<InitxPluginInfo[]>;
 declare function loadPlugins(): Promise<LoadPluginResult[]>;
-declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): MatchedPlugin[];
+declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): Promise<MatchedPlugin[]>;
 
 type InitxRuleFields<TRule extends object = object> = TRule & {
     /**
@@ -38,12 +39,25 @@ type InitxRuleFields<TRule extends object = object> = TRule & {
      * If multiple handlers are matched, this description will be displayed
      */
     description: string;
+    /**
+     * Optional values
+     *
+     * Check if the first value is in the optional values.
+     *
+     * If no matching value is found in the optional value, the handler will not be executed.
+     */
+    optional?: OptionalValue[];
+    /**
+     * Verify function
+     *
+     * If the function returns false, the handler will not be executed.
+     */
+    verify?: (context: InitxRunContext, ...others: string[]) => MaybePromise<boolean>;
 };
 type InitxMatcherRules<TRule extends object = object> = MatcherRules<InitxRuleFields<TRule>>;
-interface HandlerInfo {
+type HandlerInfo = InitxRuleFields & {
     handler: () => MaybePromise<void>;
-    description: string;
-}
+};
 interface InitxBaseContext {
     /**
      * Matching string
@@ -89,7 +103,7 @@ declare abstract class InitxPlugin<TStore extends object = object> {
     abstract rules: InitxMatcherRules;
     abstract handle(context: InitxContext, ...others: string[]): MaybePromise<void>;
     defaultStore?: TStore;
-    run(context: InitxRunContext, ...others: string[]): HandlerInfo[];
+    run(context: InitxRunContext, ...others: string[]): Promise<HandlerInfo[]>;
     private executeHandle;
 }
 

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { MatcherRules } from 'matchinitx';
 
 type MaybePromise<T> = T | Promise<T>;
+type OptionalValue = string | RegExp | undefined;
 
 interface PackageInfo {
     root: string;
@@ -29,7 +30,7 @@ type MatchedPlugin = HandlerInfo & {
 };
 declare function fetchPlugins(): Promise<InitxPluginInfo[]>;
 declare function loadPlugins(): Promise<LoadPluginResult[]>;
-declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): MatchedPlugin[];
+declare function matchPlugins(plugins: LoadPluginResult[], { key, cliOptions }: InitxBaseContext, ...others: string[]): Promise<MatchedPlugin[]>;
 
 type InitxRuleFields<TRule extends object = object> = TRule & {
     /**
@@ -38,12 +39,25 @@ type InitxRuleFields<TRule extends object = object> = TRule & {
      * If multiple handlers are matched, this description will be displayed
      */
     description: string;
+    /**
+     * Optional values
+     *
+     * Check if the first value is in the optional values.
+     *
+     * If no matching value is found in the optional value, the handler will not be executed.
+     */
+    optional?: OptionalValue[];
+    /**
+     * Verify function
+     *
+     * If the function returns false, the handler will not be executed.
+     */
+    verify?: (context: InitxRunContext, ...others: string[]) => MaybePromise<boolean>;
 };
 type InitxMatcherRules<TRule extends object = object> = MatcherRules<InitxRuleFields<TRule>>;
-interface HandlerInfo {
+type HandlerInfo = InitxRuleFields & {
     handler: () => MaybePromise<void>;
-    description: string;
-}
+};
 interface InitxBaseContext {
     /**
      * Matching string
@@ -89,7 +103,7 @@ declare abstract class InitxPlugin<TStore extends object = object> {
     abstract rules: InitxMatcherRules;
     abstract handle(context: InitxContext, ...others: string[]): MaybePromise<void>;
     defaultStore?: TStore;
-    run(context: InitxRunContext, ...others: string[]): HandlerInfo[];
+    run(context: InitxRunContext, ...others: string[]): Promise<HandlerInfo[]>;
     private executeHandle;
 }
 

package/dist/index.mjs

@@ -1 +1 @@
-import{useInitxMatcher as k}from"matchinitx";import{homedir as w}from"node:os";import a from"node:path";import{defu as I}from"defu";import s from"fs-extra";import d from"node:process";import{c as $}from"@initx-plugin/utils";let m=null;const f=a.resolve(w(),".initx"),v="store.json",g=n=>a.resolve(f,n,v);function y(n,o={}){s.ensureDirSync(a.resolve(f,n));const i=g(n),e=c=>(x(i,c),O(c));if(!s.existsSync(i))return e(o);let t;try{const c=s.readJsonSync(i);t=I(c,o)}catch{t=o}return e(t)}function h(n){m&&x(g(n),m)}function x(n,o){s.writeJsonSync(n,o,{spaces:2})}function O(n={}){const o=e=>Object.prototype.toString.call(e)==="[object Object]",i=e=>new Proxy(e,{get(t,c){const r=Reflect.get(t,c);return o(r)?i(r):r},set(t,c,r){const u=Reflect.set(t,c,r);return m=t,u}});return i(n)}class P{defaultStore;run(o,...i){return k((e,...t)=>({handler:()=>this.executeHandle(o,e,...t),description:e.description})).match(this.rules,o.key,...i)}async executeHandle(o,i,...e){const t=y(o.packageInfo.name,this.defaultStore);await this.handle({...o,rule:i,store:t},...e),h(o.packageInfo.name)}}const l={plugin:/^(?:@initx-plugin\/|initx-plugin-)/,exclude:/@initx-plugin\/(?:core|utils)$/};async function b(){const n=a.join(d.cwd(),"package.json");if(!s.existsSync(n))return[];const o=s.readJsonSync(n),{dependencies:i={},devDependencies:e={}}=o;return Object.keys({...i,...e}).filter(t=>l.plugin.test(t)&&!l.exclude.test(t)).map(t=>({name:t,root:a.join(d.cwd(),"node_modules",t)}))}async function S(){const{content:n}=await $("npm",["root","-g"]),o=s.readdirSync(n),i=a.join(n,"@initx-plugin");return[...s.existsSync(i)?s.readdirSync(i).map(e=>`@initx-plugin/${e}`):[],...o].filter(e=>l.plugin.test(e)&&!l.exclude.test(e)).map(e=>({name:e,root:a.join(n,e)}))}async function J(){const n=await b(),o=n.map(({name:t})=>t),i=[...(await S()).filter(({name:t})=>!o.includes(t)),...n],e=await import("importx");return Promise.all(i.map(async({root:t})=>{const c=await e.import(t,import.meta.url).then(u=>u.default),r=s.readJsonSync(a.join(t,"package.json"));return{packageInfo:{root:t,name:r.name,version:r.version,description:r.description,author:r.author,homepage:r.homepage},instance:new c}}))}function D(n,{key:o,cliOptions:i},...e){const t=[];for(const c of n){const{instance:r,packageInfo:u}=c,j=r.run({key:o,cliOptions:i,packageInfo:u,optionsList:Object.keys(i).filter(p=>i[p]===!0).map(p=>`--${p}`)},...e);t.push(...j.map(p=>({handler:p.handler,description:p.description,packageInfo:u})))}return t}export{P as InitxPlugin,y as createStore,S as fetchPlugins,J as loadPlugins,D as matchPlugins,h as writeStore};
+import{useInitxMatcher as j}from"matchinitx";import{homedir as k}from"node:os";import s from"node:path";import{defu as v}from"defu";import c from"fs-extra";import f from"node:process";import{c as I}from"@initx-plugin/utils";let m=null;const d=s.resolve(k(),".initx"),O="store.json",y=o=>s.resolve(d,o,O);function g(o,t={}){c.ensureDirSync(s.resolve(d,o));const n=y(o),i=r=>(x(n,r),P(r));if(!c.existsSync(n))return i(t);let e;try{const r=c.readJsonSync(n);e=v(r,t)}catch{e=t}return i(e)}function h(o){m&&x(y(o),m)}function x(o,t){c.writeJsonSync(o,t,{spaces:2})}function P(o={}){const t=i=>Object.prototype.toString.call(i)==="[object Object]",n=i=>new Proxy(i,{get(e,r){const a=Reflect.get(e,r);return t(a)?n(a):a},set(e,r,a){const l=Reflect.set(e,r,a);return m=e,l}});return n(o)}const p={plugin:/^(?:@initx-plugin\/|initx-plugin-)/,exclude:/@initx-plugin\/(?:core|utils)$/};async function $(){const o=s.join(f.cwd(),"package.json");if(!c.existsSync(o))return[];const t=c.readJsonSync(o),{dependencies:n={},devDependencies:i={}}=t;return Object.keys({...n,...i}).filter(e=>p.plugin.test(e)&&!p.exclude.test(e)).map(e=>({name:e,root:s.join(f.cwd(),"node_modules",e)}))}async function S(){const{content:o}=await I("npm",["root","-g"]),t=c.readdirSync(o),n=s.join(o,"@initx-plugin");return[...c.existsSync(n)?c.readdirSync(n).map(i=>`@initx-plugin/${i}`):[],...t].filter(i=>p.plugin.test(i)&&!p.exclude.test(i)).map(i=>({name:i,root:s.join(o,i)}))}async function b(){const o=await $(),t=o.map(({name:e})=>e),n=[...(await S()).filter(({name:e})=>!t.includes(e)),...o],i=await import("importx");return Promise.all(n.map(async({root:e})=>{const r=await i.import(e,import.meta.url).then(l=>l.default),a=c.readJsonSync(s.join(e,"package.json"));return{packageInfo:{root:e,name:a.name,version:a.version,description:a.description,author:a.author,homepage:a.homepage},instance:new r}}))}async function J(o,{key:t,cliOptions:n},...i){const e=[];for(const r of o){const{instance:a,packageInfo:l}=r,w=await a.run({key:t,cliOptions:n,packageInfo:l,optionsList:Object.keys(n).filter(u=>n[u]===!0).map(u=>`--${u}`)},...i);e.push(...w.map(u=>({handler:u.handler,description:u.description,packageInfo:l})))}return e}function D(o,t){return o.some(n=>typeof n=="string"||typeof n>"u"?n===t:n.test(t))}class H{defaultStore;async run(t,...n){const i=j((e,...r)=>({handler:()=>this.executeHandle(t,e,...r),...e}));return(await Promise.all(i.match(this.rules,t.key,...n).map(async e=>e.verify&&!e.verify(t,...n)||e.optional&&!D(e.optional,n[0])?!1:e))).filter(Boolean)}async executeHandle(t,n,...i){const e=g(t.packageInfo.name,this.defaultStore);await this.handle({...t,rule:n,store:e},...i),h(t.packageInfo.name)}}export{H as InitxPlugin,g as createStore,S as fetchPlugins,b as loadPlugins,J as matchPlugins,h as writeStore};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@initx-plugin/core",
   "type": "module",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "description": "core module for initx plugins",
   "license": "MIT",
   "homepage": "https://github.com/initx-collective/initx#readme",
@@ -23,10 +23,10 @@
   ],
   "dependencies": {
     "defu": "^6.1.4",
-    "fs-extra": "^11.2.0",
-    "importx": "^0.5.1",
-    "matchinitx": "^0.0.2",
-    "@initx-plugin/utils": "0.0.29"
+    "fs-extra": "^11.3.0",
+    "importx": "^0.5.2",
+    "matchinitx": "^0.0.4",
+    "@initx-plugin/utils": "0.0.30"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4"