@tramvai/cli 2.64.0 → 2.66.0

package/src/library/webpack/utils/transpiler.ts

@@ -5,6 +5,7 @@ import { getSwcOptions } from '../../swc';
 import babelConfig from '../../babel';
 import type { Env } from '../../../typings/Env';
 import type { Target } from '../../../typings/target';
+import type { CliConfigEntry } from '../../../typings/configEntry/cli';
 
 export type TranspilerConfig = {
   env: Env;
@@ -25,7 +26,7 @@ export type TranspilerConfig = {
 };
 
 export const addTranspilerLoader = (
-  configManager: ConfigManager,
+  configManager: ConfigManager<CliConfigEntry>,
   rule: Config.Use,
   transpilerConfig: TranspilerConfig
 ) => {
@@ -49,16 +50,10 @@ Please run "tramvai add --dev @tramvai/swc-integration" to fix the problem
 };
 
 export const getTranspilerConfig = (
-  configManager: ConfigManager,
+  configManager: ConfigManager<CliConfigEntry>,
   overrideOptions: Partial<TranspilerConfig> = {}
 ): TranspilerConfig => {
-  const {
-    generateDataQaTag,
-    alias,
-    removeTypeofWindow,
-    enableFillActionNamePlugin,
-    excludesPresetEnv,
-  } = configManager.build.configurations;
+  const { generateDataQaTag, alias, enableFillActionNamePlugin, excludesPresetEnv } = configManager;
   const { env, modern } = configManager;
 
   return {
@@ -68,8 +63,8 @@ export const getTranspilerConfig = (
     modern,
     alias,
     tramvai: true,
-    removeTypeofWindow,
-    hot: configManager.hotRefresh,
+    removeTypeofWindow: true,
+    hot: !!configManager.hotRefresh.enabled,
     excludesPresetEnv,
     enableFillActionNamePlugin,
     rootDir: configManager.rootDir,

package/src/library/webpack/utils/workersPool.ts

@@ -2,6 +2,7 @@ import * as threadLoader from 'thread-loader';
 import { getPool } from 'thread-loader/dist/workerPools';
 import os from 'os';
 import type { ConfigManager } from '../../../config/configManager';
+import type { CliConfigEntry } from '../../../typings/configEntry/cli';
 
 // fork https://github.com/webpack-contrib/thread-loader/blob/76535bfaafd70bd1ec50e66541d2ad8a64175880/src/workerPools.js#L6
 function getCpuNumber() {
@@ -15,17 +16,13 @@ function calculateNumberOfWorkers() {
   return Math.max(1, cpus / 2 - 1);
 }
 
-const getCustomConfig = (configManager: ConfigManager) => {
-  const {
-    build: {
-      configurations: { threadLoader: additionalConfig },
-    },
-  } = configManager;
+const getCustomConfig = (configManager: ConfigManager<CliConfigEntry>): any => {
+  const { threadLoader: additionalConfig } = configManager;
 
   return additionalConfig || {};
 };
 
-const createTranspilerConfig = (configManager: ConfigManager) => {
+const createTranspilerConfig = (configManager: ConfigManager<CliConfigEntry>) => {
   return {
     name: 'transpiler',
     poolTimeout: configManager.env === 'development' ? Infinity : undefined,
@@ -34,7 +31,7 @@ const createTranspilerConfig = (configManager: ConfigManager) => {
   };
 };
 
-export const createWorkerPoolTranspiler = (configManager: ConfigManager) => {
+export const createWorkerPoolTranspiler = (configManager: ConfigManager<CliConfigEntry>) => {
   const config = createTranspilerConfig(configManager);
 
   if (!(createWorkerPoolTranspiler as any).warmup) {
@@ -56,6 +53,6 @@ export const createWorkerPoolTranspiler = (configManager: ConfigManager) => {
   return config;
 };
 
-export const closeWorkerPoolTranspiler = (configManager: ConfigManager) => {
+export const closeWorkerPoolTranspiler = (configManager: ConfigManager<CliConfigEntry>) => {
   getPool(createTranspilerConfig(configManager))?.disposeWorkers();
 };

package/src/models/config.spec.ts

@@ -0,0 +1,352 @@
+import { ConfigManager } from './config';
+
+const syncConfigFile = jest.fn();
+
+it('should populate defaults for config', () => {
+  const config: any = {
+    projects: {
+      app: {
+        name: 'test-app',
+        root: 'src',
+        type: 'application',
+      },
+      'child-app': {
+        name: 'test-child-app',
+        root: 'packages/child-app',
+        type: 'child-app',
+      },
+    },
+  };
+
+  const configManager = new ConfigManager({ config, syncConfigFile });
+
+  expect(configManager.config).toMatchInlineSnapshot(`
+    {
+      "projects": {
+        "app": {
+          "checkAsyncTs": false,
+          "cssMinimize": "css-minimizer",
+          "dedupe": {
+            "enabled": true,
+            "strategy": "equality",
+          },
+          "define": {
+            "development": {},
+            "production": {},
+            "shared": {},
+          },
+          "enableFillActionNamePlugin": false,
+          "experiments": {
+            "minicss": {
+              "useImportModule": true,
+            },
+            "serverRunner": "process",
+            "transpilation": {
+              "loader": "babel",
+            },
+            "webpack": {
+              "backCompat": false,
+              "cacheUnaffected": true,
+            },
+          },
+          "externals": [],
+          "fileSystemPages": {
+            "enabled": false,
+            "pagesDir": "pages",
+            "routesDir": "routes",
+          },
+          "generateDataQaTag": false,
+          "hotRefresh": {
+            "enabled": true,
+          },
+          "modern": true,
+          "name": "test-app",
+          "notifications": {},
+          "output": {
+            "client": "dist/client",
+            "server": "dist/server",
+            "static": "dist/static",
+          },
+          "postcss": {},
+          "root": "src",
+          "serverApiDir": "src/api",
+          "sourceMap": false,
+          "splitChunks": {
+            "commonChunkSplitNumber": 3,
+            "granularChunksMinSize": 20000,
+            "granularChunksSplitNumber": 2,
+            "mode": "granularChunks",
+          },
+          "terser": {
+            "parallel": true,
+          },
+          "transpileOnlyModernLibs": true,
+          "type": "application",
+          "webpack": {},
+        },
+        "child-app": {
+          "cssMinimize": "css-minimizer",
+          "dedupe": {
+            "enabled": true,
+            "strategy": "equality",
+          },
+          "define": {
+            "development": {},
+            "production": {},
+            "shared": {},
+          },
+          "enableFillActionNamePlugin": false,
+          "experiments": {
+            "minicss": {
+              "useImportModule": true,
+            },
+            "transpilation": {
+              "loader": "babel",
+            },
+            "webpack": {
+              "backCompat": false,
+              "cacheUnaffected": true,
+            },
+          },
+          "generateDataQaTag": false,
+          "hotRefresh": {
+            "enabled": true,
+          },
+          "name": "test-child-app",
+          "notifications": {},
+          "output": "dist/child-app",
+          "postcss": {
+            "cssLocalIdentName": "[hash:base64:5]",
+          },
+          "root": "packages/child-app",
+          "sourceMap": false,
+          "terser": {
+            "parallel": true,
+          },
+          "transpileOnlyModernLibs": true,
+          "type": "child-app",
+          "webpack": {},
+        },
+      },
+    }
+  `);
+});
+
+it('should populate defaults for overridable options', () => {
+  const config: any = {
+    projects: {
+      app: {
+        name: 'test-app',
+        root: 'src',
+        type: 'application',
+        output: {
+          client: 'assets/compiled',
+        },
+        sourceMap: false,
+        externals: ['test'],
+        fileSystemPages: { enabled: true },
+        experiments: {
+          webpack: {
+            backCompat: true,
+          },
+          transpilation: {
+            loader: {
+              development: 'swc',
+            },
+          },
+        },
+        dedupe: {
+          strategy: 'semver',
+        },
+        define: {
+          shared: {
+            'process.env.APP_ID': 'app',
+          },
+        },
+        svgo: {
+          plugins: [
+            {
+              'test-plugin': true,
+            },
+          ],
+        },
+      },
+      'child-app': {
+        name: 'test-child-app',
+        root: 'packages/child-app',
+        type: 'child-app',
+        sourceMap: {
+          development: true,
+        },
+        experiments: {
+          transpilation: {
+            loader: {},
+          },
+        },
+        define: {
+          shared: {
+            commonProp: 'unknown',
+          },
+          production: {
+            'process.env.PROD': 'true',
+          },
+        },
+        webpack: {
+          resolveAlias: {
+            stream: 'browser-stream',
+          },
+          provide: {
+            Buffer: ['buffer', 'Buffer'],
+          },
+        },
+      },
+    },
+  };
+
+  const configManager = new ConfigManager({ config, syncConfigFile });
+
+  expect(configManager.config).toMatchInlineSnapshot(`
+    {
+      "projects": {
+        "app": {
+          "checkAsyncTs": false,
+          "cssMinimize": "css-minimizer",
+          "dedupe": {
+            "enabled": true,
+            "strategy": "semver",
+          },
+          "define": {
+            "development": {},
+            "production": {},
+            "shared": {
+              "process.env.APP_ID": "app",
+            },
+          },
+          "enableFillActionNamePlugin": false,
+          "experiments": {
+            "minicss": {
+              "useImportModule": true,
+            },
+            "serverRunner": "process",
+            "transpilation": {
+              "loader": {
+                "development": "swc",
+                "production": "babel",
+              },
+            },
+            "webpack": {
+              "backCompat": true,
+              "cacheUnaffected": true,
+            },
+          },
+          "externals": [
+            "test",
+          ],
+          "fileSystemPages": {
+            "enabled": true,
+            "pagesDir": "pages",
+            "routesDir": "routes",
+          },
+          "generateDataQaTag": false,
+          "hotRefresh": {
+            "enabled": true,
+          },
+          "modern": true,
+          "name": "test-app",
+          "notifications": {},
+          "output": {
+            "client": "assets/compiled",
+            "server": "dist/server",
+            "static": "dist/static",
+          },
+          "postcss": {},
+          "root": "src",
+          "serverApiDir": "src/api",
+          "sourceMap": false,
+          "splitChunks": {
+            "commonChunkSplitNumber": 3,
+            "granularChunksMinSize": 20000,
+            "granularChunksSplitNumber": 2,
+            "mode": "granularChunks",
+          },
+          "svgo": {
+            "plugins": [
+              {
+                "test-plugin": true,
+              },
+            ],
+          },
+          "terser": {
+            "parallel": true,
+          },
+          "transpileOnlyModernLibs": true,
+          "type": "application",
+          "webpack": {},
+        },
+        "child-app": {
+          "cssMinimize": "css-minimizer",
+          "dedupe": {
+            "enabled": true,
+            "strategy": "equality",
+          },
+          "define": {
+            "development": {},
+            "production": {
+              "process.env.PROD": "true",
+            },
+            "shared": {
+              "commonProp": "unknown",
+            },
+          },
+          "enableFillActionNamePlugin": false,
+          "experiments": {
+            "minicss": {
+              "useImportModule": true,
+            },
+            "transpilation": {
+              "loader": {
+                "development": "babel",
+                "production": "babel",
+              },
+            },
+            "webpack": {
+              "backCompat": false,
+              "cacheUnaffected": true,
+            },
+          },
+          "generateDataQaTag": false,
+          "hotRefresh": {
+            "enabled": true,
+          },
+          "name": "test-child-app",
+          "notifications": {},
+          "output": "dist/child-app",
+          "postcss": {
+            "cssLocalIdentName": "[hash:base64:5]",
+          },
+          "root": "packages/child-app",
+          "sourceMap": {
+            "development": true,
+            "production": false,
+          },
+          "terser": {
+            "parallel": true,
+          },
+          "transpileOnlyModernLibs": true,
+          "type": "child-app",
+          "webpack": {
+            "provide": {
+              "Buffer": [
+                "buffer",
+                "Buffer",
+              ],
+            },
+            "resolveAlias": {
+              "stream": "browser-stream",
+            },
+          },
+        },
+      },
+    }
+  `);
+});

package/src/models/config.ts

@@ -1,19 +1,20 @@
 import Ajv from 'ajv';
+import isObject from '@tinkoff/utils/is/object';
+import isEmpty from '@tinkoff/utils/is/empty';
 import clone from '@tinkoff/utils/clone';
 import type { Config, SyncJsonFile } from '../typings/projectType';
 import type { ConfigEntry } from '../typings/configEntry/common';
+import { isOverridableOption } from '../typings/configEntry/common';
 import { getTramvaiConfig } from '../utils/getTramvaiConfig';
 import { merge } from '../utils/merge';
 import { schema } from '../schema/tramvai';
 
 export class ConfigManager {
-  private readonly defaultConfigFileName = 'platform.json';
-
   config: Config;
 
   syncConfigFile: SyncJsonFile;
 
-  constructor({ config, syncConfigFile }) {
+  constructor({ config, syncConfigFile }: { config: Config; syncConfigFile: SyncJsonFile }) {
     this.config = config;
     this.syncConfigFile = syncConfigFile;
 
@@ -53,7 +54,7 @@ export class ConfigManager {
   }
 
   private updateConfig(config: Config): Promise<void> {
-    const { path, configName: configFileName = this.defaultConfigFileName } = getTramvaiConfig();
+    const { path } = getTramvaiConfig();
 
     return this.syncConfigFile({ path, newContent: config }).then(() => {
       this.set(config);
@@ -77,14 +78,45 @@ export class ConfigManager {
     Object.keys(configParameters.projects).forEach((projectName) => {
       const entry = configParameters.projects[projectName];
 
-      configParameters.projects[projectName] = merge(
-        projectsConfig,
-        projectsConfig[entry.type],
-        entry
-      );
+      configParameters.projects[projectName] = merge(projectsConfig, entry);
     });
 
     const ajv = new Ajv({ useDefaults: true });
+
+    ajv.addKeyword('cli_overridable', {
+      modifying: true,
+      errors: false,
+      validate(schemaValue, currentValue, propSchema) {
+        const defaultValue = (propSchema as any).default;
+
+        if (!isObject(currentValue)) {
+          return true;
+        }
+
+        let defaultDev = defaultValue;
+        let defaultProd = defaultValue;
+
+        if (isOverridableOption(defaultValue)) {
+          defaultDev = defaultValue.development;
+          defaultProd = defaultValue.production;
+        }
+
+        if (isOverridableOption(currentValue) || isEmpty(currentValue)) {
+          if (!currentValue.development) {
+            // eslint-disable-next-line no-param-reassign
+            currentValue.development = defaultDev;
+          }
+
+          if (!currentValue.production) {
+            // eslint-disable-next-line no-param-reassign
+            currentValue.production = defaultProd;
+          }
+        }
+
+        return true;
+      },
+    });
+
     const validate = ajv.compile(schema);
     const valid = validate(configParameters);
 

package/src/schema/ConfigSchema.ts

@@ -2,6 +2,17 @@ import type { ModuleConfigEntry } from '../typings/configEntry/module';
 import type { ApplicationConfigEntry } from '../typings/configEntry/application';
 import type { PackageConfigEntry } from '../typings/configEntry/package';
 import type { ChildAppConfigEntry } from '../typings/configEntry/child-app';
+import type { ConfigEntry, OverridableOption } from '../typings/configEntry/common';
+
+type ConvertOptionsToSchema<T> = T extends OverridableOption<infer U>
+  ? { development?: U; production?: U } | U
+  : T extends Record<string, any>
+  ? {
+      [key in keyof T]?: ConvertOptionsToSchema<T[key]>;
+    }
+  : T;
+
+export type ConvertToSchema<T extends ConfigEntry> = ConfigEntry & ConvertOptionsToSchema<T>;
 
 /**
  * Исходный интерфейс для генерации JSON Schema файла конфигурации.
@@ -14,8 +25,8 @@ import type { ChildAppConfigEntry } from '../typings/configEntry/child-app';
  * которые можно использовать как угодно, в том числе внутри conditional веток с ключевыми словами `if`, `then`, `else`
  */
 export type ConfigSchema = {
-  application: ApplicationConfigEntry;
-  module: ModuleConfigEntry;
-  'child-app': ChildAppConfigEntry;
-  package: PackageConfigEntry;
+  application: ConvertToSchema<ApplicationConfigEntry>;
+  module: ConvertToSchema<ModuleConfigEntry>;
+  'child-app': ConvertToSchema<ChildAppConfigEntry>;
+  package: ConvertToSchema<PackageConfigEntry>;
 };