oclif 4.0.0 → 4.0.2

package/lib/aws.d.ts

@@ -1,14 +1,5 @@
 import * as CloudFront from 'aws-sdk/clients/cloudfront';
 import * as S3 from 'aws-sdk/clients/s3';
-export declare namespace upload {
-    interface Options {
-        localFile: string;
-        s3Params: {
-            Bucket: string;
-            Key: string;
-        };
-    }
-}
 declare const _default: {
     readonly cloudfront: {
         createCloudfrontInvalidation: (options: CloudFront.Types.CreateInvalidationRequest) => Promise<unknown>;

package/lib/aws.js

@@ -34,8 +34,9 @@ const aws = {
             return cache.s3;
         }
         catch (error) {
-            if (error.code === 'MODULE_NOT_FOUND')
-                throw new Error(`${error.message}\naws-sdk is needed to run this command.\nInstall aws-sdk as a devDependency in your CLI. \`yarn add -D aws-sdk\``);
+            const { code, message } = error;
+            if (code === 'MODULE_NOT_FOUND')
+                throw new Error(`${message}\naws-sdk is needed to run this command.\nInstall aws-sdk as a devDependency in your CLI. \`yarn add -D aws-sdk\``);
             throw error;
         }
     },

package/lib/commands/pack/win.js

@@ -268,7 +268,7 @@ the CLI should already exist in a directory named after the CLI that is the root
             });
             const o = buildConfig.dist(`win32/${templateKey}`);
             await (0, fs_extra_1.move)(path.join(installerBase, 'installer.exe'), o);
-            const windows = config.pjson.oclif.windows;
+            const { windows } = config.pjson.oclif;
             if (windows && windows.name && windows.keypath) {
                 await signWindows(o, arch, config, windows);
             }
