@squiz/dxp-cli-next 0.0.0-development

package/README.md

@@ -0,0 +1,27 @@
+# DXP
+
+## Not a tool yet, install wont work
+
+> DXP command line tool
+
+## Install
+
+```bash
+npm install @squiz-dxp
+```
+
+## Usage
+
+```bash
+Usage: dxp [options] [command]
+
+dxp commands
+
+Options:
+  -V, --version  output the version number
+  -h, --help     display help for command
+
+Commands:
+  auth           log into the sxc
+  td             Template deployment commands
+```

package/bin/dxp.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+'use strict';
+require('../lib/dxp.js');

package/lib/__tests__/helpers.d.ts

@@ -0,0 +1,17 @@
+import execa from 'execa';
+declare type RunOptions = {
+    nodeOptions?: string;
+    nodePath?: string;
+    timeout?: number;
+    expectedFailure?: boolean;
+};
+declare type SpawnOptions = RunOptions & {
+    cwd: string;
+};
+declare type SpawnFunction<T> = (execPath: string, args: string[], options: SpawnOptions) => T;
+/**
+ * Helper function to run CLI command in a given folder
+ */
+export declare function runCLI(dir: string, args?: string[], options?: RunOptions): execa.ExecaSyncReturnValue;
+export declare const spawnScript: SpawnFunction<execa.ExecaSyncReturnValue>;
+export {};

package/lib/__tests__/helpers.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spawnScript = exports.runCLI = void 0;
+const path_1 = __importDefault(require("path"));
+const execa_1 = __importDefault(require("execa"));
+const chalk_1 = __importDefault(require("chalk"));
+const TEST_CLI_PATH = path_1.default.resolve(__dirname, './integration/bin.js');
+/**
+ * Helper function to run CLI command in a given folder
+ */
+function runCLI(dir, args, options = {
+    expectedFailure: false,
+}) {
+    return (0, exports.spawnScript)(process.execPath, [TEST_CLI_PATH, ...(args || [])], Object.assign(Object.assign({}, options), { cwd: dir }));
+}
+exports.runCLI = runCLI;
+const spawnScript = (execPath, args, options) => {
+    const result = execa_1.default.sync(execPath, args, getExecaOptions(options));
+    handleTestFailure(execPath, options, result, args);
+    return result;
+};
+exports.spawnScript = spawnScript;
+function getExecaOptions(options) {
+    const isRelative = !path_1.default.isAbsolute(options.cwd);
+    const cwd = isRelative ? path_1.default.resolve(__dirname, options.cwd) : options.cwd;
+    const env = Object.assign({}, process.env, { FORCE_COLOR: '0' });
+    if (options.nodeOptions) {
+        env.NODE_OPTIONS = options.nodeOptions;
+    }
+    if (options.nodePath) {
+        env.NODE_PATH = options.nodePath;
+    }
+    return {
+        cwd,
+        env,
+        reject: false,
+        timeout: options.timeout || 0,
+    };
+}
+function handleTestFailure(cmd, options, result, args) {
+    if (!options.expectedFailure && result.code !== 0) {
+        console.log(`Running ${cmd} command failed for unexpected reason. Here's more info:
+${chalk_1.default.bold('cmd:')}     ${cmd}
+${chalk_1.default.bold('options:')} ${JSON.stringify(options)}
+${chalk_1.default.bold('args:')}    ${(args || []).join(' ')}
+${chalk_1.default.bold('stderr:')}  ${result.stderr}
+${chalk_1.default.bold('stdout:')}  ${result.stdout}
+${chalk_1.default.bold('code:')}    ${result.code}`);
+    }
+}

package/lib/__tests__/integration/main.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/integration/main.spec.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("../helpers");
+describe('my-command', () => {
+    it('should display the help contents', () => {
+        const { stdout } = (0, helpers_1.runCLI)(process.cwd(), ['--help']);
+        expect(stdout).toContain('Usage: my-command [options]');
+    });
+});

