@codiac.io/codiac-cli 1.2.202 → 1.2.203

package/dist/ops/test/when-versions-are-parsed.spec.js

@@ -1,62 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-require("mocha");
-require("chai");
-const chai_1 = require("chai");
-const LocalOps_1 = require("../LocalOps");
-const codiac_ops_common_1 = require("@codiac.io/codiac-ops-common");
-const codiac_common_1 = require("@codiac.io/codiac-common");
-const data_1 = require("../data");
-const inversify_1 = require("inversify");
-describe("when versions are parsed", () => {
-    let localOps;
-    let logger;
-    let ioc = new inversify_1.Container();
-    let cliExec;
-    before(() => {
-        logger = new codiac_common_1.BetterConsoleLogger();
-        cliExec = new codiac_ops_common_1.CliExec(logger);
-        let uiPvd = new codiac_ops_common_1.ThrowingUserInputProvider(logger);
-        let styler = new codiac_ops_common_1.NoStyleOutputStyler();
-        let cliRoot = process.cwd(); // we're not using this for this test
-        let projRoot = process.cwd();
-        console.log(`projRoot: ${projRoot}`);
-        let cfgRepo = new data_1.ProjectContextRepo({ projectRoot: projRoot });
-        ioc.bind(data_1.ProjectContextRepo).toConstantValue(cfgRepo);
-        localOps = new LocalOps_1.LocalOps(ioc); // , { cliConfigDir: cwd(), version: "0.0.0" }, { projectRoot: projRoot }, cfgRepo, uiPvd, styler, cliExec, logger);
-    });
-    it("then branch shall be recognized in prerelease.", () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-            try {
-                let v1 = "1.2.3-branch-name.4";
-                let newBranchName = "my-new.branchname";
-                // let modified = localOps.addPrereleaseId(v1, newBranchName);
-                // console.log(modified);
-                // expect(modified).to.equal(`1.2.3-${newBranchName}.0`, "The version number was incorrect");
-                chai_1.expect.fail();
-                resolve();
-            }
-            catch (err) {
-                reject(err);
-            }
-        }));
-    }));
-    it("then build number suffixes shall be supported in prerelease.", () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-            try {
-                let v1 = "1.2.3-branch-name.4+8989";
-                let newBranchName = "my-new.branch_name";
-                // let modified = localOps.addPrereleaseId(v1, newBranchName);
-                // console.log(modified);
-                // expect(modified).to.equal(`1.2.3-my-new.branch-name.0`, "The version number was incorrect");
-                chai_1.expect.fail();
-                resolve();
-            }
-            catch (err) {
-                reject(err);
-            }
-        }));
-    }));
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("mocha");
+require("chai");
+const chai_1 = require("chai");
+const LocalOps_1 = require("../LocalOps");
+const codiac_ops_common_1 = require("@codiac.io/codiac-ops-common");
+const codiac_common_1 = require("@codiac.io/codiac-common");
+const data_1 = require("../data");
+const inversify_1 = require("inversify");
+describe("when versions are parsed", () => {
+    let localOps;
+    let logger;
+    let ioc = new inversify_1.Container();
+    let cliExec;
+    before(() => {
+        logger = new codiac_common_1.BetterConsoleLogger();
+        cliExec = new codiac_ops_common_1.CliExec(logger);
+        let uiPvd = new codiac_ops_common_1.ThrowingUserInputProvider(logger);
+        let styler = new codiac_ops_common_1.NoStyleOutputStyler();
+        let cliRoot = process.cwd(); // we're not using this for this test
+        let projRoot = process.cwd();
+        console.log(`projRoot: ${projRoot}`);
+        let cfgRepo = new data_1.ProjectContextRepo({ projectRoot: projRoot });
+        ioc.bind(data_1.ProjectContextRepo).toConstantValue(cfgRepo);
+        localOps = new LocalOps_1.LocalOps(ioc); // , { cliConfigDir: cwd(), version: "0.0.0" }, { projectRoot: projRoot }, cfgRepo, uiPvd, styler, cliExec, logger);
+    });
+    it("then branch shall be recognized in prerelease.", () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+            try {
+                let v1 = "1.2.3-branch-name.4";
+                let newBranchName = "my-new.branchname";
+                // let modified = localOps.addPrereleaseId(v1, newBranchName);
+                // console.log(modified);
+                // expect(modified).to.equal(`1.2.3-${newBranchName}.0`, "The version number was incorrect");
+                chai_1.expect.fail();
+                resolve();
+            }
+            catch (err) {
+                reject(err);
+            }
+        }));
+    }));
+    it("then build number suffixes shall be supported in prerelease.", () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+            try {
+                let v1 = "1.2.3-branch-name.4+8989";
+                let newBranchName = "my-new.branch_name";
+                // let modified = localOps.addPrereleaseId(v1, newBranchName);
+                // console.log(modified);
+                // expect(modified).to.equal(`1.2.3-my-new.branch-name.0`, "The version number was incorrect");
+                chai_1.expect.fail();
+                resolve();
+            }
+            catch (err) {
+                reject(err);
+            }
+        }));
+    }));
+});
 //# sourceMappingURL=when-versions-are-parsed.spec.js.map

