fix(client-electron): include every 3rd party license

fixes #205
marcincichocki · Sep 16, 2021 · 9dcfbce · 9dcfbce
1 parent 08919a9
commit 9dcfbce
Show file tree

Hide file tree

Showing 20 changed files with 478 additions and 310 deletions.
diff --git a/configs/common.ts b/configs/common.ts
@@ -1,50 +1,88 @@
 import { execSync } from 'child_process';
-import { LicenseWebpackPlugin } from 'license-webpack-plugin';
-import { DefinePlugin, RuleSetRule, WebpackPluginInstance } from 'webpack';
+import { join, resolve } from 'path';
+import TsconfigPathsPlugin from 'tsconfig-paths-webpack-plugin';
+import { Configuration, DefinePlugin } from 'webpack';
 
 function git(command: string) {
   return execSync(`git ${command}`, { encoding: 'utf-8' }).trim();
 }
 
 const pkg = require('../package.json');
 
-export const commonPlugins: WebpackPluginInstance[] = [
-  new DefinePlugin({
-    GIT_COMMIT_DATE: JSON.stringify(
-      git('log -1 --format=%cd --date=iso-strict')
-    ),
-    GIT_COMMIT_SHA: JSON.stringify(git('rev-parse HEAD')),
-    VERSION: JSON.stringify(pkg.version),
-    HOMEPAGE_URL: JSON.stringify(pkg.homepage),
-    BUGS_URL: JSON.stringify(pkg.bugs),
-    PRODUCT_NAME: JSON.stringify(pkg.build.productName),
-    APP_ID: JSON.stringify(pkg.build.appId),
-    BUILD_PLATFORM: JSON.stringify(process.platform),
-  }),
-  new LicenseWebpackPlugin({
-    outputFilename: 'THIRD_PARTY_LICENSES.txt',
-  }) as any,
-];
-
-export const commonRules: RuleSetRule[] = [
-  {
-    test: /\.tsx?$/,
-    exclude: /node_modules/,
-    loader: 'ts-loader',
-  },
-  {
-    test: /\.(ttf|svg|png)$/,
-    type: 'asset/resource',
-  },
-  {
-    test: /\.css$/,
-    use: ['style-loader', 'css-loader'],
-  },
-];
+export const defineConstantsPlugin = new DefinePlugin({
+  GIT_COMMIT_DATE: JSON.stringify(git('log -1 --format=%cd --date=iso-strict')),
+  GIT_COMMIT_SHA: JSON.stringify(git('rev-parse HEAD')),
+  VERSION: JSON.stringify(pkg.version),
+  HOMEPAGE_URL: JSON.stringify(pkg.homepage),
+  BUGS_URL: JSON.stringify(pkg.bugs),
+  PRODUCT_NAME: JSON.stringify(pkg.build.productName),
+  APP_ID: JSON.stringify(pkg.build.appId),
+  BUILD_PLATFORM: JSON.stringify(process.platform),
+});
+
+export const root = resolve(__dirname, '..');
 
 export function getCSPMetaTagConfig(content: string) {
   return {
     'http-equiv': 'Content-Security-Policy',
     content,
   };
 }
+
+type ConfigurationCallback = (
+  isProduction: boolean,
+  env: any,
+  options: any
+) => Configuration;
+
+export function getConfig(
+  configOrCallback: Configuration | ConfigurationCallback
+) {
+  return (env: any, options: any) => {
+    const defaultConfig: Configuration = {
+      mode: 'development',
+      context: join(root, './src/electron'),
+      output: {
+        path: join(root, 'dist'),
+        filename: '[name].js',
+      },
+      resolve: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
+        plugins: [new TsconfigPathsPlugin()],
+      },
+      module: {
+        rules: [
+          {
+            test: /\.tsx?$/,
+            exclude: /node_modules/,
+            loader: 'ts-loader',
+          },
+          {
+            test: /\.(ttf|svg|png)$/,
+            type: 'asset/resource',
+          },
+          {
+            test: /\.css$/,
+            use: ['style-loader', 'css-loader'],
+          },
+        ],
+      },
+      optimization: {
+        // NOTE: This allow WebpackLicensePlugin to work with ESNext module,
+        // which is required for treeshaking.
+        concatenateModules: false,
+      },
+    };
+
+    const isProduction = options.mode === 'production';
+    const config =
+      typeof configOrCallback === 'function'
+        ? configOrCallback(isProduction, env, options)
+        : configOrCallback;
+
+    return {
+      ...defaultConfig,
+      ...config,
+    };
+  };
+}
diff --git a/configs/webpack.config.main.ts b/configs/webpack.config.main.ts
@@ -1,22 +1,15 @@
-import { join } from 'path';
-import { TsconfigPathsPlugin } from 'tsconfig-paths-webpack-plugin';
-import webpack from 'webpack';
-import { commonPlugins, commonRules } from './common';
+import WebpackLicensePlugin from 'webpack-license-plugin';
+import { defineConstantsPlugin, getConfig } from './common';
 
