@owox/ctl 0.37.0 → 0.39.0

package/dist/commands/plugins/check.d.ts

@@ -0,0 +1,19 @@
+import type { OWOXPluginCheckResult } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+import { type PluginsClient } from '../../plugins-support.js';
+export declare function checkPlugin(client: PluginsClient, repository: string, ref: string, version?: string): Promise<OWOXPluginCheckResult>;
+/** One line per issue, then what a clean result means. Goes to stderr so stdout stays JSON. */
+export declare function checkSummary(result: OWOXPluginCheckResult): string;
+export default class PluginsCheck extends BaseCommand {
+    static description: string;
+    static args: {
+        repository: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        ref: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        version: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/plugins/check.js

@@ -0,0 +1,59 @@
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
+import { installationHint, repositoryArg } from '../../plugins-support.js';
+export function checkPlugin(client, repository, ref, version) {
+    return client.plugins.check({ repository, ref, ...(version !== undefined ? { version } : {}) });
+}
+/** One line per issue, then what a clean result means. Goes to stderr so stdout stays JSON. */
+export function checkSummary(result) {
+    const lines = result.issues.map(issue => `${issue.code}: ${issue.detail}`);
+    if (lines.length === 0) {
+        const sha = result.commitSha?.slice(0, 7);
+        lines.push(result.candidateVersion
+            ? `A release of version ${result.candidateVersion}${sha ? ` from ${sha}` : ''} would pass the checks.`
+            : `No issues found${sha ? ` in ${sha}` : ''}.`);
+    }
+    if (!result.collectionsEvaluated && result.commitSha) {
+        if (!result.candidateVersion) {
+            lines.push('Collection compatibility was not checked: the plugin has no current version and no --version was given.');
+        }
+        else if (result.baselineVersion === null) {
+            lines.push('Collection compatibility was not checked: no version is recorded in that compatibility line.');
+        }
+    }
+    return lines.join('\n');
+}
+export default class PluginsCheck extends BaseCommand {
+    static description = 'Check whether a release from a branch, tag or commit would be accepted, without releasing anything';
+    static args = repositoryArg;
+    static flags = {
+        ...BaseCommand.baseFlags,
+        ref: Flags.string({ description: 'Branch, tag or commit SHA to check', required: true }),
+        version: Flags.string({
+            description: 'Candidate SemVer; defaults to the next version after the current one',
+        }),
+    };
+    static examples = [
+        '<%= config.bin %> <%= command.id %> OWOX/example-plugin --ref main',
+        '<%= config.bin %> <%= command.id %> OWOX/example-plugin --ref 3f2a1bc --version 1.5.0',
+    ];
+    async run() {
+        let result;
+        try {
+            const { args, flags } = await this.parse(PluginsCheck);
+            this.loadEnvironment(flags);
+            result = await checkPlugin(this.getAuthenticatedClient(), args.repository, flags.ref, flags.version);
+            process.stderr.write(`${checkSummary(result)}\n`);
+            this.writeJson(result);
+        }
+        catch (error) {
+            const hint = installationHint(error);
+            if (hint) {
+                process.stderr.write(`${hint}\n`);
+            }
+            this.handleCliError(error);
+        }
+        if (result.issues.length > 0)
+            this.exit(1);
+    }
+}

package/oclif.manifest.json

@@ -182,6 +182,62 @@
         "list.js"
       ]
     },
+    "plugins:check": {
+      "aliases": [],
+      "args": {
+        "repository": {
+          "description": "GitHub repository, as a URL or owner/name",
+          "name": "repository",
+          "required": true
+        }
+      },
+      "description": "Check whether a release from a branch, tag or commit would be accepted, without releasing anything",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> OWOX/example-plugin --ref main",
+        "<%= config.bin %> <%= command.id %> OWOX/example-plugin --ref 3f2a1bc --version 1.5.0"
+      ],
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "ref": {
+          "description": "Branch, tag or commit SHA to check",
+          "name": "ref",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "version": {
+          "description": "Candidate SemVer; defaults to the next version after the current one",
+          "name": "version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "plugins:check",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "plugins",
+        "check.js"
+      ]
+    },
     "plugins:publish": {
       "aliases": [],
       "args": {
@@ -531,5 +587,5 @@
       ]
     }
   },
-  "version": "0.37.0"
+  "version": "0.39.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@owox/ctl",
   "description": "OWOX Data Marts Control CLI",
-  "version": "0.37.0",
+  "version": "0.39.0",
   "type": "module",
   "author": "OWOX",
   "license": "ELv2",
@@ -15,8 +15,8 @@
   "dependencies": {
     "@oclif/core": "^4",
     "@oclif/plugin-help": "^6",
-    "@owox/api-client": "0.37.0",
-    "@owox/internal-helpers": "0.37.0",
+    "@owox/api-client": "0.39.0",
+    "@owox/internal-helpers": "0.39.0",
     "undici": "^6.26.0"
   },
   "devDependencies": {