@common-stack/generate-plugin 7.0.3-alpha.2 → 7.0.4-alpha.1

package/src/generators/add-frontend/templates/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+    "**/.server/**/*.ts",
+    "**/.server/**/*.tsx",
+    "**/.client/**/*.ts",
+    "**/.client/**/*.tsx"
+  ],
+  "compilerOptions": {
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "types": ["@remix-run/node", "vite/client"],
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "jsx": "react-jsx",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "target": "ES2022",
+    "strict": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": ".",
+    "paths": {
+      "~/*": ["./src/*"]
+    },
+
+    // Vite takes care of building everything, not tsc.
+    "noEmit": true
+  }
+}

package/src/generators/add-frontend/templates/tsconfig.node.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+      "composite": true,
+      "skipLibCheck": true,
+      "module": "ESNext",
+      "moduleResolution": "bundler",
+      "allowSyntheticDefaultImports": true
+    },
+    "include": ["vite.config.ts"]
+  }

package/src/generators/add-frontend/templates/vite.config.ts.template

@@ -0,0 +1,115 @@
+import { defineConfig } from 'vite';
+import { vitePlugin as remix } from '@remix-run/dev';
+import { dirname, resolve } from 'path';
+import { installGlobals } from '@remix-run/node';
+import { fileURLToPath } from 'url';
+import { defineRoutesConfig } from '@common-stack/rollup-vite-utils/lib/vite-wrappers/json-wrappers.js';
+import tsconfigPaths from 'vite-tsconfig-paths';
+import { i18nInternationalizationPlugin } from '@common-stack/rollup-vite-utils/lib/vite-plugins/i18n-internationalization-plugin.js';
+import { performCopyOperations } from '@common-stack/rollup-vite-utils/lib/preStartup/configLoader/configLoader.js';
+import { loadEnvConfig } from '@common-stack/rollup-vite-utils/lib/preStartup/configLoader/envLoader.js';
+import { cjsInterop } from 'vite-plugin-cjs-interop';
+import { mergeWith } from 'lodash-es';
+import config from './app/cde-webconfig.json' assert { type: 'json' };
+
+// This installs globals such as "fetch", "Response", "Request" and "Headers".
+installGlobals();
+
+const directoryName = dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig(async ({ isSsrBuild }) => {
+    console.log('--- IS SSR BUILD:', isSsrBuild);
+
+    // Load environment variables from dotenv or other config
+    const dotEnvResult = loadEnvConfig(directoryName);
+
+    // Define environment variables for Vite
+    const envVariables = {
+        __ENV__: JSON.stringify(dotEnvResult?.parsed),
+        __SERVER__: true,
+        __CLIENT__: false,
+        ...Object.fromEntries(
+            Object.entries(config.buildConfig).map(([key, value]) => [
+                key,
+                typeof value === 'string' ? `"${value.replace(/\\/g, '\\\\')}"` : value,
+            ])
+        ),
+    };
+
+    // Define routes configuration
+    const routesConfig = async (defineRoutes) => {
+        // In production, perform required file copy operations
+        if (process.env.NODE_ENV === 'production') {
+            await performCopyOperations(config);
+        }
+
+        // Load metadata for routes
+        let metaJson = null;
+        try {
+            metaJson = await import('./app/sync-meta.json');
+        } catch {
+            console.warn('No sync-meta.json found, continuing without metadata.');
+        }
+
+        // Return routes definition
+        return defineRoutes((routeFn) =>
+            defineRoutesConfig(
+                routeFn,
+                {
+                    routesFileName: 'routes.json',
+                    packages: config.modules,
+                    paths: config.paths,
+                    iconsRepository: config?.iconsRepository,
+                    rootPath: resolve(directoryName, '../..'),
+                    settings: {
+                        _useFutureCommonPackage: true,
+                    },
+                },
+                metaJson
+            )
+        );
+    };
+
+    // Vite configuration
+    const viteConfig = {
+        define: envVariables,
+        plugins: [
+            i18nInternationalizationPlugin({
+                folderName: 'cdm-locales',
+                packages: [...config.modules, ...config.i18n.packages],
+                namespaceResolution: 'basename',
+            }),
+            cjsInterop({
+                dependencies: ['@apollo/client'],
+            }),
+            remix({
+                appDirectory: 'src',
+                routes: routesConfig,
+            }),
+            tsconfigPaths({ ignoreConfigErrors: true }),
+        ],
+        optimizeDeps: {
+            esbuildOptions: {
+                target: 'esnext',
+            },
+        },
+        build: {
+            target: 'esnext',
+        },
+        resolve: {
+            alias: {
+                '@app': resolve(directoryName, 'app'),
+                '@src': resolve(directoryName, 'src'),
+            },
+        },
+    };
+
+    // Deep merge custom Vite config from config.json
+    // to merge Arrays properly need to concat. 
+    const result = mergeWith(config.viteConfig, viteConfig, (objValue, srcValue) => {
+        if (Array.isArray(objValue)) {
+            return objValue.concat(srcValue);
+        }
+    });
+    return result;
+});

