@tramvai/cli 2.63.0 → 2.65.9

package/src/schema/tramvai.spec.ts

@@ -14,51 +14,6 @@ describe('JSON schema для tramvai.json', () => {
     expect(() => ajv.compile(schema)).not.toThrow();
   });
 
-  it('Базовая конфигурация проходит валидацию схемы', () => {
-    const ajv = new Ajv({ allErrors: true });
-    const validate = ajv.compile(schema);
-
-    const baseConfig = {
-      projects: {
-        app: {
-          name: 'test-app',
-          root: 'src/app',
-          type: 'application',
-          commands: {
-            build: {
-              options: {},
-              configurations: {},
-            },
-            serve: {
-              configurations: {},
-              notifications: {},
-            },
-          },
-        },
-        module: {
-          name: 'test-module',
-          root: 'src/module',
-          type: 'module',
-          commands: {
-            build: {
-              options: {},
-              configurations: {},
-            },
-            serve: {
-              configurations: {},
-              notifications: {},
-            },
-          },
-        },
-      },
-    };
-
-    const valid = validate(baseConfig);
-
-    expect(valid).toBe(true);
-    expect(validate.errors).toBe(null);
-  });
-
   it('Применяет значения по умолчанию', () => {
     (resolve as any).mockReturnValue('mock');
     (requireResolve as any).mockReturnValue('mock');
@@ -85,165 +40,115 @@ describe('JSON schema для tramvai.json', () => {
     const valid = validate(config);
 
     expect(valid).toBe(true);
+    expect(validate.errors).toBe(null);
     expect(config).not.toEqual(originalConfig);
 
     expect(config).toMatchInlineSnapshot(`
       {
         "projects": {
           "app": {
-            "commands": {
-              "build": {
-                "configurations": {
-                  "checkAsyncTs": false,
-                  "commonChunk": false,
-                  "commonChunkSplitNumber": 3,
-                  "dedupe": "equality",
-                  "definePlugin": {
-                    "dev": {},
-                    "prod": {},
-                  },
-                  "enableFillActionNamePlugin": false,
-                  "experiments": {
-                    "minicss": {
-                      "useImportModule": true,
-                    },
-                    "transpilation": {
-                      "loader": "babel",
-                    },
-                    "webpack": {
-                      "backCompat": false,
-                      "cacheUnaffected": true,
-                    },
-                  },
-                  "externals": [],
-                  "fileSystemPages": {
-                    "enable": false,
-                    "pagesDir": "pages",
-                    "routesDir": "routes",
-                  },
-                  "generateDataQaTag": false,
-                  "granularChunks": true,
-                  "granularChunksMinSize": 20000,
-                  "granularChunksSplitNumber": 2,
-                  "modern": true,
-                  "postcss": {
-                    "config": "postcss.config",
-                  },
-                  "removeTypeofWindow": true,
-                  "sourceMap": false,
-                  "sourceMapServer": false,
-                  "terserParallel": true,
-                  "transpileOnlyModernLibs": true,
-                },
-                "options": {
-                  "outputClient": "dist/client",
-                  "outputServer": "dist/server",
-                  "outputStatic": "dist/static",
-                  "polyfill": "",
-                  "server": "src/server",
-                  "serverApiDir": "src/api",
-                },
+            "checkAsyncTs": false,
+            "cssMinimize": "css-minimizer",
+            "dedupe": {
+              "enabled": true,
+              "strategy": "equality",
+            },
+            "define": {
+              "development": {},
+              "production": {},
+              "shared": {},
+            },
+            "enableFillActionNamePlugin": false,
+            "experiments": {
+              "minicss": {
+                "useImportModule": true,
               },
-              "serve": {
-                "configurations": {
-                  "experiments": {
-                    "minicss": {
-                      "useImportModule": true,
-                    },
-                    "serverRunner": "process",
-                    "transpilation": {
-                      "loader": "babel",
-                    },
-                    "webpack": {
-                      "backCompat": false,
-                      "cacheUnaffected": true,
-                    },
-                  },
-                  "externals": [
-                    "react$",
-                    "react-dom",
-                    "prop-types",
-                    "express",
-                    "core-js",
-                  ],
-                  "hotRefresh": true,
-                  "modern": true,
-                  "sourceMap": false,
-                },
-                "notifications": {},
+              "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/app",
+            "serverApiDir": "src/api",
+            "sourceMap": false,
+            "splitChunks": {
+              "commonChunkSplitNumber": 3,
+              "granularChunksMinSize": 20000,
+              "granularChunksSplitNumber": 2,
+              "mode": "granularChunks",
+            },
+            "terser": {
+              "parallel": true,
+            },
+            "transpileOnlyModernLibs": true,
             "type": "application",
+            "webpack": {},
           },
           "module": {
-            "commands": {
-              "build": {
-                "configurations": {
-                  "dedupe": "equality",
-                  "definePlugin": {
-                    "dev": {},
-                    "prod": {},
-                  },
-                  "enableFillActionNamePlugin": false,
-                  "experiments": {
-                    "minicss": {
-                      "useImportModule": true,
-                    },
-                    "transpilation": {
-                      "loader": "babel",
-                    },
-                    "webpack": {
-                      "backCompat": false,
-                      "cacheUnaffected": true,
-                    },
-                  },
-                  "fileSystemPages": {
-                    "enable": false,
-                    "pagesDir": "pages",
-                    "routesDir": "routes",
-                  },
-                  "generateDataQaTag": false,
-                  "modern": true,
-                  "postcss": {
-                    "config": "postcss.config",
-                    "cssLocalIdentName": "[hash:base64:5]",
-                  },
-                  "removeTypeofWindow": true,
-                  "sourceMap": false,
-                  "sourceMapServer": false,
-                  "terserParallel": true,
-                  "transpileOnlyModernLibs": true,
-                },
-                "options": {
-                  "output": "dist/modules",
-                },
+            "cssMinimize": "css-minimizer",
+            "dedupe": {
+              "enabled": true,
+              "strategy": "equality",
+            },
+            "define": {
+              "development": {},
+              "production": {},
+              "shared": {},
+            },
+            "enableFillActionNamePlugin": false,
+            "experiments": {
+              "minicss": {
+                "useImportModule": true,
+              },
+              "transpilation": {
+                "loader": "babel",
               },
-              "serve": {
-                "configurations": {
-                  "experiments": {
-                    "minicss": {
-                      "useImportModule": true,
-                    },
-                    "transpilation": {
-                      "loader": "babel",
-                    },
-                    "webpack": {
-                      "backCompat": false,
-                      "cacheUnaffected": true,
-                    },
-                  },
-                  "hotRefresh": true,
-                  "modern": true,
-                  "sourceMap": false,
-                },
-                "notifications": {},
+              "webpack": {
+                "backCompat": false,
+                "cacheUnaffected": true,
               },
             },
+            "generateDataQaTag": false,
+            "hotRefresh": {
+              "enabled": true,
+            },
             "name": "test-module",
+            "notifications": {},
+            "output": "dist/modules",
+            "postcss": {
+              "cssLocalIdentName": "[hash:base64:5]",
+            },
             "root": "src/module",
+            "sourceMap": false,
+            "terser": {
+              "parallel": true,
+            },
+            "transpileOnlyModernLibs": true,
             "type": "module",
+            "webpack": {},
           },
         },
       }

package/src/typings/configEntry/application.ts

@@ -1,129 +1,127 @@
-import type { ConfigEntry, Experiments } from './common';
-import type { CheckAsyncTsConfig } from './CheckAsyncTsConfig';
+// eslint-disable-next-line no-restricted-imports
+import type { ForkTsCheckerWebpackPluginOptions } from 'fork-ts-checker-webpack-plugin/lib/ForkTsCheckerWebpackPluginOptions';
+import type { CliConfigEntry, Experiments } from './cli';
+import type { OverridableOption } from './common';
 
-export interface ApplicationBuild {
+export interface CheckAsyncTsConfig {
   /**
+   * при включении этого флага в build-сборку добавляется проверка типов
+   * при невалидных типах сборка падает
+   */
+  failOnBuild?: boolean;
+  /**
+   * дополнительные опции
+   * @link https://github.com/TypeStrong/fork-ts-checker-webpack-plugin
+   */
+  pluginOptions?: Partial<ForkTsCheckerWebpackPluginOptions>;
+}
+
+export interface ApplicationExperiments extends Experiments {
+  /**
+   * @title How to run server build
+   * @default "process"
+   */
+  serverRunner?: 'process' | 'thread';
+}
+
+export interface ApplicationConfigEntry extends CliConfigEntry {
+  type: 'application';
+  /**
+   * @title Path to polyfill file. By default, looks for the `src/polyfill`
+   */
+  polyfill?: string;
+  /**
+   * @title Path to folder with papi handlers
+   * @default "src/api"
+   */
+  serverApiDir: string;
+  /**
+   * @title Controls the cli output locations
    * @default {}
    */
-  options?: {
-    /**
-     * @title `@deprecated` Vendor is not used anymore
-     * @deprecated Vendor is not used anymore
-     */
-    vendor?: string;
-    /**
-     * @title Path to polyfill file
-     * @default ""
-     */
-    polyfill?: string;
-    /**
-     * @title Path to server entry point
-     * @default "src/server"
-     */
-    server?: string;
-    /**
-     * @title Path to folder with papi handlers
-     * @default "src/api"
-     */
-    serverApiDir?: string;
+  output: {
     /**
      * @title Path to build assets for server
      * @default "dist/server"
      */
-    outputServer?: string;
+    server: string;
     /**
      * @title Path to build assets for client
      * @default "dist/client"
      */
-    outputClient?: string;
+    client: string;
     /**
      * @title Path to build static assets
      * @default "dist/static"
      */
-    outputStatic?: string;
+    static: string;
   };
   /**
+   * @title Enable build for modern browsers
+   * @default true
+   */
+  modern?: boolean;
+
+  /**
+   * @title File-System Routing feature
    * @default {}
    */
-  configurations?: ConfigEntry['commands']['build']['configurations'] & {
+  fileSystemPages: {
     /**
-     * @title Separate one common chunk to many small dynamic chunks
-     * @default true
+     * @title Read pages from file system
+     * @default false
      */
-    granularChunks?: boolean;
+    enabled: boolean;
     /**
-     * @title Move module to shared chunk if used at least as many times in other chunks
-     * @default 2
+     * @title Folder with pages from which static routers are generated
+     * @default "routes"
      */
-    granularChunksSplitNumber?: number;
+    routesDir: string | false;
     /**
-     * @title Minimum shared chunk size in bytes
-     * @default 20000
+     * @title Folder with components which can be manually added to static routers
+     * @default "pages"
      */
-    granularChunksMinSize?: number;
-    /**
-     * @title Enable auto chunk splitting (`granularChunks` option alternative)
-     * @default false
-     */
-    commonChunk?: boolean;
+    pagesDir: string | false;
+  };
+  /**
+   * @title Configure the options on webpack splitChunks
+   * @default {}
+   */
+  splitChunks: {
     /**
-     * @title Move module to common chunk if used at least as many times in other chunks
-     * @default 3
+     * @default "granularChunks"
      */
-    commonChunkSplitNumber?: number;
+    mode: 'granularChunks' | 'commonChunk' | false;
     /**
-     * @title Configuration for fork-ts-checker-webpack-plugin
-     * @default false
+     * @title Move module to shared chunk if used at least as many times in other chunks
+     * @default 2
      */
-    checkAsyncTs?: boolean | CheckAsyncTsConfig;
+    granularChunksSplitNumber: number;
     /**
-     * @title Pass list to Webpack config externals field
-     * @default []
+     * @title Minimum shared chunk size in bytes
+     * @default 20000
      */
-    externals?: string[];
+    granularChunksMinSize: number;
     /**
-     * @default {"config": "postcss.config"}
+     * @title `@deprecated will be removed in next major release` Move module to common chunk if used at least as many times in other chunks
+     * @default 3
      */
-    postcss?: ConfigEntry['commands']['build']['configurations']['postcss'];
+    commonChunkSplitNumber: number;
   };
-}
-
-export type ApplicationServe = ConfigEntry['commands']['serve'] & {
   /**
-   * @default {}
+   * @title Configuration for fork-ts-checker-webpack-plugin
+   * @default false
    */
-  configurations?: ConfigEntry['commands']['serve']['configurations'] & {
-    /**
-     * @title Pass list to Webpack config externals field
-     * @default ["react$", "react-dom", "prop-types", "express", "core-js"]
-     */
-    externals?: string[];
-    /**
-     * @default {}
-     */
-    experiments?: Experiments & {
-      /**
-       * @title How to run server build
-       * @default "process"
-       */
-      serverRunner?: 'process' | 'thread';
-    };
-  };
-};
+  checkAsyncTs: boolean | CheckAsyncTsConfig;
 
-export interface ApplicationConfigEntry extends ConfigEntry {
-  type: 'application';
   /**
+   * @title Pass list to Webpack config externals field
+   * @default []
+   */
+  externals: OverridableOption<string[]>;
+  /**
+   * @title Experimental settings
    * @default {}
    */
-  commands?: {
-    /**
-     * @default {}
-     */
-    build?: ApplicationBuild;
-    /**
-     * @default {}
-     */
-    serve?: ApplicationServe;
-  };
+  experiments: ApplicationExperiments;
 }

package/src/typings/configEntry/child-app.ts

@@ -1,40 +1,20 @@
-import type { ConfigEntry } from './common';
+import type { CliConfigEntry } from './cli';
 
-export interface ChildAppBuild {
-  /**
-   * @default {}
-   */
-  options?: {
-    /**
-     * @title Path to build module assets
-     * @default "dist/child-app"
-     */
-    output?: string;
-  };
+export interface ChildAppConfigEntry extends CliConfigEntry {
+  type: 'child-app';
   /**
-   * @default {}
+   * @title Path to build module assets
+   * @default "dist/child-app"
    */
-  configurations?: ConfigEntry['commands']['build']['configurations'] & {
-    /**
-     * @default {"config": "postcss.config", "cssLocalIdentName": "[hash:base64:5]"}
-     */
-    postcss?: ConfigEntry['commands']['build']['configurations']['postcss'];
-  };
-}
-
-export interface ChildAppConfigEntry extends ConfigEntry {
-  type: 'child-app';
+  output: string;
   /**
    * @default {}
    */
-  commands?: {
-    /**
-     * @default {}
-     */
-    build?: ChildAppBuild;
+  postcss: CliConfigEntry['postcss'] & {
     /**
-     * @default {}
+     * @title CSS identifiers build algorithm
+     * @default "[hash:base64:5]"
      */
-    serve?: ConfigEntry['commands']['serve'];
+    cssLocalIdentName?: CliConfigEntry['postcss']['cssLocalIdentName'];
   };
 }