@nemmtor/ts-databuilders 0.0.1-alpha.10 → 0.0.1-alpha.12

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.
Files changed (3) hide show
  1. package/README.md +44 -13
  2. package/dist/main.js +24 -0
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -15,36 +15,62 @@ yarn add -D @nemmtor/ts-databuilders
15
15
  ```
16
16
 
17
17
  ## Configuration
18
- All configuration is optional with sensible defaults.
18
+ Configuration is optional - it fallbacks to sensible defaults.
19
19
 
20
- ### Initialize Config File (optional)
21
- Generate a default `ts-databuilders.json` configuration file:
20
+ ### Configure via CLI flags (optional):
22
21
  ```bash
23
- pnpm ts-databuilders init
22
+ pnpm ts-databuilders --include "src/**/*.ts{,x}" --output-dir src/__generated__ --jsdoc-tag DataBuilder
24
23
  ```
25
- You can also generate configuration file by providing values step by step in an interactive wizard:
24
+ You can also provide configuration by going through interactive wizard:
26
25
  ```bash
27
- pnpm ts-databuilders init --wizard
26
+ pnpm ts-databuilders --wizard
28
27
  ```
29
28
 
30
- ### Configure via CLI flags (optional):
29
+ ### Configure via config file (optional)
30
+ Ts-databuilders will try to find config file `ts-databuilders.json` in the root of your repository.
31
+ Config file is optional.
32
+
33
+ Example of default config file:
34
+ ```json
35
+ {
36
+ "$schema": "https://raw.githubusercontent.com/nemmtor/ts-databuilders/refs/heads/main/schema.json",
37
+ "jsdocTag": "DataBuilder",
38
+ "inlineDefaultJsdocTag": "DataBuilderDefault",
39
+ "withNestedBuilders": true,
40
+ "outputDir": "generated/builders",
41
+ "include": "src/**/*.ts{,x}",
42
+ "fileSuffix": ".builder",
43
+ "fileCase": "kebab",
44
+ "builderSuffix": "Builder",
45
+ "defaults": {
46
+ "string": "",
47
+ "number": 0,
48
+ "boolean": false
49
+ }
50
+ }
51
+ ```
52
+
53
+ You can generate a default configuration file by running `init` command:
31
54
  ```bash
32
- pnpm ts-databuilders --output-dir="src/__generated__" --jsdoc-tag=MyBuilder
55
+ pnpm ts-databuilders init
33
56
  ```
34
- You can also provide configuration by going through interactive wizard:
57
+ You can also generate it by providing values step by step in an interactive wizard:
35
58
  ```bash
36
- pnpm ts-databuilders --wizard
59
+ pnpm ts-databuilders init --wizard
37
60
  ```
38
61
 
62
+
39
63
  ### Options Reference
40
64
 
41
- | Name | Flag | Description | Default |
65
+ | Name (in config file) | Flag (cli flags) | Description | Default |
42
66
  |---------------|-------------------------------------------------------|-----------------------------------------|----------------------|
43
67
  | jsdocTag | `--jsdoc-tag` | JSDoc tag to mark types for generation | `DataBuilder` |
44
- | inlineDefaultJsdocTag | `--inline-default-jsdoc-tag` | JSDoc tag used to set default value of given field. | `DataBuilderDefault` |
68
+ | inlineDefaultJsdocTag | `--inline-default-jsdoc-tag` | JSDoc tag used to set default value of given field | `DataBuilderDefault` |
69
+ | withNestedBuilders | `--with-nested-builders` | When set to true ts-databuilders will use nested builders approach | `true` |
45
70
  | outputDir | `--output-dir -o` | Output directory for generated builders | `generated/builders` |
46
71
  | include | `--include -i` | Glob pattern for source files | `src/**/*.ts{,x}` |
47
72
  | fileSuffix | `--file-suffix` | File suffix for builder files | `.builder` |
73
+ | fileCase | `--file-case` | Naming convention for generated builder file, one of 3: `kebab`, `camel`, `pascal` | `kebab` |
48
74
  | builderSuffix | `--builder-suffix` | Class name suffix | `Builder` |
49
75
  | defaults | `--default-string --default-number --default-boolean` | Default values for primitives | See example above |
50
76
 
@@ -200,6 +226,9 @@ This not only makes the test code less verbose but also highlights what is reall
200
226
  [Read more about data builders.](http://www.natpryce.com/articles/000714.html)
201
227
 
202
228
  ## Nested Builders
229
+ > [!NOTE]
230
+ > Nested builders can be turned off by using withNestedBuilders option. Check configuration section for more details.
231
+
203
232
  When your types contain complex nested objects, you can annotate their type definitions and TS DataBuilders will automatically generate nested builders, allowing you to compose them fluently.
204
233
  ### Example
205
234
 
@@ -291,6 +320,8 @@ const userWithCity = new UserBuilder()
291
320
  ```
292
321
 
293
322
  ## Inline Default Values
323
+ > [!NOTE]
324
+ > It's your responsibility to provide inline default value that satisfies expected type.
294
325
 
295
326
  While global defaults work well for most cases, sometimes you need field-specific default values. This is especially important for specialized string types like ISO dates, UUIDs etc.
296
327
 