package/src/generators/add-fullstack/files/_browserslistrc

@@ -0,0 +1,3 @@
+defaults
+not IE 11
+not IE_Mob 11

package/src/generators/add-fullstack/files/_eslintignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+lib

package/src/generators/add-fullstack/files/_eslintrc.js

@@ -0,0 +1,89 @@
+const common = {
+    env: {
+        node: true,
+        es6: true,
+        'jest/globals': true,
+    },
+    plugins: ['prettier', 'jest', 'markdown'],
+    extends: ['airbnb-base', 'prettier', 'plugin:jest/all', 'plugin:json/recommended'],
+    rules: {
+        'jest/unbound-method': 'off',
+        'prettier/prettier': 'error',
+        'jest/no-disabled-tests': 'warn',
+        'jest/no-focused-tests': 'error',
+        'jest/no-identical-title': 'error',
+        'jest/prefer-to-have-length': 'warn',
+        'jest/valid-expect': 'error',
+        'jest/expect-expect': 'off',
+        'jest/prefer-expect-assertions': 'off',
+        'jest/no-test-return-statement': 'off',
+        'import/prefer-default-export': 'off',
+        'import/extensions': 'off',
+        'no-console': 'off',
+        'no-iterator': 'off',
+        'no-restricted-syntax': 'off',
+        'no-await-in-loop': 'off',
+        'consistent-return': 'off',
+        'no-shadow': 'off',
+        'no-unused-vars': 'off',
+        'jsonc/indent': ['error', 2, {}],
+    },
+    globals: {
+        fetch: true,
+        window: true,
+        document: true,
+        __CDN_URL__: true,
+        __DEV__: true,
+        __TEST__: true,
+        __CLIENT__: true,
+        __SERVER__: true,
+        __GRAPHQL_ENDPOINT__: true,
+        __SSR__: true,
+        __PERSIST_GQL__: true,
+        __API_URL__: true,
+        __WEBSITE_URL__: true,
+        __FRONTEND_BUILD_DIR__: true,
+    },
+};
+
+module.exports = {
+    root: true,
+    overrides: [
+        {
+            /*
+        eslint-plugin-markdown only finds javascript code block snippet.
+        For specific spec, refer to https://github.com/eslint/eslint-plugin-markdown
+        */
+            files: ['**/*.js', '**/*.md'],
+            ...common,
+        },
+        {
+            files: ['**/*.ts'],
+            parser: '@typescript-eslint/parser',
+            env: common.env,
+            plugins: [...common.plugins, '@typescript-eslint'],
+            extends: [
+                ...common.extends,
+                'plugin:@typescript-eslint/recommended',
+                'plugin:import/errors',
+                'plugin:import/warnings',
+                'plugin:import/typescript',
+            ],
+            rules: {
+                ...common.rules,
+                '@typescript-eslint/explicit-function-return-type': 'off',
+            },
+            settings: {
+                'import/resolver': {
+                    node: {
+                        extensions: ['.js', '.jsx', '.ts', '.d.ts', '.tsx', '.graphql', '.gql'],
+                    },
+                    typescript: {
+                        // alwaysTryTypes: true,
+                        // paths: './tsconfig.json',
+                    },
+                },
+            },
+        },
+    ],
+};

