bod 5.15.2 → 5.16.0

package/dist/bod.js

@@ -1,4 +1,5 @@
 "use strict";
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
@@ -8,7 +9,7 @@ const utils_1 = require("./utils");
 const index_1 = require("./index");
 const packageJsonPath = node_path_1.default.join(__dirname, '../package.json');
 const packageJson = JSON.parse(node_fs_1.default.readFileSync(packageJsonPath, { encoding: 'utf-8' }));
-utils_1.program.version(packageJson.version, '-v, --version');
+utils_1.program.version((_a = packageJson.version) !== null && _a !== void 0 ? _a : '0.0.1', '-v, --version');
 for (const command of index_1.CommandFactory.values()) {
     utils_1.program
         .command(command.getUsage())

package/dist/commands/__tests__/BaseCommand.test.d.ts

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

package/dist/commands/__tests__/BaseCommand.test.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const BaseCommand_1 = tslib_1.__importDefault(require("../BaseCommand"));
+const options = {
+    name: 'base',
+    description: 'Base command description',
+    usage: 'base',
+    alias: 'c',
+};
+describe('baseCommand', () => {
+    it('should have [name] field', () => {
+        const baseCommand = new BaseCommand_1.default(options);
+        expect(baseCommand.getName()).toBe(options.name);
+    });
+    it('should have [description] field', () => {
+        const baseCommand = new BaseCommand_1.default(options);
+        expect(baseCommand.getDescription()).toBe(options.description);
+    });
+    it('should have [usage] field', () => {
+        const baseCommand = new BaseCommand_1.default(options);
+        expect(baseCommand.getUsage()).toBe(options.usage);
+    });
+    it('should have [alias] field', () => {
+        const baseCommand = new BaseCommand_1.default(options);
+        expect(baseCommand.getAlias()).toBe(options.alias);
+    });
+    it('should set [alias] field to first character of [name] field by default', () => {
+        const baseCommand = new BaseCommand_1.default(Object.assign(Object.assign({}, options), { alias: undefined }));
+        expect(baseCommand.getAlias()).toBe(options.name[0]);
+    });
+    it('should have [run] method', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const baseCommand = new BaseCommand_1.default(options);
+        yield expect(baseCommand.run()).resolves.toBeUndefined();
+    }));
+});

package/dist/commands/__tests__/CreateCommand.test.d.ts

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

package/dist/commands/__tests__/CreateCommand.test.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const ci_info_1 = require("ci-info");
+const rimraf_1 = require("rimraf");
+const utils_1 = require("../../utils");
+const CreateCommand_1 = tslib_1.__importDefault(require("../CreateCommand"));
+const appPath = node_path_1.default.join(process.cwd(), '..', 'bod-unit-tests');
+describe('createCommand', () => {
+    beforeEach(() => (0, rimraf_1.sync)(appPath));
+    afterEach(() => (0, rimraf_1.sync)(appPath));
+    it('should extends [BaseCommand] fields', () => {
+        const createCommand = new CreateCommand_1.default();
+        expect(createCommand.getName()).toBe('create');
+        expect(createCommand.getDescription()).toBe('Create a new project powered by @sabertazimi/react-scripts');
+        expect(createCommand.getUsage()).toBe('create <appName>');
+        expect(createCommand.getAlias()).toBe('c');
+    });
+    it.each(CreateCommand_1.default.TemplateActions)('should get correct command/args and invoke [inquirer] via template choice [$name]', (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ value }) {
+        const mockPrompt = jest
+            .spyOn(utils_1.inquirer, 'prompt')
+            .mockImplementation(() => {
+            const promise = new Promise((resolve) => {
+                resolve({ templateName: value });
+            });
+            return promise;
+        });
+        const mockSpawn = jest.spyOn(utils_1.spawn, 'sync').mockImplementation(() => {
+            return {
+                status: 0,
+            };
+        });
+        const createCommand = new CreateCommand_1.default();
+        yield expect(createCommand.run(appPath)).resolves.toBeUndefined();
+        const { command, args } = CreateCommand_1.default.TemplateActions.find(action => action.value === value);
+        expect(createCommand.getCommand()).toBe(command);
+        expect(createCommand.getCommandArgs()).toHaveLength(args.length + 1);
+        expect(createCommand.getCommandArgs()).toStrictEqual(args.concat(appPath));
+        expect(mockPrompt).toBeCalledTimes(1);
+        expect(mockSpawn).toBeCalledTimes(1);
+        mockPrompt.mockRestore();
+        mockSpawn.mockRestore();
+    }));
+    it.each(CreateCommand_1.default.TemplateActions)('should throw error when exited with non zero via template choice [$name]', (_b) => tslib_1.__awaiter(void 0, [_b], void 0, function* ({ value }) {
+        const mockPrompt = jest
+            .spyOn(utils_1.inquirer, 'prompt')
+            .mockImplementation(() => {
+            const promise = new Promise((resolve) => {
+                resolve({ templateName: value });
+            });
+            return promise;
+        });
+        const mockSpawn = jest.spyOn(utils_1.spawn, 'sync').mockImplementation(() => {
+            return {
+                status: 1,
+            };
+        });
+        const createCommand = new CreateCommand_1.default();
+        yield expect(createCommand.run(appPath)).rejects.toThrowError();
+        expect(mockPrompt).toBeCalledTimes(1);
+        expect(mockSpawn).toBeCalledTimes(1);
+        mockPrompt.mockRestore();
+        mockSpawn.mockRestore();
+    }));
+    it.each(CreateCommand_1.default.TemplateActions)('should initialize app directory via template choice [$name]', (_c) => tslib_1.__awaiter(void 0, [_c], void 0, function* ({ value }) {
+        const mockPrompt = jest
+            .spyOn(utils_1.inquirer, 'prompt')
+            .mockImplementation(() => {
+            const promise = new Promise((resolve) => {
+                resolve({ templateName: value });
+            });
+            return promise;
+        });
+        const createCommand = new CreateCommand_1.default();
+        if (ci_info_1.isCI) {
+            yield expect(createCommand.run(appPath)).resolves.toBeUndefined();
+            expect(mockPrompt).toBeCalledTimes(1);
+        }
+        mockPrompt.mockRestore();
+    }));
+});

