pixotope-documentalist 1.1.0 → 1.2.1
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 +20 -31
- 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/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,6 +63,23 @@ 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 |
|
|
@@ -111,7 +128,7 @@ documents:
|
|
|
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
|
|
114
|
-
- `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`, `.h`, `.cpp`, `.hpp`.
|
|
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`.
|
|
115
132
|
|
|
116
133
|
## CLI Commands
|
|
117
134
|
|
|
@@ -145,7 +162,6 @@ npx pixotope-documentalist diff --config ./config.yml --target master
|
|
|
145
162
|
|----------|---------|
|
|
146
163
|
| `CONFLUENCE_USER` | Confluence account email |
|
|
147
164
|
| `CONFLUENCE_TOKEN` | Confluence API token ([generate here](https://id.atlassian.com/manage-profile/security/api-tokens)) |
|
|
148
|
-
| `PIXOTOPE_DOCS_NPM_TOKEN` | npm publish auth token (only for publishing the package) |
|
|
149
165
|
|
|
150
166
|
Create a `.env` file (git-ignored) for local use:
|
|
151
167
|
|
|
@@ -154,37 +170,10 @@ CONFLUENCE_USER=your.email@pixotope.com
|
|
|
154
170
|
CONFLUENCE_TOKEN=your_api_token
|
|
155
171
|
```
|
|
156
172
|
|
|
157
|
-
## Development
|
|
158
|
-
|
|
159
|
-
```bash
|
|
160
|
-
# Install dependencies
|
|
161
|
-
npm install
|
|
162
|
-
|
|
163
|
-
# Run locally with ts-node
|
|
164
|
-
npx ts-node src/index.ts preview --config example/config.yml
|
|
165
|
-
|
|
166
|
-
# Run tests
|
|
167
|
-
npm test
|
|
168
|
-
|
|
169
|
-
# Build
|
|
170
|
-
npm run build
|
|
171
|
-
|
|
172
|
-
# Publish to npm
|
|
173
|
-
npm publish
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
## Example
|
|
177
|
-
|
|
178
|
-
The `example/` folder contains a self-contained demo:
|
|
179
|
-
|
|
180
|
-
```bash
|
|
181
|
-
npx ts-node src/index.ts preview --config example/config.yml
|
|
182
|
-
# Check output in example/output/formatted/
|
|
183
|
-
```
|
|
184
|
-
|
|
185
173
|
## Supported File Types
|
|
186
174
|
|
|
187
175
|
- `.ts`, `.tsx` (TypeScript)
|
|
188
176
|
- `.js`, `.jsx` (JavaScript)
|
|
189
177
|
- `.py` (Python)
|
|
178
|
+
- `.rs` (Rust)
|
|
190
179
|
- `.h`, `.cpp`, `.hpp` (C++)
|
|
@@ -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"}
|
package/package.json
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pixotope-documentalist",
|
|
3
|
-
"version": "1.1
|
|
3
|
+
"version": "1.2.1",
|
|
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": [
|