@pega/dx-component-builder-sdk 0.1.0

package/src/tasks/bundle/builder/modules.js

@@ -0,0 +1,139 @@
+/* eslint-disable import/no-dynamic-require */
+
+import fs from 'fs';
+import path from 'path';
+import { createRequire } from 'module';
+
+import chalk from 'chalk';
+import resolve from 'resolve';
+
+import paths from './paths.js';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * Get additional module paths based on the baseUrl of a compilerOptions object.
+ *
+ * @param {Object} options
+ */
+function getAdditionalModulePaths(options = {}) {
+  const baseUrl = options.baseUrl;
+
+  if (!baseUrl) {
+    return '';
+  }
+
+  const baseUrlResolved = path.resolve(paths.appPath, baseUrl);
+
+  // We don't need to do anything if `baseUrl` is set to `node_modules`. This is
+  // the default behavior.
+  if (path.relative(paths.appNodeModules, baseUrlResolved) === '') {
+    return null;
+  }
+
+  // Allow the user set the `baseUrl` to `appSrc`.
+  if (path.relative(paths.appSrc, baseUrlResolved) === '') {
+    return [paths.appSrc];
+  }
+
+  // If the path is equal to the root directory we ignore it here.
+  // We don't want to allow importing from the root directly as source files are
+  // not transpiled outside of `src`. We do allow importing them with the
+  // absolute path (e.g. `src/Components/Button.js`) but we set that up with
+  // an alias.
+  if (path.relative(paths.appPath, baseUrlResolved) === '') {
+    return null;
+  }
+
+  // Otherwise, throw an error.
+  throw new Error(
+    chalk.red.bold(
+      "Your project's `baseUrl` can only be set to `src` or `node_modules`." +
+        ' Create React App does not support other values at this time.'
+    )
+  );
+}
+
+/**
+ * Get webpack aliases based on the baseUrl of a compilerOptions object.
+ *
+ * @param {*} options
+ */
+function getWebpackAliases(options = {}) {
+  const baseUrl = options.baseUrl;
+
+  if (!baseUrl) {
+    return {};
+  }
+
+  const baseUrlResolved = path.resolve(paths.appPath, baseUrl);
+
+  if (path.relative(paths.appPath, baseUrlResolved) === '') {
+    return {
+      src: paths.appSrc
+    };
+  }
+}
+
+/**
+ * Get jest aliases based on the baseUrl of a compilerOptions object.
+ *
+ * @param {*} options
+ */
+function getJestAliases(options = {}) {
+  const baseUrl = options.baseUrl;
+
+  if (!baseUrl) {
+    return {};
+  }
+
+  const baseUrlResolved = path.resolve(paths.appPath, baseUrl);
+
+  if (path.relative(paths.appPath, baseUrlResolved) === '') {
+    return {
+      '^src/(.*)$': '<rootDir>/src/$1'
+    };
+  }
+}
+
+function getModules() {
+  // Check if TypeScript is setup
+  const hasTsConfig = fs.existsSync(paths.appTsConfig);
+  const hasJsConfig = fs.existsSync(paths.appJsConfig);
+
+  if (hasTsConfig && hasJsConfig) {
+    throw new Error(
+      'You have both a tsconfig.json and a jsconfig.json. If you are using TypeScript please remove your jsconfig.json file.'
+    );
+  }
+
+  let config;
+
+  // If there's a tsconfig.json we assume it's a
+  // TypeScript project and set up the config
+  // based on tsconfig.json
+  if (hasTsConfig) {
+    const ts = require(resolve.sync('typescript', {
+      basedir: paths.appNodeModules
+    }));
+    config = ts.readConfigFile(paths.appTsConfig, ts.sys.readFile).config;
+    // Otherwise we'll check if there is jsconfig.json
+    // for non TS projects.
+  } else if (hasJsConfig) {
+    config = require(paths.appJsConfig);
+  }
+
+  config = config || {};
+  const options = config.compilerOptions || {};
+
+  const additionalModulePaths = getAdditionalModulePaths(options);
+
+  return {
+    additionalModulePaths,
+    webpackAliases: getWebpackAliases(options),
+    jestAliases: getJestAliases(options),
+    hasTsConfig
+  };
+}
+
+module.exports = getModules();

