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

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.2",
-        "@common-stack/rollup-vite-utils": "7.0.3-alpha.2",
+        "@common-stack/env-list-loader": "7.0.4-alpha.0",
+        "@common-stack/generate-plugin": "7.0.4-alpha.1",
+        "@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/files/rollup.config.base.mjs

@@ -2,16 +2,22 @@
 import graphql from '@rollup/plugin-graphql';
 import image from '@rollup/plugin-image';
 import typescript from '@rollup/plugin-typescript';
+import esbuild from 'rollup-plugin-esbuild'
 import { string } from 'rollup-plugin-string';
 import svg from 'rollup-plugin-svg';
 import { copy } from '@web/rollup-plugin-copy';
+import json from '@rollup/plugin-json';
 import modifyLibFilesPlugin from '@common-stack/rollup-vite-utils/lib/rollup/rollupPluginModifyLibFiles.js';
 import generateJsonFromObject from '@common-stack/rollup-vite-utils/lib/rollup/rollupPluginGenerateJson.js';
 import addJsExtensionToImportsPlugin from '@common-stack/rollup-vite-utils/lib/rollup/rollupPluginAddJsExtension.js';
 import { ignoreCssUrlPlugin } from '@common-stack/rollup-vite-utils/lib/rollup/pluginIgnore.js';
 // Define any additional plugins specific to this bundle
 const additionalPlugins = [
-    copy({ patterns: ['**/cdm-locales/**/*', '**/*.gql', '**/**/*.graphql', '**/styles/**/*', '**/css/**/*'], rootDir: './src' }),
+    copy({
+        patterns: ['**/cdm-locales/**/*', '**/*.gql', '**/**/*.graphql', '**/styles/**/*', '**/templates/**/*', '**/css/**/*'],
+        rootDir: './src',
+    }),
+    json(),
 ];
 
 function deepMergeConfigs(baseConfig, specificConfig) {
@@ -37,37 +43,54 @@ const baseConfig = {
         addJsExtensionToImportsPlugin({
             packages: '*',
             needToAddIndexJs: [],
-            excludeImports: ['@emotion/react/jsx-runtime'],
+            // exclude fs/promises from modifying
+            excludeImports: ['@emotion/react/jsx-runtime', 'fs/promises', '@apollo/server*'],
         }),
-        typescript(), // TypeScript at the top as per best practices
+        typescript(), // Initially include the TypeScript plugin
         ignoreCssUrlPlugin(),
-        modifyLibFilesPlugin({
-            include: ['**/**/compute.js'], // Adjust to target specific files or patterns
-            outputDir: 'lib', // Ensure this matches your actual output directory
-        }),
-        generateJsonFromObject({}),
-
         ...additionalPlugins,
     ],
     external: (id) => !/^[./]/.test(id),
     globals: { react: 'React' },
 };
 
-// Function to create a configuration by extending the base
-function createRollupConfig(overrides, isWatchMode = false) {
-    const config = deepMergeConfigs(baseConfig, overrides);
+// Updated createRollupConfig function to accept an options object as the second parameter.
+// If useEsbuild is true, the TypeScript plugin is removed completely and replaced with the esbuild plugin.
+function createRollupConfig(specificOverrides, options = {}) {
+    const { useEsbuild, isWatchMode, generateRoutesJSON } = options;
+    const config = deepMergeConfigs(baseConfig, specificOverrides);
 
-    // Adjust TypeScript plugin based on watch mode
-    config.plugins = config.plugins.map((plugin) => {
-        if (plugin.name === 'typescript') {
-            return typescript({
-                ...plugin.options,
-                noEmitOnError: !isWatchMode, // Set to false only in watch mode
-            });
-        }
-        return plugin;
-    });
+    // Conditionally add both modifyLibFilesPlugin and generateJsonFromObject plugins if generateRoutesJSON option is provided.
+    if (generateRoutesJSON) {
+        // Add modifyLibFilesPlugin with predetermined configuration.
+        config.plugins.push(modifyLibFilesPlugin({
+            include: ['**/**/compute.js'], // Adjust to target specific files or patterns
+            outputDir: 'lib',              // Ensure this matches your actual output directory
+        }));
+        // Allow generateRoutesJSON to be an object with plugin configuration or simply a boolean.
+        const jsonConfig = typeof generateRoutesJSON === 'object' ? generateRoutesJSON : {};
+        config.plugins.push(generateJsonFromObject(jsonConfig));
+    }
 
+    if (useEsbuild) {
+        // Remove the TypeScript plugin completely.
+        config.plugins = config.plugins.filter((plugin) => plugin.name !== 'typescript');
+        // Add the esbuild plugin only. Note: The "watch" option is removed as it's not supported by esbuild.
+        config.plugins.push(esbuild({
+            target: 'es2017', // Adjust the target as needed
+        }));
+    } else {
+        // Retain the TypeScript plugin and adjust its options based on watch mode.
+        config.plugins = config.plugins.map((plugin) => {
+            if (plugin.name === 'typescript') {
+                return typescript({
+                    ...plugin.options,
+                    noEmitOnError: !isWatchMode, // Adjust based on watch mode
+                });
+            }
+            return plugin;
+        });
+    }
     return config;
 }
 

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();
     });
 });