@@ -316,7 +347,7 @@ Use `@DataBuilderDefault` JSDoc tag to override defaults per field:
316
347
  type Order = {
317
348
  /** @DataBuilderDefault '550e8400-e29b-41d4-a716-446655440000' */
318
349
  id: string;
319
-
350
+
320
351
  /** @DataBuilderDefault '2025-11-05T15:32:58.727Z' */
321
352
  createdAt: string;
322
353
  }
package/dist/main.js ADDED
@@ -0,0 +1,24 @@
1
+ #!/usr/bin/env node
2
+ import*as dt from"@effect/platform-node/NodeContext";import*as ft from"@effect/platform-node/NodeRuntime";import*as pt from"effect/Effect";import*as ut from"effect/Layer";import*as mt from"effect/Logger";import*as gt from"effect/LogLevel";import*as J from"@effect/cli/Command";import*as o from"@effect/cli/Options";import*as oe from"effect/Layer";import{Project as bt}from"ts-morph";import*as Pe from"@effect/platform/FileSystem";import*as Fe from"@effect/platform/Path";import*as g from"effect/Effect";import*as I from"effect/Match";import*as Ye from"effect/Option";import*as Q from"effect/Schema";import*as Oe from"@effect/platform/FileSystem";import*as je from"@effect/platform/Path";import*as _e from"effect/Context";import*as x from"effect/Effect";import*as P from"effect/Option";import*as i from"effect/Schema";var C={jsdocTag:"JSDoc tag used to mark types for data building generation.",inlineDefaultJsdocTag:"JSDoc tag used to set default value of given field.",withNestedbuilders:"When set to true ts-databuilders will use nested builders approach.",outputDir:"Output directory for generated builders.",include:"Glob pattern for files included while searching for jsdoc tag.",fileSuffix:"File suffix for created builder files.",fileCase:"Naming convention for generated builder file",builderSuffix:"Suffix for generated classes.",defaults:"Default values to be used in data builder constructor.",defaultString:"Default string value to be used in data builder constructor.",defaultNumber:"Default number value to be used in data builder constructor.",defaultBoolean:"Default boolean value to be used in data builder constructor."};import*as ue from"effect/Effect";var L=class extends ue.Service()("@TSDataBuilders/Process",{succeed:{cwd:ue.sync(()=>process.cwd())}}){};var yt=e=>e!==void 0,ae=e=>Object.fromEntries(Object.entries(e).filter(([n,s])=>yt(s)));var De="ts-databuilders.json",Tt=i.Struct({jsdocTag:i.NonEmptyTrimmedString,inlineDefaultJsdocTag:i.NonEmptyTrimmedString,withNestedBuilders:i.Boolean,outputDir:i.NonEmptyTrimmedString,include:i.NonEmptyTrimmedString,fileSuffix:i.NonEmptyTrimmedString,fileCase:i.Literal("kebab","camel","pascal"),builderSuffix:i.NonEmptyTrimmedString,defaults:i.Struct({string:i.String,number:i.Number,boolean:i.Boolean})}),_=Tt.make({jsdocTag:"DataBuilder",inlineDefaultJsdocTag:"DataBuilderDefault",withNestedBuilders:!0,outputDir:"generated/builders",include:"src/**/*.ts{,x}",fileSuffix:".builder",fileCase:"kebab",builderSuffix:"Builder",defaults:{string:"",number:0,boolean:!1}}),be=i.Struct({$schema:i.optional(i.String),jsdocTag:i.String.pipe(i.annotations({description:C.jsdocTag})),inlineDefaultJsdocTag:i.String.pipe(i.annotations({description:C.inlineDefaultJsdocTag})),withNestedBuilders:i.Boolean.pipe(i.annotations({description:C.withNestedbuilders})),outputDir:i.String.pipe(i.annotations({description:C.outputDir})),include:i.String.pipe(i.annotations({description:C.include})),fileSuffix:i.String.pipe(i.annotations({description:C.fileSuffix})),fileCase:i.Literal("kebab","camel","pascal").pipe(i.annotations({description:C.fileCase})),builderSuffix:i.String.pipe(i.annotations({description:C.builderSuffix})),defaults:i.Struct({string:i.String.pipe(i.annotations({description:C.defaultString})),number:i.Number.pipe(i.annotations({description:C.defaultNumber})),boolean:i.Boolean.pipe(i.annotations({description:C.defaultBoolean}))}).pipe(i.partial,i.annotations({description:C.defaults}))}).pipe(i.partial),$=class extends _e.Tag("Configuration")(){},G=i.Struct({jsdocTag:i.NonEmptyTrimmedString,inlineDefaultJsdocTag:i.NonEmptyTrimmedString,withNestedBuilders:i.BooleanFromString,outputDir:i.NonEmptyTrimmedString,include:i.NonEmptyTrimmedString,fileSuffix:i.NonEmptyTrimmedString,fileCase:i.Literal("kebab","camel","pascal"),builderSuffix:i.NonEmptyTrimmedString,defaultString:i.String,defaultNumber:i.NumberFromString,defaultBoolean:i.BooleanFromString}),Ge=e=>x.gen(function*(){yield*x.logDebug("[Configuration]: Loading configuration");let s=yield*(yield*L).cwd,a=(yield*je.Path).join(s,De),r=yield*Ct(a),h=yield*ht({fromCLI:e,fromConfigFile:r});return $.of(h)}),ht=e=>x.gen(function*(){let n=Et(e),s=P.flatMap(e.fromConfigFile,h=>P.fromNullable(h.defaults)).pipe(P.map(h=>ae(h)),P.getOrElse(()=>({}))),f=ae({string:e.fromCLI.defaultString.pipe(P.getOrUndefined),number:e.fromCLI.defaultNumber.pipe(P.getOrUndefined),boolean:e.fromCLI.defaultBoolean.pipe(P.getOrUndefined)}),a={...s,...f},r={builderSuffix:yield*n("builderSuffix"),include:yield*n("include"),withNestedBuilders:yield*n("withNestedBuilders"),fileSuffix:yield*n("fileSuffix"),fileCase:yield*n("fileCase"),jsdocTag:yield*n("jsdocTag"),inlineDefaultJsdocTag:yield*n("inlineDefaultJsdocTag"),outputDir:yield*n("outputDir"),defaults:{..._.defaults,...a}};return yield*x.logDebug(`[Configuration]: Resolving config with value: ${JSON.stringify(r,null,4)}`),r}),Et=e=>n=>e.fromCLI[n].pipe(x.orElse(()=>P.flatMap(e.fromConfigFile,s=>P.fromNullable(s[n]))),x.orElseSucceed(()=>_[n])),Ct=e=>x.gen(function*(){let n=yield*Oe.FileSystem;if(yield*x.orDie(n.exists(e))){yield*x.logDebug("[Configuration]: Found config file - attempting to read it");let f=yield*Nt(e),a=yield*i.decodeUnknown(be)(f);return P.some(a)}else return yield*x.logDebug("[Configuration]: No config file found"),P.none()}),Nt=e=>x.gen(function*(){let n=yield*Oe.FileSystem,s=yield*x.orDie(n.readFileString(e));return yield*x.try({try:()=>JSON.parse(s),catch:f=>`[FileSystem] Unable to read and parse JSON file from '${e}': ${String(f)}`})}).pipe(x.orDie);import*as M from"effect/Schema";var we=M.transform(M.String,M.String.pipe(M.brand("KebabCase")),{decode:e=>e.replace(/([a-z0-9])([A-Z])/g,"$1-$2").replace(/([A-Z])([A-Z][a-z])/g,"$1-$2").replace(/_/g,"-").toLowerCase(),encode:e=>e}),xe=M.transform(M.String,M.String.pipe(M.brand("PascalCase")),{decode:e=>e.split(/[-_\s]+/).flatMap(n=>n.split(/(?=[A-Z])/)).filter(Boolean).map(n=>n.charAt(0).toUpperCase()+n.slice(1).toLowerCase()).join(""),encode:e=>e}),Ie=M.transform(M.String,M.String.pipe(M.brand("CamelCase")),{decode:e=>e.split(/[-_\s]+/).flatMap(n=>n.split(/(?=[A-Z])/)).filter(Boolean).map((n,s)=>{let f=n.toLowerCase();return s===0?f:f.charAt(0).toUpperCase()+f.slice(1)}).join(""),encode:e=>e});import{randomUUID as Dt}from"crypto";import*as me from"effect/Effect";var q=class extends me.Service()("@TSDataBuilders/IdGenerator",{succeed:{generateUuid:me.sync(()=>Dt())}}){};var ge=class extends g.Service()("@TSDataBuilders/BuilderGenerator",{effect:g.gen(function*(){let n=yield*Pe.FileSystem,s=yield*Fe.Path,f=yield*L,a=yield*$,r=yield*q,{fileSuffix:h,builderSuffix:S,defaults:E,fileCase:m}=a,c=g.fnUntraced(function*(u){return yield*{kebab:we.pipe(Q.decode),pascal:xe.pipe(Q.decode),camel:Ie.pipe(Q.decode)}[m](u)}),p=u=>Ye.getOrUndefined(u.inlineDefault)??I.value(u).pipe(I.when({kind:"STRING"},()=>`"${E.string}"`),I.when({kind:"NUMBER"},()=>E.number),I.when({kind:"BOOLEAN"},()=>E.boolean),I.when({kind:"UNDEFINED"},()=>"undefined"),I.when({kind:"NULL"},()=>"null"),I.when({kind:"DATE"},()=>"new Date()"),I.when({kind:"ARRAY"},()=>"[]"),I.when({kind:"LITERAL"},l=>l.literalValue),I.when({kind:"TYPE_CAST"},l=>p(l.baseTypeMetadata)),I.when({kind:"TUPLE"},l=>`[${l.members.map(d=>p(d)).map(d=>`${d}`).join(", ")}]`),I.when({kind:"TYPE_LITERAL"},l=>`{${Object.entries(l.metadata).filter(([d,{optional:T}])=>!T).map(([d,T])=>`${d}: ${p(T)}`).join(", ")}}`),I.when({kind:"RECORD"},l=>{if(l.keyType.kind==="STRING"||l.keyType.kind==="NUMBER")return"{}";let O=p(l.keyType),d=p(l.valueType);return`{${O}: ${d}}`}),I.when({kind:"UNION"},l=>{let d=l.members.slice().sort((T,b)=>{let w=Je.indexOf(T.kind),D=Je.indexOf(b.kind);return(w===-1?1/0:w)-(D===-1?1/0:D)})[0];return d?p(d):"never"}),I.when({kind:"BUILDER"},l=>`new ${l.name}${S}().build()`),I.exhaustive);return{generateBaseBuilder:g.fnUntraced(function*(){let u=s.join(yield*f.cwd,a.outputDir),l=s.resolve(u,`${yield*c("dataBuilder")}.ts`);yield*g.logDebug(`[Builders]: Creating base builder at ${l}`),yield*g.orDie(n.writeFileString(l,`${wt}
3
+ `))}),generateBuilder:g.fnUntraced(function*(u){let l=new bt,O=u.name;yield*g.logDebug(`[Builders]: Creating builder for ${O}`);let d=s.join(yield*f.cwd,a.outputDir),T=s.resolve(d,`${yield*c(O)}${h}.ts`);yield*g.logDebug(`[Builders]: Creating builder content for ${O}`);let b=l.createSourceFile(`__temp_${yield*r.generateUuid}.ts`,"",{overwrite:!0}),w=s.resolve(u.path),D=s.relative(s.dirname(T),w).replace(/\.ts$/,"");if(b.addImportDeclaration({namedImports:[O],isTypeOnly:!0,moduleSpecifier:D}),b.addImportDeclaration({namedImports:["DataBuilder"],moduleSpecifier:"./data-builder"}),u.shape.kind!=="TYPE_LITERAL")return yield*g.dieMessage("[BuilderGenerator]: Expected root type to be type literal");let F=[...new Set(xt(u.shape.metadata))];yield*g.forEach(F,B=>we.pipe(Q.decode)(B).pipe(g.andThen(R=>b.addImportDeclaration({namedImports:[`${B}${S}`],moduleSpecifier:`./${R}${h}`}))),{concurrency:"unbounded"});let k=Object.entries(u.shape.metadata).filter(([B,{optional:R}])=>!R).map(([B,R])=>`${B}: ${R.kind==="TYPE_CAST"?`${p(R)} as ${O}['${B}']`:p(R)}`),Y=yield*g.all(Object.entries(u.shape.metadata).map(([B,{optional:R,kind:z}])=>It({fieldName:B,optional:R,typeName:O,isNestedBuilder:z==="BUILDER"})),{concurrency:"unbounded"}),V=`{
4
+ ${k.join(`,
5
+ `)}
6
+ }`;b.addClass({name:`${O}${S}`,isExported:!0,extends:`DataBuilder<${O}>`,methods:[{name:"constructor",statements:[`super(${V});`]},...Y]}),yield*g.logDebug(`[Builders]: Saving builder content at ${T}`),yield*n.writeFileString(T,`${b.getText()}
7
+ `)})}}),dependencies:[q.Default]}){},Je=["UNDEFINED","BOOLEAN","NUMBER","STRING","DATE","LITERAL","TYPE_LITERAL","ARRAY","TUPLE","RECORD"],wt=`export abstract class DataBuilder<T> {
8
+ private data: T;
9
+
10
+ constructor(initialData: T) {
11
+ this.data = initialData;
12
+ }
13
+
14
+ public build(): Readonly<T> {
15
+ return structuredClone(this.data);
16
+ }
17
+
18
+ protected with(partial: Partial<T>): this {
19
+ this.data = { ...this.data, ...partial };
20
+ return this;
21
+ }
22
+ }
23
+ `;function xt(e){let n=[];function s(f){switch(f.kind){case"BUILDER":n.push(f.name);break;case"TYPE_LITERAL":Object.values(f.metadata).forEach(s);break;case"UNION":case"TUPLE":f.members.forEach(s);break;case"RECORD":s(f.keyType),s(f.valueType);break}}return Object.values(e).forEach(s),n}var It=e=>g.gen(function*(){let{fieldName:n,optional:s,typeName:f,isNestedBuilder:a}=e,r=n.replaceAll("'","").replaceAll('"',""),h=yield*Ie.pipe(Q.decode)(r),S=`with${yield*xe.pipe(Q.decode)(r)}`,E=[`return this.with({ ${n}: ${h} });`],m=[`return this.with({ ${n}: ${h}.build() });`],c=a?m:E,p=[`if (!${h}) {`,` const { "${r}": _unused, ...rest } = this.build();`," return this.with(rest);","}"],u=s?[...p,...c]:c,l=`${f}['${r}']`;return{name:S,isPublic:!0,parameters:[{name:h,type:a?`DataBuilder<${l}>`:l}],statements:u}}),X=class extends g.Service()("@TSDataBuilders/BuildersGenerator",{effect:g.gen(function*(){let n=yield*Pe.FileSystem,s=yield*ge,f=yield*L,a=yield*Fe.Path,r=yield*$;return{create:g.fnUntraced(function*(h){let S=a.join(yield*f.cwd,r.outputDir);(yield*g.orDie(n.exists(S)))&&(yield*g.logDebug(`[Builders]: Removing already existing output directory at ${S}`),yield*g.orDie(n.remove(S,{recursive:!0}))),yield*g.logDebug(`[Builders]: Creating output directory at ${S}`),yield*g.orDie(n.makeDirectory(S,{recursive:!0})),yield*s.generateBaseBuilder();let m=h.map(u=>u.name),c=m.filter((u,l)=>m.indexOf(u)!==l),p=[...new Set(c)];if(c.length>0)return yield*g.dieMessage(`Duplicated builders: ${p.join(", ")}`);yield*g.all(h.map(u=>s.generateBuilder(u)),{concurrency:"unbounded"})})}}),dependencies:[ge.Default]}){};import*as Ve from"@effect/platform/FileSystem";import*as Ze from"@effect/platform/Path";import*as ze from"effect/Effect";import*as U from"effect/Option";import*as qe from"effect/Schema";var He=e=>ze.gen(function*(){let n=yield*L,s=yield*Ve.FileSystem,f=yield*n.cwd,r=(yield*Ze.Path).join(f,De),h=ae({string:e.defaultString.pipe(U.getOrUndefined),number:e.defaultNumber.pipe(U.getOrUndefined),boolean:e.defaultBoolean.pipe(U.getOrUndefined)}),S=yield*qe.decode(be)({$schema:"https://raw.githubusercontent.com/nemmtor/ts-databuilders/refs/heads/main/schema.json",builderSuffix:e.builderSuffix.pipe(U.getOrElse(()=>_.builderSuffix)),fileSuffix:e.fileSuffix.pipe(U.getOrElse(()=>_.fileSuffix)),fileCase:e.fileCase.pipe(U.getOrElse(()=>_.fileCase)),include:e.include.pipe(U.getOrElse(()=>_.include)),jsdocTag:e.jsdocTag.pipe(U.getOrElse(()=>_.jsdocTag)),inlineDefaultJsdocTag:e.inlineDefaultJsdocTag.pipe(U.getOrElse(()=>_.inlineDefaultJsdocTag)),withNestedBuilders:e.withNestedBuilders.pipe(U.getOrElse(()=>_.withNestedBuilders)),outputDir:e.outputDir.pipe(U.getOrElse(()=>_.outputDir)),defaults:{..._.defaults,...h}});yield*s.writeFileString(r,`${JSON.stringify(S,null,2)}
24
+ `)});import*as te from"effect/Chunk";import*as A from"effect/Effect";import*as ye from"effect/Option";import*as Te from"effect/Stream";import*as Qe from"@effect/platform/FileSystem";import*as Xe from"effect/Chunk";import*as W from"effect/Effect";import*as K from"effect/Stream";var ce=class extends W.Service()("@TSDataBuilders/FileContentChecker",{effect:W.gen(function*(){let n=yield*Qe.FileSystem,s=new TextDecoder;return{check:W.fnUntraced(function*(f){let{content:a,filePath:r}=f;return yield*W.logDebug(`[FileContentChecker](${r}): Checking file content`),yield*K.orDie(n.stream(r,{chunkSize:16*1024})).pipe(K.map(E=>s.decode(E,{stream:!0})),K.mapAccum("",(E,m)=>{let c=E+m;return[c.slice(-a.length+1),c.includes(a)]}),K.find(E=>!!E),K.tap(()=>W.logDebug(`[FileContentChecker](${r}): found expected content`)),K.runCollect,W.map(E=>E.pipe(Xe.get(0))))})}})}){};import*as et from"effect/Data";import*as H from"effect/Effect";import*as tt from"effect/Stream";import{glob as Ft}from"glob";import*as Se from"effect/Effect";var le=class extends Se.Service()("@TSDataBuilders/Glob",{succeed:{iterate:n=>Se.sync(()=>Ft.iterate(n.path,{cwd:n.cwd,nodir:!0}))}}){};var de=class extends H.Service()("@TSDataBuilders/TreeWalker",{effect:H.gen(function*(){let n=yield*le,s=yield*L;return{walk:H.fnUntraced(function*(f){let a=yield*s.cwd;return yield*H.logDebug(`[TreeWalker]: Walking path: ${a}/${f}`),tt.fromAsyncIterable(yield*n.iterate({path:f,cwd:a}),r=>new ke({cause:r}))})}}),dependencies:[le.Default]}){},ke=class extends et.TaggedError("TreeWalkerError"){};var ee=class extends A.Service()("@TSDataBuilders/Finder",{effect:A.gen(function*(){let n=yield*ce,s=yield*de,{include:f,jsdocTag:a}=yield*$,r=`@${a}`;return{find:A.gen(function*(){yield*A.logDebug("[Finder]: Attempting to find files with builders");let S=yield*(yield*s.walk(f)).pipe(Te.mapEffect(E=>n.check({filePath:E,content:r}).pipe(A.map(m=>m.pipe(ye.map(()=>E)))),{concurrency:"unbounded"}),Te.runCollect,A.map(te.filter(E=>ye.isSome(E))),A.map(te.map(E=>E.value)));return yield*A.logDebug(`[Finder]: Found builders in files: ${S.pipe(te.toArray).join(", ")}`),S}).pipe(A.catchTag("TreeWalkerError",h=>A.die(h)))}}),dependencies:[de.Default,ce.Default]}){};import{Node as Mt,Project as Bt,SyntaxKind as N}from"ts-morph";import*as nt from"@effect/platform/FileSystem";import*as Z from"effect/Data";import*as t from"effect/Effect";import*as fe from"effect/Either";import*as y from"effect/Match";import*as v from"effect/Option";var he=class extends t.Service()("@TSDataBuilders/TypeNodeParser",{effect:t.gen(function*(){let{jsdocTag:n,inlineDefaultJsdocTag:s,withNestedBuilders:f}=yield*$,a=yield*q,r=t.fnUntraced(function*(E){let m=E.getJsDocs();for(let c of m){let u=c.getTags().find(l=>l.getTagName()===s);if(u){let l=u.getComment();if(typeof l=="string")return v.some(l.trim())}}return v.none()}),h=t.fnUntraced(function*(E){let{type:m,contextNode:c,optional:p,inlineDefault:u}=E,l=m.getProperties();if(!m.isObject()||l.length===0)return yield*new Me({raw:m.getText(),kind:c.getKind()});let O={};for(let d of l){let T=d.getName(),b=d.getTypeAtLocation(c),w=d.isOptional(),D=c.getProject().createSourceFile(`__temp_${yield*a.generateUuid}.ts`,`type __T = ${b.getText()}`,{overwrite:!0}),F=D.getTypeAliasOrThrow("__T").getTypeNodeOrThrow(),k=yield*t.suspend(()=>S({typeNode:F,optional:w,inlineDefault:v.none()}));O[T]=k,c.getProject().removeSourceFile(D)}return{kind:"TYPE_LITERAL",metadata:O,inlineDefault:u,optional:p}}),S=E=>t.gen(function*(){let{typeNode:m,optional:c,inlineDefault:p}=E,u=m.getKind(),l=y.value(u).pipe(y.when(y.is(N.StringKeyword),()=>t.succeed({kind:"STRING",inlineDefault:p,optional:c})),y.when(y.is(N.NumberKeyword),()=>t.succeed({kind:"NUMBER",inlineDefault:p,optional:c})),y.when(y.is(N.BooleanKeyword),()=>t.succeed({kind:"BOOLEAN",inlineDefault:p,optional:c})),y.when(y.is(N.UndefinedKeyword),()=>t.succeed({kind:"UNDEFINED",inlineDefault:p,optional:c})),y.when(y.is(N.ArrayType),()=>t.succeed({kind:"ARRAY",inlineDefault:p,optional:c})),y.when(y.is(N.LiteralType),()=>{let d=m.asKindOrThrow(N.LiteralType).getLiteral().getText();return d==="null"?t.succeed({kind:"NULL",inlineDefault:p,optional:c}):t.succeed({kind:"LITERAL",inlineDefault:p,literalValue:d,optional:c})}),y.when(y.is(N.TypeLiteral),()=>t.gen(function*(){let T=m.asKindOrThrow(N.TypeLiteral).getMembers(),b=yield*t.reduce(T,{},(w,D)=>t.gen(function*(){if(!D.isKind(N.PropertySignature))return w;let F=D.getTypeNode();if(!F)return w;let k=D.getNameNode().getText(),Y=D.hasQuestionToken(),V=yield*r(D),B=yield*t.suspend(()=>S({typeNode:F,optional:Y,inlineDefault:V}));return{...w,[k]:B}}));return{kind:"TYPE_LITERAL",inlineDefault:p,metadata:b,optional:c}})),y.when(y.is(N.ImportType),()=>t.gen(function*(){let d=m.asKindOrThrow(N.ImportType),T=d.getType(),b=T.getSymbol(),w=T.getText();if(!b)return yield*new $e({raw:w});let D=b.getDeclarations();if(D&&D.length>1)return yield*new Ce({raw:w});let[F]=D;return F?yield*h({type:T,contextNode:d,inlineDefault:p,optional:c}):yield*new Ee({raw:w})})),y.when(y.is(N.TupleType),()=>t.gen(function*(){let T=m.asKindOrThrow(N.TupleType).getElements(),b=yield*t.all(T.map(w=>t.suspend(()=>S({typeNode:w,optional:!1,inlineDefault:v.none()}))),{concurrency:"unbounded"});return{kind:"TUPLE",inlineDefault:p,optional:c,members:b}})),y.when(y.is(N.TypeReference),()=>t.gen(function*(){let d=m.asKindOrThrow(N.TypeReference),T=d.getTypeName().getText();if(T==="Date")return{kind:"DATE",optional:c,inlineDefault:p};if(T==="Array")return{kind:"ARRAY",optional:c,inlineDefault:p};let b=d.getTypeArguments();if(T==="Record"){let[z,pe]=b;if(!z||!pe)return yield*new ie({kind:u,raw:m.getText()});let Ne=yield*t.suspend(()=>S({typeNode:z,optional:!1,inlineDefault:v.none()})),St=yield*t.suspend(()=>S({typeNode:pe,optional:!1,inlineDefault:v.none()}));return{kind:"RECORD",keyType:Ne,valueType:St,optional:c,inlineDefault:p}}if(["Pick","Omit","Partial","Required","Readonly","Extract","NonNullable"].includes(T))return yield*h({type:d.getType(),contextNode:d,optional:c,inlineDefault:p});let D=d.getType(),F=D.getText(),k=D.getAliasSymbol();if(!k)return yield*h({type:D,contextNode:d,optional:c,inlineDefault:p});let Y=k.getDeclarations();if(Y&&Y.length>1)return yield*new Ce({raw:F});let[V]=Y;if(!V)return yield*new Ee({raw:F});let B=k?.getJsDocTags().map(z=>z.getName()).includes(n);if(!Mt.isTypeAliasDeclaration(V))return yield*new Ae;let R=V.getTypeNode();return R?!B||!f?yield*t.suspend(()=>S({typeNode:R,optional:c,inlineDefault:p})):{kind:"BUILDER",name:V.getName(),inlineDefault:p,optional:c}:yield*new ie({kind:u,raw:F})})),y.when(y.is(N.UnionType),()=>t.gen(function*(){let d=yield*t.all(m.asKindOrThrow(N.UnionType).getTypeNodes().map(T=>t.suspend(()=>S({typeNode:T,optional:!1,inlineDefault:v.none()}))),{concurrency:"unbounded"});return{kind:"UNION",optional:c,members:d,inlineDefault:p}})),y.when(y.is(N.IntersectionType),()=>t.gen(function*(){let d=m.asKindOrThrow(N.IntersectionType),T=d.getTypeNodes(),b=[N.StringKeyword,N.NumberKeyword,N.BooleanKeyword],w=T.find(k=>b.includes(k.getKind()));if(w&&T.length>1)return{kind:"TYPE_CAST",baseTypeMetadata:yield*t.suspend(()=>S({typeNode:w,optional:!1,inlineDefault:p})),inlineDefault:p,optional:c};let F=d.getType().getProperties();if(F.length>0){let k={};for(let Y of F){let V=Y.getName(),B=Y.getTypeAtLocation(d),R=Y.isOptional(),z=d.getProject().createSourceFile(`__temp_${yield*a.generateUuid}.ts`,`type __T = ${B.getText()}`,{overwrite:!0}),pe=z.getTypeAliasOrThrow("__T").getTypeNodeOrThrow(),Ne=yield*t.suspend(()=>S({typeNode:pe,optional:R,inlineDefault:v.none()}));k[V]=Ne,d.getProject().removeSourceFile(z)}return{kind:"TYPE_LITERAL",metadata:k,inlineDefault:p,optional:c}}return yield*new ie({kind:u,raw:m.getText()})})),y.option);return v.isNone(l)?yield*new ie({kind:u,raw:m.getText()}):yield*l.value});return{generateMetadata:S}}),dependencies:[q.Default]}){},ne=class extends t.Service()("@TSDataBuilders/Parser",{effect:t.gen(function*(){let n=yield*nt.FileSystem,s=yield*he,{jsdocTag:f}=yield*$;return{generateBuildersMetadata:a=>t.gen(function*(){yield*t.logDebug(`[Parser](${a}): Generating builder metadata`),yield*t.logDebug(`[Parser](${a}): Reading source code`);let r=yield*t.orDie(n.readFileString(a)),h=yield*t.try({try:()=>new Bt().createSourceFile(a,r,{overwrite:!0}).getTypeAliases().filter(u=>u.getJsDocs().flatMap(l=>l.getTags().flatMap(O=>O.getTagName())).includes(f)).map(u=>{let l=u.getName();if(!u.isExported())return fe.left(new Re({typeName:l}));let O=u.getTypeNode();return O?.isKind(N.TypeLiteral)||O?.isKind(N.TypeReference)?fe.right({name:u.getName(),node:O}):fe.left(new Le({typeName:u.getName()}))}).filter(Boolean),catch:m=>new Be({cause:m})}),S=yield*t.all(h.map(m=>m),{concurrency:"unbounded"});return yield*t.logDebug(`[Parser](${a}): Generating metadata for types: ${S.map(({name:m})=>m).join(", ")}`),yield*t.all(S.map(({name:m,node:c})=>s.generateMetadata({typeNode:c,optional:!1,inlineDefault:v.none()}).pipe(t.tap(()=>t.logDebug(`[Parser](${a}): Finished generating metadata for type: ${m}`)),t.map(p=>({name:m,shape:p,path:a})))),{concurrency:"unbounded"})}).pipe(t.catchTags({ParserError:r=>t.die(r),MissingSymbolDeclarationError:r=>t.dieMessage(`[Parser](${a}): Missing symbol declaration for type: ${r.raw}`),UnsupportedTypeAliasDeclarationError:()=>t.dieMessage(`[Parser](${a}): Unsupported type alias declaration`),MultipleSymbolDeclarationsError:r=>t.dieMessage(`[Parser](${a}): Missing symbol declaration error for type: ${r.raw}`),MissingSymbolError:r=>t.dieMessage(`[Parser](${a}): Missing symbol error for type: ${r.raw}`),UnexportedDatabuilderError:r=>t.dieMessage(`[Parser](${a}): Unexported databuilder ${r.typeName}`),UnsupportedSyntaxKindError:r=>t.dieMessage(`[Parser](${a}): Unsupported syntax kind of id: ${r.kind} for type: ${r.raw}`),CannotBuildTypeReferenceMetadataError:r=>t.dieMessage(`[Parser](${a}): Cannot build type reference metadata with kind of id: ${r.kind} for type: ${r.raw}. Is it a root of databuilder?`),UnsupportedBuilderTypeError:r=>t.dieMessage(`[Parser](${a}): Unsupported builder type ${r.typeName}`)}))}}),dependencies:[he.Default]}){},ie=class extends Z.TaggedError("UnsupportedSyntaxKindError"){},Ae=class extends Z.TaggedError("UnsupportedTypeAliasDeclarationError"){},Me=class extends Z.TaggedError("CannotBuildTypeReferenceMetadataError"){},Be=class extends Z.TaggedError("ParserError"){},Re=class extends Z.TaggedError("UnexportedDatabuilderError"){},Le=class extends Z.TaggedError("UnsupportedBuilderTypeError"){},$e=class extends Z.TaggedError("MissingSymbolError"){},Ee=class extends Z.TaggedError("MissingSymbolDeclarationError"){},Ce=class extends Z.TaggedError("MultipleSymbolDeclarationsError"){};import*as rt from"effect/Chunk";import*as j from"effect/Effect";import*as at from"effect/Function";var st=j.gen(function*(){let e=yield*ee,n=yield*ne,s=yield*X;yield*j.logInfo("[TSDatabuilders]: Generating builders for your project.");let f=yield*e.find;yield*j.logInfo(`[TSDatabuilders]: Found builders in ${f.length} file(s).`),yield*j.logDebug("[TSDatabuilders]: Attempting to generate builders metadata");let a=yield*j.all(rt.map(f,r=>n.generateBuildersMetadata(r)),{concurrency:"unbounded"}).pipe(j.map(r=>r.flatMap(at.identity)));a.length!==0&&(yield*j.logDebug("[TSDatabuilders]: Attempting to create builders files"),yield*s.create(a),yield*j.logInfo(`[TSDatabuilders]: Created ${a.length} builder(s).`))});var Rt=o.text("jsdoc-tag").pipe(o.withDescription(C.jsdocTag),o.withSchema(G.fields.jsdocTag),o.optional),Lt=o.text("inline-default-jsdoc-tag").pipe(o.withDescription(C.inlineDefaultJsdocTag),o.withSchema(G.fields.inlineDefaultJsdocTag),o.optional),$t=o.text("with-nested-builders").pipe(o.withDescription(C.withNestedbuilders),o.withSchema(G.fields.withNestedBuilders),o.optional),Ut=o.text("output-dir").pipe(o.withAlias("o"),o.withDescription(C.outputDir),o.withSchema(G.fields.outputDir),o.optional),vt=o.text("include").pipe(o.withAlias("i"),o.withDescription(C.include),o.withSchema(G.fields.include),o.optional),jt=o.text("file-case").pipe(o.withDescription(C.fileCase),o.withSchema(G.fields.fileCase),o.optional),_t=o.text("file-suffix").pipe(o.withDescription(C.fileSuffix),o.withSchema(G.fields.fileSuffix),o.optional),Gt=o.text("builder-suffix").pipe(o.withDescription(C.builderSuffix),o.withSchema(G.fields.builderSuffix),o.optional),Kt=o.text("default-string").pipe(o.withDescription(C.defaultString),o.withSchema(G.fields.defaultString),o.optional),Jt=o.text("default-number").pipe(o.withDescription(C.defaultNumber),o.withSchema(G.fields.defaultNumber),o.optional),Yt=o.text("default-boolean").pipe(o.withDescription(C.defaultBoolean),o.withSchema(G.fields.defaultBoolean),o.optional),ct={jsdocTag:Rt,outputDir:Ut,withNestedBuilders:$t,include:vt,fileSuffix:_t,fileCase:jt,builderSuffix:Gt,defaultString:Kt,defaultNumber:Jt,defaultBoolean:Yt,inlineDefaultJsdocTag:Lt},Wt=J.make("init",ct).pipe(J.withHandler(He)),Vt=J.make("ts-databuilders",ct),lt=Vt.pipe(J.withHandler(()=>st),J.withSubcommands([Wt]),J.provide(e=>oe.mergeAll(ee.Default,ne.Default,X.Default).pipe(oe.provide(oe.effect($,Ge(e))))),J.run({name:"Typescript Databuilders generator",version:"v0.0.1"}));var Zt=ut.mergeAll(mt.minimumLogLevel(gt.Info),L.Default,dt.layer);lt(process.argv).pipe(pt.provide(Zt),ft.runMain);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@nemmtor/ts-databuilders",
4
- "version": "0.0.1-alpha.10",
4
+ "version": "0.0.1-alpha.12",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "description": "CLI tool that automatically generates builder classes from annotated TypeScript types.",
@@ -49,7 +49,7 @@
49
49
  "@effect/vitest": "^0.27.0",
50
50
  "@total-typescript/ts-reset": "^0.6.1",
51
51
  "@types/node": "^24.0.0",
52
- "@vitest/coverage-v8": "4.0.7",
52
+ "@vitest/coverage-v8": "4.0.8",
53
53
  "dependency-cruiser": "^17.2.0",
54
54
  "knip": "^5.66.4",
55
55
  "lefthook": "^2.0.2",