@squiz/dxp-cli-next 2.11.0 → 2.11.1-develop.2

package/lib/__tests__/cmp/dev-mode.spec.d.ts

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

package/lib/__tests__/cmp/dev-mode.spec.js

@@ -0,0 +1,54 @@
+"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 dev_mode_1 = require("../../cmp/dev-mode");
+describe('cmp dev', () => {
+    it('correctly parses the port', () => __awaiter(void 0, void 0, void 0, function* () {
+        const program = (0, dev_mode_1.buildDevModeCommand)()
+            .exitOverride()
+            .action(() => { });
+        program.parse(['node', 'dxp-cli', 'dev', '--port', '3005']);
+        const opts = program.opts();
+        expect(opts.port).toStrictEqual(3005);
+    }));
+    it('defaults the port to 3000', () => {
+        const program = (0, dev_mode_1.buildDevModeCommand)()
+            .exitOverride()
+            .action(() => { });
+        program.parse(['node', 'dxp-cli', 'dev']);
+        const opts = program.opts();
+        expect(opts.port).toStrictEqual(3000);
+    });
+    it.each(['3000', '3001', '65535', '1024'])('correctly parses the port (%s)', (attemptedPort) => __awaiter(void 0, void 0, void 0, function* () {
+        const program = (0, dev_mode_1.buildDevModeCommand)()
+            .exitOverride()
+            .action(() => { });
+        program.parse(['node', 'dxp-cli', 'dev', '--port', attemptedPort]);
+        const opts = program.opts();
+        expect(typeof opts.port).toStrictEqual('number');
+    }));
+    it.each([
+        'hello_world',
+        '3_000',
+        '65_535',
+        '1000',
+        '100',
+        '1_000_000',
+        '1000000',
+        'abc_1000',
+        '1000arst',
+    ])('errors when port (%s) is not a number between 1000-65535', attemptedPort => {
+        const program = (0, dev_mode_1.buildDevModeCommand)()
+            .exitOverride()
+            .action(() => { });
+        expect(() => program.parse(['node', 'dxp-cli', 'dev', '--port', attemptedPort])).toThrowError('Port must be a number between 1024-65535');
+    });
+});

package/lib/cmp/dev-mode.d.ts

@@ -1,3 +1,4 @@
 import { Command } from 'commander';
+export declare const buildDevModeCommand: () => Command;
 declare const devModeCommand: Command;
 export default devModeCommand;

package/lib/cmp/dev-mode.js

@@ -9,9 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDevModeCommand = void 0;
 const commander_1 = require("commander");
 const component_cli_lib_1 = require("@squiz/component-cli-lib");
-const devModeCommand = new commander_1.Command()
+const MIN_PORT = 1024;
+const MAX_PORT = 65535;
+const buildDevModeCommand = () => new commander_1.Command()
     .name('dev')
     .description('A local component runner for developing new components')
     .addHelpText('after', `
@@ -22,8 +25,18 @@ The logs are currently \`bunyan\` formatted and should be piped into the bunyan
     .argument('<source>', 'folder containing the template files in development')
     .addOption(new commander_1.Option('-p, --port <number>', 'Define port the webserver runs on')
     .default(3000)
-    .argParser(parseInt))
+    .argParser(v => {
+    const parsedPort = Number(v);
+    if (isNaN(parsedPort) ||
+        MIN_PORT > parsedPort ||
+        parsedPort > MAX_PORT) {
+        throw new commander_1.InvalidArgumentError(`Port must be a number between ${MIN_PORT}-${MAX_PORT}`);
+    }
+    return parsedPort;
+}))
     .action((source, options) => __awaiter(void 0, void 0, void 0, function* () {
     yield (0, component_cli_lib_1.startDevelopmentRender)(source, options);
 }));
+exports.buildDevModeCommand = buildDevModeCommand;
+const devModeCommand = (0, exports.buildDevModeCommand)();
 exports.default = devModeCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "2.11.0",
+  "version": "2.11.1-develop.2",
   "repository": {
     "url": "https://gitlab.squiz.net/developer-experience/dxp-cli-next"
   },
@@ -39,25 +39,25 @@
     "codecov"
   ],
   "dependencies": {
-    "@squiz/component-cli-lib": "1.2.1-alpha.68",
+    "@squiz/component-cli-lib": "1.2.1-alpha.70",
     "@squiz/deployment-service-lib": "1.1.5-alpha.83",
     "cli-color": "2.0.3",
-    "commander": "9.3.0",
+    "commander": "9.4.0",
     "update-notifier": "5.1.0"
   },
   "devDependencies": {
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/gitlab": "9.3.2",
+    "@semantic-release/gitlab": "9.4.1",
     "@semantic-release/npm": "9.0.1",
     "@types/cli-color": "2.0.2",
-    "@types/jest": "28.1.4",
+    "@types/jest": "28.1.6",
     "@types/node": "17.0.45",
     "@types/update-notifier": "5.1.0",
-    "@typescript-eslint/eslint-plugin": "5.30.5",
-    "@typescript-eslint/parser": "5.30.5",
     "chalk": "4.1.2",
+    "@typescript-eslint/eslint-plugin": "5.30.7",
+    "@typescript-eslint/parser": "5.30.7",
     "codecov": "3.8.3",
-    "commitizen": "4.2.4",
+    "commitizen": "4.2.5",
     "cz-conventional-changelog": "3.3.0",
     "eslint": "8.19.0",
     "eslint-config-prettier": "8.5.0",
@@ -65,12 +65,12 @@
     "eslint-plugin-prettier": "4.2.1",
     "execa": "5.1.1",
     "husky": "8.0.1",
-    "jest": "28.1.2",
+    "jest": "28.1.3",
     "lint-staged": "13.0.3",
     "prettier": "2.7.1",
     "semantic-release": "19.0.3",
-    "ts-jest": "28.0.5",
-    "ts-node": "10.8.2",
+    "ts-jest": "28.0.7",
+    "ts-node": "10.9.1",
     "typescript": "4.7.4"
   },
   "config": {