@bymbly/api-tools 1.0.0 → 1.3.2
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 +45 -0
- package/package.json +13 -13
package/README.md
CHANGED
|
@@ -9,6 +9,10 @@ customization through CLI options and passthrough arguments.
|
|
|
9
9
|
|
|
10
10
|
**Wraps:** [Redocly](https://github.com/Redocly/redocly-cli) | [Spectral](https://github.com/stoplightio/spectral)
|
|
11
11
|
|
|
12
|
+
[](https://github.com/bymbly/api-tools/actions/workflows/workflow.yaml)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
12
16
|
## Features
|
|
13
17
|
|
|
14
18
|
- **Single unified CLI** - One tool for all API spec operations
|
|
@@ -18,6 +22,47 @@ customization through CLI options and passthrough arguments.
|
|
|
18
22
|
- **Bundled configs** - Default Spectral and Redocly configuration included
|
|
19
23
|
- **Auto-detection** - Finds OpenAPI, AsyncAPI, and Arazzo specs automatically
|
|
20
24
|
|
|
25
|
+
## Table of Contents
|
|
26
|
+
|
|
27
|
+
- [@bymbly/api-tools](#bymblyapi-tools)
|
|
28
|
+
- [Features](#features)
|
|
29
|
+
- [Table of Contents](#table-of-contents)
|
|
30
|
+
- [Installation](#installation)
|
|
31
|
+
- [Quick Start](#quick-start)
|
|
32
|
+
- [Command Structure](#command-structure)
|
|
33
|
+
- [Global Options](#global-options)
|
|
34
|
+
- [Commands](#commands)
|
|
35
|
+
- [Spectral Commands](#spectral-commands)
|
|
36
|
+
- [`spectral lint`](#spectral-lint)
|
|
37
|
+
- [`spectral init`](#spectral-init)
|
|
38
|
+
- [Redocly Commands](#redocly-commands)
|
|
39
|
+
- [`redocly lint`](#redocly-lint)
|
|
40
|
+
- [`redocly build-docs`](#redocly-build-docs)
|
|
41
|
+
- [`redocly bundle`](#redocly-bundle)
|
|
42
|
+
- [`redocly join`](#redocly-join)
|
|
43
|
+
- [`redocly generate-arazzo`](#redocly-generate-arazzo)
|
|
44
|
+
- [`redocly respect`](#redocly-respect)
|
|
45
|
+
- [`redocly init`](#redocly-init)
|
|
46
|
+
- [Default File Locations](#default-file-locations)
|
|
47
|
+
- [Configuration Files](#configuration-files)
|
|
48
|
+
- [Auto-Discovery](#auto-discovery)
|
|
49
|
+
- [Bundled Defaults](#bundled-defaults)
|
|
50
|
+
- [Custom Configs](#custom-configs)
|
|
51
|
+
- [Passthrough Arguments](#passthrough-arguments)
|
|
52
|
+
- [CI/CD Integration](#cicd-integration)
|
|
53
|
+
- [GitHub Actions Example](#github-actions-example)
|
|
54
|
+
- [Common Workflows](#common-workflows)
|
|
55
|
+
- [Development](#development)
|
|
56
|
+
- [Pre-commit](#pre-commit)
|
|
57
|
+
- [CI Pipeline](#ci-pipeline)
|
|
58
|
+
- [API Testing](#api-testing)
|
|
59
|
+
- [Troubleshooting](#troubleshooting)
|
|
60
|
+
- [Command not found](#command-not-found)
|
|
61
|
+
- [Config not found](#config-not-found)
|
|
62
|
+
- [Bundled config issues](#bundled-config-issues)
|
|
63
|
+
- [Contributing](#contributing)
|
|
64
|
+
- [License](#license)
|
|
65
|
+
|
|
21
66
|
## Installation
|
|
22
67
|
|
|
23
68
|
```bash
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymbly/api-tools",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.3.2",
|
|
5
5
|
"description": "Unified, opinionated CLI wrapper for API specification tooling.",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"keywords": [
|
|
@@ -49,20 +49,20 @@
|
|
|
49
49
|
"copy:defaults": "copyfiles --all defaults/* dist/"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@commander-js/extra-typings": "
|
|
53
|
-
"@redocly/cli": "
|
|
54
|
-
"@stoplight/spectral-cli": "
|
|
52
|
+
"@commander-js/extra-typings": "14.0.0",
|
|
53
|
+
"@redocly/cli": "2.14.7",
|
|
54
|
+
"@stoplight/spectral-cli": "6.15.0"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
|
-
"@eslint/js": "
|
|
58
|
-
"@types/node": "
|
|
59
|
-
"@vitest/ui": "
|
|
60
|
-
"copyfiles": "
|
|
61
|
-
"eslint": "
|
|
57
|
+
"@eslint/js": "9.39.2",
|
|
58
|
+
"@types/node": "24.10.9",
|
|
59
|
+
"@vitest/ui": "4.0.17",
|
|
60
|
+
"copyfiles": "2.4.1",
|
|
61
|
+
"eslint": "9.39.2",
|
|
62
62
|
"markdownlint-cli2": "0.20.0",
|
|
63
|
-
"prettier": "3.8.
|
|
64
|
-
"typescript": "
|
|
65
|
-
"typescript-eslint": "
|
|
66
|
-
"vitest": "
|
|
63
|
+
"prettier": "3.8.1",
|
|
64
|
+
"typescript": "5.9.3",
|
|
65
|
+
"typescript-eslint": "8.53.1",
|
|
66
|
+
"vitest": "4.0.17"
|
|
67
67
|
}
|
|
68
68
|
}
|