package/dist/ops/throwing-user-input-provider.js

@@ -1,37 +1,37 @@
-"use strict";
-// import { inject, injectable } from "inversify";
-// import { INTERFACES } from "@codiac.io/codiac-common";
-// import { IBetterLogger } from "@codiac.io/codiac-common/IBetterLogger";
-// import { EntryValue, choice, IUserInputProvider } from "@codiac.io/codiac-ops-common";
-// /** For use in a non-TTY scenario: Throws on any request for user interaction.
-//  */
-// @injectable()
-// export class ThrowingUserInputProvider implements IUserInputProvider {
-//   constructor(@inject(INTERFACES.IBetterLogger) private logger: IBetterLogger) {
-//   }
-//   userMessage(message: string): void {
-//     this.logger.notice(message);
-//   }
-//   prompt<T extends EntryValue>(id: string, prompt: string, required?: boolean, defaultValue?: T): Promise<T | undefined> {
-//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
-//   }
-//   promptPassword(id: string, prompt: string): Promise<string> {
-//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
-//   }
-//   promptSelect<T extends EntryValue>(id: string, prompt: string, choices: choice<T>[], multiSelect?: boolean): Promise<T | undefined> {
-//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
-//   }
-//   promptConfirm(id: string, prompt: string, defaultValue?: boolean): Promise<boolean> {
-//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
-//   }
-//   openUrl(url: string): Promise<void> {
-//     throw new Error(`Cannot open browser window to url [${url}]: Cannot interact with user from this environment.`);
-//   }
-//   startSpinner(userMessage: string): void {
-//     this.userMessage(userMessage);
-//   }
-//   stopSpinner(userMessage: string): void {
-//     this.userMessage(userMessage);
-//   }
-// }
+"use strict";
+// import { inject, injectable } from "inversify";
+// import { INTERFACES } from "@codiac.io/codiac-common";
+// import { IBetterLogger } from "@codiac.io/codiac-common/IBetterLogger";
+// import { EntryValue, choice, IUserInputProvider } from "@codiac.io/codiac-ops-common";
+// /** For use in a non-TTY scenario: Throws on any request for user interaction.
+//  */
+// @injectable()
+// export class ThrowingUserInputProvider implements IUserInputProvider {
+//   constructor(@inject(INTERFACES.IBetterLogger) private logger: IBetterLogger) {
+//   }
+//   userMessage(message: string): void {
+//     this.logger.notice(message);
+//   }
+//   prompt<T extends EntryValue>(id: string, prompt: string, required?: boolean, defaultValue?: T): Promise<T | undefined> {
+//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
+//   }
+//   promptPassword(id: string, prompt: string): Promise<string> {
+//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
+//   }
+//   promptSelect<T extends EntryValue>(id: string, prompt: string, choices: choice<T>[], multiSelect?: boolean): Promise<T | undefined> {
+//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
+//   }
+//   promptConfirm(id: string, prompt: string, defaultValue?: boolean): Promise<boolean> {
+//     throw new Error(`Cannot acquire input [id: ${id}]: Cannot interact with user from this environment.`);
+//   }
+//   openUrl(url: string): Promise<void> {
+//     throw new Error(`Cannot open browser window to url [${url}]: Cannot interact with user from this environment.`);
+//   }
+//   startSpinner(userMessage: string): void {
+//     this.userMessage(userMessage);
+//   }
+//   stopSpinner(userMessage: string): void {
+//     this.userMessage(userMessage);
+//   }
+// }
 //# sourceMappingURL=throwing-user-input-provider.js.map

package/dist/ops/workspace-versioner.d.ts

