@initx-plugin/core 0.0.29 → 0.0.31

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,11 +103,11 @@ 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;
 }
 
-declare function createStore(name: string, defaultStore?: Record<string, any>): any;
+declare function createStore(name: string, defaultStore?: Record<string, any>): Record<string, any>;
 declare function writeStore(name: string): void;
 
 export { type HandlerInfo, type InitxBaseContext, type InitxContext, type InitxMatcherRules, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };

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,11 +103,11 @@ 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;
 }
 
-declare function createStore(name: string, defaultStore?: Record<string, any>): any;
+declare function createStore(name: string, defaultStore?: Record<string, any>): Record<string, any>;
 declare function writeStore(name: string): void;
 
 export { type HandlerInfo, type InitxBaseContext, type InitxContext, type InitxMatcherRules, InitxPlugin, type InitxPluginInfo, type LoadPluginResult, type MatchedPlugin, type PackageInfo, createStore, fetchPlugins, loadPlugins, matchPlugins, writeStore };

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@initx-plugin/core",
   "type": "module",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "description": "core module for initx plugins",
   "license": "MIT",
   "homepage": "https://github.com/initx-collective/initx#readme",
@@ -23,10 +23,11 @@
   ],
   "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",
+    "pathe": "^2.0.3",
+    "@initx-plugin/utils": "0.0.31"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4"