@nimbus-ds/scripts 1.7.0-rc.1 → 1.7.0-rc.2
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/CHANGELOG.md +8 -0
- package/dist/docgen/Docgen.d.ts +3 -0
- package/dist/docgen/Docgen.js +8 -6
- package/dist/docgen/Docgen.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
This package is intended for internal use in generating custom script builds at design system build time.
|
|
4
4
|
|
|
5
|
+
## 2025-06-04 `1.7.0`
|
|
6
|
+
|
|
7
|
+
#### 🎉 New features
|
|
8
|
+
|
|
9
|
+
- Added `generateBundle` function to `Docgen` class to generate a .json bundle file of all components and subcomponents documentation. ([#296](https://github.com/TiendaNube/nimbus-design-system/pull/296) by [@joacotornello](https://github.com/joacotornello))
|
|
10
|
+
|
|
11
|
+
- Added `GeneratedDoc` type and improved logging. ([#296](https://github.com/TiendaNube/nimbus-design-system/pull/296) by [@joacotornello](https://github.com/joacotornello))
|
|
12
|
+
|
|
5
13
|
## 2025-03-20 `1.6.1` and `1.6.2`
|
|
6
14
|
|
|
7
15
|
#### 🐛 Bug fixes
|
package/dist/docgen/Docgen.d.ts
CHANGED
|
@@ -13,6 +13,9 @@ export declare class Docgen {
|
|
|
13
13
|
};
|
|
14
14
|
};
|
|
15
15
|
constructor(options?: DocgenOptions);
|
|
16
|
+
/**
|
|
17
|
+
* Bundles generated documentation into a single JSON file.
|
|
18
|
+
*/
|
|
16
19
|
generateBundle(docs: GeneratedDoc[], outputPath: string): void;
|
|
17
20
|
generate(paths: Paths): GeneratedDoc[];
|
|
18
21
|
private createDoc;
|
package/dist/docgen/Docgen.js
CHANGED
|
@@ -30,25 +30,27 @@ class Docgen {
|
|
|
30
30
|
// You should probably validate all the options here as well.
|
|
31
31
|
this.options = { ...Docgen.defaultOptions, ...options };
|
|
32
32
|
}
|
|
33
|
+
/**
|
|
34
|
+
* Bundles generated documentation into a single JSON file.
|
|
35
|
+
*/
|
|
33
36
|
generateBundle(docs, outputPath) {
|
|
34
37
|
const docById = docs.reduce((acc, doc) => {
|
|
35
38
|
acc[doc.id] = doc;
|
|
36
39
|
return acc;
|
|
37
40
|
}, {});
|
|
38
|
-
//
|
|
39
|
-
|
|
40
|
-
|
|
41
|
+
// Write the bundled documentation as minified JSON
|
|
42
|
+
(0, fs_1.writeFileSync)(outputPath, JSON.stringify(docById));
|
|
43
|
+
console.log(`Bundle documentation generated successfully in ${outputPath}`);
|
|
41
44
|
}
|
|
42
45
|
generate(paths) {
|
|
43
46
|
this.paths = { ...this.paths, ...paths };
|
|
44
|
-
|
|
45
|
-
console.log("Building compiler for sent paths...");
|
|
47
|
+
console.log(`Building documentation for ${paths.components.length} components...`);
|
|
46
48
|
const allPaths = [...paths.components, ...(paths?.subComponents ?? [])];
|
|
47
49
|
this.program = TJS.getProgramFromFiles(allPaths.map((path) => path_1.default.resolve(path)), this.options.compilerOptions);
|
|
48
50
|
this.generator = TJS.buildGenerator(this.program, this.options.settings);
|
|
49
51
|
// Building documentation
|
|
50
52
|
const docs = this.paths.components.map((path) => this.createDoc(path));
|
|
51
|
-
console.log("
|
|
53
|
+
console.log("Documentation generated successfully");
|
|
52
54
|
return docs;
|
|
53
55
|
}
|
|
54
56
|
createDoc(path) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Docgen.js","sourceRoot":"","sources":["../../src/docgen/Docgen.ts"],"names":[],"mappings":";;;;AAAA,wDAA4B;AAC5B,oEAA8C;AAC9C,2BAAiD;AACjD,6CAA+D;AAC/D,6DAA+E;AAG/E,8BAA8B;AAC9B,MAAa,MAAM;IACT,OAAO,CAAe;IAEtB,OAAO,GAAkB,EAAE,CAAC;IAE5B,SAAS,GAAmC,IAAI,CAAC;IAEjD,KAAK,GAAU,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;IAErD,SAAS,GAAG;QAClB,EAAE,EAAE,EAAE;QACN,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,EAAE;QACV,aAAa,EAAE,EAAE;KAClB,CAAC;IAEF,MAAM,CAAC,cAAc,GAAG;QACtB,QAAQ,EAAE,oCAAe;QACzB,eAAe,EAAE,2CAAsB;KACxC,CAAC;IAEF,YAAY,UAAyB,EAAE;QACrC,2DAA2D;QAC3D,qEAAqE;QACrE,6DAA6D;QAE7D,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,MAAM,CAAC,cAAc,EAAE,GAAG,OAAO,EAAE,CAAC;IAC1D,CAAC;
|
|
1
|
+
{"version":3,"file":"Docgen.js","sourceRoot":"","sources":["../../src/docgen/Docgen.ts"],"names":[],"mappings":";;;;AAAA,wDAA4B;AAC5B,oEAA8C;AAC9C,2BAAiD;AACjD,6CAA+D;AAC/D,6DAA+E;AAG/E,8BAA8B;AAC9B,MAAa,MAAM;IACT,OAAO,CAAe;IAEtB,OAAO,GAAkB,EAAE,CAAC;IAE5B,SAAS,GAAmC,IAAI,CAAC;IAEjD,KAAK,GAAU,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;IAErD,SAAS,GAAG;QAClB,EAAE,EAAE,EAAE;QACN,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,EAAE;QACV,aAAa,EAAE,EAAE;KAClB,CAAC;IAEF,MAAM,CAAC,cAAc,GAAG;QACtB,QAAQ,EAAE,oCAAe;QACzB,eAAe,EAAE,2CAAsB;KACxC,CAAC;IAEF,YAAY,UAAyB,EAAE;QACrC,2DAA2D;QAC3D,qEAAqE;QACrE,6DAA6D;QAE7D,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,MAAM,CAAC,cAAc,EAAE,GAAG,OAAO,EAAE,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,IAAoB,EAAE,UAAkB;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACvC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;YAClB,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAyB,CAAC,CAAC;QAE9B,mDAAmD;QACnD,IAAA,kBAAa,EAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QAEnD,OAAO,CAAC,GAAG,CAAC,kDAAkD,UAAU,EAAE,CAAC,CAAC;IAC9E,CAAC;IAEM,QAAQ,CAAC,KAAY;QAC1B,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;QAEzC,OAAO,CAAC,GAAG,CACT,8BAA8B,KAAK,CAAC,UAAU,CAAC,MAAM,gBAAgB,CACtE,CAAC;QACF,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,KAAK,EAAE,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,mBAAmB,CACpC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAC9C,IAAI,CAAC,OAAO,CAAC,eAAe,CAC7B,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEzE,yBAAyB;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAEvE,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,SAAS,CAAC,IAAY;QAC5B,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,KAAK,CAAC,CAAC;QAErD,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAE1C,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CACpC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,MAAM,CACpD,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAC3C,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAC5B,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,MAAM,EAC5B,IAAI,CAAC,SAAS,CAAC,IAAI,CACpB,eAAe,CACjB,CAAC;QAEF,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,YAAY,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9C,MAAM,GAAG,GAAiB;YACxB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;YACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACzB,UAAU,EAAE,KAAK,CAAC,MAAM;YACxB,WAAW;YACX,OAAO;YACP,OAAO;YACP,KAAK;YACL,aAAa;SACd,CAAC;QAEF,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;QACrE,IAAA,kBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAClD,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC;QAEjC,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,WAAW,CACjB,MAAsB,EACtB,gBAA2B;QAE3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CACxD,CAAC,IAAY,EAAE,IAAI,EAAE,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,IAAI,CAAoB,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,EAAE,QAAQ;gBACjC,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxC,CAAC,CAAC,KAAK,CAAC;YAEV,IAAI,QAAQ;gBAAE,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/D,OAAO,IAAI,CAAC;QACd,CAAC,EACD,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,CAAC,gBAAgB,EAAE,MAAM,EAAE;YAC9B,MAAM,SAAS,GACb,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAE3D,KAAK,CAAC,OAAO,CAAC;gBACZ,OAAO,EAAE,SAAS;gBAClB,WAAW,EACT,qFAAqF;gBACvF,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,gBAAgB;wBACtB,IAAI,EAAE,QAAQ;qBACf;oBACD;wBACE,IAAI,EAAE,mBAAmB;qBAC1B;iBACF;gBACD,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAC;SACJ;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,SAAS,CAAC,YAAoB;QACpC,IAAI;YACF,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,CAC/B,IAAI,CAAC,OAAO,EACZ,YAAY,EACZ,IAAI,CAAC,OAAO,CAAC,QAAQ,EACrB,EAAE,EACF,IAAI,CAAC,SAAS,IAAI,SAAS,CAC5B,CAAC;YAEF,IAAI,CAAC,MAAM,EAAE;gBACX,4HAA4H;gBAC5H,OAAO,CAAC,IAAI,CAAC,uBAAuB,YAAY,EAAE,CAAC,CAAC;gBACpD,OAAO,EAAE,CAAC;aACX;YAED,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,mCAAmC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC;YACtE,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAEO,SAAS,CAAC,IAAY;QAC5B,OAAO,IAAA,iBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAEO,gBAAgB,CAAC,IAAY;QACnC,MAAM,KAAK,GAAG,MAAM,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9C,OAAO,IAAA,wBAAU,EAAC,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,cAAc;QACpB,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7D,CAAC;IAEO,UAAU;QAChB,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7D,CAAC;IAEO,eAAe;QACrB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1D,OAAO,iDAAiD,OAAO,eAAe,IAAA,uBAAS,EACrF,IAAI,CAAC,SAAS,CAAC,EAAE,CAClB,EAAE,CAAC;IACN,CAAC;IAEO,mBAAmB;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,4CAA4C,EAAE,GAAG,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3D,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC;IAEO,cAAc;QACpB,OAAO,IAAA,uBAAS,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAEO,qBAAqB;QAC3B,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EACxE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CACZ,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,IAAY;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAClD,CAAC;IAEO,gBAAgB;QACtB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAExD,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,IAAW,EAAE,IAAI,EAAE,EAAE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAE3C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,YAAY,YAAY,CAAC,CAAC;YAE3D,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAEvC,IAAI,CAAC,IAAI,CAAC;gBACR,IAAI,EAAE,IAAI;gBACV,UAAU,EAAE,KAAK,CAAC,MAAM;gBACxB,KAAK;aACN,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,aAAa,CAAC;IACvB,CAAC;;AAhPH,wBAiPC"}
|