@@ -282,9 +282,10 @@ the CLI should already exist in a directory named after the CLI that is the root
             await exec('makensis');
         }
         catch (error) {
-            if (error.code === 1)
+            const { code } = error;
+            if (code === 1)
                 return;
-            if (error.code === 127)
+            if (code === 127)
                 this.error('install makensis');
             else
                 throw error;

package/lib/commands/promote.js

@@ -61,9 +61,10 @@ class Promote extends core_1.Command {
             });
         };
         const promoteGzTarballs = async (target) => {
-            const versionedTarGzName = (0, upload_util_1.templateShortKey)('versioned', '.tar.gz', {
+            const versionedTarGzName = (0, upload_util_1.templateShortKey)('versioned', {
                 arch: target.arch,
                 bin: config.bin,
+                ext: '.tar.gz',
                 platform: target.platform,
                 sha: flags.sha,
                 version: flags.version,
@@ -84,9 +85,10 @@ class Promote extends core_1.Command {
             ]);
         };
         const promoteXzTarballs = async (target) => {
-            const versionedTarXzName = (0, upload_util_1.templateShortKey)('versioned', '.tar.xz', {
+            const versionedTarXzName = (0, upload_util_1.templateShortKey)('versioned', {
                 arch: target.arch,
                 bin: config.bin,
+                ext: '.tar.xz',
                 platform: target.platform,
                 sha: flags.sha,
                 version: flags.version,

package/lib/commands/readme.js

@@ -129,7 +129,8 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
             ]).join('\n\n');
         }
         catch (error) {
-            this.error(error.message);
+            const { message } = error;
+            this.error(message);
         }
     }
     replaceTag(readme, tag, body) {

package/lib/commands/upload/deb.js

@@ -40,7 +40,7 @@ class UploadDeb extends core_1.Command {
         };
         const uploadDeb = async (arch) => {
             const deb = (0, upload_util_1.templateShortKey)('deb', {
-                arch: arch,
+                arch,
                 bin: config.bin,
                 versionShaRevision: (0, upload_util_1.debVersion)(buildConfig),
             });

package/lib/commands/upload/tarballs.js

@@ -51,7 +51,7 @@ class UploadTarballs extends core_1.Command {
                 version: config.version,
             };
             const releaseTarballs = async (ext) => {
-                const localKey = (0, upload_util_1.templateShortKey)('versioned', ext, shortKeyInputs);
+                const localKey = (0, upload_util_1.templateShortKey)('versioned', { ...shortKeyInputs, ext });
                 const cloudKey = `${(0, upload_util_1.commitAWSDir)(config.version, buildConfig.gitSha, s3Config)}/${localKey}`;
                 await aws_1.default.s3.uploadFile(dist(localKey), {
                     ...S3Options,

package/lib/generators/cli.d.ts

@@ -1,3 +1,4 @@
+import { Interfaces } from '@oclif/core';
 import * as Generator from 'yeoman-generator';
 export default class CLI extends Generator {
     answers: {
@@ -29,7 +30,7 @@ export default class CLI extends Generator {
         force: boolean;
         yarn: boolean;
     };
-    pjson: any;
+    pjson: Interfaces.PJSON.Plugin;
     repository?: string;
     yarn: boolean;
     constructor(args: string | string[], opts: Generator.GeneratorOptions);

package/lib/generators/cli.js

@@ -13,6 +13,9 @@ try {
     hasYarn = true;
 }
 catch { }
+function removeKey(obj, key) {
+    delete obj[key];
+}
 class CLI extends Generator {
     answers;
     githubUser;
@@ -42,7 +45,6 @@ class CLI extends Generator {
         });
         console.log(`\nCreated ${this.pjson.name} in ${this.destinationRoot()}`);
     }
-    // eslint-disable-next-line complexity
     async prompting() {
         const msg = 'Time to build an oclif CLI!';
         this.log(`${msg} Version: ${version}`);
@@ -80,6 +82,7 @@ class CLI extends Generator {
             license: '',
             main: '',
             name: '',
+            // @ts-expect-error because required props will be added later
             oclif: {},
             repository: '',
             scripts: {},
@@ -90,6 +93,8 @@ class CLI extends Generator {
         if (this.githubUser)
             repository = `${this.githubUser}/${repository.split('/')[1]}`;
         const defaults = {
+            description: '',
+            files: [],
             ...this.pjson,
             author: this.githubUser ? `${this.user.git.name()} @${this.githubUser}` : this.user.git.name(),
             bin: this.name,
@@ -104,10 +109,6 @@ class CLI extends Generator {
             repository,
             version: '0.0.0',
         };
-        this.repository = defaults.repository;
-        if (this.repository && this.repository.url) {
-            this.repository = this.repository.url;
-        }
         this.answers = this.options.defaults
             ? defaults
             : await this.prompt([
@@ -208,7 +209,7 @@ class CLI extends Generator {
             this.pjson.oclif.plugins.sort();
         }
         if ((0, util_1.isEmpty)(this.pjson.oclif))
-            delete this.pjson.oclif;
+            removeKey(this.pjson, 'oclif');
         this.pjson.files = (0, util_1.uniq)((this.pjson.files || []).sort());
         this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson);
         this.fs.write(this.destinationPath('.gitignore'), this._gitignore());

package/lib/log.d.ts

@@ -1,2 +1,2 @@
 export declare const debug: any;
-export declare function log(format: string, ...args: any[]): void;
+export declare function log(format: string, ...args: unknown[]): void;

package/lib/tarballs/build.js

@@ -94,16 +94,18 @@ async function build(c, options = {}) {
     };
     const buildTarget = async (target) => {
         const workspace = c.workspace(target);
-        const gzLocalKey = (0, upload_util_1.templateShortKey)('versioned', '.tar.gz', {
+        const gzLocalKey = (0, upload_util_1.templateShortKey)('versioned', {
             arch: target.arch,
             bin: c.config.bin,
+            ext: '.tar.gz',
             platform: target.platform,
             sha: c.gitSha,
             version: config.version,
         });
-        const xzLocalKey = (0, upload_util_1.templateShortKey)('versioned', '.tar.xz', {
+        const xzLocalKey = (0, upload_util_1.templateShortKey)('versioned', {
             arch: target.arch,
             bin: c.config.bin,
+            ext: '.tar.xz',
             platform: target.platform,
             sha: c.gitSha,
             version: config.version,
@@ -140,7 +142,7 @@ async function build(c, options = {}) {
             ...(xz ? [(0, util_1.hash)('sha256', c.dist(xzLocalKey))] : []),
         ]);
         const manifest = {
-            baseDir: (0, upload_util_1.templateShortKey)('baseDir', target, { bin: c.config.bin }),
+            baseDir: (0, upload_util_1.templateShortKey)('baseDir', { ...target, bin: c.config.bin }),
             gz: config.s3Url(gzCloudKey),
             node: {
                 compatible: config.pjson.engines.node,

package/lib/upload-util.d.ts

@@ -2,7 +2,16 @@ import { Interfaces } from '@oclif/core';
 import { BuildConfig as TarballConfig } from './tarballs/config';
 export declare function commitAWSDir(version: string, sha: string, s3Config: TarballConfig['s3Config']): string;
 export declare function channelAWSDir(channel: string, s3Config: TarballConfig['s3Config']): string;
-export declare function templateShortKey(type: 'deb' | 'macos' | 'win32' | keyof Interfaces.PJSON.S3.Templates, ext?: '.tar.gz' | '.tar.xz' | Interfaces.Config.s3Key.Options, options?: Interfaces.Config.s3Key.Options): string;
+type TemplateOptions = {
+    arch?: DebArch | Interfaces.ArchTypes;
+    bin?: string;
+    ext?: '.tar.gz' | '.tar.xz';
+    sha?: string;
+    version?: string;
+    versionShaRevision?: string;
+} | Interfaces.Config.s3Key.Options;
+export declare function templateShortKey(type: 'deb' | 'macos' | 'win32' | keyof Interfaces.PJSON.S3.Templates, options?: TemplateOptions): string;
 export type DebArch = 'amd64' | 'arm64' | 'armel' | 'i386';
 export declare function debArch(arch: Interfaces.ArchTypes): DebArch;
 export declare function debVersion(buildConfig: TarballConfig): string;
+export {};

package/lib/upload-util.js

@@ -1,33 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.debVersion = exports.debArch = exports.templateShortKey = exports.channelAWSDir = exports.commitAWSDir = void 0;
-const path = require("node:path");
+const node_path_1 = require("node:path");
 const template = require("lodash.template");
 function commitAWSDir(version, sha, s3Config) {
     let s3SubDir = s3Config.folder || '';
     if (s3SubDir !== '' && s3SubDir.slice(-1) !== '/')
         s3SubDir = `${s3SubDir}/`;
-    return path.join(s3SubDir, 'versions', version, sha);
+    return (0, node_path_1.join)(s3SubDir, 'versions', version, sha);
 }
 exports.commitAWSDir = commitAWSDir;
 function channelAWSDir(channel, s3Config) {
     let s3SubDir = s3Config.folder || '';
     if (s3SubDir !== '' && s3SubDir.slice(-1) !== '/')
         s3SubDir = `${s3SubDir}/`;
-    return path.join(s3SubDir, 'channels', channel);
+    return (0, node_path_1.join)(s3SubDir, 'channels', channel);
 }
 exports.channelAWSDir = channelAWSDir;
-// to-do:
-// When this pkg starts using oclif/core
-// refactor this key name lookup
-// helper to oclif/core
-function templateShortKey(type, ext, 
-// eslint-disable-next-line unicorn/no-object-as-default-parameter
-options = { root: '.' }) {
-    if (typeof ext === 'object')
-        options = Object.assign(options, ext);
-    else if (ext)
-        options.ext = ext;
+// TODO: refactor this key name lookup helper to oclif/core
+function templateShortKey(type, options) {
+    if (!options)
+        options = {
+            root: '.',
+        };
     const templates = {
         baseDir: '<%- bin %>',
         deb: '<%- bin %>_<%- versionShaRevision %>_<%- arch %>.deb',

package/lib/util.d.ts

@@ -1,17 +1,15 @@
 export declare function castArray<T>(input?: T | T[]): T[];
-export declare function uniqBy<T>(arr: T[], fn: (cur: T) => any): T[];
+export declare function uniqBy<T>(arr: T[], fn: (cur: T) => unknown): T[];
 export declare function compact<T>(a: (T | undefined)[]): T[];
 export declare function uniq<T>(arr: T[]): T[];
-export declare function sortBy<T>(arr: T[], fn: (i: T) => sort.Types | sort.Types[]): T[];
-export declare namespace sort {
-    type Types = boolean | number | string | undefined;
-}
-export declare const template: (context: any) => (t: string | undefined) => string;
+type Types = boolean | number | string | undefined;
+export declare function sortBy<T>(arr: T[], fn: (i: T) => Types | Types[]): T[];
+export declare const template: (context: object | undefined) => (t: string | undefined) => string;
 interface VersionsObject {
     [key: string]: string;
 }
 export declare const sortVersionsObjectByKeysDesc: (input: VersionsObject) => VersionsObject;
-export declare const prettifyPaths: (input: string) => string;
+export declare const prettifyPaths: (input: unknown) => string;
 export declare const hash: (algo: string, fp: string | string[]) => Promise<string>;
 export declare function checkFor7Zip(): Promise<void>;
 export declare function isEmpty(obj: Record<string, unknown>): boolean;

package/lib/util.js

@@ -104,7 +104,8 @@ async function checkFor7Zip() {
         await exec('7z');
     }
     catch (error) {
-        if (error.code === 127)
+        const { code } = error;
+        if (code === 127)
             core_1.Errors.error('install 7-zip to package windows tarball');
         else
             throw error;

package/oclif.manifest.json

@@ -679,5 +679,5 @@
       ]
     }
   },
-  "version": "4.0.0"
+  "version": "4.0.2"
 }

package/package.json

@@ -1,21 +1,20 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
   },
   "bugs": "https://github.com/oclif/oclif/issues",
   "dependencies": {
-    "@oclif/core": "^3.0.1",
+    "@oclif/core": "^3.0.4",
     "@oclif/plugin-help": "^5.2.14",
     "@oclif/plugin-not-found": "^2.3.32",
     "@oclif/plugin-warn-if-update-available": "^2.0.44",
     "async-retry": "^1.3.3",
     "aws-sdk": "^2.1231.0",
     "change-case": "^4",
-    "concurrently": "^7.6.0",
     "debug": "^4.3.3",
     "eslint-plugin-perfectionist": "^2.1.0",
     "find-yarn-workspace-root": "^2.0.0",
@@ -47,7 +46,7 @@
     "chai": "^4.3.7",
     "commitlint": "^17.7.2",
     "conventional-changelog-cli": "^2.2.2",
-    "eslint-config-oclif-typescript": "^2.0.1",
+    "eslint-config-oclif-typescript": "^3.0.1",
     "eslint-config-oclif": "^5.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint": "^8.50.0",