@common-stack/generate-plugin 6.0.6-alpha.7 → 6.0.6-alpha.71

package/src/generators/add-fullstack/files/tools/update-dependencies.mjs

@@ -10,86 +10,118 @@ const __dirname = fileURLToPath(new URL('.', import.meta.url));
 const JSON_SPACING = 4;
 const ADD_END_NEWLINE = true; // Set to true to add a newline at the end of the file
 
-// Paths to package.json files
-const backendPackagePath = resolve(__dirname, '../servers/backend-server/package.json');
-const frontendPackagePath = resolve(__dirname, '../servers/frontend-server/package.json');
+// Paths to package.json files (now using arrays to handle multiple paths for backend, frontend, and mobile)
+const packagePaths = {
+    backend: [
+        resolve(__dirname, '../servers/backend-server/package.json'),
+    ],
+    frontend: [
+        resolve(__dirname, '../servers/frontend-server/package.json'),
+    ],
+    mobile: [
+        resolve(__dirname, '../portable-devices/mobile/package.json'),
+    ]
+};
 
 // Packages to check
 const packagesToCheck = [
     '@common-stack/server-stack',
-    '@common-stack/frontend-stack-react'
+    '@common-stack/frontend-stack-react',
+    '@common-stack/mobile-stack-react'
 ];
 
+// Utility function to wrap `exec` in a promise for sequential execution
+const execCommand = (command, cwd) => {
+    return new Promise((resolve, reject) => {
+        exec(command, { cwd }, (err, stdout, stderr) => {
+            if (err) {
+                console.error(`Error executing command: ${command}\n${stderr}`);
+                return reject(err);
+            }
+            console.log(stdout);
+            resolve();
+        });
+    });
+};
+
 // Function to update dependencies
 const updateDependencies = async (targetPackagePath, sourcePackagePath) => {
-  const targetPackageJson = JSON.parse(await readFile(targetPackagePath, 'utf-8'));
-  const sourcePackageJson = JSON.parse(await readFile(sourcePackagePath, 'utf-8'));
-
-  const mergeDependencies = (targetDeps = {}, sourceDeps = {}) => ({
-    ...targetDeps,
-    ...sourceDeps
-  });
-
-  // Merge dependencies only
-  targetPackageJson.dependencies = mergeDependencies(
-    targetPackageJson.dependencies,
-    sourcePackageJson.dependencies
-  );
-
-  // Format the JSON string with the specified spacing
-  let jsonString = JSON.stringify(targetPackageJson, null, JSON_SPACING);
-
-  // Optionally add a newline at the end
-  if (ADD_END_NEWLINE) {
-    jsonString += '\n';
-  }
-
-  // Write the formatted JSON back to disk
-  await writeFile(targetPackagePath, jsonString, 'utf-8');
+    const targetPackageJson = JSON.parse(await readFile(targetPackagePath, 'utf-8'));
+    const sourcePackageJson = JSON.parse(await readFile(sourcePackagePath, 'utf-8'));
+
+    const mergeDependencies = (targetDeps = {}, sourceDeps = {}) => ({
+        ...targetDeps,
+        ...sourceDeps
+    });
+
+    // Merge dependencies only
+    targetPackageJson.dependencies = mergeDependencies(targetPackageJson.dependencies, sourcePackageJson.dependencies);
+
+    // Format the JSON string with the specified spacing
+    let jsonString = JSON.stringify(targetPackageJson, null, JSON_SPACING);
+
+    // Optionally add a newline at the end
+    if (ADD_END_NEWLINE) {
+        jsonString += '\n';
+    }
+
+    // Write the formatted JSON back to disk
+    await writeFile(targetPackagePath, jsonString, 'utf-8');
 };
 
