@scalar/cli 2.12.1 → 2.12.3
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 +2 -0
- package/chunks/{action-JT6C472I.js → action-4ESHWOAM.js} +4 -4
- package/chunks/{action-7HXYZPOT.js → action-5BJL72JE.js} +4 -4
- package/chunks/{action-UTFRCKGE.js → action-6A4NM5WS.js} +4 -4
- package/chunks/{action-KWFAMQN5.js → action-6I2PWENU.js} +19 -19
- package/chunks/{action-D52JJ3NL.js → action-7CUPRYNA.js} +13 -13
- package/chunks/{action-6IHAGCNR.js → action-AYKKHH7A.js} +13 -13
- package/chunks/{action-AOKHLTZ6.js → action-B74PPGKB.js} +5 -5
- package/chunks/{action-NY2MGVBS.js → action-BDDXF4YV.js} +13 -13
- package/chunks/{action-T2I4TFLU.js → action-BYYKW4S6.js} +8 -8
- package/chunks/action-D7L757PX.js +422 -0
- package/chunks/{action-HJSRU322.js → action-ED4TSPRZ.js} +13 -13
- package/chunks/{action-IASJWF5P.js → action-EPGS3U3T.js} +14 -14
- package/chunks/{action-D3IVCY24.js → action-EWDQOX5B.js} +4 -4
- package/chunks/{action-TH3TYR2A.js → action-EWZLVN45.js} +21 -21
- package/chunks/{action-A2GXYB2K.js → action-FBOTIFVC.js} +10 -10
- package/chunks/{action-YL3CEKE7.js → action-FBQAU5LV.js} +13 -13
- package/chunks/{action-4G23NFVD.js → action-GJHOZ6Q5.js} +66 -46
- package/chunks/{action-GZKDPO3N.js → action-GMJJMZXY.js} +13 -13
- package/chunks/{action-XPJFCCAT.js → action-H4GW3KAI.js} +17 -17
- package/chunks/{action-6IZYBY5P.js → action-HAKFAXTQ.js} +4 -4
- package/chunks/{action-4B3MNNEG.js → action-I2IV4VLL.js} +18 -18
- package/chunks/{action-6UOTMYQ4.js → action-JXCU2JKC.js} +2 -2
- package/chunks/{action-KDT6H6ML.js → action-KIOYSVKX.js} +4 -4
- package/chunks/{action-IIQMZVRJ.js → action-LRR52RXL.js} +10 -8
- package/chunks/{action-INB2R2NQ.js → action-M5OUEDV2.js} +4 -4
- package/chunks/{action-AQ7BSPBE.js → action-O7ROX6NF.js} +89 -51
- package/chunks/{action-JHPUNA7Z.js → action-Q3DI54OW.js} +17 -17
- package/chunks/{action-6KP6KOYC.js → action-RPTLQBMK.js} +6 -6
- package/chunks/{action-RDXVIAS3.js → action-T4MM4OUS.js} +19 -19
- package/chunks/{action-S7SONQ5E.js → action-UHXBY3RD.js} +2 -2
- package/chunks/{action-ENZGEP4Y.js → action-VVKMUOKR.js} +8 -6
- package/chunks/{action-O757TFA2.js → action-YXRCGKCK.js} +4 -4
- package/chunks/{action-HA3CMV3P.js → action-ZBEOLJJR.js} +4 -4
- package/chunks/{action-5I763IT2.js → action-ZOYQBWGD.js} +16 -16
- package/chunks/{actions-LNIEIP7C.js → actions-EXQNVV4T.js} +13 -13
- package/chunks/{agent-F2A4UROF.js → agent-XAHNA4MB.js} +4 -4
- package/chunks/{asyncapi-HASQNFWS.js → asyncapi-FNOWXSKB.js} +51 -43
- package/chunks/{build.action-XKJ4ET3G.js → build.action-TIKRZPQ5.js} +17 -17
- package/chunks/{chunk-N645RGAB.js → chunk-2AK5O3NQ.js} +33 -33
- package/chunks/{chunk-LWIAFTKX.js → chunk-2GKXAGSH.js} +55 -10
- package/chunks/chunk-2I6V7AI3.js +68 -0
- package/chunks/{chunk-CFI5GBAK.js → chunk-4YQVGOHX.js} +1 -1
- package/chunks/{chunk-ZW62VYJW.js → chunk-62OOT7FY.js} +5 -5
- package/chunks/{chunk-KWLAZV7P.js → chunk-7S34K2P3.js} +1 -1
- package/chunks/{chunk-U764PQUA.js → chunk-AOZQPCWI.js} +2 -0
- package/chunks/{chunk-BHWUD65X.js → chunk-BDNCJLJP.js} +1 -1
- package/chunks/{chunk-WZJTV4ET.js → chunk-BOPEAS7H.js} +1 -1
- package/chunks/{chunk-D5YZ3FXG.js → chunk-CUHVXHIV.js} +1 -1
- package/chunks/{chunk-PU5UIHAF.js → chunk-EUFK4MVX.js} +2 -2
- package/chunks/{chunk-V3MYP5SQ.js → chunk-EXJUFF6G.js} +13 -2
- package/chunks/{chunk-7M44FQHX.js → chunk-F3TQHNSQ.js} +139 -95
- package/chunks/{chunk-NTRWXCXD.js → chunk-FI7UKPRF.js} +2 -2
- package/chunks/{chunk-LLZDQXYS.js → chunk-FYMDIB7J.js} +1 -1
- package/chunks/{chunk-SNOAL2C5.js → chunk-I7ZVWF57.js} +1 -1
- package/chunks/{chunk-DKZ3PS3X.js → chunk-IOW726L2.js} +1 -1
- package/chunks/{chunk-7TSQ7ZGU.js → chunk-IRA5BW2J.js} +7 -5
- package/chunks/{chunk-4BE7UCJO.js → chunk-JWNWOK2M.js} +2 -2
- package/chunks/{chunk-JLNHOA5Z.js → chunk-KPLWZIOV.js} +36 -4
- package/chunks/{chunk-EJSGWV2K.js → chunk-KWIY2QZY.js} +1 -1
- package/chunks/{chunk-GPQXLA43.js → chunk-LEECPQZN.js} +2 -2
- package/chunks/{chunk-YLZP3W37.js → chunk-MQ65WBVF.js} +22 -1
- package/chunks/{chunk-IZVRYC2N.js → chunk-OZQPMMTA.js} +3 -3
- package/chunks/{chunk-V6LUKXBV.js → chunk-RE5Z56QD.js} +2 -2
- package/chunks/{chunk-XLZEIIPW.js → chunk-TI4NDKQC.js} +40 -7
- package/chunks/{chunk-VUNOOPEG.js → chunk-TYNF7ROW.js} +1 -1
- package/chunks/{chunk-YMRRFDEQ.js → chunk-UN2AAVO5.js} +2 -2
- package/chunks/chunk-V7RTDFHK.js +56 -0
- package/chunks/{chunk-PERC34BV.js → chunk-WKW5W2ZP.js} +1 -1
- package/chunks/{chunk-RYWXF3LO.js → chunk-Y2OQOAY7.js} +1 -1
- package/chunks/{chunk-E57QCEAV.js → chunk-YTTDYTVB.js} +1 -1
- package/chunks/{create.action-XXOLILUS.js → create.action-K7GTWYST.js} +17 -17
- package/chunks/{delete.action-R5KGPLDG.js → delete.action-E4XRGKQW.js} +16 -16
- package/chunks/{delete.action-TQJOZRV7.js → delete.action-JKLXBYRD.js} +17 -17
- package/chunks/{get.action-IQMOL4WM.js → get.action-2AKMD4W3.js} +10 -10
- package/chunks/{get.action-46OBVOQQ.js → get.action-IY7WSJMX.js} +16 -16
- package/chunks/{list.action-RIS7Q4OU.js → list.action-44YVCWKN.js} +16 -16
- package/chunks/{list.action-GXTKKVHY.js → list.action-NRL2DDL5.js} +17 -17
- package/chunks/{publish.action-A4T4BT3F.js → publish.action-E76MHLCN.js} +21 -21
- package/chunks/{update.action-TK5L4PXB.js → update.action-FTTVWVAB.js} +16 -16
- package/chunks/{update.action-IZ5GULPY.js → update.action-LZCAHAWW.js} +17 -17
- package/index.js +223 -117
- package/package.json +1 -1
- package/skills/scalar-cli/SKILL.md +1 -1
- package/template.md +2 -0
- package/chunks/action-VK5HZHSC.js +0 -165
- package/chunks/chunk-JFIXNSPP.js +0 -26
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ description: "Operate the Scalar CLI (`scalar`, or `npx @scalar/cli`) to validat
|
|
|
5
5
|
|
|
6
6
|
# Scalar CLI
|
|
7
7
|
|
|
8
|
-
Validate, lint, bundle, mock, and preview OpenAPI and AsyncAPI descriptions, and publish them to Scalar (`@scalar/cli` 2.12.
|
|
8
|
+
Validate, lint, bundle, mock, and preview OpenAPI and AsyncAPI descriptions, and publish them to Scalar (`@scalar/cli` 2.12.3).
|
|
9
9
|
|
|
10
10
|
## Operating notes
|
|
11
11
|
|
package/template.md
CHANGED
|
@@ -96,6 +96,8 @@ Or with npm:
|
|
|
96
96
|
npm install --global @scalar/cli
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
+
Run `scalar upgrade` to upgrade an npm installation or show portable upgrade instructions, including the installed and latest available versions. Use `scalar upgrade --check` to check without installing, or `scalar upgrade --json` for machine-readable results. Version checks return exit code 1 when the release service cannot be reached or returns invalid data. `scalar --version` remains an offline check of the installed version.
|
|
100
|
+
|
|
99
101
|
Git ships an unrelated `scalar` executable. If it gets in the way, use npm's `scalar-cli` alias, or run `npm install --global --force @scalar/cli` to replace it. The [installation guide](https://scalar.com/tools/cli/getting-started#installation) covers upgrades and shell completion.
|
|
100
102
|
|
|
101
103
|
## Use with AI agents
|
|
@@ -1,165 +0,0 @@
|
|
|
1
|
-
import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
|
|
2
|
-
import {
|
|
3
|
-
downloadIsolate
|
|
4
|
-
} from "./chunk-PU5UIHAF.js";
|
|
5
|
-
import "./chunk-ORCUZITN.js";
|
|
6
|
-
import {
|
|
7
|
-
readAndParseConfig,
|
|
8
|
-
renderConfigError
|
|
9
|
-
} from "./chunk-CFI5GBAK.js";
|
|
10
|
-
import {
|
|
11
|
-
CONFIG_FILE_DEFAULT,
|
|
12
|
-
findConfig
|
|
13
|
-
} from "./chunk-YLZP3W37.js";
|
|
14
|
-
import {
|
|
15
|
-
ISOLATE_DIR
|
|
16
|
-
} from "./chunk-D5YZ3FXG.js";
|
|
17
|
-
import "./chunk-5ENKYZA4.js";
|
|
18
|
-
import "./chunk-V6LUKXBV.js";
|
|
19
|
-
import "./chunk-VUXPDHTQ.js";
|
|
20
|
-
import {
|
|
21
|
-
getAuthData
|
|
22
|
-
} from "./chunk-NTRWXCXD.js";
|
|
23
|
-
import {
|
|
24
|
-
config
|
|
25
|
-
} from "./chunk-LLZDQXYS.js";
|
|
26
|
-
import "./chunk-DKZ3PS3X.js";
|
|
27
|
-
import "./chunk-7M44FQHX.js";
|
|
28
|
-
import {
|
|
29
|
-
ConfigVersion
|
|
30
|
-
} from "./chunk-VRZSDUZK.js";
|
|
31
|
-
import {
|
|
32
|
-
requireInteractive
|
|
33
|
-
} from "./chunk-EGOXR5FB.js";
|
|
34
|
-
import "./chunk-4ORL4MST.js";
|
|
35
|
-
import {
|
|
36
|
-
output
|
|
37
|
-
} from "./chunk-T5HJUAWB.js";
|
|
38
|
-
import "./chunk-Q26DFKTY.js";
|
|
39
|
-
import "./chunk-I57ID5K7.js";
|
|
40
|
-
import "./chunk-3MZYUBJ6.js";
|
|
41
|
-
|
|
42
|
-
// src/domains/project/preview/action.ts
|
|
43
|
-
import { isCancel, text } from "@clack/prompts";
|
|
44
|
-
import as from "ansis";
|
|
45
|
-
|
|
46
|
-
// src/domains/project/preview/v2.ts
|
|
47
|
-
import { spawn } from "node:child_process";
|
|
48
|
-
import path from "node:path";
|
|
49
|
-
async function runIsolate(isolateOptions) {
|
|
50
|
-
const executable = process.env.SCALAR_CLI_DISTRIBUTION === "portable" ? path.join(
|
|
51
|
-
path.dirname(process.execPath),
|
|
52
|
-
"runtime",
|
|
53
|
-
process.platform === "win32" ? "node.exe" : "node"
|
|
54
|
-
) : process.execPath;
|
|
55
|
-
const child = spawn(executable, ["dist/isolate-entry.js"], {
|
|
56
|
-
cwd: ISOLATE_DIR,
|
|
57
|
-
env: {
|
|
58
|
-
...process.env,
|
|
59
|
-
PATH: `${path.dirname(executable)}${path.delimiter}${process.env.PATH ?? ""}`
|
|
60
|
-
}
|
|
61
|
-
});
|
|
62
|
-
child.stdin.write(JSON.stringify(isolateOptions));
|
|
63
|
-
child.stdin.end();
|
|
64
|
-
child.stdout.pipe(process.stdout);
|
|
65
|
-
child.stderr.pipe(process.stderr);
|
|
66
|
-
child.on("error", (error) => {
|
|
67
|
-
console.error(`Could not start docs preview: ${error.message}`);
|
|
68
|
-
process.exitCode = 1;
|
|
69
|
-
});
|
|
70
|
-
child.on("close", (code, signal) => {
|
|
71
|
-
console.log(
|
|
72
|
-
`Process exited with code ${code}${signal ? ` (signal ${signal})` : ""}.`
|
|
73
|
-
);
|
|
74
|
-
process.exitCode = code ?? 1;
|
|
75
|
-
});
|
|
76
|
-
}
|
|
77
|
-
async function getAccessToken() {
|
|
78
|
-
try {
|
|
79
|
-
const { accessToken } = await getAuthData({ noExit: true });
|
|
80
|
-
return accessToken;
|
|
81
|
-
} catch {
|
|
82
|
-
output.info().message(
|
|
83
|
-
"You're not logged in. Private Scalar content will not be fetched."
|
|
84
|
-
).print();
|
|
85
|
-
return "";
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
async function previewV2Project({
|
|
89
|
-
logLevel,
|
|
90
|
-
configPath,
|
|
91
|
-
port,
|
|
92
|
-
config: config2,
|
|
93
|
-
host,
|
|
94
|
-
openBrowser
|
|
95
|
-
}) {
|
|
96
|
-
const root = path.resolve(path.dirname(configPath), config2.root ?? "./");
|
|
97
|
-
const relativeConfigPath = path.relative(root, configPath);
|
|
98
|
-
const accessToken = await getAccessToken();
|
|
99
|
-
await downloadIsolate();
|
|
100
|
-
output.info().message("Starting preview\u2026").print();
|
|
101
|
-
await runIsolate({
|
|
102
|
-
configPath: relativeConfigPath,
|
|
103
|
-
projectDir: root,
|
|
104
|
-
logLevel,
|
|
105
|
-
domain: "localhost",
|
|
106
|
-
mode: "preview",
|
|
107
|
-
previewServerPort: port,
|
|
108
|
-
registryBaseUrl: config.projects.registry,
|
|
109
|
-
baseUrl: config.services.api,
|
|
110
|
-
token: accessToken,
|
|
111
|
-
host,
|
|
112
|
-
openBrowser
|
|
113
|
-
});
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
// src/domains/project/preview/action.ts
|
|
117
|
-
async function previewAction(__configPath, options) {
|
|
118
|
-
const _port = Number.parseInt(options.port || "7970", 10);
|
|
119
|
-
if (Number.isNaN(_port)) {
|
|
120
|
-
return output.error().title("Invalid port").message("Provide a valid port number").exit("error");
|
|
121
|
-
}
|
|
122
|
-
if (_port < 0 || _port > 65535) {
|
|
123
|
-
return output.error().title("Invalid port").message("Port number must be between 0 and 65535").exit("error");
|
|
124
|
-
}
|
|
125
|
-
let configPath = __configPath || findConfig();
|
|
126
|
-
if (!configPath) {
|
|
127
|
-
requireInteractive(
|
|
128
|
-
"Pass the path to your Scalar configuration file to preview non-interactively."
|
|
129
|
-
);
|
|
130
|
-
const response = await text({
|
|
131
|
-
message: "Where is your configuration file located?",
|
|
132
|
-
defaultValue: CONFIG_FILE_DEFAULT,
|
|
133
|
-
placeholder: CONFIG_FILE_DEFAULT
|
|
134
|
-
});
|
|
135
|
-
if (isCancel(response)) return;
|
|
136
|
-
configPath = response;
|
|
137
|
-
}
|
|
138
|
-
const parseConfigResult = readAndParseConfig(configPath);
|
|
139
|
-
if (!parseConfigResult.success) {
|
|
140
|
-
renderConfigError(parseConfigResult.error);
|
|
141
|
-
}
|
|
142
|
-
if (parseConfigResult.success) {
|
|
143
|
-
output.info().line(
|
|
144
|
-
`${as.green("[SUCCESS]")} ${as.green("Configuration is valid:")} ${as.green(parseConfigResult.filePath)}`
|
|
145
|
-
).print();
|
|
146
|
-
}
|
|
147
|
-
const { config: config2 } = parseConfigResult;
|
|
148
|
-
if (config2.version === ConfigVersion.V1) {
|
|
149
|
-
return output.error().title("Version 1 previews are no longer supported").message("Run `scalar project upgrade` to upgrade your project.").exit("error");
|
|
150
|
-
}
|
|
151
|
-
if (config2.version === ConfigVersion.V2) {
|
|
152
|
-
await previewV2Project({
|
|
153
|
-
logLevel: options.logLevel,
|
|
154
|
-
configPath,
|
|
155
|
-
config: config2,
|
|
156
|
-
port: _port,
|
|
157
|
-
host: options.host,
|
|
158
|
-
openBrowser: (options.open ?? true) && Boolean(process.stdin.isTTY) && !process.env.CI
|
|
159
|
-
});
|
|
160
|
-
return;
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
export {
|
|
164
|
-
previewAction
|
|
165
|
-
};
|
package/chunks/chunk-JFIXNSPP.js
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
|
|
2
|
-
|
|
3
|
-
// src/helpers/url-opener.ts
|
|
4
|
-
import { exec } from "node:child_process";
|
|
5
|
-
var escapeCliArg = (url) => {
|
|
6
|
-
return url.replace(/([&])/g, "\\$1");
|
|
7
|
-
};
|
|
8
|
-
var openBrowser = (url) => {
|
|
9
|
-
if (process.env.NODE_ENV === "INTEGRATION") return;
|
|
10
|
-
const escapedUrl = escapeCliArg(url);
|
|
11
|
-
switch (process.platform) {
|
|
12
|
-
case "darwin":
|
|
13
|
-
exec(`open ${escapedUrl}`);
|
|
14
|
-
break;
|
|
15
|
-
case "win32":
|
|
16
|
-
exec(`start ${escapedUrl}`);
|
|
17
|
-
break;
|
|
18
|
-
case "linux":
|
|
19
|
-
exec(`xdg-open ${escapedUrl}`);
|
|
20
|
-
break;
|
|
21
|
-
}
|
|
22
|
-
};
|
|
23
|
-
|
|
24
|
-
export {
|
|
25
|
-
openBrowser
|
|
26
|
-
};
|