package/dist/commands/__tests__/InfoCommand.test.d.ts

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

package/dist/commands/__tests__/InfoCommand.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const utils_1 = require("../../utils");
+const InfoCommand_1 = tslib_1.__importDefault(require("../InfoCommand"));
+describe('infoCommand', () => {
+    jest.setTimeout(20000);
+    it('should extends [BaseCommand] fields', () => {
+        const infoCommand = new InfoCommand_1.default();
+        expect(infoCommand.getName()).toBe('info');
+        expect(infoCommand.getDescription()).toBe('Print debugging information about your environment');
+        expect(infoCommand.getUsage()).toBe('info');
+        expect(infoCommand.getAlias()).toBe('i');
+    });
+    it('should print environment variables', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const mockConsoleInfo = jest
+            .spyOn(utils_1.printer, 'info')
+            .mockImplementation(jest.fn());
+        const infoCommand = new InfoCommand_1.default();
+        yield expect(infoCommand.run()).resolves.toBeUndefined();
+        expect(mockConsoleInfo).toHaveBeenCalledTimes(2);
+        mockConsoleInfo.mockRestore();
+    }));
+});

package/dist/commands/__tests__/index.test.d.ts

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

package/dist/commands/__tests__/index.test.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../index");
+describe('commands', () => {
+    let commands;
+    let counts;
+    beforeEach(() => {
+        commands = new Set([
+            new index_1.BaseCommand({
+                name: 'base',
+                description: 'Base command description',
+                usage: 'base',
+            }),
+            new index_1.CreateCommand(),
+            new index_1.InfoCommand(),
+        ]);
+        counts = new Map();
+    });
+    afterEach(() => {
+        commands.clear();
+        counts.clear();
+    });
+    it('should has unique name', () => {
+        for (const command of commands) {
+            const name = command.getName();
+            if (counts.has(name))
+                counts.set(name, counts.get(name) + 1);
+            else
+                counts.set(name, 1);
+            expect(command).toBeDefined();
+        }
+        for (const [name, count] of counts) {
+            expect(name).toBeTruthy();
+            expect(count).toBe(1);
+        }
+    });
+    it('should has unique usage', () => {
+        for (const command of commands) {
+            const usage = command.getUsage();
+            if (counts.has(usage))
+                counts.set(usage, counts.get(usage) + 1);
+            else
+                counts.set(usage, 1);
+            expect(command).toBeDefined();
+        }
+        for (const [usage, count] of counts) {
+            expect(usage).toBeTruthy();
+            expect(count).toBe(1);
+        }
+    });
+    it('should has unique alias', () => {
+        for (const command of commands) {
+            const alias = command.getAlias();
+            if (counts.has(alias))
+                counts.set(alias, counts.get(alias) + 1);
+            else
+                counts.set(alias, 1);
+            expect(command).toBeDefined();
+        }
+        for (const [alias, count] of counts) {
+            expect(alias).toBeTruthy();
+            expect(count).toBe(1);
+        }
+    });
+});

package/dist/utils/__tests__/index.test.d.ts

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

package/dist/utils/__tests__/index.test.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../index");
+describe('utils', () => {
+    it('should execute chalk correctly', () => {
+        expect((0, index_1.color)('raw text')).toStrictEqual('raw text');
+    });
+    it('should execute program correctly', () => {
+        const mockParse = jest.spyOn(index_1.program, 'parse').mockImplementation(jest.fn());
+        expect(process.env.__BOD__).toStrictEqual('__BOD__');
+        mockParse.mockRestore();
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bod",
-  "version": "5.15.2",
+  "version": "5.16.0",
   "description": "Boilerplate CLI App",
   "author": "sabertazimi <sabertazimi@gmail.com>",
   "license": "MIT",
@@ -30,11 +30,11 @@
   "types": "dist/index.d.ts",
   "bin": "bin/bod.js",
   "files": [
+    "!dist/**/*.test.d.ts",
+    "!dist/**/*.test.js",
     "bin/bod.js",
-    "dist/**/*.js",
     "dist/**/*.d.ts",
-    "!dist/**/*.test.js",
-    "!dist/**/*.test.d.ts"
+    "dist/**/*.js"
   ],
   "engines": {
     "node": ">=18.0.0"
@@ -65,7 +65,8 @@
     "@types/inquirer": "^8.2.10",
     "@types/rimraf": "^4.0.5",
     "ci-info": "^4.0.0",
-    "rimraf": "^5.0.5"
+    "rimraf": "^5.0.5",
+    "type-fest": "^4.14.0"
   },
-  "gitHead": "7d53ab4766c1ac69f99983ec9c2d9c1faa4cee7a"
+  "gitHead": "5fc2f0beb64314994b9b2c4915533c289bc066e7"
 }