package/src/tasks/bundle/builder/paths.js

@@ -0,0 +1,50 @@
+import path from 'path';
+import fs from 'fs';
+
+// Make sure any symlinks in the project folder are resolved:
+// https://github.com/facebook/create-react-app/issues/637
+const appDirectory = fs.realpathSync(process.cwd());
+const resolveApp = relativePath => path.resolve(appDirectory, relativePath);
+
+const buildPath = 'dist/components';
+
+export const moduleFileExtensions = [
+  'web.mjs',
+  'mjs',
+  'web.js',
+  'js',
+  'web.ts',
+  'ts',
+  'web.tsx',
+  'tsx',
+  'json',
+  'web.jsx',
+  'jsx'
+];
+
+// Resolve file paths in the same order as webpack
+const resolveModule = (resolveFn, filePath) => {
+  const extension = moduleFileExtensions.find(ext =>
+    fs.existsSync(resolveFn(`${filePath}.${ext}`))
+  );
+
+  if (extension) {
+    return resolveFn(`${filePath}.${extension}`);
+  }
+
+  return resolveFn(`${filePath}.js`);
+};
+
+// config after eject: we're in ./config/
+export default {
+  dotenv: resolveApp('.env'),
+  appPath: resolveApp('.'),
+  appBuild: resolveApp(buildPath),
+  appPublic: resolveApp('public'),
+  appIndexJs: resolveModule(resolveApp, 'src/index'),
+  appPackageJson: resolveApp('package.json'),
+  appSrc: resolveApp('src'),
+  appTsConfig: resolveApp('tsconfig.json'),
+  appJsConfig: resolveApp('jsconfig.json'),
+  appNodeModules: resolveApp('node_modules')
+};

package/src/tasks/bundle/builder/webpack.config.js