package/src/generators/add-fullstack/files/_git-crypt/.gitattributes

@@ -0,0 +1,4 @@
+# Do not edit this file.  To specify the files to encrypt, create your own
+# .gitattributes file in the directory where your files are.
+* !filter !diff
+*.gpg binary

package/src/generators/add-fullstack/files/_git-crypt/keys/default/0/49AB3942E38DB928ACF3905EC2DB4383B4A6E5EA.gpg

@@ -0,0 +1 @@
+�
n�'���
�s�U�����5�‰��dyO"�fn�p��S���͢U

package/src/generators/add-fullstack/files/_gitattributes

@@ -0,0 +1,5 @@
+values.secret.json filter=git-crypt diff=git-crypt
+.npmrc filter=git-crypt diff=git-crypt
+values-dev.yaml filter=git-crypt diff=git-crypt
+values-stage.yaml filter=git-crypt diff=git-crypt
+values-prod.yaml filter=git-crypt diff=git-crypt

package/src/generators/add-fullstack/files/_gitignore

@@ -0,0 +1,62 @@
+dist
+lib
+.nx
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# remove unwanted
+.expo 
+.drawio-chrome
+
+# Spinjs cache
+.cache
+.awcache
+.nx
+
+# Jest Env
+globalConfig.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.sqlite3
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+.build
+build
+build/Release
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+.dist
+
+# ignore temp created for pushing prod changes to devleop
+lerna-temp.json
+# IDE 
+.idea
+*.DS_Store
+.DS_Store
+dump.rdb
+v8-compile-cache-0

package/src/generators/add-fullstack/files/_husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged 

package/src/generators/add-fullstack/files/_husky/prepare-commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitizen --hook || true 

package/src/generators/add-fullstack/files/_markdownlint.json

@@ -0,0 +1,6 @@
+{
+    "default": true,
+    "MD013": false,
+    "MD042": false,
+    "MD033": false
+}

package/src/generators/add-fullstack/files/_markdownlintignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+lib
+.git
+CHANGELOG.md

package/src/generators/add-fullstack/files/_npmrc

@@ -0,0 +1,2 @@
+email=none@cdmbase.com
+//registry.npmjs.org/:_authToken=

package/src/generators/add-fullstack/files/_nxignore

@@ -0,0 +1,8 @@
+**/fixtures/**
+**/test/**
+**/__tests__/**
+**/__mocks__/**
+**/__integration__/**
+**/__fixtures__/**
+**/*.spec.ts
+**/*.test.ts

package/src/generators/add-fullstack/files/lint-staged.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-    '*.{js,jsx,ts,tsx,json,md}': ['prettier --write', 'git add'],
-    // '*.{ts,tsx}': ['eslint --fix'], // this can be tested
+    '*.{js,jsx,ts,tsx}': ['eslint --fix', 'prettier --write'],
+    '*.{json,md}': ['prettier --write'],
     'package.json': ['sort-package-json', 'prettier --write'],
 };

package/src/generators/add-fullstack/files/package.json

@@ -98,12 +98,6 @@
         "zen:watch": "zen  watch -x",
         "zen:watch:debug": "yarn zen:watch -- -v"
     },
-    "husky": {
-        "hooks": {
-            "pre-commit": "lint-staged",
-            "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-        }
-    },
     "resolutions": {
         "@apollo/client": "^3.9.0",
         "@nx/workspace": "20.4.3",
@@ -150,9 +144,9 @@
         "@babel/preset-typescript": "^7.18.6",
         "@babel/register": "^7.18.9",
         "@babel/runtime": "^7.20.1",
-        "@common-stack/env-list-loader": "6.0.8-alpha.31",
-        "@common-stack/generate-plugin": "7.0.3-alpha.1",
-        "@common-stack/rollup-vite-utils": "7.0.3-alpha.1",
+        "@common-stack/env-list-loader": "7.0.4-alpha.0",
+        "@common-stack/generate-plugin": "7.0.4-alpha.0",
+        "@common-stack/rollup-vite-utils": "7.0.4-alpha.0",
         "@emotion/babel-plugin": "^11.11.0",
         "@graphql-codegen/add": "^5.0.3",
         "@graphql-codegen/cli": "^5.0.4",

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

@@ -1,3 +1,4 @@
+import { beforeEach, describe, expect, it } from '@jest/globals';
 import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
 import { Tree, readProjectConfiguration } from '@nx/devkit';
 
@@ -15,6 +16,7 @@ describe('add-fullstack generator', () => {
     it('should run successfully', async () => {
         await addFullstackGenerator(tree, options);
         const config = readProjectConfiguration(tree, 'test');
+
         expect(config).toBeDefined();
     });
 });

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

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable import/no-cycle */
-import { addProjectConfiguration, formatFiles, generateFiles, Tree } from '@nx/devkit';
+import { formatFiles, generateFiles, Tree, updateJson } from '@nx/devkit';
 import * as path from 'path';
 import * as fs from 'fs';
 import { AddFullstackGeneratorSchema } from './schema';
 import { getValid, isValid } from '../../utils';