@@ -1,122 +1,122 @@
-import { IBetterLogger } from "@codiac.io/codiac-common";
-import { ProjectContextRepo } from "./data/cli-context-repo";
-import { VersionBump } from "./LocalOps";
-import { ImageExport, ProjectConfig } from "@codiac.io/codiac-relay-contracts";
-/** Manages the semantic version number for image exports declared in the workspace (aka: the codiac.json).  */
-export declare class WorkspaceVersioner {
-    private logger;
-    private projCfgRepo;
-    constructor(logger: IBetterLogger, projCfgRepo: ProjectContextRepo);
-    private versioner;
-    /** Increments the version number of the given image export by the given increment.
-     *  Retains existing version number if no increment is specified.
-     *  Sets to the default init version number if the imageExport doesnt yet have a version declared.
-     *  Writes changes to the project config (aka: codiac.json).
-     *  Throws if existing version is invalid.
-     *
-     * @param cfg Project config doc (aka: codiac.json deserialized)
-     */
-    incrementImageVersion(imageExport: ImageExport, cfg: ProjectConfig, increment: VersionBump): Promise<ImageExport>;
-    /** Increments the project code version number by the given increment.
-     *  Retains existing version number if no increment is specified.
-     *  Writes changes to the project config (aka: codiac.json).
-     *  Throws if existing version is invalid.
-     *
-     * @param cfg Project config doc (aka: codiac.json deserialized)
-     */
-    incrementCodeVersion(cfg: ProjectConfig, increment: VersionBump): Promise<ProjectConfig>;
-}
-export declare class SemanticVersioner {
-    private logger;
-    constructor(logger: IBetterLogger);
-    /** Increments the given semantic version nnumber by the given increment.
-     *  Returns existing version number if no increment is specified.
-     *  Throws if existing version is invalid.
-     */
-    incrementVersion(existing: string, increment: VersionBump): string;
-    /** Prefixes the prerelease version segment
-     * with the given prerelease identifier.
-     *
-     * using format:  `[major].[minor].[patch]-[id].[prereleaseNumber]`
-     *
-     * eg:  `1.2.3`  remains  `1.2.3`
-     * eg:  `1.2.3-4`  becomes  `1.2.3-thisBranch.4`
-     * eg:  `1.2.3-toro.4`  becomes  `1.2.3-thisBranch.4`   */
-    private addPrereleaseId;
-    /** Rewrites the entire semantic version with the given semantic version.
-     *
-     * @param version (required) Must be a valid semantic version (eg: `1.2.3` or `1.2.3-something` or `1.2.3-something.4`).
-     */
-    bump(change: VersionBump): string;
-    /** Rewrites the entire semantic version with the given semantic version.
-     *
-     * @param version (required) Must be a valid semantic version (eg: `1.2.3` or `1.2.3-something` or `1.2.3-something.4`).
-     */
-    set(version: string): string;
-    /** Increments the major number of the semantic version for the current image definition.
-     *
-     * That is: the term `[major]` in the version format:
-     * ```
-     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
-     * ```
-     *
-     * eg:  `1.2.3` becomes `2.0.0`
-     *
-     * eg:  `1.2.3-my-branch.3` becomes `2.0.0`
-     */
-    major(): string;
-    /** Increments the minor number of the semantic version for the current image definition.
-     *
-     * That is: the term `[minor]` in the version format:
-     * ```
-     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
-     * ```
-     *
-     * eg:  `1.2.3` becomes `1.3.0`
-     *
-     * eg:  `1.2.3-my-branch.3` becomes `1.3.0`
-     */
-    minor(newValue?: boolean): string;
-    /** Increments the patch number of the semantic version for the current image definition.
-     *
-     * That is: the term `[patch]` in the version format:
-     * ```
-     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
-     * ```
-     *
-     * eg:  `1.2.3` becomes `1.2.4`
-     *
-     * eg:  `1.2.3-my-branch.3` becomes `1.2.3`
-     *
-     * *(note: NOT 1.2.4 because prereleases lead up to a patch release, thus the term "cut a version")*
-     */
-    patch(): string;
-    /** Increments the prerelease of the semantic version for the current image definition.
-     * Passing in an alphanumeric prerelease name
-     * will prefix the number and delimit with a period (.).
-     *
-     * That is: the `[prereleaseName]` and `[prereleaseNumber]` terms in the version format:
-     * ```
-     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
-     * ```
-     *
-     * eg: without providing a name...
-     *
-     * `1.2.3` becomes `1.2.4-0`
-     *
-     * `1.2.3-my-branch.3` becomes `1.2.3-my-branch.4`
-     *
-     * `1.2.3-my-branch` becomes `1.2.3-my-branch.0`
-     *
-     * eg: providing "workitem-pdq" as name...
-     *
-     * `1.2.3` becomes `1.2.4-workitem-pdq.0`
-     *
-     * `1.2.3-workitem-pdq.0` becomes `1.2.3-workitem-pdq.1`
-     *
-     * `1.2.3-my-branch.3` becomes `1.2.3-workitem-pdq.0`
-     *
-     * `1.2.3-my-branch` becomes `1.2.3-workitem-pdq.0`
-     */
-    prerelease(name?: string | undefined): string;
-}
+import { IBetterLogger } from "@codiac.io/codiac-common";
+import { ProjectContextRepo } from "./data/cli-context-repo";
+import { VersionBump } from "./LocalOps";
+import { ImageExport, ProjectConfig } from "@codiac.io/codiac-relay-contracts";
+/** Manages the semantic version number for image exports declared in the workspace (aka: the codiac.json).  */
+export declare class WorkspaceVersioner {
+    private logger;
+    private projCfgRepo;
+    constructor(logger: IBetterLogger, projCfgRepo: ProjectContextRepo);
+    private versioner;
+    /** Increments the version number of the given image export by the given increment.
+     *  Retains existing version number if no increment is specified.
+     *  Sets to the default init version number if the imageExport doesnt yet have a version declared.
+     *  Writes changes to the project config (aka: codiac.json).
+     *  Throws if existing version is invalid.
+     *
+     * @param cfg Project config doc (aka: codiac.json deserialized)
+     */
+    incrementImageVersion(imageExport: ImageExport, cfg: ProjectConfig, increment: VersionBump): Promise<ImageExport>;
+    /** Increments the project code version number by the given increment.
+     *  Retains existing version number if no increment is specified.
+     *  Writes changes to the project config (aka: codiac.json).
+     *  Throws if existing version is invalid.
+     *
+     * @param cfg Project config doc (aka: codiac.json deserialized)
+     */
+    incrementCodeVersion(cfg: ProjectConfig, increment: VersionBump): Promise<ProjectConfig>;
+}
+export declare class SemanticVersioner {
+    private logger;
+    constructor(logger: IBetterLogger);
+    /** Increments the given semantic version nnumber by the given increment.
+     *  Returns existing version number if no increment is specified.
+     *  Throws if existing version is invalid.
+     */
+    incrementVersion(existing: string, increment: VersionBump): string;
+    /** Prefixes the prerelease version segment
+     * with the given prerelease identifier.
+     *
+     * using format:  `[major].[minor].[patch]-[id].[prereleaseNumber]`
+     *
+     * eg:  `1.2.3`  remains  `1.2.3`
+     * eg:  `1.2.3-4`  becomes  `1.2.3-thisBranch.4`
+     * eg:  `1.2.3-toro.4`  becomes  `1.2.3-thisBranch.4`   */
+    private addPrereleaseId;
+    /** Rewrites the entire semantic version with the given semantic version.
+     *
+     * @param version (required) Must be a valid semantic version (eg: `1.2.3` or `1.2.3-something` or `1.2.3-something.4`).
+     */
+    bump(change: VersionBump): string;
+    /** Rewrites the entire semantic version with the given semantic version.
+     *
+     * @param version (required) Must be a valid semantic version (eg: `1.2.3` or `1.2.3-something` or `1.2.3-something.4`).
+     */
+    set(version: string): string;
+    /** Increments the major number of the semantic version for the current image definition.
+     *
+     * That is: the term `[major]` in the version format:
+     * ```
+     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
+     * ```
+     *
+     * eg:  `1.2.3` becomes `2.0.0`
+     *
+     * eg:  `1.2.3-my-branch.3` becomes `2.0.0`
+     */
+    major(): string;
+    /** Increments the minor number of the semantic version for the current image definition.
+     *
+     * That is: the term `[minor]` in the version format:
+     * ```
+     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
+     * ```
+     *
+     * eg:  `1.2.3` becomes `1.3.0`
+     *
+     * eg:  `1.2.3-my-branch.3` becomes `1.3.0`
+     */
+    minor(newValue?: boolean): string;
+    /** Increments the patch number of the semantic version for the current image definition.
+     *
+     * That is: the term `[patch]` in the version format:
+     * ```
+     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
+     * ```
+     *
+     * eg:  `1.2.3` becomes `1.2.4`
+     *
+     * eg:  `1.2.3-my-branch.3` becomes `1.2.3`
+     *
+     * *(note: NOT 1.2.4 because prereleases lead up to a patch release, thus the term "cut a version")*
+     */
+    patch(): string;
+    /** Increments the prerelease of the semantic version for the current image definition.
+     * Passing in an alphanumeric prerelease name
+     * will prefix the number and delimit with a period (.).
+     *
+     * That is: the `[prereleaseName]` and `[prereleaseNumber]` terms in the version format:
+     * ```
+     * [major].[minor].[patch]-[prereleaseName].[prereleaseNumber]
+     * ```
+     *
+     * eg: without providing a name...
+     *
+     * `1.2.3` becomes `1.2.4-0`
+     *
+     * `1.2.3-my-branch.3` becomes `1.2.3-my-branch.4`
+     *
+     * `1.2.3-my-branch` becomes `1.2.3-my-branch.0`
+     *
+     * eg: providing "workitem-pdq" as name...
+     *
+     * `1.2.3` becomes `1.2.4-workitem-pdq.0`
+     *
+     * `1.2.3-workitem-pdq.0` becomes `1.2.3-workitem-pdq.1`
+     *
+     * `1.2.3-my-branch.3` becomes `1.2.3-workitem-pdq.0`
+     *
+     * `1.2.3-my-branch` becomes `1.2.3-workitem-pdq.0`
+     */
+    prerelease(name?: string | undefined): string;
+}