-// Function to run `ncu`, update dependencies, and then run linting
+// Function to run `ncu`, `yarn` from the root, update dependencies, and then run linting
 export const runUpdateDependencies = async () => {
-  // Run `ncu` command to update the dependencies from the root level
-  await new Promise((resolve, reject) => {
-    exec('ncu -u -t minor "@common-stack*" && lerna exec "ncu -u -t minor /@common-stack*/"', { cwd: resolve(__dirname, '..') }, (err, stdout, stderr) => {
-      if (err) {
-        console.error(`Error running ncu and lerna: ${stderr}`);
-        return reject(err);
-      }
-      console.log(stdout);
-      resolve();
-    });
-  });
+    // Step 1: Run `ncu` to update the dependencies from the root level
+    console.log('Updating dependencies using `ncu`...');
+    await execCommand(
+        'ncu -u -t minor "@common-stack*" && lerna exec "ncu -u -t minor /@common-stack*/"',
+        resolve(__dirname, '..')
+    );
 
-  // Check for changes in the specified packages
-  for (const packageName of packagesToCheck) {
-    const packagePath = resolve(__dirname, `../node_modules/${packageName}/package.json`);
-    try {
-      await updateDependencies(
-        packageName.includes('server-stack') ? backendPackagePath : frontendPackagePath,
-        packagePath
-      );
-    } catch (error) {
-      console.warn(`Package ${packageName} not found or failed to update:`, error);
+    // Step 2: Run `yarn` to install updated packages from the root
+    console.log('Running yarn install...');
+    await execCommand('yarn', resolve(__dirname, '..'));
+
+    // Step 3: Update dependencies for each package
+    for (const packageName of packagesToCheck) {
+        const packagePath = resolve(__dirname, `../node_modules/${packageName}/package.json`);
+        let targetPaths;
+
+        // Determine the target package.json paths (array of paths)
+        if (packageName.includes('server-stack')) {
+            targetPaths = packagePaths.backend;
+        } else if (packageName.includes('mobile-stack-react')) {
+            targetPaths = packagePaths.mobile;
+        } else {
+            targetPaths = packagePaths.frontend;
+        }
+
+        // Iterate over all target paths in the corresponding array
+        for (const targetPackagePath of targetPaths) {
+            try {
+                await updateDependencies(targetPackagePath, packagePath);
+                console.log(`Updated dependencies for ${packageName} in ${targetPackagePath}`);
+            } catch (error) {
+                console.warn(`Package ${packageName} not found or failed to update in ${targetPackagePath}:`, error);
+            }
+        }
     }
-  }
 
-  console.log('Dependencies from @common-stack packages have been updated.');
+    console.log('Dependencies from @common-stack packages have been updated.');
 
-  // Run linting to apply Prettier
-  try {
-    await runLintStaged();
-    console.log('Prettier formatting applied.');
-  } catch (err) {
-    console.error('Failed to run Prettier:', err);
-  }
+    // Step 4: Run linting to apply Prettier
+    try {
+        await runLintStaged();
+        console.log('Prettier formatting applied.');
+    } catch (err) {
+        console.error('Failed to run Prettier:', err);
+    }
 };
 
 // Execute the function if this file is run directly
 if (import.meta.url === `file://${process.argv[1]}`) {
-  runUpdateDependencies().catch(err => {
-    console.error('Failed to update dependencies:', err);
-    process.exit(1);
-  });
+    runUpdateDependencies().catch((err) => {
+        console.error('Failed to update dependencies:', err);
+        process.exit(1);
+    });
 }

package/src/generators/add-fullstack/files/tools/update-dependency-link.mjs

@@ -1,4 +1,4 @@
-import glob from 'glob';
+import { glob } from 'glob';
 import { resolve, dirname, relative } from 'path';
 import { readFileSync, writeFileSync } from 'fs';
 import simpleGit from 'simple-git';
@@ -8,25 +8,27 @@ import { fileURLToPath } from 'url';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
+const git = simpleGit();
+const monorepoRoot = resolve(__dirname, '..');
+
 // matching prettier format
 const JSON_SPACING = 4;
 const ADD_END_NEWLINE = true; // Set to true to add a newline at the end of the file
 
-const git = simpleGit();
-
-const monorepoRoot = resolve(__dirname, '..');
-
-const findPackageJsonFiles = () => {
-    return new Promise((resolve, reject) => {
-        glob(
+const findPackageJsonFiles = async () => {
+    try {
+        const findings = await glob(
             `${monorepoRoot}/+(servers|portable-devices|packages|packages-modules)/**/package.json`,
             { onlyFiles: true, ignore: '**/node_modules/**' },
             (err, files) => {
-                if (err) reject(`Unable to scan directory: ${err}`);
+                if (err) reject();
                 resolve(files);
             },
         );
-    });
+        return findings;
+    } catch (err) {
+        throw new Error(`Unable to scan directory: ${err}`);
+    }
 };
 
 const buildPackageMap = async () => {

package/src/generators/add-fullstack/files/tools/{update-dependency-version.js → update-dependency-version.mjs}

@@ -1,26 +1,34 @@
-const path = require('path');
-const fs = require('fs');
-const simpleGit = require('simple-git');
-const glob = require('glob');
+import { glob } from 'glob';
+import { resolve, join, dirname, relative } from 'path';
+import { readFileSync, writeFileSync } from 'fs';
+import simpleGit from 'simple-git';
+import { runLintStaged } from './runLint.mjs';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
 const git = simpleGit();
-const monorepoRoot = path.resolve(__dirname, '..');
+const monorepoRoot = resolve(__dirname, '..');
 
 // matching prettier format
 const JSON_SPACING = 4;
 const ADD_END_NEWLINE = true; // Set to true to add a newline at the end of the file
 
-const findPackageJsonFiles = () => {
-    return new Promise((resolve, reject) => {
-        glob(
+const findPackageJsonFiles = async () => {
+    try {
+        const findings = await glob(
             `${monorepoRoot}/+(servers|portable-devices|packages|packages-modules)/**/package.json`,
             { onlyFiles: true, ignore: '**/node_modules/**' },
             (err, files) => {
-                if (err) reject(`Unable to scan directory: ${err}`);
+                if (err) reject();
                 resolve(files);
             },
         );
-    });
+        return findings;
+    } catch (err) {
+        throw new Error(`Unable to scan directory: ${err}`);
+    }
 };
 
 const buildPackageMap = async () => {
@@ -28,10 +36,10 @@ const buildPackageMap = async () => {
     const packageMap = new Map();
 
     packageJsonFiles.forEach((file) => {
-        const packageJson = JSON.parse(fs.readFileSync(file, 'utf8'));
+        const packageJson = JSON.parse(readFileSync(file, 'utf8'));
         if (packageJson.name) {
             packageMap.set(packageJson.name, {
-                path: path.dirname(file),
+                path: dirname(file),
                 version: packageJson.version,
             });
         }
@@ -46,11 +54,11 @@ const searchAndUpdate = (dependencies, filePath, obj, packageMap) => {
     for (const key in dependencies) {
         if (dependencies[key].startsWith('link:')) {
             const relativeDepFolder = dependencies[key].split('link:')[1];
-            const dependencyFolder = path.join(path.dirname(filePath), relativeDepFolder);
+            const dependencyFolder = join(dirname(filePath), relativeDepFolder);
 
             try {
-                const packageJsonPath = path.join(dependencyFolder, 'package.json');
-                const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+                const packageJsonPath = join(dependencyFolder, 'package.json');
+                const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
                 if (dependencies[key] !== packageJson.version) {
                     dependencies[key] = packageJson.version;
                     modified = true;
@@ -74,7 +82,7 @@ const searchAndUpdate = (dependencies, filePath, obj, packageMap) => {
         if (ADD_END_NEWLINE) {
             formattedJson += '\n';
         }
-        fs.writeFileSync(filePath, formattedJson, 'utf8');
+        writeFileSync(filePath, formattedJson, 'utf8');
     }
 
     return modified;
@@ -88,7 +96,7 @@ const updateDependencies = async () => {
     packageJsonFiles.forEach((file) => {
         if (!file.includes('node_modules')) {
             try {
-                const data = fs.readFileSync(file, 'utf8');
+                const data = readFileSync(file, 'utf8');
                 const obj = JSON.parse(data);
                 const { dependencies, peerDependencies, devDependencies } = obj;
 
@@ -106,16 +114,39 @@ const updateDependencies = async () => {
         }
     });
 
-    if (modifiedFiles.length > 0) {
-        await git.add(modifiedFiles);
-        await git.commit('Updated packages to use correct versions and linked dependencies');
-    } else {
-        console.log('No changes detected');
-    }
+    return modifiedFiles;
 };
 
 updateDependencies()
-    .then(() => {
-        console.log('Dependencies updated successfully.');
+    .then((modifiedFiles) => {
+        const addArray = modifiedFiles.map((file) => `./${relative(monorepoRoot, file)}`);
+        console.log('-- Modified Files --', modifiedFiles, addArray);
+        if (addArray.length === 0) {
+            console.log('No files to stage.');
+            return null;
+        }
+        return git.add(addArray).then(() => git.status()); // Stage files and then check status
     })
-    .catch((err) => console.error(`Error in updateDependencies: ${err.message}`));
+    .then((status) => {
+        if (status && status.modified.length) {
+            const fileArray = status.modified.filter((element) => element.includes('package.json'));
+            const addArray = fileArray.map((element) => `./${element}`);
+            return git
+                .add(addArray)
+                .then(runLintStaged)
+                .then(() => git.status()); // Run lint-staged after adding
+        } else {
+            console.log('No changes to lint or commit.');
+            return null;
+        }
+    })
+    .then((status) => {
+        if (status && status.modified.length > 0) {
+            return git.commit('Updated packages to use correct versions');
+        } else {
+            console.log('No changes after linting. Nothing to commit.');
+        }
+    })
+    .catch((err) => {
+        console.error(err);
+    });

package/src/generators/add-fullstack/generator.ts

@@ -5,31 +5,56 @@ import * as path from 'path';
 import * as fs from 'fs';
 import { AddFullstackGeneratorSchema } from './schema';
 import { getValid, isValid } from '../../utils';
-import { updateJenkinsFile, updatePackageJson } from './updates';
+import { 
+    updateJenkinsFile,
+    updatePackageJson,
+    backupLernaJson,
+    restoreLernaJson,
+    updateHtmlPlugin,
+    updateLicense,
+    backupFiles,
+    restoreFiles,
+    updateRepository,
+} from './updates';
 import {
     generateBackend,
     generateFrontend,
     generateMoleculer,
-    generateBrowserPackage,
-    generateClientPackage,
-    generateCorePackage,
-    generateServerPackage,
+    generatePackage,
 } from '../../index';
 
 export async function addFullstackGenerator(tree: Tree, options: AddFullstackGeneratorSchema) {
     const basePath = options.path || '';
-    const projectRoot = path.join(basePath, getValid(options.name) ?? 'fullstack-pro');
+    const projectName = getValid(options.name) ?? 'fullstack-pro';
+    const projectRoot = path.join(basePath, projectName);
 
     console.log(`basePath: ${basePath}`);
 
+    // backup existing lerna values
+    const lernaBackup = backupLernaJson(tree, projectRoot);
+
+    // backup files codegen.yaml
+    const filesToBackup = ['codegen.yml', 'values-dev.yaml', 'values-prod.yaml', 'values-stage.yaml'];
+    const filesBackup = backupFiles(tree, projectRoot, filesToBackup);
+
     generateFiles(tree, path.join(__dirname, 'files'), projectRoot, options);
 
     // Update Jenkinsfile with dynamic values
-    const jenkinsFilePath = path.join(projectRoot, 'Jenkinsfile');
-    updateJenkinsFile(jenkinsFilePath, options.name);
+    updateJenkinsFile(tree, projectRoot, projectName);
 
     // Update package.json with the project name
-    updatePackageJson(tree, projectRoot, getValid(options.name));
+    updatePackageJson(tree, projectRoot, { name: projectName });
+
+    // Update tools/html-plugin-template
+    updateHtmlPlugin(tree, projectRoot);
+
+    if (lernaBackup) {
+        // When update the existing lerna.json, it shouldn't overwrite version, allowbranch, packages
+        restoreLernaJson(tree, projectRoot, lernaBackup);
+    }
+
+    // Restore files backup to ignore update
+    restoreFiles(tree, projectRoot, filesBackup);
 
     await formatFiles(tree);
 
@@ -37,9 +62,9 @@ export async function addFullstackGenerator(tree: Tree, options: AddFullstackGen
         const configPath = path.resolve(basePath, getValid(options.config));
         if (fs.existsSync(configPath)) {
             try {
-                const content = String(fs.readFileSync(configPath));
-                const configs = JSON.parse(content);
+                const configs = JSON.parse(fs.readFileSync(configPath).toString());
                 configs.parent = projectRoot;
+                configs.ns = projectName;
 
                 await processConfigs(tree, configs);
             } catch (error) {
@@ -47,14 +72,17 @@ export async function addFullstackGenerator(tree: Tree, options: AddFullstackGen
             }
         }
     }
-}
 
+    // Update license from package.json
+    updateLicense(tree, projectRoot);
+}
 
-const generateServers = async (tree: Tree, parent: string, servers: any) => {
-    for (const [serverName, serverConfig] of Object.entries(servers)) {
+const generateServers = async (tree: Tree, options: any) => {
+    for (const [serverName, serverConfig] of Object.entries(options.servers)) {
         const configs: any = serverConfig;
         configs.name = serverName;
-        configs.directory = path.join(parent, 'servers');
+        configs.directory = path.join(options.parent, 'servers');
+        configs.ns = options.ns;
 
         switch (configs?.type) {
             case 'frontend':
@@ -72,38 +100,36 @@ const generateServers = async (tree: Tree, parent: string, servers: any) => {
     }
 };
 
-const generatePackages = async (tree: Tree, parent: string, packages: any) => {
-    for (const [packageName, packageConfig] of Object.entries(packages)) {
-        const configs: any = packageConfig;
-        configs.name = packageName;
-        configs.directory = path.join(parent, 'packages');
-
-        switch ((packageConfig as any)?.type) {
-            case 'packages-core':
-                await generateCorePackage(tree, configs);
-                break;
-            case 'packages-browser':
-                await generateBrowserPackage(tree, configs);
-                break;
-            case 'packages-client':
-                await generateClientPackage(tree, configs);
-                break;
-            case 'packages-server':
-                await generateServerPackage(tree, configs);
-                break;
-            default:
-                break;
+const generateModules = async (tree: Tree, options: any) => {
+    for (const [moduleName, moduleConfig] of Object.entries(options.packages.modules)) {
+        for (const [packageName, packageConfig] of Object.entries(moduleConfig)) {
+            const configs: any = {
+                ...(packageConfig as any),
+                name: moduleName,
+                directory: path.join(options.parent, 'packages'),
+                ns: options.ns,
+                type: packageName,
+            };
+            await generatePackage(tree, configs, false);
         }
     }
 };
 
 const processConfigs = async (tree: Tree, configs: any) => {
     if (configs.servers) {
-        await generateServers(tree, configs.parent, configs.servers);
+        await generateServers(tree, configs);
     }
 
     if (configs.packages && configs.packages.modules) {
-        await generatePackages(tree, configs.parent, configs.packages.modules);
+        await generateModules(tree, configs);
+    }
+
+    if (configs.license) {
+        updatePackageJson(tree, configs.parent, { license: getValid(configs.license) });
+    }
+
+    if (configs.repository) {
+        updateRepository(tree, configs.parent, configs.repository);
     }
 };
 

package/src/generators/add-fullstack/updates/htmlPluginUpdate.ts

@@ -0,0 +1,11 @@
+import { Tree } from '@nx/devkit';
+import * as path from 'path';
+
+export function updateHtmlPlugin(tree: Tree, projectRoot: string) {
+    const filePath = path.join(projectRoot, 'tools', 'html-plugin-template.ejs');
+    if (tree.exists(filePath)) {
+        const contents = tree.read(filePath).toString();
+        const newContents = contents.replace('<@', '<%').replace('@>', '%>');
+        tree.write(filePath, newContents);
+    }
+}

package/src/generators/add-fullstack/updates/ignoreUpdate.ts

@@ -0,0 +1,23 @@
+import { Tree } from '@nx/devkit';
+import * as path from 'path';
+
+export function backupFiles(tree: Tree, projectRoot: string, files: string[]) {
+    return files.map(file => {
+        const filePath = path.join(projectRoot, file);
+        const backup: any = { file };
+        if (tree.exists(filePath)) {
+            backup.content = tree.read(filePath).toString();
+        }
+        return backup;
+    });
+}
+
+export function restoreFiles(tree: Tree, projectRoot: string, files: any[]) {
+    files.forEach((backup: any) => {
+        const filePath = path.join(projectRoot, backup.file);
+        if (backup.content) {
+            tree.write(filePath, backup.content);
+            console.log('Restored file', filePath);
+        }
+    });
+}

package/src/generators/add-fullstack/updates/index.ts

@@ -1,2 +1,6 @@
 export * from './jenkinsfileUpdate';
 export * from './packageJsonUpdate';
+export * from './lernaJsonUpdate';
+export * from './htmlPluginUpdate';
+export * from './licenseUpdate';
+export * from './ignoreUpdate';

package/src/generators/add-fullstack/updates/jenkinsfileUpdate.ts

@@ -1,7 +1,9 @@
+import { Tree } from '@nx/devkit';
 import fs from 'fs';
 import * as path from 'path';
 
-export function updateJenkinsFile(filePath: string, name: string) {
+export function updateJenkinsFile(tree: Tree, projectRoot: string, name: string) {
+    const filePath = path.join(projectRoot, 'Jenkinsfile');
     const paramsToUpdate = {
         BASE_NAMESPACE: name,
         CONNECTION_ID: name,
@@ -10,8 +12,8 @@ export function updateJenkinsFile(filePath: string, name: string) {
     };
 
     let jenkinsFileContent = '';
-    if (fs.existsSync(filePath)) {
-        jenkinsFileContent = fs.readFileSync(filePath, 'utf-8');
+    if (tree.exists(filePath)) {
+        jenkinsFileContent = tree.read(filePath).toString();
     }
 
     let labelExists = false;
@@ -42,6 +44,6 @@ export function updateJenkinsFile(filePath: string, name: string) {
 
     // Only write back to the file if we have made changes
     if (!labelExists || Object.keys(paramsToUpdate).some(param => !updatedContent.includes(`string(name: '${param}'`))) {
-        fs.writeFileSync(filePath, updatedContent, 'utf-8');
+        tree.write(filePath, updatedContent);
     }
 }

package/src/generators/add-fullstack/updates/lernaJsonUpdate.ts

@@ -0,0 +1,53 @@
+import { Tree, updateJson } from '@nx/devkit';
+import * as path from 'path';
+import * as fs from 'fs';
+import { get, set } from 'lodash';
+
+const params = ['version', 'command:publish:allowBranch', 'command:version:allowBranch', 'packages'];
+
+export function backupLernaJson(tree: Tree, projectRoot: string) {
+    const lernaJsonPath = path.join(projectRoot, 'lerna.json');
+
+    if (tree.exists(lernaJsonPath)) {
+        const lernaJson = JSON.parse(tree.read(lernaJsonPath).toString());
+        const backup = {};
+        let exists = false;
+        for (const param of params) {
+            if (param.includes(':')) {
+                const paramValue = get(lernaJson, param.split(':'));
+                if (paramValue) {
+                    backup[param] = paramValue;
+                    exists = true;
+                }
+            } else {
+                if (lernaJson[param]) {
+                    backup[param] = lernaJson[param];
+                    exists = true;
+                }
+            }
+        }
+
+        if (exists) {
+            return backup;
+        }
+    }
+
+    return null;
+}
+
+export function restoreLernaJson(tree: Tree, projectRoot: string, backup: any) {
+    const lernaJsonPath = path.join(projectRoot, 'lerna.json');
+    if (backup && fs.existsSync(lernaJsonPath)) {
+        updateJson(tree, lernaJsonPath, (lernaJson: any) => {
+            Object.keys(backup).forEach(param => {
+                if (param.includes(':')) {
+                    lernaJson = set(lernaJson, param.split(':'), backup[param]);
+                } else {
+                    lernaJson[param] = backup[param];
+                }
+            });
+            return lernaJson;
+        });
+        console.log('Restored old values in lerna.json');
+    }
+}