@@ -0,0 +1,336 @@
+import { createRequire } from 'module';
+
+import webpack from 'webpack';
+import TerserPlugin from 'terser-webpack-plugin';
+import MiniCssExtractPlugin from 'mini-css-extract-plugin';
+import CssMinimizerPlugin from 'css-minimizer-webpack-plugin';
+import getCSSModuleLocalIdent from 'react-dev-utils/getCSSModuleLocalIdent.js';
+import ModuleNotFoundPlugin from 'react-dev-utils/ModuleNotFoundPlugin.js';
+import CompressionPlugin from 'compression-webpack-plugin';
+
+import paths from './paths.js';
+
+const require = createRequire(import.meta.url);
+
+// const appPackageJson = require(paths.appPackageJson);
+
+// Source maps are resource heavy and can cause out of memory issue for large source files.
+
+const compressionBRConfObj = {
+  filename: '[path][base].br',
+  algorithm: 'brotliCompress',
+  test: /\.(js|css|html|svg|png|jpg|woff|woff2)$/,
+  compressionOptions: { level: 11 }
+};
+
+/* For gzip use below */
+const compressionGZConfObj = {
+  filename: '[path][base].gz',
+  algorithm: 'gzip',
+  test: /\.(js|css|html|svg|png|jpg|woff|woff2)$/,
+  compressionOptions: { level: 9 }
+};
+
+let shouldUseSourceMap = process.env.SOURCE_MAP;
+
+const imageInlineSizeLimit = Number.parseInt(process.env.IMAGE_INLINE_SIZE_LIMIT || '10000', 10);
+
+// style files regex
+const cssRegex = /\.css$/;
+const cssModuleRegex = /\.module\.css$/;
+const sassRegex = /\.(scss|sass)$/;
+const sassModuleRegex = /\.module\.(scss|sass)$/;
+
+// This is the production and development configuration.
+// It is focused on developer experience, fast rebuilds, and a minimal bundle.
+export default (
+  webpackEnv,
+  // eslint-disable-next-line no-unused-vars
+  { inputFile, outputFile, componentKey, externals, globals, sourceMap, devBuild }
+) => {
+  const isEnvDevelopment = webpackEnv === 'development' || devBuild;
+  const isEnvProduction = webpackEnv === 'production';
+  sourceMap = sourceMap === 'true';
+  shouldUseSourceMap = shouldUseSourceMap || sourceMap;
+
+  // common function to get style loaders
+  const getStyleLoaders = (cssOptions, preProcessor) => {
+    const loaders = [
+      isEnvProduction && {
+        loader: MiniCssExtractPlugin.loader
+      },
+      {
+        loader: require.resolve('css-loader'),
+        options: cssOptions
+      },
+      {
+        // Options for PostCSS as we reference these options twice
+        // Adds vendor prefixing based on your specified browser support in
+        // package.json
+        loader: require.resolve('postcss-loader'),
+        options: {
+          postcssOptions: {
+            plugins: [
+              [
+                'postcss-preset-env',
+                {
+                  // Options
+                }
+              ]
+            ]
+          },
+          sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment
+        }
+      }
+    ].filter(Boolean);
+    if (preProcessor) {
+      loaders.push(
+        {
+          loader: require.resolve('resolve-url-loader'),
+          options: {
+            sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
+            root: paths.appSrc
+          }
+        },
+        {
+          loader: require.resolve(preProcessor),
+          options: {
+            sourceMap: true
+          }
+        }
+      );
+    }
+    return loaders;
+  };
+  return {
+    mode: devBuild ? 'development' : 'production',
+    // Stop compilation early in production
+    bail: isEnvProduction,
+    // These are the "entry points" to our application.
+    // This means they will be the "root" imports that are included in JS bundle.
+    entry: inputFile,
+    devtool: devBuild ? 'eval-cheap-module-source-map' : false,
+    output: {
+      // The build folder.
+      path: paths.appBuild,
+      // There will be one main bundle, and one file per asynchronous chunk.
+      // In development, it does not produce real files.
+      filename: isEnvProduction
+        ? `${componentKey}/${componentKey}.js`
+        : isEnvDevelopment && `${componentKey}/${componentKey}.js`,
+      chunkFilename: isEnvProduction
+        ? `${componentKey}/js/[name].[contenthash:8].chunk.js`
+        : isEnvDevelopment && `${componentKey}/js/[name].chunk.js`,
+      library: {
+        name: componentKey,
+        type: 'umd',
+        export: 'default'
+      }
+    },
+    optimization: {
+      minimize: isEnvProduction,
+      minimizer: [new TerserPlugin(), new CssMinimizerPlugin()]
+    },
+    resolve: {
+      plugins: [],
+      extensions: ['.tsx', '.ts', '.js']
+    },
+    resolveLoader: {
+      plugins: []
+    },
+    module: {
+      strictExportPresence: true,
+      rules: [
+        {
+          // "oneOf" will traverse all following loaders until one will
+          // match the requirements. When no loader matches it will fall
+          // back to the "file" loader at the end of the loader list.
+          oneOf: [
+            // TODO: Merge this config once `image/avif` is in the mime-db
+            // https://github.com/jshttp/mime-db
+            {
+              test: [/\.avif$/],
+              loader: require.resolve('url-loader'),
+              options: {
+                limit: imageInlineSizeLimit,
+                mimetype: 'image/avif',
+                name: `${componentKey}/media/[name].[hash:8].[ext]`
+              }
+            },
+            // "url" loader works like "file" loader except that it embeds assets
+            // smaller than specified limit in bytes as data URLs to avoid requests.
+            // A missing `test` is equivalent to a match.
+            {
+              test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/, /\.svg$/],
+              loader: require.resolve('url-loader'),
+              options: {
+                limit: imageInlineSizeLimit,
+                name: `${componentKey}/media/[name].[hash:8].[ext]`
+              }
+            },
+            // Process application JS with TS-Loader.
+            // The preset includes JSX, Flow, TypeScript, and some ESnext features.
+            {
+              test: /\.(js|mjs|jsx)$/,
+              include: paths.appSrc,
+              loader: 'ts-loader',
+              options: {
+                configFile: 'tsconfig.build.json'
+              },
+              exclude: /node_modules/
+            },
+
+            {
+              test: /\.(ts|tsx)$/,
+              loader: 'ts-loader',
+              options: {
+                configFile: 'tsconfig.build.json'
+              },
+              exclude: /node_modules/
+            },
+            // "postcss" loader applies autoprefixer to our CSS.
+            // "css" loader resolves paths in CSS and adds assets as dependencies.
+            // "style" loader turns CSS into JS modules that inject <style> tags.
+            // In production, we use MiniCSSExtractPlugin to extract that CSS
+            // to a file, but in development "style" loader enables hot editing
+            // of CSS.
+            // By default we support CSS Modules with the extension .module.css
+            {
+              test: cssRegex,
+              exclude: cssModuleRegex,
+              use: getStyleLoaders({
+                importLoaders: 1,
+                sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment
+              }),
+              // Don't consider CSS imports dead code even if the
+              // containing package claims to have no side effects.
+              // Remove this when webpack adds a warning or an error for this.
+              // See https://github.com/webpack/webpack/issues/6571
+              sideEffects: true
+            },
+            // Adds support for CSS Modules (https://github.com/css-modules/css-modules)
+            // using the extension .module.css
+            {
+              test: cssModuleRegex,
+              use: getStyleLoaders({
+                importLoaders: 1,
+                sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
+                modules: {
+                  getLocalIdent: getCSSModuleLocalIdent
+                }
+              })
+            },
+            // Opt-in support for SASS (using .scss or .sass extensions).
+            // By default we support SASS Modules with the
+            // extensions .module.scss or .module.sass
+            {
+              test: sassRegex,
+              exclude: sassModuleRegex,
+              use: getStyleLoaders(
+                {
+                  importLoaders: 3,
+                  sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment
+                },
+                'sass-loader'
+              ),
+              // Don't consider CSS imports dead code even if the
+              // containing package claims to have no side effects.
+              // Remove this when webpack adds a warning or an error for this.
+              // See https://github.com/webpack/webpack/issues/6571
+              sideEffects: true
+            },
+            // Adds support for CSS Modules, but using SASS
+            // using the extension .module.scss or .module.sass
+            {
+              test: sassModuleRegex,
+              use: getStyleLoaders(
+                {
+                  importLoaders: 3,
+                  sourceMap: isEnvProduction ? shouldUseSourceMap : isEnvDevelopment,
+                  modules: {
+                    getLocalIdent: getCSSModuleLocalIdent
+                  }
+                },
+                'sass-loader'
+              )
+            },
+            // "file" loader makes sure those assets get served by WebpackDevServer.
+            // When you `import` an asset, you get its (virtual) filename.
+            // In production, they would get copied to the `build` folder.
+            // This loader doesn't use a "test" so it will catch all modules
+            // that fall through the other loaders.
+            {
+              loader: require.resolve('file-loader'),
+              // Exclude `js` files to keep "css" loader working as it injects
+              // its runtime that would otherwise be processed through "file" loader.
+              // Also exclude `html` and `json` extensions so they get processed
+              // by webpack's internal loaders.
+              exclude: [/\.(js|mjs|jsx|ts|tsx)$/, /\.html$/, /\.json$/],
+              options: {
+                name: `${componentKey}/media/[name].[hash:8].[ext]`
+              }
+            }
+            // ** STOP ** Are you adding a new loader?
+            // Make sure to add the new loader(s) before the "file" loader.
+          ]
+        }
+      ]
+    },
+    plugins: [
+      // This gives some necessary context to module not found errors, such as
+      // the requesting resource.
+      new ModuleNotFoundPlugin(paths.appPath),
+      // Makes some environment variables available to the JS code, for example:
+      // if (process.env.NODE_ENV === 'production') { ... }. See `./env.js`.
+      // It is absolutely essential that NODE_ENV is set to production
+      // during a production build.
+      // Otherwise React will be compiled in the very slow development mode.
+      isEnvProduction &&
+        new webpack.DefinePlugin({
+          PRODUCTION: JSON.stringify(true)
+        }),
+      isEnvProduction &&
+        new MiniCssExtractPlugin({
+          // Options similar to the same options in webpackOptions.output
+          // both options are optional
+          filename: `${componentKey}/css/${componentKey}.[contenthash:8].css`,
+          chunkFilename: `${componentKey}/css/${componentKey}.[contenthash:8].chunk.css`
+        }),
+      // Moment.js is an extremely popular library that bundles large locale files
+      // by default due to how webpack interprets its code. This is a practical
+      // solution that requires the user to opt into importing specific locales.
+      // https://github.com/jmblog/how-to-optimize-momentjs-with-webpack
+      // You can remove this if you don't use Moment.js:
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/locale$/,
+        contextRegExp: /moment$/
+      }),
+      /* Ignore cosmos icons */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/icons$/,
+        contextRegExp: /@pega\/cosmos-react-core\/lib\/components\/Icon$/
+      }),
+
+      /* Ignore cosmos icons - windows */
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/icons$/,
+        contextRegExp: /@pega\\cosmos-react-core\\lib\\components\\Icon$/
+      }),
+
+      new webpack.optimize.LimitChunkCountPlugin({
+        maxChunks: 5
+      }),
+      new webpack.optimize.MinChunkSizePlugin({
+        minChunkSize: 100000 // Minimum number of characters
+      }),
+      !devBuild && new CompressionPlugin(compressionBRConfObj)
+
+      /* Dont generate gzip file */
+      /* isEnvProduction && new CompressionPlugin(compressionGZConfObj) */
+    ].filter(Boolean),
+    performance: {
+      hints: 'warning'
+    },
+    externals
+  };
+};

