release-it-docker-plugin 0.0.0

package/.nvmrc

@@ -0,0 +1 @@
+v22.9.0

package/dist/base-plugin.d.ts

@@ -0,0 +1,34 @@
+export declare class BasePlugin {
+    namespace: any;
+    options: any;
+    context: any;
+    config: any;
+    log: any;
+    shell: any;
+    spinner: any;
+    prompt: any;
+    debug: any;
+    static isEnabled(): boolean;
+    static disablePlugin(): null;
+    constructor({ namespace, options, container }?: any);
+    getInitialOptions(options: any, namespace: any): any;
+    init(): void;
+    getName(): void;
+    getLatestVersion(): void;
+    getChangelog(): void;
+    getIncrement(): void;
+    getIncrementedVersionCI(): void;
+    getIncrementedVersion(): void;
+    beforeBump(): void;
+    bump(): void;
+    beforeRelease(version: any): void;
+    release(version: any): void;
+    afterRelease(): void;
+    getContext(path?: any): any;
+    setContext(context: any): void;
+    exec(command: any, { options, context }?: any): any;
+    registerPrompts(prompts: any): void;
+    showPrompt(options: any): Promise<any>;
+    step(options: any): any;
+}
+export default Plugin;

package/dist/base-plugin.js

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasePlugin = void 0;
+const node_util_1 = require("node:util");
+const lodash_1 = __importDefault(require("lodash"));
+// I was unable to import plugin class from release-it v18, so I copied and pasted it here and typed a bit for my use case.
+// See: https://github.com/release-it/release-it/blob/main/lib/plugin/Plugin.js
+class BasePlugin {
+    static isEnabled() {
+        return true;
+    }
+    static disablePlugin() {
+        return null;
+    }
+    constructor({ namespace, options = {}, container = {} } = {}) {
+        this.namespace = namespace;
+        this.options = Object.freeze(this.getInitialOptions(options, namespace));
+        this.context = {};
+        this.config = container.config;
+        this.log = container.log;
+        this.shell = container.shell;
+        this.spinner = container.spinner;
+        this.prompt = container.prompt;
+        this.debug = (0, node_util_1.debug)(`release-it:${namespace}`);
+    }
+    getInitialOptions(options, namespace) {
+        return options[namespace] || {};
+    }
+    init() { }
+    getName() { }
+    getLatestVersion() { }
+    getChangelog() { }
+    getIncrement() { }
+    getIncrementedVersionCI() { }
+    getIncrementedVersion() { }
+    beforeBump() { }
+    bump() { }
+    beforeRelease(version) { }
+    release(version) { }
+    afterRelease() { }
+    getContext(path) {
+        const context = lodash_1.default.merge({}, this.options, this.context);
+        return path ? lodash_1.default.get(context, path) : context;
+    }
+    setContext(context) {
+        lodash_1.default.merge(this.context, context);
+    }
+    exec(command, { options, context = {} } = {}) {
+        const ctx = Object.assign(context, this.config.getContext(), { [this.namespace]: this.getContext() });
+        return this.shell.exec(command, options, ctx);
+    }
+    registerPrompts(prompts) {
+        this.prompt.register(prompts, this.namespace);
+    }
+    showPrompt(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            options.namespace = this.namespace;
+            return this.prompt.show(options);
+        });
+    }
+    step(options) {
+        const context = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
+        const opts = Object.assign({}, options, { context });
+        const isException = this.config.isPromptOnlyVersion && ['incrementList', 'publish', 'otp'].includes(opts.prompt);
+        return this.config.isCI && !isException ? this.spinner.show(opts) : this.showPrompt(opts);
+    }
+}
+exports.BasePlugin = BasePlugin;
+exports.default = Plugin;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { BasePlugin } from "./base-plugin";
+export default class DockerPlugin extends BasePlugin {
+    beforeRelease(): Promise<any>;
+    release(): Promise<any>;
+    afterRelease(): void;
+    private build;
+    private publish;
+}

package/dist/index.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_plugin_1 = require("./base-plugin");
+const DOCKER_HUB_BASE_URL = 'https://hub.docker.com';
+class DockerPlugin extends base_plugin_1.BasePlugin {
+    beforeRelease() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.options.build === false)
+                return false;
+            return this.step({ task: () => this.build(), label: 'docker build', prompt: { message: 'Build?', default: this.options.build } });
+        });
+    }
+    release() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.options.publish === false)
+                return false;
+            return this.step({ task: () => this.publish(), label: 'docker publish', prompt: { message: 'Publish?', default: this.options.publish } });
+        });
+    }
+    afterRelease() {
+        const { isPublished } = this.getContext();
+        if (isPublished) {
+            this.log.log(`🔗 ${DOCKER_HUB_BASE_URL}/r/${this.options.imageName}`);
+        }
+    }
+    build() {
+        const { imageName, latestTag } = this.options;
+        const args = [
+            '-t', `${imageName}:${this.getContext().version}`,
+            ...(latestTag ? ['-t', `${imageName}:latest`] : [])
+        ];
+        return this.exec(`docker build ${args.filter(Boolean).join(' ')} .`).then(() => this.setContext({ isBuilt: true }), (err) => {
+            this.debug(err);
+            throw new Error(err);
+        });
+    }
+    publish() {
+        const { imageName, latestTag } = this.options;
+        return Promise.all([
+            this.exec(`docker push ${imageName}:${this.getContext().version}`),
+            latestTag ? this.exec(`docker push ${imageName}:latest`) : Promise.resolve(),
+        ]).then(() => this.setContext({ isPublished: true }), (err) => {
+            this.debug(err);
+            throw new Error(err);
+        });
+    }
+}
+exports.default = DockerPlugin;

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "release-it-docker-plugin",
+  "version": "0.0.0",
+  "description": "",
+  "keywords": [],
+  "repository": "",
+  "homepage": "",
+  "author": "Raiper34",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npx tsc"
+  },
+  "devDependencies": {
+    "release-it": "^18.1.1",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "release-it": "^18.1.1"
+  },
+  "dependencies": {
+    "@types/lodash": "^4.17.14",
+    "lodash": "^4.17.21"
+  }
+}

