@tramvai/cli 2.64.0 → 2.66.0

package/src/typings/configEntry/cli.ts

@@ -0,0 +1,271 @@
+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>;
+  };
+
+  // options that affect only production builds
+  /**
+   * @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';
+
+  // options that affect only development builds
+
+  /**
+   * @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;
+  };
+}

package/src/typings/configEntry/common.ts

@@ -1,293 +1,41 @@
-import type { Configuration } from 'webpack';
+import all from '@tinkoff/utils/array/all';
 import type { ProjectType } from '../projectType';
-import type { DeduplicateStrategy } from '../../library/webpack/plugins/DedupePlugin';
 
-type ServeNotifications = {
-  /**
-   * @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;
+enum Brand {
+  _ = '',
+}
+
+/**
+ * @cli_overridable
+ */
+export type OverridableOption<T> = Brand & {
+  development?: T;
+  production?: T;
 };
 
-export interface Experiments {
-  /**
-   * @title experiments configuration for [webpack](https://webpack.js.org/configuration/experiments/)
-   * @default {}
-   */
-  webpack?: Omit<Configuration['experiments'], 'buildHttp' | 'lazyCompilation'> & {
-    /**
-     * @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;
-  };
-  /**
-   * @title experimental settings for [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin)
-   * @default {}
-   */
-  minicss?: {
-    /**
-     * @title Use a new webpack API to execute modules instead of child compilers. This improves performance and memory usage a lot.
-     * @default true
-     */
-    useImportModule?: boolean;
-  };
+export const isOverridableOption = <T>(
+  option: Record<string, any>
+): option is OverridableOption<T> => {
+  if (!option || typeof option !== 'object') {
+    return false;
+  }
 
-  /**
-   * @title experimental settings for code transpilation
-   * @default {}
-   */
-  transpilation?: {
-    /**
-     * @title specify loader to transpile js-ts code
-     * @default "babel"
-     */
-    loader?: 'babel' | 'swc';
-  };
-}
+  const keys = Object.keys(option);
 
-interface ServeConfig {
-  /**
-   * @default {}
-   */
-  notifications?: ServeNotifications & {
-    client?: ServeNotifications;
-    server?: ServeNotifications;
-  };
-  /**
-   * @default {}
-   */
-  configurations?: {
-    /**
-     * @title Enable source maps in development build (for client and server build)
-     * @default false
-     */
-    sourceMap?: boolean;
-    /**
-     * @title Enable development build for modern browsers
-     * @default true
-     */
-    modern?: boolean;
-    /**
-     * @title Enable react hot-refresh
-     * @default true
-     */
-    hotRefresh?: boolean;
-    /**
-     * @title Configure react hot-refresh https://github.com/pmmmwh/react-refresh-webpack-plugin#options
-     */
-    hotRefreshOptions?: {
-      overlay?: boolean | Record<string, any>;
-      [key: string]: any;
-    };
-    /**
-     * @title Experimental settings
-     * @default {}
-     */
-    experiments?: Experiments;
-  };
-}
+  return keys.length && all((key) => key === 'development' || key === 'production', keys);
+};
 
-interface BuildConfig {
+export interface ConfigEntry {
   /**
-   * @default {}
+   * @title name of the project
    */
-  options?: Record<string, any>;
+  name: string;
   /**
-   * @default {}
+   * @title path to the root directory relative to the tramvai.json
    */
-  configurations?: {
-    /**
-     * @title Enable production build for modern browsers
-     * @default true
-     */
-    modern?: boolean;
-    /**
-     * @title Enable DedupePlugin
-     * @default "equality"
-     */
-    dedupe?: DeduplicateStrategy | false;
-    /**
-     * @title Sets ignore to DedupePlugin
-     */
-    dedupeIgnore?: string[];
-    /**
-     * @title Enable replacing `typeof window` expression
-     * @default true
-     */
-    removeTypeofWindow?: boolean;
-    /**
-     * @title Enable source maps in production build
-     * @default false
-     */
-    sourceMap?: boolean;
-    /**
-     * @title Enable source maps for server assets in production build
-     * @default false
-     */
-    sourceMapServer?: boolean;
-    /**
-     * @title Configuration for enabling parallel compression for terser plugin
-     * @default true
-     */
-    terserParallel?: boolean;
-    /**
-     * @title List of modules to exclude from @babel/preset-env
-     */
-    excludesPresetEnv?: string[];
-    /**
-     * @title thread-loader config
-     * @additionalProperties true
-     */
-    threadLoader?: Record<string, any>;
-    /**
-     * @title Define plugin config
-     * @default {"prod": {}, "dev": {}}
-     * @additionalProperties true
-     */
-    definePlugin?: Record<string, any>;
-    /**
-     * @deprecated
-     *
-     * @default false
-     */
-    generateDataQaTag?: boolean;
-    /**
-     * @deprecated включает использование плагина fill-action-name
-     *
-     * @default false
-     */
-    enableFillActionNamePlugin?: boolean;
-    /**
-     * @title Set minimizer for css
-     */
-    cssMinimize?: 'csso';
-    postcss?: {
-      /**
-       * @title Path to postcss config file
-       */
-      config?: string;
-      /**
-       * @title CSS identifiers build algorythm
-       */
-      cssLocalIdentName?: string;
-      /**
-       * @title CSS identifiers build algorythm for development buld
-       */
-      cssLocalIdentNameDev?: string;
-      /**
-       * @title CSS identifiers build algorythm for production build
-       */
-      cssLocalIdentNameProd?: string;
-      /**
-       * @title Path to postcss config file for assets
-       */
-      assetsConfig?: string;
-    };
-    /**
-     * @title `@@deprecated @tramvai/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`
-     * @deprecated
-     * @additionalProperties true
-     */
-    alias?: Record<string, any>;
-    /**
-     * @title svgo-loader options
-     */
-    svgo?: {
-      /**
-       * @title svgo plugins
-       */
-      plugins?: Record<string, 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 Browser package resolve aliases. E.g. { "stream": "stream-browserify" }
-     * @additionalProperties true
-     */
-    webpackResolveAlias?: Record<string, string>;
-    /**
-     * @title Browser packages to provide with ProvidePlugin. E.g. { "Buffer": ["buffer", "Buffer"] }
-     * @additionalProperties true
-     */
-    webpackProvide?: Record<string, any>;
-
-    /**
-     * @title experimental settings for File-System Routing feature
-     * @default {}
-     */
-    fileSystemPages?: {
-      /**
-       * @title Read pages from file system
-       * @default false
-       */
-      enable?: boolean;
-      /**
-       * @title Folder with pages from which static routers are generated
-       * @default "routes"
-       */
-      routesDir?: string | false;
-      /**
-       * @title Folder with components which can be manually added to static routers
-       * @default "pages"
-       */
-      pagesDir?: string | false;
-    };
-    /**
-     * @title Experimental settings
-     * @default {}
-     */
-    experiments?: Experiments;
-  };
-}
-
-export interface ConfigEntry {
-  name: string;
   root: string;
-  type: ProjectType;
-  version?: string;
   /**
-   * @default {}
+   * @title type of the project
    */
-  commands?: {
-    /**
-     * @default {}
-     */
-    build?: BuildConfig;
-    /**
-     * @default {}
-     */
-    serve?: ServeConfig;
-  };
+  type: ProjectType;
 }

package/src/typings/configEntry/module.ts

@@ -1,40 +1,21 @@
-import type { ConfigEntry } from './common';
+import type { CliConfigEntry } from './cli';
+
+export interface ModuleConfigEntry extends CliConfigEntry {
+  type: 'module';
 
-export interface ModuleBuild {
   /**
-   * @default {}
+   * @title Path to build module assets
+   * @default "dist/modules"
    */
-  options?: {
-    /**
-     * @title Path to build module assets
-     * @default "dist/modules"
-     */
-    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 ModuleConfigEntry extends ConfigEntry {
-  type: 'module';
-  /**
-   * @default {}
-   */
-  commands?: {
-    /**
-     * @default {}
-     */
-    build?: ModuleBuild;
+  postcss: CliConfigEntry['postcss'] & {
     /**
-     * @default {}
+     * @title CSS identifiers build algorithm
+     * @default "[hash:base64:5]"
      */
-    serve?: ConfigEntry['commands']['serve'];
+    cssLocalIdentName?: CliConfigEntry['postcss']['cssLocalIdentName'];
   };
 }

package/src/typings/configEntry/package.ts

@@ -1,4 +1,6 @@
-export interface PackageConfigEntry {
+import type { ConfigEntry } from './common';
+
+export interface PackageConfigEntry extends ConfigEntry {
   type: 'package';
   /**
    * @title Package name

package/src/ui/commander.ts

@@ -37,7 +37,7 @@ function getOptions(cmd) {
   cmd.options.forEach((o) => {
     const key = o.long.replace(/^--/, '');
 
-    if (typeof cmd[key] !== 'function') {
+    if (typeof cmd[key] !== 'function' && typeof cmd[key] !== 'undefined') {
       args[key] = cmd[key];
     }
   });

package/src/utils/applyTemplate.ts

@@ -26,10 +26,10 @@ const replaceHbs = (pathFile: string) => pathFile.replace(/\.hbs$/, '');
  * @returns Object indicating whether the template application was successful
  */
 
-function transformOutputPath(rawPath): string {
+function transformOutputPath(rawPath: string): string {
   return rawPath
     .split('/')
-    .map((filename) => {
+    .map((filename: string) => {
       // dotfiles are ignored when published to npm, therefore in templates
       // we need to use underscore instead (e.g. "_gitignore")
       if (filename.charAt(0) === '_' && filename.charAt(1) !== '_') {

package/src/utils/detectPortSync.ts

@@ -0,0 +1,7 @@
+import { execSync } from 'child_process';
+
+export const detectPortSync = (port: number): number => {
+  const commandResult = execSync(`npx detect-port ${port}`);
+
+  return parseInt(commandResult.toString('utf-8'), 10);
+};

package/src/utils/safeRequire.ts

@@ -1,3 +1,6 @@
+import { sync as resolve } from 'resolve';
+import { extensions } from '../config/constants';
+
 export const safeRequire = (path: string, silent?: boolean) => {
   try {
     return require(path);
@@ -11,7 +14,9 @@ export const safeRequire = (path: string, silent?: boolean) => {
 
 export const safeRequireResolve = (path: string, silent?: boolean) => {
   try {
-    return require.resolve(path);
+    return resolve(path, {
+      extensions,
+    });
   } catch (error) {
     if (!silent) {
       // TODO: replace with logger from di