@tramvai/cli 2.64.0 → 2.66.0

package/lib/typings/configEntry/application.d.ts

@@ -1,126 +1,121 @@
-import type { ConfigEntry, Experiments } from './common';
-import type { CheckAsyncTsConfig } from './CheckAsyncTsConfig';
-export interface ApplicationBuild {
+import type { ForkTsCheckerWebpackPluginOptions } from 'fork-ts-checker-webpack-plugin/lib/ForkTsCheckerWebpackPluginOptions';
+import type { CliConfigEntry, Experiments } from './cli';
+import type { OverridableOption } from './common';
+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'] & {
-        /**
-         * @title Separate one common chunk to many small dynamic chunks
-         * @default true
-         */
-        granularChunks?: boolean;
-        /**
-         * @title Move module to shared chunk if used at least as many times in other chunks
-         * @default 2
-         */
-        granularChunksSplitNumber?: number;
+    fileSystemPages: {
         /**
-         * @title Minimum shared chunk size in bytes
-         * @default 20000
-         */
-        granularChunksMinSize?: number;
-        /**
-         * @title Enable auto chunk splitting (`granularChunks` option alternative)
-         * @default false
-         */
-        commonChunk?: boolean;
-        /**
-         * @title Move module to common chunk if used at least as many times in other chunks
-         * @default 3
-         */
-        commonChunkSplitNumber?: number;
-        /**
-         * @title Configuration for fork-ts-checker-webpack-plugin
+         * @title Read pages from file system
          * @default false
          */
-        checkAsyncTs?: boolean | CheckAsyncTsConfig;
+        enabled: boolean;
         /**
-         * @title Pass list to Webpack config externals field
-         * @default []
+         * @title Folder with pages from which static routers are generated
+         * @default "routes"
          */
-        externals?: string[];
+        routesDir: string | false;
         /**
-         * @default {"config": "postcss.config"}
+         * @title Folder with components which can be manually added to static routers
+         * @default "pages"
          */
-        postcss?: ConfigEntry['commands']['build']['configurations']['postcss'];
+        pagesDir: string | false;
     };
-}
-export type ApplicationServe = ConfigEntry['commands']['serve'] & {
     /**
+     * @title Configure the options on webpack splitChunks
      * @default {}
      */
-    configurations?: ConfigEntry['commands']['serve']['configurations'] & {
+    splitChunks: {
         /**
-         * @title Pass list to Webpack config externals field
-         * @default ["react$", "react-dom", "prop-types", "express", "core-js"]
+         * @default "granularChunks"
          */
-        externals?: string[];
+        mode: 'granularChunks' | 'commonChunk' | false;
         /**
-         * @default {}
+         * @title Move module to shared chunk if used at least as many times in other chunks
+         * @default 2
          */
-        experiments?: Experiments & {
-            /**
-             * @title How to run server build
-             * @default "process"
-             */
-            serverRunner?: 'process' | 'thread';
-        };
-    };
-};
-export interface ApplicationConfigEntry extends ConfigEntry {
-    type: 'application';
-    /**
-     * @default {}
-     */
-    commands?: {
+        granularChunksSplitNumber: number;
         /**
-         * @default {}
+         * @title Minimum shared chunk size in bytes
+         * @default 20000
          */
-        build?: ApplicationBuild;
+        granularChunksMinSize: number;
         /**
-         * @default {}
+         * @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
          */
-        serve?: ApplicationServe;
+        commonChunkSplitNumber: number;
     };
+    /**
+     * @title Configuration for fork-ts-checker-webpack-plugin
+     * @default false
+     */
+    checkAsyncTs: boolean | CheckAsyncTsConfig;
+    /**
+     * @title Pass list to Webpack config externals field
+     * @default []
+     */
+    externals: OverridableOption<string[]>;
+    /**
+     * @title Experimental settings
+     * @default {}
+     */
+    experiments: ApplicationExperiments;
 }

package/lib/typings/configEntry/child-app.d.ts

@@ -1,38 +1,19 @@
-import type { ConfigEntry } from './common';
-export interface ChildAppBuild {
+import type { CliConfigEntry } from './cli';
+export interface ChildAppConfigEntry extends CliConfigEntry {
+    type: 'child-app';
     /**
-     * @default {}
+     * @title Path to build module assets
+     * @default "dist/child-app"
      */
-    options?: {
-        /**
-         * @title Path to build module assets
-         * @default "dist/child-app"
-         */
-        output?: string;
-    };
+    output: string;
     /**
      * @default {}
      */
-    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';
-    /**
-     * @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'];
     };
 }

package/lib/typings/configEntry/cli.d.ts

@@ -0,0 +1,254 @@
+import type { Configuration } from 'webpack';
+import type { DeduplicateStrategy } from '@tinkoff/webpack-dedupe-plugin';
+import type { ConfigEntry, OverridableOption } from './common';
+type Notifications = {
+    /**
+     * @title Defines when success notifications are shown
+     */
+    suppressSuccess?: false | true | 'always' | 'initial';
+    /**
+     * @title True to suppress the warning notifications, otherwise false
+     */
+    suppressWarning?: boolean;
+    /**
+     * @title True to activate (focus) the terminal window when a compilation error occurs
+     */
+    activateTerminalOnError?: boolean;
+};
+export type WebpackExperiments = Omit<Configuration['experiments'], 'buildHttp' | 'lazyCompilation' | 'css'> & {
+    /**
+     * @title Enable additional in-memory caching of modules which are unchanged and reference only unchanged modules.
+     * @default true
+     */
+    cacheUnaffected: boolean;
+    /**
+     * @title Enable backward compatibility with webpack previous major versions
+     * @default false
+     */
+    backCompat: boolean;
+};
+export type MinicssExperiments = {
+    /**
+     * @title Use a new webpack API to execute modules instead of child compilers. This improves performance and memory usage a lot.
+     * @default true
+     */
+    useImportModule: OverridableOption<boolean>;
+};
+export type TranspilationExperiments = {
+    /**
+     * @title specify loader to transpile js-ts code
+     * @default "babel"
+     */
+    loader: OverridableOption<'babel' | 'swc'>;
+};
+export interface Experiments {
+    /**
+     * @title experiments configuration for [webpack](https://webpack.js.org/configuration/experiments/)
+     * @default {}
+     */
+    webpack: WebpackExperiments;
+    /**
+     * @title experimental settings for [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin)
+     * @default {}
+     */
+    minicss: MinicssExperiments;
+    /**
+     * @title experimental settings for code transpilation
+     * @default {}
+     */
+    transpilation: TranspilationExperiments;
+}
+/**
+ * @default {}
+ * @additionalProperties true
+ */
+type Define = Record<string, string>;
+/**
+ * @tutorial
+ * - Common properties that are defined in the tramvai.json config file
+ * - These properties are later used to generate the json-schema
+ * - Although, some of the marked as required in typings they are anyway converted to optional
+ * while generating schema
+ * - you can provide default value with "@default" jsdoc in order to replace with default on schema validation
+ * - if you provide default value with "@default" mark the property as required to easier its usage in cli code
+ * - if the option doesn't have a default value mark it as optional to properly handle this case in cli code
+ * - to specify option that might be overridden for dev/prod environments specify its type as `OverridableOption<T>`. You can
+ * provide the default value either as single value (will be used in both envs) or in the form of { development: T, production: T } (to be able to
+ * provide defaults for all of the envs)
+ * - do not use `OverridableOption<T>` with complex types that has internal properties with "@default" as that defaults will not be set by ajv
+ */
+export interface CliConfigEntry extends ConfigEntry {
+    /**
+     * @title Enable source maps
+     * @default false
+     */
+    sourceMap: OverridableOption<boolean>;
+    /**
+     * @title Change different experimental cli settings
+     * @default {}
+     */
+    experiments: Experiments;
+    /**
+     * @title List of modules to exclude from `@babel/preset-env`
+     * @description Option doesn't affect build with swc loader
+     */
+    excludesPresetEnv?: string[];
+    /**
+     * @title Webpack's thread-loader config
+     * @additionalProperties true
+     */
+    threadLoader?: Record<string, unknown>;
+    /**
+     * @title Define static variables that should be replaced by name with provided value
+     * @default {}
+     */
+    define: {
+        shared: Define;
+        development: Define;
+        production: Define;
+    };
+    /**
+     * @title `@deprecated` will be removed in next major release.
+     * @default false
+     */
+    generateDataQaTag: boolean;
+    /**
+     * @title `@deprecated` will be removed in next major release. Включает использование плагина fill-action-name
+     * @default false
+     */
+    enableFillActionNamePlugin: boolean;
+    /**
+     * @default {}
+     */
+    postcss: {
+        /**
+         * @title Path to postcss config file. By default, `postcss.config.js` file is used
+         */
+        config?: string;
+        /**
+         * @title CSS identifiers build algorithm
+         */
+        cssLocalIdentName?: OverridableOption<string>;
+        /**
+         * @title Path to postcss config file for assets
+         */
+        assetsConfig?: string;
+        /**
+         * @title Enable CSS modules for all files matching /RegExp/i.test(filename) regexp.
+         */
+        cssModulePattern?: string;
+    };
+    /**
+     * @title `@deprecated` as cli now supports baseUrl and paths from the app's tsconfig.json file.
+     * Just check or add configuration to your tsconfig file and remove alias from tramvai.json
+     * @additionalProperties true
+     */
+    alias?: Record<string, any>;
+    /**
+     * @title svgo-loader options
+     */
+    svgo?: {
+        /**
+         * @title svgo plugins
+         */
+        plugins?: Array<any>;
+    };
+    /**
+     * @title Settings for image-webpack-loader
+     */
+    imageOptimization?: {
+        /**
+         * @title Enable image-webpack-loader
+         */
+        enabled?: boolean;
+        /**
+         * @title Pass options to image-webpack-loader
+         * @additionalProperties true
+         */
+        options?: Record<string, any>;
+    };
+    /**
+     * @title transpile libs based only on %40tinkoff/is-modern-lib
+     * @default true
+     */
+    transpileOnlyModernLibs: boolean;
+    /**
+     * @title Webpack specific settings
+     * @default {}
+     */
+    webpack: {
+        /**
+         * @title Browser package resolve aliases. E.g. { "stream": "stream-browserify" }
+         * @additionalProperties true
+         */
+        resolveAlias?: Record<string, string>;
+        /**
+         * @title Browser packages to provide with ProvidePlugin. E.g. { "Buffer": ["buffer", "Buffer"] }
+         * @additionalProperties true
+         */
+        provide?: Record<string, any>;
+    };
+    /**
+     * @title Enable DedupePlugin
+     * @default {}
+     */
+    dedupe: {
+        /**
+         * @title Strategy for DedupePlugin
+         * @default true
+         */
+        enabled: boolean;
+        /**
+         * @title Strategy for DedupePlugin
+         * @default "equality"
+         */
+        strategy: DeduplicateStrategy;
+        /**
+         * @title Sets ignore to DedupePlugin
+         */
+        ignore?: string[];
+    };
+    /**
+     * @title terser settings
+     * @default {}
+     */
+    terser: {
+        /**
+         * @title Configuration for enabling parallel compression for terser plugin
+         * @default true
+         */
+        parallel: boolean;
+    };
+    /**
+     * @title Set minimizer for css
+     * @default "css-minimizer"
+     */
+    cssMinimize: 'csso' | 'css-minimizer';
+    /**
+     * @title React hot-refresh
+     * @default {}
+     */
+    hotRefresh: {
+        /**
+         * @title Enable react hot-refresh
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * @title Configure react hot-refresh https://github.com/pmmmwh/react-refresh-webpack-plugin#options
+         */
+        options?: {
+            overlay?: boolean | Record<string, any>;
+            [key: string]: any;
+        };
+    };
+    /**
+     * @title Controls build notifications settings during development
+     * @default {}
+     */
+    notifications: Notifications & {
+        client?: Notifications;
+        server?: Notifications;
+    };
+}
+export {};

package/lib/typings/configEntry/{CheckAsyncTsConfig.js → cli.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CheckAsyncTsConfig.js.map
+//# sourceMappingURL=cli.js.map

package/lib/typings/configEntry/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/typings/configEntry/cli.ts"],"names":[],"mappings":""}