pixotope-documentalist 1.0.0 → 1.2.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/README.md +27 -8
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.d.ts.map +1 -1
- package/dist/parser/commentExtractor.d.ts +1 -0
- package/dist/parser/commentExtractor.d.ts.map +1 -1
- package/dist/parser/commentExtractor.js +37 -0
- package/dist/parser/commentExtractor.js.map +1 -1
- package/dist/parser/fileScanner.d.ts.map +1 -1
- package/dist/parser/fileScanner.js +1 -0
- package/dist/parser/fileScanner.js.map +1 -1
- package/dist/renderer/confluenceHtml.js +52 -9
- package/dist/renderer/confluenceHtml.js.map +1 -1
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# pixotope-documentalist
|
|
2
2
|
|
|
3
|
-
Parses JSDoc-style API documentation comments from source files (TypeScript, JavaScript, Python) and publishes them as formatted pages to Confluence.
|
|
3
|
+
Parses JSDoc-style API documentation comments from source files (TypeScript, JavaScript, Python, Rust) and publishes them as formatted pages to Confluence.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -63,13 +63,30 @@ def discover_devices(subnet: str, timeout: int) -> dict:
|
|
|
63
63
|
pass
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
+
### Rust
|
|
67
|
+
|
|
68
|
+
Use `///` triple-slash doc comments (consecutive lines form one block):
|
|
69
|
+
|
|
70
|
+
```rust
|
|
71
|
+
/// @api DiscoverDevices
|
|
72
|
+
/// @group Network
|
|
73
|
+
/// @kind call
|
|
74
|
+
/// @description Discovers available devices on the local network.
|
|
75
|
+
/// @param {string} Subnet - The subnet to scan.
|
|
76
|
+
/// @param {integer} Timeout - Scan timeout in milliseconds.
|
|
77
|
+
/// @returns {boolean} Success - Whether the scan completed.
|
|
78
|
+
pub fn discover_devices(subnet: &str, timeout: u64) {
|
|
79
|
+
// ...
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
66
83
|
## Tag Reference
|
|
67
84
|
|
|
68
85
|
| Tag | Required | Description |
|
|
69
86
|
|-----|----------|-------------|
|
|
70
87
|
| `@api` | Yes | Endpoint name (displayed as title) |
|
|
71
88
|
| `@group` | No | Section grouping header |
|
|
72
|
-
| `@kind` | No | `call` (default), `get`, `set` |
|
|
89
|
+
| `@kind` | No | `call` (default), `get`, `set`, `state` (supports both Get and Set) |
|
|
73
90
|
| `@description` | No | Multi-line description (continues until next tag) |
|
|
74
91
|
| `@param` | No | `{type} Name - Description`. `[Name]` = optional, `[Name=default]` = with default |
|
|
75
92
|
| `@returns` | No | `{type} Name - Description` |
|
|
@@ -97,20 +114,21 @@ documents:
|
|
|
97
114
|
master: "1234567890"
|
|
98
115
|
release: "0987654321"
|
|
99
116
|
sources:
|
|
100
|
-
- path: "packages/Daemon/src/endpoints/calls.ts"
|
|
117
|
+
- path: "packages/Daemon/src/endpoints/calls.ts" # single file
|
|
101
118
|
|
|
102
|
-
- id:
|
|
103
|
-
title: "Daemon API -
|
|
119
|
+
- id: daemon_all
|
|
120
|
+
title: "Daemon API - All"
|
|
104
121
|
confluence_id:
|
|
105
|
-
master: "
|
|
106
|
-
release: "
|
|
122
|
+
master: "3333333333"
|
|
123
|
+
release: "4444444444"
|
|
107
124
|
sources:
|
|
108
|
-
- path: "packages/Daemon/src/endpoints/
|
|
125
|
+
- path: "packages/Daemon/src/endpoints/" # entire folder (recursive)
|
|
109
126
|
```
|
|
110
127
|
|
|
111
128
|
- `source_root`: base path for resolving relative source paths (relative to config file location)
|
|
112
129
|
- `confluence_id.master`: page ID for master/development docs
|
|
113
130
|
- `confluence_id.release`: page ID for release docs
|
|
131
|
+
- `sources[].path`: can point to a **single file** or a **folder**. When a folder is given, all supported files inside are scanned recursively. `node_modules` and hidden directories are skipped. Supported extensions: `.ts`, `.tsx`, `.js`, `.jsx`, `.py`, `.rs`, `.h`, `.cpp`, `.hpp`.
|
|
114
132
|
|
|
115
133
|
## CLI Commands
|
|
116
134
|
|
|
@@ -186,4 +204,5 @@ npx ts-node src/index.ts preview --config example/config.yml
|
|
|
186
204
|
- `.ts`, `.tsx` (TypeScript)
|
|
187
205
|
- `.js`, `.jsx` (JavaScript)
|
|
188
206
|
- `.py` (Python)
|
|
207
|
+
- `.rs` (Rust)
|
|
189
208
|
- `.h`, `.cpp`, `.hpp` (C++)
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,KAAK;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,QAAQ,CAAC,MAAM,CAAU,GAAG,QAAQ,CAWtF;AAED,wBAAgB,WAAW,CAAC,MAAM,GAAE,MAAW,GAAG,KAAK,CAOtD;AAED,wBAAgB,cAAc,CAAC,KAAK,GAAE,MAAW,GAAG,QAAQ,CAO3D"}
|
|
@@ -7,6 +7,7 @@ export interface RawDocBlock {
|
|
|
7
7
|
* Extract documentation blocks from a source file.
|
|
8
8
|
* - JS/TS: Extracts /** ... * / blocks that contain @api tags
|
|
9
9
|
* - Python: Extracts consecutive # lines that contain @api tags
|
|
10
|
+
* - Rust: Extracts consecutive /// lines that contain @api tags
|
|
10
11
|
*/
|
|
11
12
|
export declare function extractDocBlocks(filePath: string): RawDocBlock[];
|
|
12
13
|
//# sourceMappingURL=commentExtractor.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"commentExtractor.d.ts","sourceRoot":"","sources":["../../src/parser/commentExtractor.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED
|
|
1
|
+
{"version":3,"file":"commentExtractor.d.ts","sourceRoot":"","sources":["../../src/parser/commentExtractor.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,EAAE,CAiBhE"}
|
|
@@ -10,6 +10,7 @@ const path_1 = __importDefault(require("path"));
|
|
|
10
10
|
* Extract documentation blocks from a source file.
|
|
11
11
|
* - JS/TS: Extracts /** ... * / blocks that contain @api tags
|
|
12
12
|
* - Python: Extracts consecutive # lines that contain @api tags
|
|
13
|
+
* - Rust: Extracts consecutive /// lines that contain @api tags
|
|
13
14
|
*/
|
|
14
15
|
function extractDocBlocks(filePath) {
|
|
15
16
|
const content = fs_1.default.readFileSync(filePath, "utf-8");
|
|
@@ -20,6 +21,9 @@ function extractDocBlocks(filePath) {
|
|
|
20
21
|
if (ext === ".py") {
|
|
21
22
|
return extractPythonDocBlocks(content, filePath);
|
|
22
23
|
}
|
|
24
|
+
if (ext === ".rs") {
|
|
25
|
+
return extractRustDocBlocks(content, filePath);
|
|
26
|
+
}
|
|
23
27
|
return [];
|
|
24
28
|
}
|
|
25
29
|
/**
|
|
@@ -115,6 +119,39 @@ function extractPythonDocBlocks(content, filePath) {
|
|
|
115
119
|
}
|
|
116
120
|
return blocks;
|
|
117
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
* Extract consecutive /// doc comment blocks from Rust files.
|
|
124
|
+
* Only returns blocks that contain at least one @api tag.
|
|
125
|
+
*/
|
|
126
|
+
function extractRustDocBlocks(content, filePath) {
|
|
127
|
+
const blocks = [];
|
|
128
|
+
const lines = content.split("\n");
|
|
129
|
+
let blockLines = [];
|
|
130
|
+
let blockStartLine = 0;
|
|
131
|
+
for (let i = 0; i < lines.length; i++) {
|
|
132
|
+
const trimmed = lines[i].trim();
|
|
133
|
+
if (trimmed.startsWith("///")) {
|
|
134
|
+
if (blockLines.length === 0) {
|
|
135
|
+
blockStartLine = i + 1;
|
|
136
|
+
}
|
|
137
|
+
// Strip /// prefix (optional space after slashes)
|
|
138
|
+
const afterSlashes = trimmed.slice(3).trimStart();
|
|
139
|
+
blockLines.push(afterSlashes);
|
|
140
|
+
}
|
|
141
|
+
else {
|
|
142
|
+
if (blockLines.length > 0) {
|
|
143
|
+
if (hasDocTag(blockLines)) {
|
|
144
|
+
blocks.push({ lines: blockLines, startLine: blockStartLine, filePath });
|
|
145
|
+
}
|
|
146
|
+
blockLines = [];
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
if (blockLines.length > 0 && hasDocTag(blockLines)) {
|
|
151
|
+
blocks.push({ lines: blockLines, startLine: blockStartLine, filePath });
|
|
152
|
+
}
|
|
153
|
+
return blocks;
|
|
154
|
+
}
|
|
118
155
|
function stripLeadingStar(line) {
|
|
119
156
|
// Remove leading "* " or "*"
|
|
120
157
|
if (line.startsWith("* "))
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"commentExtractor.js","sourceRoot":"","sources":["../../src/parser/commentExtractor.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"commentExtractor.js","sourceRoot":"","sources":["../../src/parser/commentExtractor.ts"],"names":[],"mappings":";;;;;AAeA,4CAiBC;AAhCD,4CAAoB;AACpB,gDAAwB;AAQxB;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAEjD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvE,OAAO,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;QAClB,OAAO,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;QAClB,OAAO,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,OAAe,EAAE,QAAgB;IAC3D,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,UAAU,GAAa,EAAE,CAAC;IAC9B,IAAI,cAAc,GAAG,CAAC,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAE5B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,sBAAsB;YACtB,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,OAAO,GAAG,IAAI,CAAC;gBACf,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY;gBACpC,UAAU,GAAG,EAAE,CAAC;gBAEhB,sCAAsC;gBACtC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACjD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;oBAC1C,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACvB,OAAO,GAAG,KAAK,CAAC;oBAEhB,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;wBAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;oBAC1E,CAAC;oBACD,SAAS;gBACX,CAAC;gBAED,wCAAwC;gBACxC,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC1C,IAAI,SAAS,EAAE,CAAC;oBACd,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,iBAAiB;YACjB,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3B,yCAAyC;gBACzC,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChD,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;gBAC9C,IAAI,OAAO,EAAE,CAAC;oBACZ,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC3B,CAAC;gBACD,OAAO,GAAG,KAAK,CAAC;gBAEhB,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1E,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,oCAAoC;gBACpC,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAAC,OAAe,EAAE,QAAgB;IAC/D,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,UAAU,GAAa,EAAE,CAAC;IAC9B,IAAI,cAAc,GAAG,CAAC,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YACD,0BAA0B;YAC1B,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACrD,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,gDAAgD;YAChD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1E,CAAC;gBACD,UAAU,GAAG,EAAE,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAED,kBAAkB;IAClB,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QACnD,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,OAAe,EAAE,QAAgB;IAC7D,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,IAAI,UAAU,GAAa,EAAE,CAAC;IAC9B,IAAI,cAAc,GAAG,CAAC,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,cAAc,GAAG,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YACD,kDAAkD;YAClD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;YAClD,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1E,CAAC;gBACD,UAAU,GAAG,EAAE,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QACnD,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY;IACpC,6BAA6B;IAC7B,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChD,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,KAAe;IAChC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fileScanner.d.ts","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"fileScanner.d.ts","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":"AAUA,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAkBnD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fileScanner.js","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"fileScanner.js","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":";;;;;AAUA,4BAkBC;AA5BD,4CAAoB;AACpB,gDAAwB;AAExB,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC;IACnC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAC5B,KAAK;IACL,KAAK;IACL,IAAI,EAAE,MAAM,EAAE,MAAM;CACrB,CAAC,CAAC;AAEH,SAAgB,QAAQ,CAAC,QAAgB;IACvC,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,IAAI,GAAG,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEnC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QAClB,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAEhD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,oCAAoC;YACpC,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC1E,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB;IACvC,OAAO,oBAAoB,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AACxE,CAAC"}
|
|
@@ -32,6 +32,38 @@ function renderGroup(group) {
|
|
|
32
32
|
}
|
|
33
33
|
return lines.join("\n");
|
|
34
34
|
}
|
|
35
|
+
function getParamsLabel(kind) {
|
|
36
|
+
if (kind === "state")
|
|
37
|
+
return "Set Value";
|
|
38
|
+
if (kind === "set")
|
|
39
|
+
return "Value";
|
|
40
|
+
return "Params";
|
|
41
|
+
}
|
|
42
|
+
function getReturnsLabel(kind) {
|
|
43
|
+
if (kind === "call")
|
|
44
|
+
return "Result";
|
|
45
|
+
if (kind === "set" || kind === "state")
|
|
46
|
+
return "Return Value";
|
|
47
|
+
return "Value";
|
|
48
|
+
}
|
|
49
|
+
function renderWireFormat(endpoint) {
|
|
50
|
+
const lines = [];
|
|
51
|
+
lines.push(`<p><i>Wire format: <code>[Topic, Message]</code></i></p>`);
|
|
52
|
+
if (endpoint.kind === "get") {
|
|
53
|
+
lines.push(`<p><i>Send: <code>GetTopic</code> + <code>{}</code> → Receive: <code>UpdateTopic</code> (targeted) + <code>{Value: ...}</code></i></p>`);
|
|
54
|
+
}
|
|
55
|
+
else if (endpoint.kind === "set") {
|
|
56
|
+
lines.push(`<p><i>Send: <code>SetTopic</code> + <code>{Value: ...}</code> → Triggers: <code>UpdateTopic</code> (BROADCAST) + <code>{Value: ...}</code></i></p>`);
|
|
57
|
+
}
|
|
58
|
+
else if (endpoint.kind === "state") {
|
|
59
|
+
lines.push(`<p><i>Read: <code>GetTopic</code> + <code>{}</code> → Receive: <code>UpdateTopic</code> (targeted) + <code>{Value: ...}</code></i></p>`);
|
|
60
|
+
lines.push(`<p><i>Write: <code>SetTopic</code> + <code>{Value: ...}</code> → Triggers: <code>UpdateTopic</code> (BROADCAST) + <code>{Value: ...}</code></i></p>`);
|
|
61
|
+
}
|
|
62
|
+
else {
|
|
63
|
+
lines.push(`<p><i>Send: <code>CallTopic</code> + <code>{Params: ...}</code> → Receive: <code>CallResultTopic</code> + <code>{Result: ...}</code></i></p>`);
|
|
64
|
+
}
|
|
65
|
+
return lines.join("\n");
|
|
66
|
+
}
|
|
35
67
|
function renderEndpoint(endpoint) {
|
|
36
68
|
const bodyParts = [];
|
|
37
69
|
// Heading inside expand
|
|
@@ -48,31 +80,42 @@ function renderEndpoint(endpoint) {
|
|
|
48
80
|
if (endpoint.description) {
|
|
49
81
|
bodyParts.push(`<p>${escapeHtml(endpoint.description)}</p>`);
|
|
50
82
|
}
|
|
83
|
+
// Wire format hint
|
|
84
|
+
bodyParts.push(renderWireFormat(endpoint));
|
|
51
85
|
// Since badge
|
|
52
86
|
if (endpoint.since) {
|
|
53
87
|
bodyParts.push(`<p><i>Since: ${escapeHtml(endpoint.since)}</i></p>`);
|
|
54
88
|
}
|
|
55
|
-
//
|
|
56
|
-
if (endpoint.
|
|
57
|
-
bodyParts.push(
|
|
89
|
+
// State: explain the dual nature before showing tables
|
|
90
|
+
if (endpoint.kind === "state") {
|
|
91
|
+
bodyParts.push(`<p><i>Get requires no parameters — send <code>{}</code> as the message body. The tables below describe the Set value and the return value for both operations.</i></p>`);
|
|
92
|
+
}
|
|
93
|
+
// Params table — label depends on kind (Get has no params)
|
|
94
|
+
const paramsLabel = getParamsLabel(endpoint.kind);
|
|
95
|
+
if (endpoint.kind === "get") {
|
|
96
|
+
bodyParts.push(`<b>No parameters — message is always <code>{}</code>.</b>`);
|
|
97
|
+
}
|
|
98
|
+
else if (endpoint.params.length > 0) {
|
|
99
|
+
bodyParts.push((0, components_1.paramsTable)(endpoint.params, paramsLabel));
|
|
58
100
|
}
|
|
59
101
|
else {
|
|
60
|
-
bodyParts.push(
|
|
102
|
+
bodyParts.push(`<b>No ${paramsLabel.toLowerCase()}.</b>`);
|
|
61
103
|
}
|
|
62
|
-
// Returns table
|
|
104
|
+
// Returns table — label depends on kind
|
|
105
|
+
const returnsLabel = getReturnsLabel(endpoint.kind);
|
|
63
106
|
if (endpoint.returns.length > 0) {
|
|
64
|
-
if (endpoint.params.length === 0) {
|
|
107
|
+
if (endpoint.params.length === 0 || endpoint.kind === "get") {
|
|
65
108
|
bodyParts.push("<br/><br/>");
|
|
66
109
|
}
|
|
67
|
-
bodyParts.push((0, components_1.paramsTable)(endpoint.returns,
|
|
110
|
+
bodyParts.push((0, components_1.paramsTable)(endpoint.returns, returnsLabel));
|
|
68
111
|
}
|
|
69
112
|
// Examples
|
|
70
113
|
if (endpoint.examples.length > 0) {
|
|
71
114
|
bodyParts.push(renderExamples(endpoint.examples));
|
|
72
115
|
}
|
|
73
116
|
const body = bodyParts.join("\n");
|
|
74
|
-
// Kind badge in title
|
|
75
|
-
const kindLabel =
|
|
117
|
+
// Kind badge in title — shown for all kinds
|
|
118
|
+
const kindLabel = ` [${endpoint.kind.toUpperCase()}]`;
|
|
76
119
|
const title = endpoint.name + kindLabel;
|
|
77
120
|
return (0, components_1.expandMacro)(title, body);
|
|
78
121
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"confluenceHtml.js","sourceRoot":"","sources":["../../src/renderer/confluenceHtml.ts"],"names":[],"mappings":";;AAaA,wCAQC;AApBD,6CAOsB;AAEtB;;GAEG;AACH,SAAgB,cAAc,CAAC,GAAa;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,KAAY;IAC/B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,eAAe;IACf,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,oBAAoB;IACpB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,YAAY;IACZ,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,SAAS;IACT,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,MAAM,IAAA,wBAAW,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,QAAkB;IACxC,MAAM,SAAS,GAAa,EAAE,CAAC;IAE/B,wBAAwB;IACxB,SAAS,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAExD,oBAAoB;IACpB,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,SAAS,CAAC,IAAI,CAAC,IAAA,yBAAY,EAAC,eAAe,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,WAAW;IACX,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACxC,SAAS,CAAC,IAAI,CAAC,IAAA,yBAAY,EAAC,OAAO,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,cAAc;IACd,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzB,SAAS,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,cAAc;IACd,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,SAAS,CAAC,IAAI,CAAC,gBAAgB,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACvE,CAAC;IAED,
|
|
1
|
+
{"version":3,"file":"confluenceHtml.js","sourceRoot":"","sources":["../../src/renderer/confluenceHtml.ts"],"names":[],"mappings":";;AAaA,wCAQC;AApBD,6CAOsB;AAEtB;;GAEG;AACH,SAAgB,cAAc,CAAC,GAAa;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,KAAY;IAC/B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,eAAe;IACf,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,oBAAoB;IACpB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,YAAY;IACZ,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,SAAS;IACT,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,MAAM,IAAA,wBAAW,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,IAAsB;IAC5C,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,WAAW,CAAC;IACzC,IAAI,IAAI,KAAK,KAAK;QAAE,OAAO,OAAO,CAAC;IACnC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,eAAe,CAAC,IAAsB;IAC7C,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,QAAQ,CAAC;IACrC,IAAI,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,cAAc,CAAC;IAC9D,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAkB;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;IAEvE,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CACR,6IAA6I,CAC9I,CAAC;IACJ,CAAC;SAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CACR,yJAAyJ,CAC1J,CAAC;IACJ,CAAC;SAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACrC,KAAK,CAAC,IAAI,CACR,6IAA6I,CAC9I,CAAC;QACF,KAAK,CAAC,IAAI,CACR,0JAA0J,CAC3J,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CACR,mJAAmJ,CACpJ,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,QAAkB;IACxC,MAAM,SAAS,GAAa,EAAE,CAAC;IAE/B,wBAAwB;IACxB,SAAS,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAExD,oBAAoB;IACpB,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,SAAS,CAAC,IAAI,CAAC,IAAA,yBAAY,EAAC,eAAe,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,WAAW;IACX,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACxC,SAAS,CAAC,IAAI,CAAC,IAAA,yBAAY,EAAC,OAAO,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,cAAc;IACd,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzB,SAAS,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,mBAAmB;IACnB,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE3C,cAAc;IACd,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,SAAS,CAAC,IAAI,CAAC,gBAAgB,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACvE,CAAC;IAED,uDAAuD;IACvD,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC9B,SAAS,CAAC,IAAI,CAAC,wKAAwK,CAAC,CAAC;IAC3L,CAAC;IAED,2DAA2D;IAC3D,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC5B,SAAS,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IAC9E,CAAC;SAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtC,SAAS,CAAC,IAAI,CAAC,IAAA,wBAAW,EAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,SAAS,CAAC,IAAI,CAAC,SAAS,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,wCAAwC;IACxC,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpD,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC5D,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,IAAA,wBAAW,EAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,WAAW;IACX,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAElC,4CAA4C;IAC5C,MAAM,SAAS,GAAG,KAAK,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC;IACtD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC;IAExC,OAAO,IAAA,wBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,cAAc,CAAC,QAAmB;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CACR,wFAAwF,CACzF,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvB,MAAM,OAAO,GACX,SAAS;YACT,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACxC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAE3D,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,mBAAmB;QACnB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,WAAW,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YAC5D,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,oBAAoB;QACpB,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,WAAW,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAChE,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACnC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,IAAA,wBAAW,EAAC,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAW;IACpC,2BAA2B;IAC3B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAA,sBAAS,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,gDAAgD;QAChD,OAAO,IAAA,sBAAS,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI;SACR,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pixotope-documentalist",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Parses JSDoc-style API documentation comments from source files and publishes to Confluence",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
|
-
"bin":
|
|
8
|
-
"pixotope-documentalist": "dist/index.js"
|
|
9
|
-
},
|
|
7
|
+
"bin": "dist/index.js",
|
|
10
8
|
"files": [
|
|
11
9
|
"dist/"
|
|
12
10
|
],
|
|
@@ -15,6 +13,10 @@
|
|
|
15
13
|
"dev": "ts-node src/index.ts",
|
|
16
14
|
"test": "vitest run",
|
|
17
15
|
"test:watch": "vitest",
|
|
16
|
+
"example:publish": "ts-node src/index.ts publish -c example/config.yml",
|
|
17
|
+
"release": "npm run test && npm version patch && npm publish",
|
|
18
|
+
"release:minor": "npm run test && npm version minor && npm publish",
|
|
19
|
+
"release:major": "npm run test && npm version major && npm publish",
|
|
18
20
|
"prepublishOnly": "npm run build"
|
|
19
21
|
},
|
|
20
22
|
"keywords": [
|