@squiz/component-cli-lib 1.39.1-alpha.23 → 1.39.1-alpha.24

package/lib/templates/advanced/package.json

@@ -4,8 +4,8 @@
   },
   "devDependencies": {
     "autoprefixer": "^10.4.13",
-    "esbuild": "^0.17.6",
-    "esbuild-sass-plugin": "^2.4.5",
+    "esbuild": "^0.18.10",
+    "esbuild-sass-plugin": "^2.10.0",
     "postcss": "^8.4.21"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/component-cli-lib",
-  "version": "1.39.1-alpha.23",
+  "version": "1.39.1-alpha.24",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -13,12 +13,12 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@squiz/component-lib": "1.39.1-alpha.23",
-    "@squiz/component-web-api-lib": "1.39.1-alpha.23",
-    "@squiz/dx-common-lib": "1.39.1-alpha.23",
-    "@squiz/dx-json-schema-lib": "1.39.1-alpha.23",
-    "@squiz/dx-logger-lib": "1.39.1-alpha.23",
-    "@squiz/virus-scanner-lib": "1.39.1-alpha.23",
+    "@squiz/component-lib": "1.39.1-alpha.24",
+    "@squiz/component-web-api-lib": "1.39.1-alpha.24",
+    "@squiz/dx-common-lib": "1.39.1-alpha.24",
+    "@squiz/dx-json-schema-lib": "1.39.1-alpha.24",
+    "@squiz/dx-logger-lib": "1.39.1-alpha.24",
+    "@squiz/virus-scanner-lib": "1.39.1-alpha.24",
     "@types/cli-color": "2.0.2",
     "@types/express": "4.17.17",
     "@types/jest": "28.1.8",
@@ -32,12 +32,12 @@
     "typescript": "4.9.4"
   },
   "dependencies": {
-    "@squiz/render-runtime-lib": "1.39.1-alpha.23",
+    "@squiz/render-runtime-lib": "1.39.1-alpha.24",
     "archiver": "5.3.1",
     "axios": "1.3.2",
     "cli-color": "^2.0.2",
     "open": "^8.4.0",
     "supertest": "^6.2.3"
   },
-  "gitHead": "db60c1f1c9786595296a8001bf889a7de5a0afc5"
+  "gitHead": "8e4a8fcb0500763656aff431e30309f206cc8223"
 }

package/src/component-init.spec.ts

@@ -10,8 +10,11 @@ jest.mock('path', () => {
   };
 });
 
+const fsMocked = jest.mocked(fs);
+
 beforeEach(() => {
   jest.resetAllMocks();
+  fsMocked.readJSON.mockResolvedValue({});
 
   // Reset our process.env.NODE_ENV variable
   process.env.NODE_ENV = 'test';
@@ -200,4 +203,56 @@ describe('componentInit', () => {
       '/Users/username/Projects/squiz/new-component',
     );
   });
+
+  describe('prompts', () => {
+    it('should default when no prompts provided', async () => {
+      await componentInit({ componentType: 'basic', destination: '' });
+
+      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          name: 'default',
+          namespace: 'default-namespace',
+          displayName: 'Default',
+        }),
+        expect.objectContaining({ spaces: 2 }),
+      );
+    });
+
+    it('should overwrite default values with provided values', async () => {
+      await componentInit({
+        componentType: 'basic',
+        destination: '',
+        prompts: {
+          name: 'my-component',
+          namespace: 'my-namespace',
+          displayName: 'My Component',
+        },
+      });
+
+      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
+        expect.any(String),
+        expect.objectContaining({
+          name: 'my-component',
+          namespace: 'my-namespace',
+          displayName: 'My Component',
+        }),
+        expect.objectContaining({ spaces: 2 }),
+      );
+    });
+
+    it('should read and write the destination manifest file', async () => {
+      await componentInit({
+        componentType: 'basic',
+        destination: '/Users/username/Projects/squiz/new-component',
+      });
+
+      expect(fsMocked.readJSON).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component/manifest.json');
+      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
+        '/Users/username/Projects/squiz/new-component/manifest.json',
+        expect.any(Object),
+        expect.objectContaining({ spaces: 2 }),
+      );
+    });
+  });
 });

package/src/component-init.ts

@@ -2,17 +2,34 @@ import fse from 'fs-extra';
 import path from 'path';
 import { getLogger, LoggerOptions } from '@squiz/dx-logger-lib';
 
+export interface InitPrompts {
+  name: string;
+  displayName: string;
+  description: string;
+  namespace: string;
+}
+
+const DEFAULT_PROMPTS: InitPrompts = {
+  name: 'default',
+  displayName: 'Default',
+  description: 'Default component',
+  namespace: 'default-namespace',
+};
+
+interface InitOptions {
+  componentType: 'basic' | 'advanced';
+  destination: string;
+  loggingFormat?: LoggerOptions['format'];
+  prompts?: Partial<InitPrompts>;
+}
+
 /**
  * componentInit initializes a new component
  * @param {object} options - The options object
  * @param {string} options.componentType - The type of component to initialize
  * @returns {void}
  */
-export default async function componentInit(options: {
-  componentType: 'basic' | 'advanced';
-  destination: string;
-  loggingFormat?: LoggerOptions['format'];
-}) {
+export default async function componentInit(options: InitOptions) {
   const logger = getLogger({
     name: 'component-dev',
     format: options.loggingFormat || 'human',
@@ -43,6 +60,22 @@ export default async function componentInit(options: {
 
   // Copy the contents of the source folder to the destination folder
   await fse.copy(sourceFolder, destination);
+  await writeManifestVariables({ destination, prompts: Object.assign({}, DEFAULT_PROMPTS, options.prompts) });
 
   logger.info('Component initialized!');
 }
+
+async function writeManifestVariables(options: { destination: string; prompts: InitPrompts }) {
+  const { destination, prompts } = options;
+
+  const manifestPath = path.resolve(destination, 'manifest.json');
+
+  const manifest = await fse.readJSON(manifestPath);
+
+  manifest.name = prompts.name;
+  manifest.displayName = prompts.displayName;
+  manifest.description = prompts.description;
+  manifest.namespace = prompts.namespace;
+
+  await fse.writeJSON(manifestPath, manifest, { spaces: 2 });
+}

package/src/index.ts

@@ -1,4 +1,4 @@
 export { uploadComponentFolder } from './upload-component-folder';
 export { startDevelopmentRender } from './component-dev';
-export { default as componentInit } from './component-init';
+export { default as componentInit, InitPrompts } from './component-init';
 export { uploadJobFolder } from './upload-job';