Skip to content

Commit 6aa5db6

Browse files
docs: add missing 'docs' command and update 'test'/'package' with enhanced options
1 parent 08eeca2 commit 6aa5db6

1 file changed

Lines changed: 63 additions & 17 deletions

File tree

pages/developers/plugins/cli.mdx

Lines changed: 63 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -204,15 +204,25 @@ lokus-plugin test [options]
204204
```
205205

206206
**Options:**
207-
- `--watch` - Watch mode
208-
- `--coverage` - Generate coverage report
209-
- `--verbose` - Verbose output
210-
- `--testMatch <pattern>` - Test file pattern
207+
- `-w, --watch` - Watch mode
208+
- `-c, --coverage` - Generate coverage report
209+
- `-v, --verbose` - Verbose output
210+
- `-p, --pattern <pattern>` - Test file pattern
211+
- `--ui` - Open test UI (Vitest only)
212+
- `--reporter <name>` - Custom reporter
213+
- `--updateSnapshot` - Update snapshots
214+
- `--detectOpenHandles` - Detect open handles (Jest)
215+
216+
**Supported Frameworks:**
217+
- Vitest (Recommended)
218+
- Jest
219+
- Mocha
220+
- AVA
211221

212222
**Examples:**
213223

214224
```bash
215-
# Run all tests
225+
# Run all tests (auto-detects framework)
216226
lokus-plugin test
217227

218228
# Watch mode
@@ -222,7 +232,7 @@ lokus-plugin test --watch
222232
lokus-plugin test --coverage
223233

224234
# Specific tests
225-
lokus-plugin test --testMatch "**/*.spec.ts"
235+
lokus-plugin test --pattern "user-service"
226236
```
227237

228238
### package
@@ -234,25 +244,30 @@ lokus-plugin package [options]
234244
```
235245

236246
**Options:**
237-
- `--out <dir>` - Output directory (default: dist)
238-
- `--target <target>` - Target platform (all, win32, darwin, linux)
239-
- `--version <version>` - Override version
240-
- `--no-verify` - Skip verification
247+
- `-o, --out-dir <dir>` - Output directory (default: `dist`)
248+
- `-f, --format <format>` - Format: `zip`, `tar`, or `both`
249+
- `-t, --target <target>` - Target: `production` or `development`
250+
- `--no-minify` - Disable minification
251+
- `--sourcemap` - Include source maps
252+
- `--sign` - Sign the package
253+
- `--verify` - Verify package integrity
254+
- `--include-source` - Include source code
255+
- `--include-docs` - Include documentation
241256

242257
**Examples:**
243258

244259
```bash
245-
# Package plugin
260+
# Standard package
246261
lokus-plugin package
247262

248-
# Custom output directory
249-
lokus-plugin package --out ./releases
263+
# Development build with source maps
264+
lokus-plugin package --target development --sourcemap
250265

251-
# Specific platform
252-
lokus-plugin package --target darwin
266+
# Multi-format output
267+
lokus-plugin package --format both
253268

254-
# Override version
255-
lokus-plugin package --version 1.0.1
269+
# Include docs and source
270+
lokus-plugin package --include-docs --include-source
256271
```
257272

258273
**Output:**
@@ -423,6 +438,37 @@ lokus-plugin login [options]
423438
lokus-plugin login --token YOUR_TOKEN
424439
```
425440

441+
### docs
442+
443+
Generate comprehensive documentation for your plugin.
444+
445+
```bash
446+
lokus-plugin docs [options]
447+
```
448+
449+
**Options:**
450+
- `-g, --generator <type>` - Generator type: `typedoc`, `jsdoc`, `custom`, or `auto` (default)
451+
- `-o, --output <dir>` - Output directory (default: `docs`)
452+
- `-s, --serve` - Start local server after generation
453+
- `-p, --port <number>` - Server port (default: 8080)
454+
- `-w, --watch` - Watch mode
455+
- `--include-source` - Include source code in docs
456+
- `--include-examples` - Include examples directory
457+
- `--theme <theme>` - Documentation theme
458+
459+
**Examples:**
460+
461+
```bash
462+
# Generate docs (auto-detect)
463+
lokus-plugin docs
464+
465+
# Serve locally
466+
lokus-plugin docs --serve
467+
468+
# Use TypeDoc specifically
469+
lokus-plugin docs --generator typedoc --theme dark
470+
```
471+
426472
### logout
427473

428474
Logout from plugin registry.

0 commit comments

Comments
 (0)