package/lib/__tests__/unit/cli.js

@@ -0,0 +1,7 @@
+"use strict";
+describe('cli', () => {
+    it('should exist', () => {
+        const cli = require('../../src/cli');
+        expect(cli).toBeTruthy();
+    });
+});

package/lib/auth/identity.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const _default: Command;
+export default _default;

package/lib/auth/identity.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+exports.default = new commander_1.Command('identity')
+    .command('identity', 'returns the currently logged in users details')
+    .action(() => {
+    console.log('getting identity');
+});

package/lib/auth/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const authCommand: Command;
+export default authCommand;

package/lib/auth/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const login_1 = __importDefault(require("./login"));
+const authCommand = new commander_1.Command('auth');
+authCommand.description('log into the sxc').addCommand(login_1.default);
+//.addCommand(identityCommand);
+exports.default = authCommand;

package/lib/auth/login.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const _default: Command;
+export default _default;

package/lib/auth/login.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+exports.default = new commander_1.Command('login')
+    .name('login')
+    .argument('<username>', 'sxc username')
+    .argument('<password>', 'sxc password')
+    .action((username, password) => {
+    console.log('NOT IMPLEMENTED ', { username });
+});

package/lib/dxp.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/dxp.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = __importDefault(require("commander"));
+const auth_1 = __importDefault(require("./auth"));
+const td_1 = __importDefault(require("./td"));
+const program = new commander_1.default.Command();
+const packageJson = require('../package.json');
+const version = packageJson.version;
+program
+    .name('dxp')
+    .version(version)
+    .description('dxp commands')
+    .addCommand(auth_1.default)
+    .addCommand(td_1.default)
+    .action(() => {
+    program.help();
+})
+    .parse(process.argv);

package/lib/td/deploy.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const _default: Command;
+export default _default;

package/lib/td/deploy.js

@@ -0,0 +1,19 @@
+"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 commander_1 = require("commander");
+exports.default = new commander_1.Command()
+    .name('deploy')
+    .argument('<source>', 'template location')
+    .argument('<destination>', 'asset id to deploy too')
+    .action((source, destination) => __awaiter(void 0, void 0, void 0, function* () {
+    console.log('hello world - ', source, destination);
+}));

package/lib/td/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const authCommand: Command;
+export default authCommand;

package/lib/td/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const deploy_1 = __importDefault(require("./deploy"));
+const authCommand = new commander_1.Command('td');
+authCommand
+    .description('Template deployment commands')
+    .addCommand(deploy_1.default);
+exports.default = authCommand;

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@squiz/dxp-cli-next",
+  "version": "0.0.0-development",
+  "files": [
+    "!lib/__tests__/**/*",
+    "lib/**/*",
+    "bin/**/*"
+  ],
+  "bin": {
+    "dxp": "./bin/dxp.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf ./lib/",
+    "cm": "cz",
+    "coverage": "codecov",
+    "lint": "eslint ./src/ --fix",
+    "prepare": "husky install",
+    "semantic-release": "semantic-release",
+    "test:watch": "jest --watch",
+    "test": "jest --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "engines": {
+    "node": ">=12.0"
+  },
+  "keywords": [
+    "cli",
+    "template",
+    "typescript",
+    "vscode",
+    "jest",
+    "husky",
+    "commitizen",
+    "semantic-release",
+    "codecov"
+  ],
+  "dependencies": {
+    "commander": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.0",
+    "@types/node": "^17.0.14",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "chalk": "^4.1.2",
+    "codecov": "^3.8.3",
+    "commitizen": "^4.2.4",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.8.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "execa": "^5.1.1",
+    "husky": "^7.0.4",
+    "jest": "^27.4.7",
+    "lint-staged": "^12.3.3",
+    "prettier": "^2.5.1",
+    "semantic-release": "^19.0.2",
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.5"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache --cache-location .eslintcache --fix"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  }
+}