@adinsure-ops/ops-cli 4.8.3 → 5.0.0-rc3

package/package.json

@@ -1,78 +1,80 @@
 {
     "name": "@adinsure-ops/ops-cli",
     "description": "Operations CLI for working with AdInsure",
-    "version": "4.8.3",
+    "version": "5.0.0-rc3",
     "author": "Adacta Digital Service Department",
     "bin": {
-        "ops": "./bin/run"
+        "ops": "./bin/run.js"
     },
+    "type": "module",
     "dependencies": {
         "@azure/msal-node": "^1.14.5",
-        "@oclif/command": "^1",
-        "@oclif/config": "^1",
-        "@oclif/plugin-help": "^2",
-        "@oclif/plugin-not-found": "^1.2.2",
-        "@oclif/plugin-warn-if-update-available": "^1.7.0",
-        "@types/semver": "7.5.0",
-        "axios": "^0.27.2",
-        "chalk": "^2.4.2",
-        "cli-ux": "^5.2.1",
-        "fs-extra": "^8.0.1",
-        "globby": "^10.0.0",
-        "gray-matter": "^4.0.2",
-        "ini": "^3.0.0",
-        "inquirer": "^7.3.3",
-        "jira-client": "^8.2.2",
-        "jszip": "^3.2.2",
-        "lodash": "^4.17.11",
-        "minimatch": "^3.0.4",
+        "@oclif/core": "^2.11.8",
+        "@oclif/plugin-help": "^5.2.17",
+        "@oclif/plugin-not-found": "^2.3.37",
+        "@oclif/plugin-warn-if-update-available": "^2.0.48",
+        "axios": "^1.4.0",
+        "chalk": "^5.3.0",
+        "fs-extra": "^11.1.1",
+        "globby": "^13.2.2",
+        "gray-matter": "^4.0.3",
+        "ini": "^4.1.1",
+        "inquirer": "^9.2.10",
+        "jira-client": "8.2.2",
+        "jszip": "^3.10.1",
+        "lodash-es": "^4.17.21",
+        "minimatch": "^9.0.3",
         "moment": "^2.24.0",
         "oauth": "^0.9.15",
-        "open": "^6.4.0",
+        "open": "^9.1.0",
         "replace-in-file": "^4.3.1",
-        "request": "^2.88.2",
-        "request-promise": "^4.2.6",
-        "rimraf": "^2.6.3",
+        "rimraf": "^5.0.1",
         "semver": "^7.5.4",
         "tough-cookie": "^4.1.3",
-        "tslib": "^1",
-        "yaml": "^2.1.1"
+        "tslib": "^2.6.2",
+        "typescript": "^5.2.2",
+        "yaml": "^2.3.1"
     },
     "devDependencies": {
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
-        "@oclif/dev-cli": "^1",
-        "@oclif/test": "^1",
-        "@oclif/tslint": "^3",
+        "@oclif/test": "^2.4.8",
         "@testdeck/mocha": "^0.3.3",
-        "@types/chai": "^4",
-        "@types/fs-extra": "^7.0.0",
+        "@types/chai": "^4.3.5",
+        "@types/fs-extra": "^11.0.1",
         "@types/ini": "^1.3.31",
-        "@types/inquirer": "^7.3.1",
+        "@types/inquirer": "^9.0.3",
         "@types/jira-client": "^6.21.3",
-        "@types/jszip": "^3.4.1",
+        "@types/lodash-es": "^4.17.8",
         "@types/mocha": "^5.2.7",
         "@types/mock-fs": "^4.13.1",
-        "@types/node": "^10",
+        "@types/normalize-package-data": "^2.4.1",
         "@types/oauth": "^0.9.1",
-        "@types/request-promise": "^4.1.44",
-        "@types/rimraf": "^2.0.2",
+        "@types/semver": "^7.5.0",
         "@types/sinon": "^10.0.15",
+        "@typescript-eslint/eslint-plugin": "^6.4.1",
+        "@typescript-eslint/parser": "^6.4.1",
         "chai": "^4.3.7",
+        "eslint": "^8.47.0",
+        "eslint-config-oclif": "^4.0.0",
+        "eslint-config-oclif-typescript": "^1.0.3",
+        "eslint-plugin-unicorn": "^48.0.1",
         "mocha": "^10.2.0",
         "mocha-typescript": "^1.1.17",
         "mock-fs": "^5.1.1",
         "mock-spawn": "^0.2.6",
         "nock": "^13.1.3",
         "nyc": "^15.1.0",
+        "oclif": "^3.11.3",
         "sinon": "^15.1.0",
         "timekeeper": "^2.2.0",
         "ts-mockito": "^2.6.1",
-        "ts-node": "^8.10.2",
-        "tslint": "^5",
-        "typescript": "^3.3"
+        "ts-node": "^10.9.1"
+    },
+    "peerDependencies": {
+        "@types/node": "^20.5.7"
     },
     "engines": {
-        "node": "^12 || ^14 || ^16"
+        "node": "^14 || ^16 || ^18"
     },
     "files": [
         "/bin",
@@ -86,12 +88,13 @@
         "cli"
     ],
     "license": "SEE LICENSE IN LICENSE",
-    "main": "lib/index.js",
+    "main": "./lib/index.js",
     "oclif": {
-        "commands": "./lib/commands",
         "bin": "ops",
-        "hooks": {
-            "init": "./lib/hooks/init/version-override"
+        "dirname": "ops",
+        "commands": "./lib/commands",
+        "hook": {
+            "init": "./lib/hooks/init/version-override.ts"
         },
         "plugins": [
             "@oclif/plugin-help",
@@ -111,13 +114,14 @@
     "repository": "ops/ops-cli",
     "scripts": {
         "postpack": "rimraf oclif.manifest.json",
-        "prepack": "rimraf lib && tsc -b && oclif-dev manifest",
+        "prepack": "rimraf lib && tsc -b && oclif manifest",
         "test": "nyc --require ts-node/register --extension .ts mocha --timeout 20000 --forbid-only \"test/**/*.test.ts\"",
         "test-unit": "mocha \"./test/**/*.spec.ts\"",
+        "build": "tsc -b",
         "test-with-coverage": "nyc --require ts-node/register --extension .ts mocha --reporter=doc --timeout 20000 --forbid-only \"test/**/*.test.ts\"",
         "test-single": "nyc --require ts-node/register --extension .ts mocha --timeout 20000 --forbid-only",
         "test-single-with-coverage": "nyc --require ts-node/register --extension .ts mocha --reporter=doc --timeout 20000 --forbid-only",
-        "lint": "tslint -p test -t stylish"
+        "eslint": "eslint ./src ./test --ext .ts --config .eslintrc"
     },
     "types": "lib/index.d.ts"
 }

package/bin/run

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-
-require('@oclif/command').run()
-.then(require('@oclif/command/flush'))
-.catch(require('@oclif/errors/handle'))

package/lib/commands/prepare-content.d.ts

@@ -1,29 +0,0 @@
-import { flags } from '@oclif/command';
-import CommandBase from '../command.base';
-interface Transformation {
-    name: string;
-    srcPath: string;
-    transform(): void;
-}
-interface DotfileLine {
-    prefix: string;
-    source: string;
-    transformData: string;
-}
-export default class PrepareContent extends CommandBase {
-    static readonly dotfile = ".opsprepare";
-    static description: string;
-    static usage: string;
-    static examples: string[];
-    static flags: {
-        destination: flags.IOptionFlag<string>;
-        source: flags.IOptionFlag<string>;
-    };
-    parseDotfileLine(line: string, sourceDirectory: string): Promise<DotfileLine>;
-    readDotfile(sourceDirectory: string): Promise<DotfileLine[]>;
-    getTransformation(lineData: DotfileLine, baseSourcedir: string, baseDestinationDir: string): Promise<Transformation>;
-    prepareTransformations(linesData: DotfileLine[], baseSourceDir: string, baseDestinationDir: string): Promise<Transformation[]>;
-    runTransformations(transformations: Transformation[]): Promise<void>;
-    run(): Promise<void>;
-}
-export {};

package/lib/commands/prepare-content.js

@@ -1,386 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const chalk_1 = require("chalk");
-const cli_ux_1 = require("cli-ux");
-const fs = require("fs-extra");
-const path = require("path");
-const command_base_1 = require("../command.base");
-class CopyTransformation {
-    constructor(srcPath, dstPath) {
-        this.name = this.constructor.name;
-        this.srcPath = srcPath;
-        this.dstPath = dstPath;
-    }
-    transform() {
-        try {
-            fs.accessSync(this.srcPath, fs.constants.R_OK);
-        }
-        catch (err) {
-            if (err.code === 'ENOENT') {
-                throw new Error(`${this.name}: source file does not exist <${this.srcPath}>`);
-            }
-            else {
-                throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-            }
-        }
-        cli_ux_1.default.log(`Copying from ${this.srcPath} to ${this.dstPath}`);
-        try {
-            fs.copySync(this.srcPath, this.dstPath, { overwrite: true });
-        }
-        catch (err) {
-            throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-        }
-    }
-}
-class JavascriptTransformation {
-    constructor(srcPath, dstPath, javascriptFile, functionName) {
-        this.name = this.constructor.name;
-        this.srcPath = srcPath;
-        this.dstPath = dstPath;
-        this.jsFile = path.resolve(javascriptFile);
-        this.functionName = functionName;
-    }
-    importTransformationModule() {
-        try {
-            return require(this.jsFile);
-        }
-        catch (err) {
-            if (err.code === 'MODULE_NOT_FOUND') {
-                throw new Error(`${this.name}: module file ${this.jsFile} not found <${this.srcPath}>`);
-            }
-            else if (err instanceof SyntaxError) {
-                throw new Error(`${this.name}: ${err} in \'${this.jsFile}\' <${this.srcPath}>`);
-            }
-            throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-        }
-    }
-    executeTransformationFunction(transformationModule) {
-        try {
-            let result = transformationModule[this.functionName](this.srcPath);
-            if (typeof (result) !== 'string') {
-                throw new Error(`${this.name}: transformation functions must return string, ${this.functionName} returned ${typeof (result)} <${this.srcPath}>`);
-            }
-            return result;
-        }
-        catch (err) {
-            if (err instanceof TypeError) {
-                throw new Error(`${this.name}: invalid function \'${this.functionName}\' in ${this.jsFile} <${this.srcPath}>`);
-            }
-            /*
-            Rethrow anything errors that were thrown in the above try block
-            */
-            if (err.message && err.message.search(`${this.name}`.length > 0)) {
-                throw err;
-            }
-            throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-        }
-    }
-    transform() {
-        // Check if source exists, if not, issue a warning
-        try {
-            fs.accessSync(this.srcPath);
-        }
-        catch (err) {
-            if (err.code === 'ENOENT') {
-                let errMsg = `${this.name}: source does not exist, relying on transformation to find proper source file <${this.srcPath}>`;
-                cli_ux_1.default.log(`${chalk_1.default.yellow(errMsg)}`);
-            }
-            else {
-                throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-            }
-        }
-        cli_ux_1.default.log(`Transforming from ${this.srcPath} to ${this.dstPath} using ${this.jsFile} function ${this.functionName}`);
-        // Import transformation module
-        let transModule = this.importTransformationModule();
-        // Execute transformation function
-        let transResult = this.executeTransformationFunction(transModule);
-        // Write output to destination file
-        try {
-            fs.outputFileSync(this.dstPath, transResult, { encoding: 'utf-8', mode: 0o644, flag: 'w' });
-        }
-        catch (err) {
-            throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-        }
-    }
-}
-class RemovalTransformation {
-    constructor(srcPath) {
-        this.name = this.constructor.name;
-        this.srcPath = srcPath;
-    }
-    transform() {
-        try {
-            fs.accessSync(this.srcPath, fs.constants.W_OK);
-            cli_ux_1.default.log(`Removing ${this.srcPath}.`);
-            fs.removeSync(this.srcPath);
-        }
-        catch (err) {
-            if (err.code === 'ENOENT') {
-                let errMsg = `${this.name}: target does not exist, skipping removal <${this.srcPath}>`;
-                cli_ux_1.default.log(`${chalk_1.default.yellow(errMsg)}`);
-            }
-            else {
-                throw new Error(`${this.name}: ${err} <${this.srcPath}>`);
-            }
-        }
-    }
-}
-class PrepareContent extends command_base_1.default {
-    async parseDotfileLine(line, sourceDirectory) {
-        const re = RegExp('^([!#]{1})?(.+?)({.*?})?$');
-        let m = line.match(re);
-        let dotfileLine = {
-            prefix: m[1],
-            source: path.join(sourceDirectory, path.normalize(m[2].trim())),
-            transformData: m[3]
-        };
-        /*
-        Sanity check on source file name. Should not contain "{", ":", or "}" characters
-        */
-        const valRe = RegExp('[{:}]+');
-        let vm = dotfileLine.source.match(valRe);
-        if (vm !== null) {
-            throw new SyntaxError(`<${PrepareContent.dotfile}> source file name '${dotfileLine.source}' contains invalid character '${vm[0]}'`);
-        }
-        return dotfileLine;
-    }
-    async readDotfile(sourceDirectory) {
-        let file_content;
-        try {
-            file_content = fs.readFileSync(path.join(sourceDirectory, PrepareContent.dotfile), 'utf-8');
-        }
-        catch (err) {
-            if (err.code === 'ENOENT') {
-                let errMsg = `.opsprepare file not found in ${path.resolve(sourceDirectory)}`;
-                throw new Error(errMsg);
-            }
-            throw new Error(err.message);
-        }
-        let lines = file_content.split(/\r?\n/).filter(line => line.length !== 0);
-        const lineParse = lines.map(line => {
-            return this.parseDotfileLine(line.trim(), sourceDirectory);
-        });
-        const parsedLines = Promise.all(lineParse).then(lines => lines.filter(line => line.prefix !== '#'));
-        return parsedLines;
-    }
-    async getTransformation(lineData, baseSourcedir, baseDestinationDir) {
-        const targetPath = path.join(baseDestinationDir, lineData.source);
-        /*
-        Anything prefixed with ! is a removal
-        */
-        if (lineData.prefix === '!') {
-            return new RemovalTransformation(targetPath);
-        }
-        /*
-        In case transformation data is present, prepare transformations based on requested plugin.
-        */
-        if (lineData.transformData) {
-            const re = RegExp('^{(.+?):.*}$');
-            const transformType = lineData.transformData.match(re)[1];
-            switch (transformType) {
-                case 'cp': {
-                    const rePath = RegExp('^{cp:([^:]+)}$');
-                    const mPath = lineData.transformData.match(rePath);
-                    if (!mPath) {
-                        throw new SyntaxError(`<${PrepareContent.dotfile}> syntax '${lineData.transformData}' is invalid for 'cp' transformation type`);
-                    }
-                    const tPath = path.join(baseDestinationDir, path.dirname(lineData.source), mPath[1]);
-                    return new CopyTransformation(lineData.source, tPath);
-                }
-                case 'js': {
-                    /* TODO: Some sanity checking will be required after regex matching
-                             to make sure everything was matched and is defined
-                    */
-                    // Parse transformation data
-                    const reData = RegExp('^{js:(.+?):(.+)}$');
-                    const mData = lineData.transformData.match(reData);
-                    if (!mData) {
-                        throw new SyntaxError(`<${PrepareContent.dotfile}> syntax '${lineData.transformData}' is invalid for 'js' transformation type`);
-                    }
-                    const jsFile = path.join(baseSourcedir, mData[1]);
-                    const jsFunc = mData[2];
-                    // File path absolute. Should it be relative to the transformation function?
-                    const filePath = path.resolve(lineData.source);
-                    return new JavascriptTransformation(filePath, targetPath, jsFile, jsFunc);
-                }
-                default: {
-                    const p = lineData.prefix ? lineData.prefix : '';
-                    const s = lineData.source;
-                    const t = lineData.transformData ? lineData.transformData : '';
-                    this.error(`No valid transformation can be extrapolated from ${p}${s}${t}`);
-                }
-            }
-        }
-        /*
-        Return default transformation
-        */
-        return new CopyTransformation(lineData.source, targetPath);
-    }
-    async prepareTransformations(linesData, baseSourceDir, baseDestinationDir) {
-        const transformations = linesData.map(line => {
-            return this.getTransformation(line, baseSourceDir, baseDestinationDir);
-        });
-        return Promise.all(transformations);
-    }
-    /*
-    This function divides transformations into execution groups based on their class
-    and runs transformations for each group
-    */
-    async runTransformations(transformations) {
-        let copyTransformList = [];
-        let modlueTransformList = [];
-        let excludeList = [];
-        // Sort transformation into two lists
-        transformations.forEach(t => {
-            if (t instanceof CopyTransformation) {
-                copyTransformList.push(t);
-            }
-            else if (t instanceof RemovalTransformation) {
-                excludeList.push(t);
-            }
-            else {
-                modlueTransformList.push(t);
-            }
-        });
-        const t = async (transformation) => {
-            try {
-                transformation.transform();
-            }
-            catch (err) {
-                return Promise.reject(err.message);
-            }
-        };
-        const doCopyTransform = copyTransformList.map(t);
-        const doModuleTransform = modlueTransformList.map(t);
-        const doExclude = excludeList.map(t);
-        /* Copy first, then transform and finally remove files. This should
-           ensure that transformations can overwrite previous copies. Removals
-           can still erase transformations though. If needed, we can remove
-           before transforming.
-        */
-        await Promise.all(doCopyTransform);
-        await Promise.all(doModuleTransform);
-        await Promise.all(doExclude);
-    }
-    /*
-    Validates file system on source repository by checking if files or directories exist
-    */
-    /*
-    async validate(arr: string[][], source: string): Promise<boolean> {
-        //this.log(`${chalk.blue('Validating if files and directories exist.')}`);
-        cli.action.start(`${chalk.blue('Validating if files and directories exist')}`, '', {stdout: true});
-        for (let a of arr[0]) {
-            let element_path = path.join(source, a);
-            if(!(fs.existsSync(path.join(element_path)))) {
-                this.log(`${chalk.red('File or directory: ' + path.join(element_path) + ' could not be found')}`);
-                return false;
-            }
-        }
-        for (let a of arr[1]) {
-            let element_path = path.join(source, a);
-            if(!(fs.existsSync(element_path))) {
-                this.log(`${chalk.red('File or directory: ' + element_path + ' could not be found')}`);
-                return false;
-            }
-        }
-
-        //this.log(`${chalk.green('Validation done.')}`);
-        cli.action.stop(`${chalk.green('done')}`);
-        return true;
-    }
-    */
-    /*
-    This function copies elements and removes excluded ones.
-    */
-    /*
-    async copyWorkspace(arr: string[][], dest: string, source: string): Promise<any> {
-        if (await this.validate(arr, source)) {
-            cli.action.start(`${chalk.blue('Preparing content')}`, '', {stdout: true});
-            arr[0].forEach(a => {
-                this.log('Copying: ', path.join(source, a));
-                fs.copySync(path.join(source, a), path.join(dest, a), {overwrite: true});
-            });
-            this.log(`${chalk.green('Copying done.')}`);
-            this.log(`${chalk.blue('Removing excluded elements.')}`);
-            arr[1].forEach(a => {
-                let curPath = path.join(dest, a);
-                if (fs.pathExistsSync(curPath)) {
-                    if (fs.lstatSync(curPath).isFile()) {
-                        try {
-                            fs.removeSync(curPath);
-                            this.log('Removing file: ', curPath);
-                        } catch (err) {
-                            cli.action.stop(`${chalk.red('failed')}`);
-                            this.error(error.message);
-                        }
-                    } else if (fs.lstatSync(curPath).isDirectory()) {
-                        try {
-                            fs.removeSync(curPath);
-                            this.log('Removing dir: ', curPath);
-                        } catch (err) {
-                            cli.action.stop(`${chalk.red('failed')}`);
-                            this.error(error.message);
-                        }
-                    } else {
-                        cli.action.stop(`${chalk.red('error')}`);
-                        this.error('Type not file or directory');
-                    }
-                }
-            });
-            this.log(`${chalk.green('Removing done.')}`);
-            cli.action.stop(`${chalk.green('done')}`);
-        } else {
-            cli.action.stop(`${chalk.red('error')}`);
-            this.error('Content validation failed.');
-        }
-    }
-    */
-    async run() {
-        const { flags } = this.parse(PrepareContent);
-        // read the flags and set paths relative to execution directory
-        let source = path.relative(process.cwd(), flags.source);
-        source = source ? source : '.';
-        let dest = flags.destination;
-        try {
-            let dotfileLines = await this.readDotfile(source);
-            this.log(`${chalk_1.default.blue('Content transformation started.')}`);
-            let transformations = await this.prepareTransformations(dotfileLines, source, dest);
-            await this.runTransformations(transformations);
-            this.log(`${chalk_1.default.green('Content prepared at: ', dest)}`);
-        }
-        catch (err) {
-            this.log(`${chalk_1.default.red(err)}`);
-            /*
-            In test mode, exit with status 0
-            */
-            if (process.env.OPS_TEST_MODE === 'true') {
-                this.exit(0);
-            }
-            this.exit(1);
-        }
-    }
-}
-exports.default = PrepareContent;
-PrepareContent.dotfile = '.opsprepare';
-PrepareContent.description = `copies files as described in ${PrepareContent.dotfile} which is at root of source directory`;
-PrepareContent.usage = 'prepare-content -d <destination> [-s <source>]';
-PrepareContent.examples = [
-    `$ ops prepare-content -d .\\my_workspace`,
-    `$ ops prepare-content -d .\\my_workspace -s .\\my_repository`,
-    `$ ops prepare-content -d C:\\git\\my_workspace`,
-    `$ ops prepare-content -d C:\\git\\my_workspace -s C:\\git\\my_repository\\my_repository`
-];
-PrepareContent.flags = {
-    destination: command_1.flags.string({
-        char: 'd',
-        description: 'where to copy the workspace files',
-        required: true
-    }),
-    source: command_1.flags.string({
-        char: 's',
-        description: '[optional] source directory, default: current dir',
-        required: false,
-        default: '.'
-    })
-};