-import { 
+import {
     updateJenkinsFile,
     updatePackageJson,
     backupLernaJson,
@@ -15,13 +15,20 @@ import {
     backupFiles,
     restoreFiles,
     updateRepository,
+    renameDotFiles,
+    setupGit,
+    commitInitialFiles,
+    setupGitCrypt,
+    setupHusky,
+    prepareGitAttributes,
+    setupNpmAuth,
+    setupNxConfig,
 } from './updates';
-import {
-    generateBackend,
-    generateFrontend,
-    generateMoleculer,
-    generatePackage,
-} from '../../index';
+// import { generateBackend, generateFrontend } from '../../index';
+import { addBackendGenerator as generateBackend } from '../add-backend/generator';
+import { addFrontendGenerator as generateFrontend } from '../add-frontend/generator';
+import { addMoleculerGenerator as generateMoleculer } from '../add-moleculer/generator';
+import { addPackageGenerator as generatePackage } from '../add-package/generator';
 
 export async function addFullstackGenerator(tree: Tree, options: AddFullstackGeneratorSchema) {
     let projectPath = options.path || '';
@@ -37,31 +44,37 @@ export async function addFullstackGenerator(tree: Tree, options: AddFullstackGen
     // 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'];
+    // backup files including codegen.ts (instead of codegen.yml)
+    const filesToBackup = ['codegen.ts', '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
-    updateJenkinsFile(tree, projectRoot, projectName);
+    // Rename files that begin with underscore to dot files
+    renameDotFiles(tree, projectRoot);
 
-    // Update package.json with the project name
-    updatePackageJson(tree, projectRoot, { name: projectName });
+    // Handle gitattributes file (Tree-phase)
+    prepareGitAttributes(tree, projectRoot);
 
-    // Update tools/html-plugin-template
+    // First update files in the tree
+    updateJenkinsFile(tree, projectRoot, projectName);
+    updatePackageJson(tree, projectRoot, { name: projectName });
     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);
+    updateLicense(tree, projectRoot);
 
+    // Format all files
     await formatFiles(tree);
 
+    // Set a flag to perform Git operations after files are written
+    const performGitOperations = true;
+
+    // Process configurations if needed
     if (isValid(options.config)) {
         const configPath = path.resolve(projectPath, getValid(options.config));
         if (fs.existsSync(configPath)) {
@@ -77,8 +90,49 @@ export async function addFullstackGenerator(tree: Tree, options: AddFullstackGen
         }
     }
 
-    // Update license from package.json
-    updateLicense(tree, projectRoot);
+    // Add this before commitInitialFiles
+    await setupNxConfig(tree, projectRoot);
+
+    // Setup git and commit files
+    setupGit(tree, projectRoot);
+
+    // Step 2: Set up git-crypt
+    setupGitCrypt(tree, projectRoot);
+
+    // Step 3: Set up npm authentication
+    setupNpmAuth(tree, projectRoot);
+
+    // Step 4: Set up husky
+    setupHusky(tree, projectRoot);
+
+    // Step 5: Commit all files (they will be encrypted if they match patterns in .gitattributes)
+    commitInitialFiles(projectRoot);
+
+    console.log('Git setup completed.');
+
+    // Return function to execute after all files are written to disk
+    if (performGitOperations) {
+        return () => {
+            console.log('All files have been generated. Now setting up Git...');
+
+            // Step 1: Initialize git repository
+            setupGit(tree, projectRoot);
+
+            // Step 2: Set up git-crypt
+            setupGitCrypt(tree, projectRoot);
+
+            // Step 3: Set up npm authentication
+            setupNpmAuth(tree, projectRoot);
+
+            // Step 4: Set up husky
+            setupHusky(tree, projectRoot);
+
+            // Step 5: Commit all files (they will be encrypted if they match patterns in .gitattributes)
+            commitInitialFiles(projectRoot);
+
+            console.log('Git setup completed.');
+        };
+    }
 }
 
 const generateServers = async (tree: Tree, options: any) => {
@@ -114,7 +168,7 @@ const generateModules = async (tree: Tree, options: any) => {
                 ns: options.ns,
                 type: packageName,
             };
-            await generatePackage(tree, configs, false);
+            await generatePackage(tree, configs);
         }
     }
 };

package/src/generators/add-fullstack/schema.d.ts

@@ -1,5 +1,5 @@
 export interface AddFullstackGeneratorSchema {
     name: string;
     config?: string;
-    path?: string;  // Optional path property for specifying the base path
-}
+    path?: string; // Optional path property for specifying the base path
+}

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

@@ -0,0 +1,60 @@
+import { Tree } from '@nx/devkit';
+import * as path from 'path';
+import * as fs from 'fs';
+
+/**
+ * Renames _gitattributes to .gitattributes during the Tree modification phase
+ */
+export function prepareGitAttributes(tree: Tree, projectRoot: string) {
+    const gitattributesSrc = path.join(projectRoot, '_gitattributes');
+    const gitattributesDest = path.join(projectRoot, '.gitattributes');
+    
+    if (tree.exists(gitattributesSrc)) {
+        // Read content and write to destination
+        const content = tree.read(gitattributesSrc).toString();
+        tree.write(gitattributesDest, content);
+        // Remove the source file
+        tree.delete(gitattributesSrc);
+        console.log(`Renamed ${gitattributesSrc} to ${gitattributesDest}`);
+        return true;
+    }
+    
+    return false;
+}
+
+/**
+ * Updates .gitattributes with additional patterns if needed after files are on disk
+ */
+export function updateGitAttributes(projectRoot: string, attributesToAdd: Record<string, string>) {
+    try {
+        const gitattributesPath = path.join(projectRoot, '.gitattributes');
+        
+        if (!fs.existsSync(gitattributesPath)) {
+            console.log('.gitattributes file not found, skipping update');
+            return false;
+        }
+        
+        let gitattributesContent = fs.readFileSync(gitattributesPath, 'utf8');
+        let contentUpdated = false;
+        
+        // Add each attribute if not already present
+        Object.entries(attributesToAdd).forEach(([pattern, attribute]) => {
+            const attributeLine = `${pattern} ${attribute}`;
+            if (!gitattributesContent.includes(attributeLine)) {
+                contentUpdated = true;
+                gitattributesContent += `\n${attributeLine}`;
+            }
+        });
+        
+        // Write the file if we made changes
+        if (contentUpdated) {
+            fs.writeFileSync(gitattributesPath, gitattributesContent, 'utf8');
+            console.log('Updated .gitattributes file with additional patterns');
+        }
+        
+        return contentUpdated;
+    } catch (error) {
+        console.error('Error updating .gitattributes:', error);
+        return false;
+    }
+}