package/src/base-plugin.ts

@@ -0,0 +1,86 @@
+import { debug } from 'node:util';
+import _ from 'lodash';
+
+// I was unable to import plugin class from release-it v18, so I copied and pasted it here and typed a bit for my use case.
+// See: https://github.com/release-it/release-it/blob/main/lib/plugin/Plugin.js
+export class BasePlugin {
+
+    namespace: any;
+    options: any;
+    context: any;
+    config: any;
+    log: any;
+    shell: any;
+    spinner: any;
+    prompt: any;
+    debug: any;
+
+    static isEnabled() {
+        return true;
+    }
+
+    static disablePlugin() {
+        return null;
+    }
+
+    constructor({ namespace, options = {}, container = {} }: any = {}) {
+        this.namespace = namespace;
+        this.options = Object.freeze(this.getInitialOptions(options, namespace));
+        this.context = {};
+        this.config = container.config;
+        this.log = container.log;
+        this.shell = container.shell;
+        this.spinner = container.spinner;
+        this.prompt = container.prompt;
+        this.debug = debug(`release-it:${namespace}`);
+    }
+
+    getInitialOptions(options: any, namespace: any) {
+        return options[namespace] || {};
+    }
+
+    init() {}
+    getName() {}
+    getLatestVersion() {}
+    getChangelog() {}
+    getIncrement() {}
+    getIncrementedVersionCI() {}
+    getIncrementedVersion() {}
+    beforeBump() {}
+    bump() {}
+    beforeRelease(version: any) {}
+    release(version: any) {}
+    afterRelease() {}
+
+    getContext(path?: any): any {
+        const context = _.merge({}, this.options, this.context);
+        return path ? _.get(context, path) : context;
+    }
+
+    setContext(context: any) {
+        _.merge(this.context, context);
+    }
+
+    exec(command: any, { options, context = {} }: any = {}) {
+        const ctx = Object.assign(context, this.config.getContext(), { [this.namespace]: this.getContext() });
+        return this.shell.exec(command, options, ctx);
+    }
+
+    registerPrompts(prompts: any) {
+        this.prompt.register(prompts, this.namespace);
+    }
+
+    async showPrompt(options: any) {
+        options.namespace = this.namespace;
+        return this.prompt.show(options);
+    }
+
+    step(options: any) {
+        const context = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
+        const opts = Object.assign({}, options, { context });
+        const isException = this.config.isPromptOnlyVersion && ['incrementList', 'publish', 'otp'].includes(opts.prompt);
+        return this.config.isCI && !isException ? this.spinner.show(opts) : this.showPrompt(opts);
+    }
+}
+
+export default Plugin;

package/src/index.ts

@@ -0,0 +1,52 @@
+import {BasePlugin} from "./base-plugin";
+
+const DOCKER_HUB_BASE_URL = 'https://hub.docker.com';
+
+export default class DockerPlugin extends BasePlugin{
+
+    async beforeRelease() {
+        if (this.options.build === false) return false;
+        return this.step({ task: () => this.build(), label: 'docker build', prompt: {message: 'Build?', default: this.options.build}});
+    }
+
+    async release() {
+        if (this.options.publish === false) return false;
+        return this.step({ task: () => this.publish(), label: 'docker publish', prompt: {message: 'Publish?', default: this.options.publish} });
+    }
+
+    afterRelease() {
+        const { isPublished } = this.getContext();
+        if (isPublished) {
+            this.log.log(`🔗 ${DOCKER_HUB_BASE_URL}/r/${this.options.imageName}`);
+        }
+    }
+
+    private build() {
+        const { imageName, latestTag } = this.options;
+        const args = [
+            '-t', `${imageName}:${this.getContext().version}`,
+            ...(latestTag ? ['-t', `${imageName}:latest`] : [])
+        ];
+        return this.exec(`docker build ${args.filter(Boolean).join(' ')} .`).then(
+            () => this.setContext({ isBuilt: true }),
+            (err: any) => {
+                this.debug(err);
+                throw new Error(err);
+            }
+        );
+    }
+
+    private publish() {
+        const { imageName, latestTag } = this.options;
+        return Promise.all([
+            this.exec(`docker push ${imageName}:${this.getContext().version}`),
+            latestTag ? this.exec(`docker push ${imageName}:latest`) : Promise.resolve(),
+        ]).then(
+            () => this.setContext({ isPublished: true }),
+            (err: any) => {
+                this.debug(err);
+                throw new Error(err);
+            }
+        );
+    }
+}

package/tsconfig.json

@@ -0,0 +1,102 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src"]
+}