@rocketh/doc 0.17.16 → 0.17.18

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 (6) hide show
  1. package/README.md +3 -7
  2. package/dist/cli.js +1 -1
  3. package/dist/cli.js.map +1 -1
  4. package/package.json +7 -7
  5. package/src/cli.ts +4 -4
  6. package/src/index.ts +2 -2
package/README.md CHANGED
@@ -1,11 +1,7 @@
1
1
  # @rocketh/doc
2
2
 
3
- `rocketh-doc` generates documentation from deployments files, following rocketh format composed of address,abi, etc....
3
+ Documentation generation tool for rocketh, capable of generating documentation from deployed contracts using customizable Handlebars templates.
4
4
 
5
- There is plan to support doc generation from compiled artifacts too, but no work has started on that.
5
+ For full documentation, visit [rocketh.dev](https://rocketh.dev).
6
6
 
7
- We welcome contribution if you are interested to support that feature.
8
-
9
- For now rocketh-doc is intended to be used to document a set of deployed contract.
10
-
11
- Note that documentation template (written in handlebars) have access to the deployment address.
7
+ For hardhat-deploy documentation, see [rocketh.dev/hardhat-deploy/](https://rocketh.dev/hardhat-deploy/).
package/dist/cli.js CHANGED
@@ -3,7 +3,7 @@ import { run } from './index.js';
3
3
  import { Command } from 'commander';
4
4
  import pkg from '../package.json' with { type: 'json' };
5
5
  import { readAndResolveConfig } from '@rocketh/node';
6
- const commandName = "rocketh-doc";
6
+ const commandName = 'rocketh-doc';
7
7
  const program = new Command();
8
8
  program
9
9
  .name(commandName)
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,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAGrD,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"}
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,EAAC,oBAAoB,EAAC,MAAM,eAAe,CAAC;AAGnD,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,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rocketh/doc",
3
- "version": "0.17.16",
3
+ "version": "0.17.18",
4
4
  "description": "can generate doc from rocketh deployments and provided template",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -31,18 +31,18 @@
31
31
  "commander": "^14.0.2",
32
32
  "fs-extra": "^11.3.3",
33
33
  "handlebars": "^4.7.8",
34
- "viem": "^2.44.1",
35
- "@rocketh/core": "0.17.8"
34
+ "viem": "^2.44.4",
35
+ "@rocketh/core": "0.17.9"
36
36
  },
37
37
  "devDependencies": {
38
- "@types/node": "^25.0.6",
39
- "as-soon": "^0.0.11",
38
+ "@types/node": "^25.0.10",
39
+ "as-soon": "^0.1.4",
40
40
  "rimraf": "^6.1.2",
41
41
  "typescript": "^5.9.3",
42
- "@rocketh/node": "0.17.16"
42
+ "@rocketh/node": "0.17.18"
43
43
  },
44
44
  "peerDependencies": {
45
- "@rocketh/node": "0.17.16"
45
+ "@rocketh/node": "0.17.18"
46
46
  },
47
47
  "scripts": {
48
48
  "build": "tsc --project tsconfig.json",
package/src/cli.ts CHANGED
@@ -3,10 +3,10 @@ import {run} from './index.js';
3
3
  import {Command} from 'commander';
4
4
  import pkg from '../package.json' with {type: 'json'};
5
5
  import {RunOptions} from './index.js';
6
- import { readAndResolveConfig } from '@rocketh/node';
7
- import type {ConfigOverrides} from '@rocketh/core/types'
6
+ import {readAndResolveConfig} from '@rocketh/node';
7
+ import type {ConfigOverrides} from '@rocketh/core/types';
8
8
 
9
- const commandName = "rocketh-doc";
9
+ const commandName = 'rocketh-doc';
10
10
 
11
11
  const program = new Command();
12
12
  program
@@ -23,4 +23,4 @@ program
23
23
  const {environment, ...options} = program.opts();
24
24
  options.exceptSuffix = options.exceptSuffix?.split(',') || [];
25
25
  const resolvedConfig = await readAndResolveConfig({...(options as ConfigOverrides)});
26
- run(resolvedConfig, environment, options as RunOptions,);
26
+ run(resolvedConfig, environment, options as RunOptions);
package/src/index.ts CHANGED
@@ -47,7 +47,7 @@ export async function run(config: ResolvedUserConfig, environmentName: string, o
47
47
 
48
48
  export async function generate(
49
49
  {deployments}: {deployments: UnknownDeployments; chainId?: string},
50
- options: RunOptions
50
+ options: RunOptions,
51
51
  ) {
52
52
  if (!deployments || Object.keys(deployments).length === 0) {
53
53
  console.log(`no deployments to export`);
@@ -129,7 +129,7 @@ export async function generateFromDeployments(deployments: UnknownDeployments, o
129
129
 
130
130
  export function generateDocumentationData(
131
131
  name: string,
132
- deploymentOrArfifact: Partial<Deployment<Abi>> & Artifact<Abi>
132
+ deploymentOrArfifact: Partial<Deployment<Abi>> & Artifact<Abi>,
133
133
  ): DocumentationData {
134
134
  const abi = deploymentOrArfifact.abi;
135
135
  const abiMap = new Map<string, AbiConstructor | AbiError | AbiEvent | AbiFunction>();