juisy 2.0.0-beta.9 → 2.1.0

package/bin/cli/cmds/public/print-globals.js

@@ -14,7 +14,7 @@ export default new CLI.Command({
     cli.option('t', {
       alias: 'target',
       type: 'string',
-      describe: 'The target file exporting project globals (fallback to ./globals.config.js)'
+      describe: 'The target file exporting project globals (fallback to ./project.globals.js)'
     })
     return cli
   },

package/dist/cli/CLIFactory.d.ts

@@ -52,5 +52,7 @@ export type PluginAPI = {
 export declare function CLIFactory(builder: CLIBuilder, options?: CLIFactoryOptions): Promise<(argv?: typeof process.argv) => CLIEngine>;
 export declare namespace CLIFactory {
     var use: (plugin: Plugin) => void;
+    var removePlugin: (name: string) => void;
+    var getRegisteredPlugins: () => Plugin[];
 }
 export {};

package/dist/cli/Command.d.ts

@@ -1,11 +1,12 @@
-import { CommandObject } from './types';
+import { OutputUtils } from './OutputUtils';
+import { CLIEngine, CommandObject, CommandHandlerArgs } from './types';
 type CommandOptions = {
     command: CommandObject['command'];
     aliases?: CommandObject['aliases'];
     describe?: CommandObject['describe'];
     deprecated?: CommandObject['deprecated'];
-    builder?: CommandObject['builder'];
-    handler?: CommandObject['handler'];
+    builder?: Command['builder'];
+    handler?: Command['handler'];
     middlewares?: CommandObject['middlewares'];
     meta?: CommandObject['meta'];
 };
@@ -17,7 +18,7 @@ export declare class Command implements CommandObject {
      * Creates a Command instance from object (CommandObject)
      * @param {CommandObject} commandObject - The command definition object
      */
-    constructor(commandObject: CommandOptions);
+    constructor(commandObject?: CommandOptions);
     /**
      * The command
      */
@@ -41,14 +42,53 @@ export declare class Command implements CommandObject {
     /**
      * Command builder
      */
-    builder: (cli: import('./types').CLIEngine) => import('./types').CLIEngine | PromiseLike<import('./types').CLIEngine>;
+    builder(cli: CLIEngine): CLIEngine | PromiseLike<CLIEngine>;
     /**
      * Command handler
      */
-    handler: import('./types').CommandHandler | undefined;
+    handler(this: Command, argv: CommandHandlerArgs): void | Promise<void>;
     /**
      * Command middlewares
      */
     middlewares: import('yargs').MiddlewareFunction[] | undefined;
+    /**
+     * Log a message in the console output. Uses OutputUtils.log method.
+     * @param msg The message to log. Can be empty to log blank line
+     * @param options The options to pass to OutputUtils.log second argument
+     */
+    log(msg?: string, options?: Parameters<typeof OutputUtils.log>[1]): void;
+    /**
+     * Get the process.argv without bin
+     * @returns An array of command line arguments
+     */
+    getProcessArgv(): string[];
+    /**
+     * Get Command instance as plain object
+     * @returns The command definition object to pass to yargs
+     */
+    toObject(): {
+        command: string | readonly string[] | undefined;
+        aliases: string | readonly string[] | undefined;
+        describe: string | false | undefined;
+        deprecated: string | boolean | undefined;
+        meta: Partial<import('./types').CommandMeta> | undefined;
+        builder: (cli: CLIEngine) => CLIEngine | PromiseLike<CLIEngine>;
+        handler: (argv: CommandHandlerArgs) => void | Promise<void>;
+        middlewares: import('yargs').MiddlewareFunction[] | undefined;
+    };
+    /**
+     * Getters
+     */
+    /**
+     * Get the CLI engine
+     */
+    get engine(): CLIEngine;
+    /**
+     * Static properties
+     */
+    /**
+     * The CLI engine. Will be set by createEngine method
+     */
+    static engine: CLIEngine;
 }
 export {};

package/dist/cli/GlobalSettings.schema.json

@@ -1 +1 @@
-{"$schema":"http://json-schema.org/draft-07/schema#","$ref":"#/definitions/GlobalSettings","definitions":{"GlobalSettings":{"type":"object","properties":{"release":{"$ref":"#/definitions/UserProvidedConfigSetting%3CReleaseIt.Config%3E","description":"Release configuration"}}},"UserProvidedConfigSetting<ReleaseIt.Config>":{"anyOf":[{"type":"object","properties":{"config":{"type":"string","description":"The configuration file path"}},"required":["config"]},{"type":"object","properties":{}}],"description":"Provide a configuration object or an object with only \"config\" property","examples":[{"config":"path/to/config/file"}]}}}
+{"$schema":"http://json-schema.org/draft-07/schema#","$ref":"#/definitions/GlobalSettings","definitions":{"GlobalSettings":{"type":"object","properties":{"release":{"$ref":"#/definitions/UserProvidedConfigSetting%3CConfig%3E","description":"Release configuration"}}},"UserProvidedConfigSetting<Config>":{"anyOf":[{"type":"object","properties":{"config":{"type":"string","description":"The configuration file path"}},"required":["config"]},{"type":"object","properties":{"hooks":{"$ref":"#/definitions/Hooks"},"plugins":{"type":"object","additionalProperties":{"type":"object"}},"git":{"type":"object","properties":{"changelog":{"type":"string","default":"git log --pretty=format:\"* %s (%h)\" ${from}...${to}"},"requireCleanWorkingDir":{"type":"boolean","default":true},"requireBranch":{"type":"boolean","enum":[false],"default":false},"requireUpstream":{"type":"boolean","default":true},"requireCommits":{"type":"boolean","default":false},"requireCommitsFail":{"type":"boolean","default":true},"commitsPath":{"type":"string","default":""},"addUntrackedFiles":{"type":"boolean","default":false},"commit":{"type":"boolean","default":true},"commitMessage":{"type":"string","default":"Release ${version}"},"commitArgs":{"type":"array","items":{}},"tag":{"type":"boolean","default":true},"tagExclude":{"default":null},"tagName":{"default":null},"tagMatch":{"default":null},"getLatestTagFromAllRefs":{"type":"boolean","default":false},"tagAnnotation":{"type":"string","default":"Release ${version}"},"tagArgs":{"type":"array","items":{}},"push":{"type":"boolean","default":true},"pushArgs":{"type":"array","items":{"type":"string"},"default":["--follow-tags"]},"pushRepo":{"type":"string","default":""}}},"npm":{"type":"object","properties":{"publish":{"type":"boolean","default":true},"publishPath":{"type":"string","default":"."},"publishArgs":{"type":"array","items":{}},"tag":{"default":null},"otp":{"default":null},"ignoreVersion":{"type":"boolean","default":false},"allowSameVersion":{"type":"boolean","default":false},"versionArgs":{"type":"array","items":{}},"skipChecks":{"type":"boolean","default":false},"timeout":{"type":"number","default":10}}},"github":{"type":"object","properties":{"release":{"type":"boolean","default":false},"releaseName":{"type":"string","default":"Release ${version}"},"releaseNotes":{"default":null},"autoGenerate":{"type":"boolean","default":false},"preRelease":{"type":"boolean","default":false},"draft":{"type":"boolean","default":false},"tokenRef":{"type":"string","default":"GITHUB_TOKEN"},"assets":{"default":null},"host":{"default":null},"timeout":{"type":"number","default":0},"proxy":{"default":null},"makeLatest":{"anyOf":[{"type":"boolean"},{"type":"string","const":"legacy"}],"default":"true\n'legacy' - Github determines the latest release based on the release creation date and higher semantic version.\nSee https://docs.github.com/en/rest/releases/releases?apiVersion=latest#create-a-release"},"discussionCategoryName":{"type":["boolean","string"],"default":false},"skipChecks":{"type":"boolean","default":false},"web":{"type":"boolean","default":false},"comments":{"type":"object","properties":{"submit":{"type":"boolean","default":false},"issue":{"type":"string","default":":rocket?: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"},"pr":{"type":"string","default":":rocket?: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"}}}}},"gitlab":{"type":"object","properties":{"release":{"type":"boolean","default":false},"releaseName":{"type":"string","default":"Release ${version}"},"releaseNotes":{"default":null},"milestones":{"type":"array","items":{}},"tokenRef":{"type":"string","default":"GITLAB_TOKEN"},"tokenHeader":{"type":"string","default":"Private-Token"},"certificateAuthorityFile":{"default":null},"secure":{"type":"boolean","default":null},"assets":{"default":null},"useIdsForUrls":{"type":"boolean","default":false},"useGenericPackageRepositoryForAssets":{"type":"boolean","default":false},"genericPackageRepositoryName":{"type":"string","default":"release-it"},"origin":{"default":null},"skipChecks":{"type":"boolean","default":false}}}}}],"description":"Provide a configuration object or an object with only \"config\" property","examples":[{"config":"path/to/config/file"}]},"Hooks":{"type":"object","properties":{"before:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:version:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:version:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:version:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:version:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:version:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:version:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:git:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:git:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:git:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:git:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:git:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:git:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:npm:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:npm:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:npm:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:npm:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:npm:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:npm:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:github:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:github:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:github:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:github:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:github:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:github:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:gitlab:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:gitlab:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"before:gitlab:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:gitlab:init":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:gitlab:bump":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"after:gitlab:release":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}}}}

package/dist/cli/InterfaceUtils.d.ts

@@ -1,4 +1,4 @@
-import { ExecaError } from 'execa';
+import { ResultPromise as ExecaResultPromise, ExecaError, Options as ExecaOptions } from 'execa';
 import { default as _prompts } from 'prompts';
 /**
  * Command execution error thrown by execa
@@ -9,45 +9,49 @@ export declare class InterfaceUtils {
     /**
      * Get root directory path
      * @example
-     * import { CLIUtils: { rootDir } } from '@hperchec/juisy'
+     * const { rootDir } = InterfaceUtils
      * console.log(rootDir) // => 'path/to/your/root/dir'
      */
     static rootDir: string;
     /**
-     * @param {string} bin - Command
-     * @param {string[]} args - Same as execa second arg
-     * @param {object} [opts] - Options
-     * @returns {Promise<object>} The `execa` Promise
+     * @param bin - Command
+     * @param args - Same as execa second arg
+     * @param opts - Options
+     * @returns The `execa` Promise
      * @throws {RunError}
      * @description
      * Run command (child_process). See also `execa` package documentation
      * @example
-     * const { run } = require('@hperchec/juisy').utils
+     * const { run } = InterfaceUtils
+     * await run('npm run test')
+     * // With options
+     * await run('npm run test', { stdio: 'inherit' })
+     * // Old way
      * await run('npm', [ 'run', 'test' ], { stdio: 'inherit' })
      */
-    static run(bin: string, args: string[], opts?: {}): import('execa').ExecaChildProcess<string>;
+    static run(command: string, opts?: ExecaOptions): ExecaResultPromise;
+    static run(bin: string, args: string[], opts?: ExecaOptions): ExecaResultPromise;
     /**
-     * @alias utils.abort
      * @param {number} [code] - Code for process.exit() (default: 0)
      * @returns {void}
      * @description
      * Exit process
      * @example
-     * const { abort } = require('@hperchec/juisy').utils
+     * const { abort } = InterfaceUtils
      * abort() // => exit process with code 0
      * abort(1) // => error code
      */
     static abort(code?: number): void;
     /**
-     * @alias utils.confirm
-     * @param {prompts.PromptObject} question - A prompt question object (see https://gitlab.com/hperchec/juisy/-/blob/main/documentation/utils.md#utilspromptsargs-object)
+     * @param question - A prompt question object
+     * @param options - A prompt options object
      * @returns {Promise<boolean>} - True if confirmed
      * @description
      * Demand confirmation with prompts native util. If not confirmed, it will automatically abort the script.
      * @example
      * confirm({ message: 'Confirm to continue' }) // Deny it will abort the script
      */
-    static confirm(question: _prompts.PromptObject): Promise<true | undefined>;
+    static confirm(question: _prompts.PromptObject, options?: _prompts.Options): Promise<true | undefined>;
     /**
      * See `prompts` package documentation
      * @example

package/dist/cli/OutputUtils.d.ts

@@ -1,4 +1,3 @@
-import { default as chalk } from 'chalk';
 import { default as indent } from 'indent-string';
 import { default as _stripAnsi } from 'strip-ansi';
 export declare class OutputUtils {
@@ -13,17 +12,7 @@ export declare class OutputUtils {
      * const { $style } = OutputUtils
      * console.log($style.green('Green text!')) // => '[32mGreen text![0m'
      */
-    static $style: chalk.Chalk & chalk.ChalkFunction & {
-        supportsColor: chalk.ColorSupport | false;
-        Level: chalk.Level;
-        Color: ("black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright") | ("bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright");
-        ForegroundColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
-        BackgroundColor: "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright";
-        Modifiers: "bold" | "hidden" | "reset" | "dim" | "italic" | "underline" | "inverse" | "strikethrough" | "visible";
-        stderr: chalk.Chalk & {
-            supportsColor: chalk.ColorSupport | false;
-        };
-    };
+    static $style: import('chalk').ChalkInstance;
     /**
      * Format a message for console output
      * @param msg - The message to format

package/dist/cli/index.d.ts

@@ -13,6 +13,7 @@ declare global {
     };
 }
 export { CLIFactory } from './CLIFactory';
+export { Plugin } from './Plugin';
 export * from './Command';
 export * from './InterfaceUtils';
 export * from './OutputUtils';
@@ -27,6 +28,5 @@ export type * from './plugins/register-git-hooks-commands/augment';
 export type * from './plugins/register-lint-commands/augment';
 export type * from './plugins/register-release-command/augment';
 export type * from './plugins/default-command-fallbacks/augment';
-export type * from './plugins/command-handler-injections/augment';
 export type * from './plugins/command-meta/augment';
 export type * from './plugins/private-commands/augment';