@rocketh/doc 0.15.0-testing.8 → 0.15.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/dist/cli.js +3 -3
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/cli.ts +3 -3
- package/src/index.ts +3 -3
package/dist/cli.js
CHANGED
|
@@ -13,10 +13,10 @@ program
|
|
|
13
13
|
.option('-o, --output <value>', 'folder where to generate docs')
|
|
14
14
|
.option('-t, --template <value>', 'template used to generate docs')
|
|
15
15
|
.option('--except-suffix <suffix, suffix....>', 'ignore contract that ends with the provided suffixes')
|
|
16
|
-
.requiredOption('--
|
|
16
|
+
.requiredOption('-e, --environment <value>', 'environment context to use')
|
|
17
17
|
.parse(process.argv);
|
|
18
|
-
const {
|
|
18
|
+
const { environment, ...options } = program.opts();
|
|
19
19
|
options.exceptSuffix = options.exceptSuffix?.split(',') || [];
|
|
20
20
|
const resolvedConfig = await readAndResolveConfig({ ...options });
|
|
21
|
-
run(resolvedConfig,
|
|
21
|
+
run(resolvedConfig, environment, options);
|
|
22
22
|
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAEtD,OAAO,EAAmB,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEhE,MAAM,WAAW,GAAG,aAAa,CAAC;AAElC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO;KACL,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,sDAAsD,CAAC;KACnE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;KACpB,MAAM,CAAC,2BAA2B,EAAE,oCAAoC,CAAC;KACzE,MAAM,CAAC,sBAAsB,EAAE,+BAA+B,CAAC;KAC/D,MAAM,CAAC,wBAAwB,EAAE,gCAAgC,CAAC;KAClE,MAAM,CAAC,sCAAsC,EAAE,sDAAsD,CAAC;KACtG,cAAc,CAAC,
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAEtD,OAAO,EAAmB,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEhE,MAAM,WAAW,GAAG,aAAa,CAAC;AAElC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO;KACL,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,sDAAsD,CAAC;KACnE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;KACpB,MAAM,CAAC,2BAA2B,EAAE,oCAAoC,CAAC;KACzE,MAAM,CAAC,sBAAsB,EAAE,+BAA+B,CAAC;KAC/D,MAAM,CAAC,wBAAwB,EAAE,gCAAgC,CAAC;KAClE,MAAM,CAAC,sCAAsC,EAAE,sDAAsD,CAAC;KACtG,cAAc,CAAC,2BAA2B,EAAE,4BAA4B,CAAC;KACzE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtB,MAAM,EAAC,WAAW,EAAE,GAAG,OAAO,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;AACjD,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;AAC9D,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAI,OAA2B,EAAC,CAAC,CAAC;AACrF,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE,OAAqB,CAAE,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export type RunOptions = {
|
|
|
6
6
|
output?: string;
|
|
7
7
|
exceptSuffix?: string[];
|
|
8
8
|
};
|
|
9
|
-
export declare function run(config: ResolvedUserConfig,
|
|
9
|
+
export declare function run(config: ResolvedUserConfig, environmentName: string, options: RunOptions): Promise<void>;
|
|
10
10
|
export declare function generate({ deployments }: {
|
|
11
11
|
deployments: UnknownDeployments;
|
|
12
12
|
chainId?: string;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,UAAU,EACV,QAAQ,EACR,GAAG,EACH,kBAAkB,EAMlB,kBAAkB,EAClB,MAAM,SAAS,CAAC;AAQjB,OAAO,EAAC,iBAAiB,EAAqD,MAAM,YAAY,CAAC;AAEjG,cAAc,YAAY,CAAC;AAI3B,MAAM,MAAM,UAAU,GAAG;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC;AAavF,wBAAsB,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,UAAU,EACV,QAAQ,EACR,GAAG,EACH,kBAAkB,EAMlB,kBAAkB,EAClB,MAAM,SAAS,CAAC;AAQjB,OAAO,EAAC,iBAAiB,EAAqD,MAAM,YAAY,CAAC;AAEjG,cAAc,YAAY,CAAC;AAI3B,MAAM,MAAM,UAAU,GAAG;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC;AAavF,wBAAsB,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,iBAMjG;AAED,wBAAsB,QAAQ,CAC7B,EAAC,WAAW,EAAC,EAAE;IAAC,WAAW,EAAE,kBAAkB,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAC,EAClE,OAAO,EAAE,UAAU,iBAiBnB;AAED,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,iBAiBtE;AAgBD,wBAAsB,uBAAuB,CAAC,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,UAAU,iBA0BjG;AAED,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,MAAM,EACZ,oBAAoB,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAC5D,iBAAiB,CAkLnB"}
|
package/dist/index.js
CHANGED
|
@@ -17,10 +17,10 @@ function filter(options, name) {
|
|
|
17
17
|
}
|
|
18
18
|
return true;
|
|
19
19
|
}
|
|
20
|
-
export async function run(config,
|
|
21
|
-
const { deployments, chainId } = loadDeployments(config.deployments,
|
|
20
|
+
export async function run(config, environmentName, options) {
|
|
21
|
+
const { deployments, chainId } = loadDeployments(config.deployments, environmentName);
|
|
22
22
|
if (!chainId) {
|
|
23
|
-
throw new Error(`no chainId found for ${
|
|
23
|
+
throw new Error(`no chainId found for ${environmentName}`);
|
|
24
24
|
}
|
|
25
25
|
generate({ deployments }, options);
|
|
26
26
|
}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAa1B,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AACxC,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAC,QAAQ,EAAE,gBAAgB,EAAC,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAC;AAIlC,cAAc,YAAY,CAAC;AAE3B,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAI1D,SAAS,MAAM,CAAC,OAAmB,EAAE,IAAY;IAChD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,MAA0B,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAa1B,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AACxC,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAC,QAAQ,EAAE,gBAAgB,EAAC,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAC;AAIlC,cAAc,YAAY,CAAC;AAE3B,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAI1D,SAAS,MAAM,CAAC,OAAmB,EAAE,IAAY;IAChD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,MAA0B,EAAE,eAAuB,EAAE,OAAmB;IACjG,MAAM,EAAC,WAAW,EAAE,OAAO,EAAC,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IACpF,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,eAAe,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,QAAQ,CAAC,EAAC,WAAW,EAAC,EAAE,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC7B,EAAC,WAAW,EAAsD,EAClE,OAAmB;IAEnB,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;QACxC,OAAO;IACR,CAAC;IAED,MAAM,UAAU,GAAuB,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC5B,SAAS;QACV,CAAC;QACD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,OAAO,uBAAuB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc,EAAE,OAAmB;IACtE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,WAAW,GAAuB,EAAE,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC5B,SAAS;YACV,CAAC;YAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YAChD,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;QAChC,CAAC;IACF,CAAC;IAED,OAAO,uBAAuB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AAED,gHAAgH;AAChH,yCAAyC;AACzC,+CAA+C;AAC/C,+BAA+B;AAC/B,kCAAkC;AAClC,iFAAiF;AACjF,sDAAsD;AACtD,6DAA6D;AAC7D,MAAM;AACN,KAAK;AAEL,yDAAyD;AACzD,IAAI;AAEJ,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,WAA+B,EAAE,OAAmB;IACjG,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;IAC9C,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,+CAA+C,CAAC,CAAC;IACnH,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAErD,MAAM,eAAe,GAAwB,EAAE,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,yBAAyB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACzD,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC9B,IAAI,YAAY,KAAK,eAAe,EAAE,CAAC;QACtC,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE,CAAC;YAC1C,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;YACvC,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC7B,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;YAC/E,CAAC;QACF,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,SAAS,GAAG,QAAQ,CAAC,EAAC,SAAS,EAAE,eAAe,EAAC,CAAC,CAAC;QACzD,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;AACF,CAAC;AAED,MAAM,UAAU,yBAAyB,CACxC,IAAY,EACZ,oBAA8D;IAE9D,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8D,CAAC;IACrF,KAAK,MAAM,UAAU,IAAI,GAAG,EAAE,CAAC;QAC9B,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACzB,KAAK,aAAa;gBACjB,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;gBACtC,MAAM;YACP,KAAK,OAAO;gBACX,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACxC,MAAM;YACP,KAAK,OAAO;gBACX,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACxC,MAAM;YACP,KAAK,UAAU;gBACd,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACxC,MAAM;QACR,CAAC;IACF,CAAC;IAED,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAgB,EAAE,CAAC;IAEhC,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1C,+BAA+B;QAC/B,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/E,MAAM,SAAS,GACd,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;YAEzG,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAa,CAAC;YAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACV,SAAS;YACV,CAAC;YACD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;YAEvE,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC7E,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,cAAc,CAAC,CAAC;YAC9E,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,IAAI,eAAe,EAAE,CAAC;gBACrB,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;oBACnC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;wBAChB,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;4BAC/D,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;wBACpE,CAAC;wBACD,yBAAyB;wBACzB,sDAAsD;oBACvD,CAAC;gBACF,CAAC;YACF,CAAC;YACD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,gBAAgB,EAAE,CAAC;gBACtB,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;oBACpC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;wBAChB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;4BAC1B,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;gCAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACnB,CAAC;wBACF,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;YAED,MAAM,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,cAAc;gBACzB,GAAG,EAAE,GAAG;gBACR,UAAU;gBACV,MAAM;gBACN,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1C,+BAA+B;QAC/B,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/E,MAAM,SAAS,GACd,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;YAEzG,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAa,CAAC;YAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACV,SAAS;YACV,CAAC;YACD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;YAEvE,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC7E,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,cAAc,CAAC,CAAC;YAC9E,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,IAAI,eAAe,EAAE,MAAM,EAAE,CAAC;gBAC7B,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC3E,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;gBAChF,CAAC;YACF,CAAC;YAED,MAAM,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,cAAc;gBACzB,GAAG,EAAE,GAAe;gBACpB,UAAU;gBACV,MAAM,EAAE,gBAAgB,CAAC,MAAM;gBAC/B,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,IAAI,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;QAC3C,+BAA+B;QAC/B,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACjF,MAAM,UAAU,GACf,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;YAE7G,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAiC,CAAC;YACnE,IAAI,CAAC,GAAG,EAAE,CAAC;gBACV,SAAS;YACV,CAAC;YACD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACzF,MAAM,WAAW,GAAG,GAAG,IAAI,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAE/G,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YAChF,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC;YACjF,MAAM,MAAM,GAAe,EAAE,CAAC;YAC9B,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;gBAC9B,KAAK,MAAM,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5E,MAAM,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;gBACjF,CAAC;YACF,CAAC;YACD,MAAM,OAAO,GAAgB,EAAE,CAAC;YAChC,IAAI,gBAAgB,EAAE,OAAO,EAAE,CAAC;gBAC/B,KAAK,MAAM,UAAU,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC/E,OAAO,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAC,CAAC,CAAC;gBACrF,CAAC;YACF,CAAC;YAED,IAAI,UAAU,KAAK,aAAa,EAAE,CAAC;gBAClC,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,aAAa;oBACnB,GAAG,EAAE,GAAqB;oBAC1B,SAAS,EAAE,eAAe;oBAC1B,UAAU;oBACV,MAAM,EAAE,iBAAiB,CAAC,MAAM;oBAChC,MAAM;oBACN,OAAO;iBACP,CAAC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAyB,CAAC;gBACtE,OAAO,CAAC,IAAI,CAAC;oBACZ,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,GAAkB;oBACvB,SAAS,EAAE,eAAe;oBAC1B,UAAU;oBACV,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE,iBAAiB,CAAC,MAAM;oBAChC,MAAM;oBACN,OAAO;iBACP,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC;IAED,MAAM,IAAI,GAAsB;QAC/B,IAAI;QACJ,OAAO,EAAE,oBAAoB,CAAC,OAAO;QACrC,GAAG;QACH,MAAM,EAAE,oBAAoB,CAAC,MAAM,EAAE,MAAM;QAC3C,KAAK,EAAE,oBAAoB,CAAC,MAAM,EAAE,KAAK;QACzC,MAAM,EAAE,oBAAoB,CAAC,OAAO,EAAE,MAAM;QAC5C,MAAM;QACN,MAAM;QACN,OAAO;KACP,CAAC;IACF,OAAO,IAAI,CAAC;AACb,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rocketh/doc",
|
|
3
|
-
"version": "0.15.0
|
|
3
|
+
"version": "0.15.0",
|
|
4
4
|
"description": "can generate doc from rocketh deployments and provided template",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -28,10 +28,10 @@
|
|
|
28
28
|
"as-soon": "^0.0.11",
|
|
29
29
|
"rimraf": "^6.0.1",
|
|
30
30
|
"typescript": "^5.9.2",
|
|
31
|
-
"rocketh": "0.15.0
|
|
31
|
+
"rocketh": "0.15.0"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
|
-
"rocketh": "0.15.0
|
|
34
|
+
"rocketh": "0.15.0"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"@types/fs-extra": "^11.0.4",
|
package/src/cli.ts
CHANGED
|
@@ -16,10 +16,10 @@ program
|
|
|
16
16
|
.option('-o, --output <value>', 'folder where to generate docs')
|
|
17
17
|
.option('-t, --template <value>', 'template used to generate docs')
|
|
18
18
|
.option('--except-suffix <suffix, suffix....>', 'ignore contract that ends with the provided suffixes')
|
|
19
|
-
.requiredOption('--
|
|
19
|
+
.requiredOption('-e, --environment <value>', 'environment context to use')
|
|
20
20
|
.parse(process.argv);
|
|
21
21
|
|
|
22
|
-
const {
|
|
22
|
+
const {environment, ...options} = program.opts();
|
|
23
23
|
options.exceptSuffix = options.exceptSuffix?.split(',') || [];
|
|
24
24
|
const resolvedConfig = await readAndResolveConfig({...(options as ConfigOverrides)});
|
|
25
|
-
run(resolvedConfig,
|
|
25
|
+
run(resolvedConfig, environment, options as RunOptions,);
|
package/src/index.ts
CHANGED
|
@@ -37,10 +37,10 @@ function filter(options: RunOptions, name: string): boolean {
|
|
|
37
37
|
return true;
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
-
export async function run(config: ResolvedUserConfig,
|
|
41
|
-
const {deployments, chainId} = loadDeployments(config.deployments,
|
|
40
|
+
export async function run(config: ResolvedUserConfig, environmentName: string, options: RunOptions) {
|
|
41
|
+
const {deployments, chainId} = loadDeployments(config.deployments, environmentName);
|
|
42
42
|
if (!chainId) {
|
|
43
|
-
throw new Error(`no chainId found for ${
|
|
43
|
+
throw new Error(`no chainId found for ${environmentName}`);
|
|
44
44
|
}
|
|
45
45
|
generate({deployments}, options);
|
|
46
46
|
}
|