rpc4next-cli 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +13 -0
- package/package.json +41 -0
package/dist/index.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import{Command as jt}from"commander";import $t from"path";var A=["page.tsx","route.ts"],O=0,P=1,F=1,w=20,W="\u2192";import M from"path";var Z=(t,r)=>{let e=x(M.relative(M.dirname(t),r)).replace(/\.tsx?$/,"");return e.startsWith("../")||(e="./"+e),e},x=t=>t.replace(/\\/g,"/"),_=t=>M.relative(process.cwd(),t);import yt from"fs";import Yt from"path";var tt=["Query"];var Y="Endpoint",U="QueryKey",j="ParamsKey",et=[Y,j,U],rt="rpc4next/client";import lt from"fs";import v from"path";import{CATCH_ALL_PREFIX as Dt,DYNAMIC_PREFIX as Ot,HTTP_METHODS_EXCLUDE_OPTIONS as Ft,OPTIONAL_CATCH_ALL_PREFIX as wt}from"rpc4next-shared";import H from"path";var E=new Map,C=new Map,ot=(t,r)=>{let e=H.resolve(r);[...t.keys()].forEach(o=>{let n=H.resolve(o);(n===e||e.startsWith(n+H.sep))&&t.delete(o)})},nt=t=>{ot(E,t)},st=t=>{ot(C,t)};import vt from"fs";import Lt from"crypto";var it=(t,r)=>{let e=Lt.createHash("md5").update(`${t}::${r}`).digest("hex").slice(0,16);return`${r}_${e}`};var R=(t,r)=>!t||!r?"":`Record<${t}, ${r}>`,b=t=>t.length===0||t.some(({name:r,type:e})=>!r||!e)?"":`{ ${t.map(({name:r,type:e})=>`"${r}": ${e}`).join(`${";"} `)}${t.length>1?";":""} }`,L=(t,r,e)=>!t||!r?"":e?`import type { ${t} as ${e} } from "${r}"${";"}`:`import type { ${t} } from "${r}"${";"}`;var pt=(t,r,e,o)=>{let n=vt.readFileSync(r,"utf8"),i=e(n);if(!i)return;let s=Z(t,r),p=it(s,i);return{importName:p,importPath:s,importStatement:L(i,s,p),type:o(i,p)}},ct=(t,r)=>pt(t,r,e=>tt.find(o=>new RegExp(`export (interface ${o} ?{|type ${o} ?=)`).test(e)),(e,o)=>R(U,o)),mt=(t,r,e)=>pt(t,r,o=>[e].find(n=>new RegExp(`export (async )?(function ${n} ?\\(|const ${n} ?=|\\{[^}]*\\b${n}\\b[^}]*\\} ?=|const \\{[^}]*\\b${n}\\b[^}]*\\} ?=|\\{[^}]*\\b${n}\\b[^}]*\\} from)`).test(o)),(o,n)=>b([{name:`$${o.toLowerCase()}`,type:`typeof ${n}`}]));var ut=new Set(A),ft=t=>{if(E.has(t))return E.get(t);let r=lt.readdirSync(t,{withFileTypes:!0});for(let e of r){let{name:o}=e,n=v.join(t,o);if(o==="node_modules"||o.startsWith("_")||o.startsWith("(.)")||o.startsWith("(..)")||o.startsWith("(...)"))return E.set(t,!1),!1;if(e.isFile()&&ut.has(o))return E.set(t,!0),!0;if(e.isDirectory()&&ft(n))return E.set(t,!0),!0}return E.set(t,!1),!1},Wt=(t,{isDynamic:r,isCatchAll:e,isOptionalCatchAll:o})=>{let n=t;return r&&(n=n.replace(/^\[+|\]+$/g,"")),(e||o)&&(n=n.replace(/^\.{3}/,"")),{paramName:n,keyName:`${o?wt:e?Dt:r?Ot:""}${n}`}},X=(t,r,e="",o=[])=>{if(C.has(r))return C.get(r);let n=e,i=e+" ",s=[],p=[],a=[],m=[],c=[...o],$=lt.readdirSync(r,{withFileTypes:!0}).filter(y=>{if(y.isDirectory()){let S=v.join(r,y.name);return ft(S)}return ut.has(y.name)}).sort();for(let y of $){let S=x(v.join(r,y.name));if(y.isDirectory()){let l=y.name,h=l.startsWith("(")&&l.endsWith(")"),u=l.startsWith("@"),f=l.startsWith("[[...")&&l.endsWith("]]"),g=l.startsWith("[...")&&l.endsWith("]"),d=l.startsWith("[")&&l.endsWith("]"),{paramName:Nt,keyName:It}=Wt(l,{isDynamic:d,isCatchAll:g,isOptionalCatchAll:f}),At=d||g||f?[...c,{paramName:Nt,routeType:{isDynamic:d,isCatchAll:g,isOptionalCatchAll:f,isGroup:h,isParallel:u}}]:c,q=h||u,{pathStructure:z,imports:Rt,paramsTypes:bt}=X(t,S,q?n:i,At);if(p.push(...Rt),m.push(...bt),q){let J=z.match(/^\s*\{([\s\S]*)\}\s*$/);J&&s.push(`${i}${J[1].trim()}`)}else s.push(`${i}"${It}": ${z}`)}else{let l=ct(t,S);if(l){let{importStatement:h,importPath:u,type:f}=l;p.push({statement:h,path:u}),a.push(f)}if(Ft.forEach(h=>{let u=mt(t,S,h);if(u){let{importStatement:f,importPath:g,type:d}=u;p.push({statement:f,path:g}),a.push(d)}}),a.push(Y),c.length>0){let h=c.map(({paramName:f,routeType:g})=>{let d=g.isCatchAll?"string[]":g.isOptionalCatchAll?"string[] | undefined":"string";return{name:f,type:d}}),u=b(h);m.push({paramsType:u,dirPath:v.dirname(S)}),a.push(R(j,u))}}}let I=a.join(" & "),D=s.length>0?`{${`
|
|
3
|
+
`}${s.join(`,${`
|
|
4
|
+
`}`)}${`
|
|
5
|
+
`}${n}}`:"",V={pathStructure:I&&D?`${I} & ${D}`:I||D,imports:p,paramsTypes:m};return C.set(r,V),V};var ht=(t,r)=>{let{pathStructure:e,imports:o,paramsTypes:n}=X(t,r),i=`export type PathStructure = ${e}${";"}`,s=o.length?`${o.sort((c,$)=>c.path.localeCompare($.path,void 0,{numeric:!0})).map(c=>c.statement).join(`
|
|
6
|
+
`)}`:"",p=et.filter(c=>e.includes(c)),a=L(p.join(" ,"),rt),m=n.map(({paramsType:c,dirPath:$})=>({paramsType:`export type Params = ${c}${";"}`,dirPath:$}));return{pathStructure:`${a}${`
|
|
7
|
+
`}${s}${`
|
|
8
|
+
`}${`
|
|
9
|
+
`}${i}`,paramsTypes:m}};var Mt=()=>!!process.stdout?.isTTY;var k=t=>r=>Mt()?`\x1B[${t}m${r}\x1B[0m`:r,gt=k(36),Et=k(32),K=k(31);var B=(t,r,e="\u2192",o=24)=>t.padEnd(o)+` ${e} ${r}`,Q=(t=0)=>" ".repeat(t),Tt=()=>({info:(t,r={})=>{let{indentLevel:e=0,event:o}=r,n=o?`${gt(`[${o}]`)} `:"";console.log(`${Q(e)}${n}${t}`)},success:(t,r={})=>{let{indentLevel:e=0}=r;console.log(`${Q(e)}${Et("\u2713")} ${t}`)},error:(t,r={})=>{let{indentLevel:e=0}=r;console.error(`${Q(e)}${K("\u2717")} ${K(t)}`)}});var dt=({baseDir:t,outputPath:r,paramsFileName:e,logger:o})=>{o.info("Generating types...",{event:"generate"});let{pathStructure:n,paramsTypes:i}=ht(r,t);yt.writeFileSync(r,n),o.success(B("Path structure type",_(r),W,w),{indentLevel:F}),e&&(i.forEach(({paramsType:s,dirPath:p})=>{let a=Yt.join(p,e);yt.writeFileSync(a,s)}),o.success(B("Params types",e,W,w),{indentLevel:F}))};import Ut from"chokidar";var St=(t,r)=>{let e=null,o=!1,n=null,i=async(...s)=>{o=!0;try{await t(...s)}finally{if(o=!1,n){let p=n;n=null,i(...p)}}};return(...s)=>{e&&clearTimeout(e),e=setTimeout(()=>{if(o){n=s;return}i(...s)},r)}};var xt=(t,r,e)=>{e.info(`${_(t)}`,{event:"watch"});let o=a=>A.some(m=>a.endsWith(m)),n=new Set,i=St(()=>{n.forEach(a=>{nt(a),st(a)}),n.clear(),r()},300),s=Ut.watch(t,{ignoreInitial:!0,ignored:(a,m)=>!!m?.isFile()&&!o(a)});s.on("ready",()=>{i(),s.on("all",(a,m)=>{if(o(m)){let c=_(m);e.info(c,{event:a}),n.add(m),i()}})}),s.on("error",a=>{a instanceof Error?e.error(`Watcher error: ${a.message}`):e.error(`Unknown watcher error: ${String(a)}`)});let p=()=>{s.close().then(()=>{e.info("Watcher closed.",{event:"watch"})}).catch(a=>{e.error(`Failed to close watcher: ${a.message}`)})};process.on("SIGINT",p),process.on("SIGTERM",p)};var Pt=(t,r,e,o)=>{try{return dt({baseDir:t,outputPath:r,paramsFileName:e,logger:o}),O}catch(n){return n instanceof Error?o.error(`Failed to generate: ${n.message}`):o.error(`Unknown error occurred during generate: ${String(n)}`),P}},_t=(t,r,e,o)=>{let n=x($t.resolve(t)),i=x($t.resolve(r)),s=typeof e.paramsFile=="string"?e.paramsFile:null;return e.paramsFile!==void 0&&!s?(o.error("Error: --params-file requires a filename."),P):e.watch?(xt(n,()=>{Pt(n,i,s,o)},o),O):Pt(n,i,s,o)};var Ct=(t,r=Tt())=>{let e=new jt;e.description("Generate RPC client type definitions based on the Next.js path structure.").argument("<baseDir>","Base directory containing Next.js paths for type generation").argument("<outputPath>","Output path for the generated type definitions").option("-w, --watch","Watch mode: regenerate on file changes").option("-p, --params-file [filename]","Generate params types file with specified filename").action(async(o,n,i)=>{try{let s=await _t(o,n,i,r);i.watch||process.exit(s)}catch(s){r.error(`Unexpected error occurred:${s instanceof Error?s.message:String(s)}`),process.exit(P)}}),e.parse(t)};Ct(process.argv);
|
|
10
|
+
/*!
|
|
11
|
+
* Inspired by pathpida (https://github.com/aspida/pathpida),
|
|
12
|
+
* especially the design and UX of its CLI.
|
|
13
|
+
*/
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "rpc4next-cli",
|
|
3
|
+
"description": "Command line interface for rpc4next. Generates RPC client type definitions from Next.js routes.",
|
|
4
|
+
"author": "watanabe-1",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"version": "0.0.1",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/watanabe-1/rpc4next.git",
|
|
10
|
+
"directory": "packages/rpc4next-cli"
|
|
11
|
+
},
|
|
12
|
+
"publishConfig": {
|
|
13
|
+
"access": "public"
|
|
14
|
+
},
|
|
15
|
+
"type": "module",
|
|
16
|
+
"bin": {
|
|
17
|
+
"rpc4next": "dist/index.js"
|
|
18
|
+
},
|
|
19
|
+
"files": [
|
|
20
|
+
"dist"
|
|
21
|
+
],
|
|
22
|
+
"scripts": {
|
|
23
|
+
"build": "bun run clean && bun build.ts",
|
|
24
|
+
"clean": "bun -e \"const fs=require('fs'); fs.rmSync('dist',{recursive:true,force:true}); fs.rmSync('tsconfig.tsbuildinfo',{force:true});\"",
|
|
25
|
+
"test": "vitest run",
|
|
26
|
+
"test:coverage": "vitest run --coverage.enabled true",
|
|
27
|
+
"test:ui": "vitest --ui --coverage.enabled true",
|
|
28
|
+
"test:watch": "vitest --watch",
|
|
29
|
+
"lint": "eslint \"src/**/*.ts\"",
|
|
30
|
+
"lint:fix": "eslint \"src/**/*.ts\" --fix",
|
|
31
|
+
"typecheck": "tsc --noEmit"
|
|
32
|
+
},
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"chokidar": "^4.0.3",
|
|
35
|
+
"commander": "^14.0.1",
|
|
36
|
+
"rpc4next-shared": "workspace:*"
|
|
37
|
+
},
|
|
38
|
+
"peerDependencies": {
|
|
39
|
+
"next": "^14.0.0 || ^15.0.0"
|
|
40
|
+
}
|
|
41
|
+
}
|