package/src/tasks/bundle/index.js

@@ -0,0 +1,65 @@
+import path from 'path';
+import fs from 'fs';
+import { stat } from 'fs/promises';
+
+import { BUILD_CONFIG_JSON_FILENAME } from '../../constants.js';
+import { getComponentDirectoryPath } from '../../util.js';
+
+import buildComponent from './builder/index.js';
+
+const extensions = ['ts', 'tsx', 'js', 'jsx'];
+
+const bundleComponent = async (componentKey, sourceMap, devBuild) => {
+  const componentDirectory = await getComponentDirectoryPath(componentKey);
+
+  const idx = (
+    await Promise.all(
+      extensions.map(ext =>
+        stat(path.join(componentDirectory, `index.${ext}`))
+          .then(() => true)
+          .catch(() => false)
+      )
+    )
+  ).findIndex(exists => exists);
+
+  if (idx === -1) throw new Error('Index file not found.');
+
+  const inputFile = path.join(componentDirectory, `index.${extensions[idx]}`);
+  const outputFile = `${componentKey}.js`;
+
+  let buildConfig = {};
+
+  if (fs.existsSync(BUILD_CONFIG_JSON_FILENAME)) {
+    buildConfig = JSON.parse(fs.readFileSync(BUILD_CONFIG_JSON_FILENAME, 'utf8'));
+  }
+
+  let externals = buildConfig.externals || [];
+  externals = {
+    react: 'React',
+    'react-dom': 'ReactDOM',
+    PCore: 'PCore',
+    ...buildConfig.externals
+  };
+
+  let globals = buildConfig.globals || {};
+
+  const defaultGlobals = {
+    react: 'React',
+    'react-dom': 'ReactDOM',
+    PCore: 'PCore',
+    ...buildConfig.globals
+  };
+
+  globals = { ...globals, ...defaultGlobals };
+  await buildComponent({
+    inputFile,
+    outputFile,
+    componentKey,
+    externals,
+    globals,
+    sourceMap,
+    devBuild
+  });
+};
+
+export default bundleComponent;