@atlaskit/ads-cli 0.8.1 → 0.9.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.
@@ -0,0 +1,420 @@
1
+ import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
2
+ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
3
+ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
4
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
5
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
6
+ import _regeneratorRuntime from "@babel/runtime/regenerator";
7
+ import { spawnSync } from 'node:child_process';
8
+ import { lstatSync } from 'node:fs';
9
+ import path from 'node:path';
10
+ import { createErrorEnvelope } from '../envelope/create-error-envelope';
11
+ import { createSuccessEnvelope } from '../envelope/create-success-envelope';
12
+ import { writeHumanError } from '../output/write-human-error';
13
+ import { writeJsonEnvelope } from '../output/write-json-envelope';
14
+ import { ExitCode } from '../types';
15
+ import { CLI_ATLAS_INVOCATION } from './cli-metadata';
16
+ var SKILL_ENTRYPOINT = 'SKILL.md';
17
+ var SKILLS = [{
18
+ name: 'atlassian-design-system',
19
+ displayName: 'ADS',
20
+ relativePath: '.agents/skills/atlassian-design-system',
21
+ requiredFiles: [SKILL_ENTRYPOINT]
22
+ }, {
23
+ name: 'ui-styling-standard',
24
+ displayName: 'UI Styling Standard',
25
+ relativePath: '.agents/skills/ui-styling-standard',
26
+ requiredFiles: [SKILL_ENTRYPOINT]
27
+ }, {
28
+ name: 'a11y-foundation',
29
+ displayName: 'Accessibility Foundation',
30
+ relativePath: '.agents/skills/a11y-foundation',
31
+ requiredFiles: [SKILL_ENTRYPOINT]
32
+ }];
33
+ var GIT_MARKER = '.git';
34
+ var SKILLS_INSTALLER_PACKAGE = '@atlassian/skills';
35
+ var SKILLS_INSTALLER_UNAVAILABLE_REASON = 'skills-installer-unavailable';
36
+ var SKILLS_INSTALLER_UNAVAILABLE_ERROR_CODES = new Set(['EACCES', 'EAI_AGAIN', 'ECONNREFUSED', 'ECONNRESET', 'ENOENT', 'ENOTFOUND', 'ETIMEDOUT']);
37
+ var defaultPathExists = function defaultPathExists(target) {
38
+ try {
39
+ lstatSync(target);
40
+ return true;
41
+ } catch (error) {
42
+ if (error.code === 'ENOENT') {
43
+ return false;
44
+ }
45
+ throw error;
46
+ }
47
+ };
48
+ var defaultRunProcess = function defaultRunProcess(_ref) {
49
+ var command = _ref.command,
50
+ args = _ref.args,
51
+ cwd = _ref.cwd,
52
+ capture = _ref.capture;
53
+ var result = spawnSync(command, args, {
54
+ cwd: cwd,
55
+ encoding: 'utf8',
56
+ stdio: capture ? 'pipe' : 'inherit'
57
+ });
58
+ return {
59
+ status: result.status,
60
+ stdout: typeof result.stdout === 'string' ? result.stdout : '',
61
+ stderr: typeof result.stderr === 'string' ? result.stderr : '',
62
+ error: result.error
63
+ };
64
+ };
65
+ var processFailureMessage = function processFailureMessage(result, fallback) {
66
+ var _result$error;
67
+ var details = result.stderr.trim() || ((_result$error = result.error) === null || _result$error === void 0 ? void 0 : _result$error.message);
68
+ return details ? "".concat(fallback, ": ").concat(details) : fallback;
69
+ };
70
+ var isSkillsInstallerUnavailableFailure = function isSkillsInstallerUnavailableFailure(result) {
71
+ var _result$error2, _result$error$message, _result$error3;
72
+ if (result.status === null || (_result$error2 = result.error) !== null && _result$error2 !== void 0 && _result$error2.code && SKILLS_INSTALLER_UNAVAILABLE_ERROR_CODES.has(result.error.code)) {
73
+ return true;
74
+ }
75
+ var details = "".concat(result.stdout, "\n").concat(result.stderr, "\n").concat((_result$error$message = (_result$error3 = result.error) === null || _result$error3 === void 0 ? void 0 : _result$error3.message) !== null && _result$error$message !== void 0 ? _result$error$message : '').toLowerCase();
76
+ if (!details.trim()) {
77
+ return true;
78
+ }
79
+ return ['401 unauthorized', '403 forbidden', '404 not found', 'authentication required', 'could not resolve', 'e401', 'e403', 'e404', 'eneedauth', 'failed to fetch', 'network error', 'not in this registry', 'registry unavailable', 'unable to authenticate', 'unable to resolve'].some(function (message) {
80
+ return details.includes(message);
81
+ });
82
+ };
83
+ var createNotInstalledSkillResults = function createNotInstalledSkillResults(reason) {
84
+ return SKILLS.map(function (skillDefinition) {
85
+ return {
86
+ name: skillDefinition.name,
87
+ status: 'not-installed',
88
+ path: skillDefinition.relativePath,
89
+ reason: reason
90
+ };
91
+ });
92
+ };
93
+ var findRepositoryRoot = function findRepositoryRoot(cwd) {
94
+ var current = path.resolve(cwd);
95
+ while (true) {
96
+ if (defaultPathExists(path.join(current, GIT_MARKER))) {
97
+ return current;
98
+ }
99
+ var parent = path.dirname(current);
100
+ if (parent === current) {
101
+ return undefined;
102
+ }
103
+ current = parent;
104
+ }
105
+ };
106
+ var writeUsageError = function writeUsageError(_ref2) {
107
+ var message = _ref2.message,
108
+ json = _ref2.json,
109
+ writer = _ref2.writer;
110
+ if (json) {
111
+ writeJsonEnvelope({
112
+ envelope: createErrorEnvelope({
113
+ command: 'init',
114
+ code: 'USAGE_ERROR',
115
+ message: message
116
+ }),
117
+ writer: writer
118
+ });
119
+ } else {
120
+ writeHumanError({
121
+ message: message,
122
+ writer: writer
123
+ });
124
+ writer.err('Usage: init');
125
+ }
126
+ return ExitCode.UsageError;
127
+ };
128
+ var validateInput = function validateInput(input) {
129
+ if (input.positionals.length > 0) {
130
+ return '`init` does not accept positional arguments.';
131
+ }
132
+ var allowedFlags = new Set(['json']);
133
+ var unknownFlag = Object.keys(input.flags).find(function (flag) {
134
+ return !allowedFlags.has(flag);
135
+ });
136
+ if (unknownFlag) {
137
+ return "Unknown flag \"--".concat(unknownFlag, "\".");
138
+ }
139
+ return undefined;
140
+ };
141
+ export var runInitCommand = /*#__PURE__*/function () {
142
+ var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref3) {
143
+ var input, json, writer, invocation, cwd, usageError, projectRoot, skills, repositorySetupErrors, npxCommand, skillsInstallerUnavailable, skillHumanOutput, _loop, _i, _SKILLS, skillResultsByName, _iterator, _step, line, atlasCwd, atlasPluginStatus, _atlasCheck$error, atlasCheck, installResult, verification, data;
144
+ return _regeneratorRuntime.wrap(function (_context2) {
145
+ while (1) switch (_context2.prev = _context2.next) {
146
+ case 0:
147
+ input = _ref3.input, json = _ref3.json, writer = _ref3.writer, invocation = _ref3.invocation, cwd = _ref3.cwd;
148
+ usageError = validateInput(input);
149
+ if (!usageError) {
150
+ _context2.next = 1;
151
+ break;
152
+ }
153
+ return _context2.abrupt("return", writeUsageError({
154
+ message: usageError,
155
+ json: json,
156
+ writer: writer
157
+ }));
158
+ case 1:
159
+ projectRoot = findRepositoryRoot(cwd);
160
+ skills = [];
161
+ repositorySetupErrors = [];
162
+ if (projectRoot) {
163
+ _context2.next = 2;
164
+ break;
165
+ }
166
+ skills.push.apply(skills, _toConsumableArray(createNotInstalledSkillResults('not-in-git-repository')));
167
+ if (!json) {
168
+ writer.out('– Repository-local skills not installed because the current directory is not in a Git repository');
169
+ }
170
+ _context2.next = 7;
171
+ break;
172
+ case 2:
173
+ npxCommand = process.platform === 'win32' ? 'npx.cmd' : 'npx';
174
+ skillsInstallerUnavailable = false;
175
+ skillHumanOutput = [];
176
+ _loop = /*#__PURE__*/_regeneratorRuntime.mark(function _loop() {
177
+ var skillDefinition, skillPath, skillEntrypoint, skillPathExists, skillEntrypointExists, isCurrent, skillResult, result, missingRequiredFile, missingRelativePath, statusMessage, _t;
178
+ return _regeneratorRuntime.wrap(function (_context) {
179
+ while (1) switch (_context.prev = _context.next) {
180
+ case 0:
181
+ skillDefinition = _SKILLS[_i];
182
+ _context.prev = 1;
183
+ skillPath = path.join(projectRoot, skillDefinition.relativePath);
184
+ skillEntrypoint = path.join(skillPath, SKILL_ENTRYPOINT);
185
+ skillPathExists = defaultPathExists(skillPath);
186
+ skillEntrypointExists = defaultPathExists(skillEntrypoint);
187
+ isCurrent = skillDefinition.requiredFiles.every(function (requiredFile) {
188
+ return defaultPathExists(path.join(skillPath, requiredFile));
189
+ });
190
+ if (!(skillPathExists && !skillEntrypointExists)) {
191
+ _context.next = 2;
192
+ break;
193
+ }
194
+ throw new Error("Cannot install the ".concat(skillDefinition.displayName, " skill because ").concat(skillDefinition.relativePath, " already exists without a ").concat(SKILL_ENTRYPOINT, ". Move or remove it, then run init again."));
195
+ case 2:
196
+ if (!isCurrent) {
197
+ _context.next = 3;
198
+ break;
199
+ }
200
+ skillResult = {
201
+ name: skillDefinition.name,
202
+ status: 'already-installed',
203
+ path: skillDefinition.relativePath
204
+ };
205
+ _context.next = 7;
206
+ break;
207
+ case 3:
208
+ result = defaultRunProcess({
209
+ command: npxCommand,
210
+ args: ['--yes', SKILLS_INSTALLER_PACKAGE, 'add', skillDefinition.name, '--universal', '--yes'],
211
+ cwd: projectRoot,
212
+ capture: true
213
+ });
214
+ if (!(result.status !== 0)) {
215
+ _context.next = 5;
216
+ break;
217
+ }
218
+ if (!isSkillsInstallerUnavailableFailure(result)) {
219
+ _context.next = 4;
220
+ break;
221
+ }
222
+ skillsInstallerUnavailable = true;
223
+ return _context.abrupt("return", 1);
224
+ case 4:
225
+ throw new Error(processFailureMessage(result, "Failed to install the ".concat(skillDefinition.displayName, " skill")));
226
+ case 5:
227
+ missingRequiredFile = skillDefinition.requiredFiles.find(function (requiredFile) {
228
+ return !defaultPathExists(path.join(skillPath, requiredFile));
229
+ });
230
+ if (!missingRequiredFile) {
231
+ _context.next = 6;
232
+ break;
233
+ }
234
+ missingRelativePath = "".concat(skillDefinition.relativePath, "/").concat(missingRequiredFile);
235
+ throw new Error("The skill installer completed without creating ".concat(missingRelativePath, "."));
236
+ case 6:
237
+ skillResult = {
238
+ name: skillDefinition.name,
239
+ status: skillEntrypointExists ? 'updated' : 'installed',
240
+ path: skillDefinition.relativePath
241
+ };
242
+ case 7:
243
+ skills.push(skillResult);
244
+ if (!json) {
245
+ statusMessage = skillResult.status === 'already-installed' ? 'already set up' : skillResult.status;
246
+ skillHumanOutput.push("\u2713 ".concat(skillDefinition.displayName, " skill ").concat(statusMessage, " at ").concat(skillDefinition.relativePath));
247
+ }
248
+ _context.next = 9;
249
+ break;
250
+ case 8:
251
+ _context.prev = 8;
252
+ _t = _context["catch"](1);
253
+ repositorySetupErrors.push(_t instanceof Error ? _t : new Error("Failed to set up the ".concat(skillDefinition.displayName, " skill.")));
254
+ case 9:
255
+ case "end":
256
+ return _context.stop();
257
+ }
258
+ }, _loop, null, [[1, 8]]);
259
+ });
260
+ _i = 0, _SKILLS = SKILLS;
261
+ case 3:
262
+ if (!(_i < _SKILLS.length)) {
263
+ _context2.next = 6;
264
+ break;
265
+ }
266
+ return _context2.delegateYield(_loop(), "t0", 4);
267
+ case 4:
268
+ if (!_context2.t0) {
269
+ _context2.next = 5;
270
+ break;
271
+ }
272
+ return _context2.abrupt("continue", 6);
273
+ case 5:
274
+ _i++;
275
+ _context2.next = 3;
276
+ break;
277
+ case 6:
278
+ if (skillsInstallerUnavailable) {
279
+ skillResultsByName = new Map(skills.map(function (skill) {
280
+ return [skill.name, skill];
281
+ }));
282
+ skills.splice.apply(skills, [0, skills.length].concat(_toConsumableArray(SKILLS.map(function (skillDefinition) {
283
+ var _skillResultsByName$g;
284
+ return (_skillResultsByName$g = skillResultsByName.get(skillDefinition.name)) !== null && _skillResultsByName$g !== void 0 ? _skillResultsByName$g : {
285
+ name: skillDefinition.name,
286
+ status: 'not-installed',
287
+ path: skillDefinition.relativePath,
288
+ reason: SKILLS_INSTALLER_UNAVAILABLE_REASON
289
+ };
290
+ }))));
291
+ }
292
+ if (!json) {
293
+ _iterator = _createForOfIteratorHelper(skillHumanOutput);
294
+ try {
295
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
296
+ line = _step.value;
297
+ writer.out(line);
298
+ }
299
+ } catch (err) {
300
+ _iterator.e(err);
301
+ } finally {
302
+ _iterator.f();
303
+ }
304
+ if (skillsInstallerUnavailable) {
305
+ writer.out(skillHumanOutput.length > 0 ? '– Remaining repository-local skills skipped because @atlassian/skills is unavailable; npx @atlaskit/ads-cli remains available' : '– Repository-local skills skipped because @atlassian/skills is unavailable; npx @atlaskit/ads-cli remains available');
306
+ }
307
+ }
308
+ case 7:
309
+ atlasCwd = projectRoot !== null && projectRoot !== void 0 ? projectRoot : path.resolve(cwd);
310
+ if (!(invocation === CLI_ATLAS_INVOCATION)) {
311
+ _context2.next = 8;
312
+ break;
313
+ }
314
+ atlasPluginStatus = 'already-installed';
315
+ if (!json) {
316
+ writer.out('✓ Atlas CLI ADS plugin already available');
317
+ }
318
+ _context2.next = 13;
319
+ break;
320
+ case 8:
321
+ atlasCheck = defaultRunProcess({
322
+ command: 'atlas',
323
+ args: ['ads', '--help'],
324
+ cwd: atlasCwd,
325
+ capture: true
326
+ });
327
+ if (!(atlasCheck.status === 0)) {
328
+ _context2.next = 9;
329
+ break;
330
+ }
331
+ atlasPluginStatus = 'already-installed';
332
+ if (!json) {
333
+ writer.out('✓ Atlas CLI ADS plugin already available');
334
+ }
335
+ _context2.next = 13;
336
+ break;
337
+ case 9:
338
+ if (!(((_atlasCheck$error = atlasCheck.error) === null || _atlasCheck$error === void 0 ? void 0 : _atlasCheck$error.code) === 'ENOENT')) {
339
+ _context2.next = 10;
340
+ break;
341
+ }
342
+ atlasPluginStatus = 'atlas-cli-unavailable';
343
+ if (!json) {
344
+ writer.out('– Atlas CLI is unavailable; use npx @atlaskit/ads-cli for ADS commands');
345
+ }
346
+ _context2.next = 13;
347
+ break;
348
+ case 10:
349
+ installResult = defaultRunProcess({
350
+ command: 'atlas',
351
+ args: ['plugin', 'install', '--name', 'ads'],
352
+ cwd: atlasCwd,
353
+ capture: json
354
+ });
355
+ if (!(installResult.status !== 0)) {
356
+ _context2.next = 11;
357
+ break;
358
+ }
359
+ throw new Error(processFailureMessage(installResult, 'Failed to install the Atlas CLI ADS plugin. npx @atlaskit/ads-cli remains available'));
360
+ case 11:
361
+ verification = defaultRunProcess({
362
+ command: 'atlas',
363
+ args: ['ads', '--help'],
364
+ cwd: atlasCwd,
365
+ capture: true
366
+ });
367
+ if (!(verification.status !== 0)) {
368
+ _context2.next = 12;
369
+ break;
370
+ }
371
+ throw new Error('The Atlas CLI ADS plugin was installed but `atlas ads --help` did not succeed. npx @atlaskit/ads-cli remains available.');
372
+ case 12:
373
+ atlasPluginStatus = 'installed';
374
+ if (!json) {
375
+ writer.out('✓ Atlas CLI ADS plugin installed');
376
+ }
377
+ case 13:
378
+ if (!(repositorySetupErrors.length > 0)) {
379
+ _context2.next = 14;
380
+ break;
381
+ }
382
+ throw new Error(repositorySetupErrors.map(function (error) {
383
+ return error.message;
384
+ }).join('\n'));
385
+ case 14:
386
+ if (!(skills.length !== SKILLS.length)) {
387
+ _context2.next = 15;
388
+ break;
389
+ }
390
+ throw new Error('Failed to determine the ADS repository setup result.');
391
+ case 15:
392
+ data = {
393
+ projectRoot: projectRoot !== null && projectRoot !== void 0 ? projectRoot : null,
394
+ skills: skills,
395
+ atlas: {
396
+ status: atlasPluginStatus
397
+ }
398
+ };
399
+ if (json) {
400
+ writeJsonEnvelope({
401
+ envelope: createSuccessEnvelope({
402
+ envelopeType: 'init',
403
+ command: 'init',
404
+ data: data,
405
+ meta: {}
406
+ }),
407
+ writer: writer
408
+ });
409
+ }
410
+ return _context2.abrupt("return", ExitCode.Ok);
411
+ case 16:
412
+ case "end":
413
+ return _context2.stop();
414
+ }
415
+ }, _callee);
416
+ }));
417
+ return function runInitCommand(_x) {
418
+ return _ref4.apply(this, arguments);
419
+ };
420
+ }();
@@ -0,0 +1,10 @@
1
+ import type { Writer } from '../output/writer';
2
+ import { type ExitCodeValue } from '../types';
3
+ import type { CommandInput } from './types';
4
+ export declare const runInitCommand: ({ input, json, writer, invocation, cwd, }: {
5
+ input: CommandInput;
6
+ json: boolean;
7
+ writer: Writer;
8
+ invocation: string;
9
+ cwd: string;
10
+ }) => Promise<ExitCodeValue>;
@@ -124,7 +124,7 @@ export type RenderContext = {
124
124
  /**
125
125
  * A single CLI command definition.
126
126
  */
127
- export type CommandDefinition = {
127
+ type CommandDefinitionBase = {
128
128
  /**
129
129
  * The command name as typed on the CLI, e.g. `search`.
130
130
  */
@@ -187,9 +187,18 @@ export type CommandDefinition = {
187
187
  data: unknown;
188
188
  input: CommandInput;
189
189
  }) => unknown;
190
+ };
191
+ export type QueryCommandDefinition = CommandDefinitionBase & {
192
+ action?: never;
190
193
  /**
191
194
  * Resolve which ADS MCP tool to run and with what arguments. Returning `{ error }` means
192
195
  * the input was invalid (a usage error); the CLI surfaces the message.
193
196
  */
194
197
  resolve: (input: CommandInput) => ResolveResult;
195
198
  };
199
+ export type ActionCommandDefinition = CommandDefinitionBase & {
200
+ action: 'init';
201
+ resolve?: never;
202
+ };
203
+ export type CommandDefinition = QueryCommandDefinition | ActionCommandDefinition;
204
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/ads-cli",
3
- "version": "0.8.1",
3
+ "version": "0.9.0",
4
4
  "description": "An npx-runnable command-line tool to query Atlassian Design System (ADS) structured content — components, tokens, icons, and guidelines — from the terminal.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -31,7 +31,7 @@
31
31
  "release:atlas:promote": "bash scripts/atlas/promote-stable.sh"
32
32
  },
33
33
  "dependencies": {
34
- "@atlaskit/ads-mcp": "^1.8.0",
34
+ "@atlaskit/ads-mcp": "^1.10.0",
35
35
  "@babel/runtime": "^7.0.0",
36
36
  "chalk": "^4.1.2"
37
37
  },