oclif 4.18.4 → 4.20.0

package/lib/aws.js

@@ -29,13 +29,19 @@ const aws = {
     },
     get s3() {
         try {
+            const endpoint = process.env.AWS_S3_ENDPOINT;
+            const checksumConfig = (0, util_1.getS3ChecksumConfig)(endpoint, process.env.AWS_REQUEST_CHECKSUM_CALCULATION);
             cache.s3 =
                 cache.s3 ??
                     new (require('@aws-sdk/client-s3').S3Client)({
                         credentials: this.creds,
-                        endpoint: process.env.AWS_S3_ENDPOINT,
+                        endpoint,
                         forcePathStyle: Boolean(process.env.AWS_S3_FORCE_PATH_STYLE),
                         region: process.env.AWS_REGION ?? 'us-east-1',
+                        // Support disabling checksums for S3-compatible storage
+                        ...(checksumConfig && {
+                            requestChecksumCalculation: checksumConfig,
+                        }),
                     });
             return cache.s3;
         }

package/lib/tarballs/build.js

@@ -19,16 +19,15 @@ const util_1 = require("../util");
 const bin_1 = require("./bin");
 const node_1 = require("./node");
 const exec = (0, node_util_1.promisify)(node_child_process_1.exec);
-const pack = async (from, to) => {
+const pack = async (from, to, c) => {
     const cwd = node_path_1.default.dirname(from);
     await (0, promises_1.mkdir)(node_path_1.default.dirname(to), { recursive: true });
     (0, log_1.log)(`packing tarball from ${(0, util_1.prettifyPaths)(node_path_1.default.dirname(from))} to ${(0, util_1.prettifyPaths)(to)}`);
+    const platformFlag = c.tarFlags?.[process.platform] ?? '';
     if (to.endsWith('gz')) {
-        return exec(`tar czf ${to} ${node_path_1.default.basename(from)}${process.platform === 'win32' ? ' --force-local' : ''}`, {
-            cwd,
-        });
+        return exec(`tar czf ${to} ${node_path_1.default.basename(from)} ${platformFlag}`, { cwd });
     }
-    await exec(`tar cfJ ${to} ${node_path_1.default.basename(from)}${process.platform === 'win32' ? ' --force-local' : ''}`, { cwd });
+    await exec(`tar cfJ ${to} ${node_path_1.default.basename(from)} ${platformFlag}`, { cwd });
 };
 const isYarnProject = (yarnRootPath) => {
     const yarnLockFileName = 'yarn.lock';
@@ -215,12 +214,15 @@ const buildTarget = async (target, c, options) => {
     if (options.pack === false)
         return;
     if (options.parallel) {
-        await Promise.all([pack(workspace, c.dist(gzLocalKey)), ...(c.xz ? [pack(workspace, c.dist(xzLocalKey))] : [])]);
+        await Promise.all([
+            pack(workspace, c.dist(gzLocalKey), c),
+            ...(c.xz ? [pack(workspace, c.dist(xzLocalKey), c)] : []),
+        ]);
     }
     else {
-        await pack(workspace, c.dist(gzLocalKey));
+        await pack(workspace, c.dist(gzLocalKey), c);
         if (c.xz)
-            await pack(workspace, c.dist(xzLocalKey));
+            await pack(workspace, c.dist(xzLocalKey), c);
     }
     if (!c.updateConfig.s3?.host)
         return;

package/lib/tarballs/config.d.ts

@@ -1,6 +1,7 @@
 import { ObjectCannedACL } from '@aws-sdk/client-s3';
 import { Interfaces } from '@oclif/core';
 export declare const TARGETS: string[];
+type TarFlags = Interfaces.OclifConfiguration['tarFlags'];
 export type S3Config = BuildConfig['updateConfig']['s3'] & {
     acl?: ObjectCannedACL;
 } & {
@@ -20,6 +21,7 @@ export type BuildConfig = {
     nodeVersion: string;
     root: string;
     s3Config: S3Config;
+    tarFlags?: TarFlags;
     targets: {
         arch: Interfaces.ArchTypes;
         platform: Interfaces.PlatformTypes;
@@ -39,3 +41,4 @@ export declare function buildConfig(root: string, options?: {
     targets?: string[];
     xz?: boolean;
 }): Promise<BuildConfig>;
+export {};

package/lib/tarballs/config.js

@@ -58,6 +58,7 @@ exports.TARGETS = [
     'darwin-x64',
     'darwin-arm64',
 ];
+const DEFAULT_TAR_FLAGS = { win32: '--force-local' };
 async function gitSha(cwd, options = {}) {
     const args = options.short ? ['rev-parse', '--short', 'HEAD'] : ['rev-parse', 'HEAD'];
     const { stdout } = await exec(`git ${args.join(' ')}`, { cwd });
@@ -94,6 +95,8 @@ async function buildConfig(root, options = {}) {
         ...updateConfig.s3,
         acl: updateConfig.s3.acl,
     };
+    const existingTarFlags = config.pjson.oclif.tarFlags;
+    const tarFlags = existingTarFlags ? { ...DEFAULT_TAR_FLAGS, ...existingTarFlags } : DEFAULT_TAR_FLAGS;
     return {
         config,
         dist: (...args) => node_path_1.default.join(config.root, 'dist', ...args),
@@ -102,6 +105,7 @@ async function buildConfig(root, options = {}) {
         nodeVersion,
         root,
         s3Config,
+        tarFlags,
         targets,
         tmp,
         updateConfig,

package/lib/util.d.ts

@@ -13,4 +13,6 @@ export declare const hash: (algo: string, fp: string | string[]) => Promise<stri
 export declare function checkFor7Zip(): Promise<void>;
 export declare function isEmpty(obj: Record<string, unknown>): boolean;
 export declare function validateBin(bin: string): boolean;
+export declare function isS3Compatible(endpoint: string | undefined): boolean;
+export declare function getS3ChecksumConfig(endpoint: string | undefined, envValue: string | undefined): string | undefined;
 export {};

package/lib/util.js

@@ -42,6 +42,8 @@ exports.sortBy = sortBy;
 exports.checkFor7Zip = checkFor7Zip;
 exports.isEmpty = isEmpty;
 exports.validateBin = validateBin;
+exports.isS3Compatible = isS3Compatible;
+exports.getS3ChecksumConfig = getS3ChecksumConfig;
 const core_1 = require("@oclif/core");
 const node_child_process_1 = require("node:child_process");
 const crypto = __importStar(require("node:crypto"));
@@ -150,3 +152,9 @@ function isEmpty(obj) {
 function validateBin(bin) {
     return /^[\w-]+$/.test(bin);
 }
+function isS3Compatible(endpoint) {
+    return Boolean(endpoint && !endpoint.includes('amazonaws.com'));
+}
+function getS3ChecksumConfig(endpoint, envValue) {
+    return envValue || (isS3Compatible(endpoint) ? 'WHEN_REQUIRED' : undefined);
+}

package/oclif.manifest.json

@@ -1131,5 +1131,5 @@
       ]
     }
   },
-  "version": "4.18.4"
+  "version": "4.20.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.18.4",
+  "version": "4.20.0",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
@@ -13,7 +13,7 @@
     "@inquirer/confirm": "^3.1.22",
     "@inquirer/input": "^2.2.4",
     "@inquirer/select": "^2.5.0",
-    "@oclif/core": "^4.3.3",
+    "@oclif/core": "^4.4.0",
     "@oclif/plugin-help": "^6.2.29",
     "@oclif/plugin-not-found": "^3.2.57",
     "@oclif/plugin-warn-if-update-available": "^3.1.38",
@@ -36,7 +36,7 @@
   "devDependencies": {
     "@commitlint/config-conventional": "^19",
     "@eslint/compat": "^1.3.0",
-    "@oclif/plugin-legacy": "^2.0.22",
+    "@oclif/plugin-legacy": "^2.0.24",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
     "@types/async-retry": "^1.4.5",