@nimbus-ds/scripts 1.2.1 → 1.3.0
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 +6 -0
- package/dist/docgen/Docgen.d.ts +3 -0
- package/dist/docgen/Docgen.js +12 -0
- package/dist/docgen/Docgen.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
This package is intended for internal use in generating custom script builds at design system build time.
|
|
4
4
|
|
|
5
|
+
## 2023-05-24 `1.3.0`
|
|
6
|
+
|
|
7
|
+
#### 🎉 New features
|
|
8
|
+
|
|
9
|
+
- Added the `packageName` and `version` props to the documentation generation script. ([#165](https://github.com/TiendaNube/nimbus-design-system/pull/165) by [@juniorconquista](https://github.com/juniorconquista))
|
|
10
|
+
|
|
5
11
|
## 2023-04-11 `1.2.1`
|
|
6
12
|
|
|
7
13
|
#### 🐛 Bug fixes
|
package/dist/docgen/Docgen.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ export declare class Docgen {
|
|
|
6
6
|
private generator;
|
|
7
7
|
private paths;
|
|
8
8
|
private sourceComponent;
|
|
9
|
+
private sourcePackage;
|
|
9
10
|
private componentName;
|
|
10
11
|
private componentId;
|
|
11
12
|
private componentPath;
|
|
@@ -22,6 +23,8 @@ export declare class Docgen {
|
|
|
22
23
|
private getSchema;
|
|
23
24
|
private getSource;
|
|
24
25
|
private getComponentName;
|
|
26
|
+
private getPackageName;
|
|
27
|
+
private getVersion;
|
|
25
28
|
private getPolymorphicProps;
|
|
26
29
|
private getComponentId;
|
|
27
30
|
private getSubComponentsNames;
|
package/dist/docgen/Docgen.js
CHANGED
|
@@ -14,6 +14,7 @@ class Docgen {
|
|
|
14
14
|
generator = null;
|
|
15
15
|
paths = { components: [], subComponents: [] };
|
|
16
16
|
sourceComponent = "";
|
|
17
|
+
sourcePackage = "";
|
|
17
18
|
componentName = "";
|
|
18
19
|
componentId = "";
|
|
19
20
|
componentPath = "";
|
|
@@ -45,14 +46,19 @@ class Docgen {
|
|
|
45
46
|
this.componentPath = this.getComponentPath(path);
|
|
46
47
|
this.componentId = this.getComponentId();
|
|
47
48
|
this.sourceComponent = this.getSource(`${this.componentPath}/${this.componentName}.tsx`);
|
|
49
|
+
this.sourcePackage = this.getSource(`${this.componentPath.replace(`${this.componentName}/src`, this.componentName)}/package.json`);
|
|
48
50
|
const polymorphicProps = this.getPolymorphicProps();
|
|
49
51
|
const schema = this.getSchema(`${this.componentName}Properties`);
|
|
50
52
|
const props = this.formatProps(schema, polymorphicProps);
|
|
53
|
+
const packageName = this.getPackageName();
|
|
54
|
+
const version = this.getVersion();
|
|
51
55
|
const subComponents = this.getSubComponents();
|
|
52
56
|
const doc = {
|
|
53
57
|
id: this.componentId,
|
|
54
58
|
name: this.componentName,
|
|
55
59
|
totalProps: props.length,
|
|
60
|
+
packageName,
|
|
61
|
+
version,
|
|
56
62
|
props,
|
|
57
63
|
subComponents,
|
|
58
64
|
};
|
|
@@ -100,6 +106,12 @@ class Docgen {
|
|
|
100
106
|
const fullPatch = path.match(/(\w+)\.types\.ts/gm)?.[0] ?? "";
|
|
101
107
|
return (0, change_case_1.pascalCase)(fullPatch.replace(".types.ts", ""));
|
|
102
108
|
}
|
|
109
|
+
getPackageName() {
|
|
110
|
+
return this.sourcePackage.match(/"name": "(.+)",/m)?.[1] ?? "";
|
|
111
|
+
}
|
|
112
|
+
getVersion() {
|
|
113
|
+
return this.sourcePackage.match(/"version": "(.+)",/m)?.[1] ?? "";
|
|
114
|
+
}
|
|
103
115
|
getPolymorphicProps() {
|
|
104
116
|
const match = this.sourceComponent.match(/PolymorphicForwardRefComponent<(.+),.+> &$/m)?.[1];
|
|
105
117
|
return match ? match.replace(/[" ]/gm, "").split("|") : [];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Docgen.js","sourceRoot":"","sources":["../../src/docgen/Docgen.ts"],"names":[],"mappings":";;;;AAAA,wDAA4B;AAC5B,oEAA8C;AAC9C,2BAAiD;AACjD,6CAAoD;AACpD,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,eAAe,GAAG,EAAE,CAAC;IAErB,aAAa,GAAG,EAAE,CAAC;IAEnB,WAAW,GAAG,EAAE,CAAC;IAEjB,aAAa,GAAG,EAAE,CAAC;IAE3B,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;IAEM,QAAQ,CAAC,KAAY;QAC1B,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;QAEzC,mCAAmC;QACnC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACnD,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,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAEO,SAAS,CAAC,IAAY;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEzC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,SAAS,CACnC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,MAAM,CAClD,CAAC;
|
|
1
|
+
{"version":3,"file":"Docgen.js","sourceRoot":"","sources":["../../src/docgen/Docgen.ts"],"names":[],"mappings":";;;;AAAA,wDAA4B;AAC5B,oEAA8C;AAC9C,2BAAiD;AACjD,6CAAoD;AACpD,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,eAAe,GAAG,EAAE,CAAC;IAErB,aAAa,GAAG,EAAE,CAAC;IAEnB,aAAa,GAAG,EAAE,CAAC;IAEnB,WAAW,GAAG,EAAE,CAAC;IAEjB,aAAa,GAAG,EAAE,CAAC;IAE3B,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;IAEM,QAAQ,CAAC,KAAY;QAC1B,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;QAEzC,mCAAmC;QACnC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACnD,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,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAEO,SAAS,CAAC,IAAY;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEzC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,SAAS,CACnC,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,MAAM,CAClD,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CACjC,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAC3B,GAAG,IAAI,CAAC,aAAa,MAAM,EAC3B,IAAI,CAAC,aAAa,CACnB,eAAe,CACjB,CAAC;QAEF,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,aAAa,YAAY,CAAC,CAAC;QACjE,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,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9C,MAAM,GAAG,GAAG;YACV,EAAE,EAAE,IAAI,CAAC,WAAW;YACpB,IAAI,EAAE,IAAI,CAAC,aAAa;YACxB,UAAU,EAAE,KAAK,CAAC,MAAM;YACxB,WAAW;YACX,OAAO;YACP,KAAK;YACL,aAAa;SACd,CAAC;QAEF,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,WAAW,YAAY,CAAC;QACnE,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;IACnC,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,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAE1E,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,OAAO,CACL,GAAG,CAAC,cAAc,CAChB,IAAI,CAAC,OAAO,EACZ,YAAY,EACZ,IAAI,CAAC,OAAO,CAAC,QAAQ,EACrB,EAAE,EACF,IAAI,CAAC,SAAS,IAAI,SAAS,CAC5B,IAAI,EAAE,CACR,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,IAAY;QAC5B,OAAO,IAAA,iBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAEO,gBAAgB,CAAC,IAAY;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9D,OAAO,IAAA,wBAAU,EAAC,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,cAAc;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACjE,CAAC;IAEO,UAAU;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpE,CAAC;IAEO,mBAAmB;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CACtC,6CAA6C,CAC9C,EAAE,CAAC,CAAC,CAAC,CAAC;QAEP,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,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,qBAAqB;QAC3B,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EACvE,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;QACxD,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;YAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,YAAY,YAAY,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACvC,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;QACP,OAAO,aAAa,CAAC;IACvB,CAAC;;AAnMH,wBAoMC;AAEY,QAAA,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC"}
|