-export const config: webpack.Configuration = {
-  mode: 'development',
-  entry: join(__dirname, '../src/electron/main/index.ts'),
+export const config = getConfig({
   target: 'electron-main',
-  resolve: {
-    extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
-    plugins: [new TsconfigPathsPlugin()],
+  entry: {
+    main: './main/index.ts',
   },
-  output: {
-    path: join(__dirname, '../dist'),
-    filename: 'main.js',
-  },
-  module: {
-    rules: [...commonRules],
-  },
-  plugins: [...commonPlugins],
-};
+  plugins: [
+    defineConstantsPlugin,
+    new WebpackLicensePlugin({
+      outputFilename: 'main-licenses.json',
+    }),
+  ],
+});
diff --git a/configs/webpack.config.preload.ts b/configs/webpack.config.preload.ts
@@ -1,22 +1,15 @@
-import { join } from 'path';
-import { TsconfigPathsPlugin } from 'tsconfig-paths-webpack-plugin';
-import webpack from 'webpack';
-import { commonPlugins, commonRules } from './common';
+import WebpackLicensePlugin from 'webpack-license-plugin';
+import { defineConstantsPlugin, getConfig } from './common';
 
-export const config: webpack.Configuration = {
-  mode: 'development',
-  entry: join(__dirname, '../src/electron/renderer/preload/index.ts'),
+export const config = getConfig({
   target: 'electron-preload',
-  output: {
-    path: join(__dirname, '../dist'),
-    filename: 'preload.js',
+  entry: {
+    preload: './renderer/preload/index.ts',
   },
-  resolve: {
-    extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
-    plugins: [new TsconfigPathsPlugin()],
-  },
-  module: {
-    rules: [...commonRules],
-  },
-  plugins: [...commonPlugins],
-};
+  plugins: [
+    defineConstantsPlugin,
+    new WebpackLicensePlugin({
+      outputFilename: 'preload-licenses.json',
+    }),
+  ],
+});
diff --git a/configs/webpack.config.renderer.ts b/configs/webpack.config.renderer.ts
@@ -1,35 +1,30 @@
 import HtmlWebpackPlugin from 'html-webpack-plugin';
-import { join } from 'path';
-import { TsconfigPathsPlugin } from 'tsconfig-paths-webpack-plugin';
-import webpack from 'webpack';
-import { commonPlugins, commonRules, getCSPMetaTagConfig } from './common';
+import WebpackLicensePlugin from 'webpack-license-plugin';
+import {
+  defineConstantsPlugin,
+  getConfig,
+  getCSPMetaTagConfig,
+} from './common';
 
 const pkg = require('../package.json');
 const allowedSources =
   "default-src 'none'; img-src data:; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; connect-src 'self' https:; font-src 'self';";
 const csp = getCSPMetaTagConfig(allowedSources);
 
-export const config: webpack.Configuration = {
-  mode: 'development',
-  entry: join(__dirname, '../src/electron/renderer/index.tsx'),
+export const config = getConfig({
   target: 'electron-renderer',
-  output: {
-    path: join(__dirname, '../dist'),
-    filename: 'renderer.js',
-  },
-  resolve: {
-    extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
-    plugins: [new TsconfigPathsPlugin()],
-  },
-  module: {
-    rules: [...commonRules],
+  entry: {
+    renderer: './renderer/index.tsx',
   },
   plugins: [
-    ...commonPlugins,
+    defineConstantsPlugin,
+    new WebpackLicensePlugin({
+      outputFilename: 'renderer-licenses.json',
+    }),
     new HtmlWebpackPlugin({
-      filename: 'renderer.html',
+      filename: '[name].html',
       title: pkg.build.productName,
       meta: { csp },
     }),
   ],
-};
+});
diff --git a/configs/webpack.config.worker.ts b/configs/webpack.config.worker.ts
@@ -1,33 +1,32 @@
 import HtmlWebpackPlugin from 'html-webpack-plugin';
 import { join } from 'path';
-import { TsconfigPathsPlugin } from 'tsconfig-paths-webpack-plugin';
-import webpack from 'webpack';
-import { commonPlugins, commonRules } from './common';
+import WebpackLicensePlugin from 'webpack-license-plugin';
+import { defineConstantsPlugin, getConfig, root } from './common';
 
-export const config: webpack.Configuration = {
-  mode: 'development',
-  entry: join(__dirname, '../src/electron/worker/index.ts'),
+const externalPackages = ['sharp', 'tesseract.js', 'screenshot-desktop'];
+const externalEnteries = externalPackages.map((n) => [n, `commonjs ${n}`]);
+const externals = Object.fromEntries(externalEnteries);
+
+function getAbsolutePathToExternalPackage(name: string) {
+  return join(root, 'node_modules', name);
+}
+
+export const config = getConfig({
   target: 'electron-renderer',
-  output: {
-    path: join(__dirname, '../dist'),
-    filename: 'worker.js',
-  },
-  resolve: {
-    extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
-    plugins: [new TsconfigPathsPlugin()],
-  },
-  module: {
-    rules: [...commonRules],
-  },
-  externals: {
-    sharp: 'commonjs sharp',
-    'tesseract.js': 'commonjs tesseract.js',
-    'screenshot-desktop': 'commonjs screenshot-desktop',
+  entry: {
+    worker: './worker/index.ts',
   },
+  externals,
   plugins: [
-    ...commonPlugins,
+    defineConstantsPlugin,
+    new WebpackLicensePlugin({
+      outputFilename: 'worker-licenses.json',
+      includePackages() {
+        return externalPackages.map(getAbsolutePathToExternalPackage);
+      },
+    }),
     new HtmlWebpackPlugin({
-      filename: 'worker.html',
+      filename: '[name].html',
     }),
   ],
-};
+});