@tramvai/cli 2.11.0 → 2.21.0

package/src/builder/webpack/providers/analyze/shared.ts

@@ -3,7 +3,6 @@ import { provide } from '@tinkoff/dippy';
 import chalk from 'chalk';
 import rimraf from 'rimraf';
 import webpack from 'webpack';
-import { INIT_HANDLER_TOKEN } from '../../../../api/start/tokens';
 import {
   CLI_PACKAGE_MANAGER,
   CLI_ROOT_DIR_TOKEN,
@@ -16,6 +15,7 @@ import { StatoscopeAnalyzePlugin } from '../../analyzePlugins/statoscope';
 import { WhyBundledAnalyzePlugin } from '../../analyzePlugins/whyBundled';
 import {
   CLIENT_CONFIG_MANAGER_TOKEN,
+  INIT_HANDLER_TOKEN,
   CLOSE_HANDLER_TOKEN,
   PROCESS_HANDLER_TOKEN,
   WEBPACK_ANALYZE_PLUGIN_NAME_TOKEN,

package/src/commands/analyze/command.ts

@@ -28,6 +28,12 @@ class AnalyzeCommand extends CLICommand<Params> {
       value: '[showConfig]',
       description: 'Show config with which cli was launched',
     },
+    {
+      name: '--fileCache',
+      value: '[fileCache]',
+      transformer: (value) => value !== 'false',
+      description: 'Enable/disable persistent file cache for used cli builder',
+    },
   ];
 
   alias = 'a';

package/src/commands/build/command.ts

@@ -50,6 +50,12 @@ class BuildCommand extends CLICommand<Params> {
       value: '[forPublish]',
       description: '<package> Prepare library package.json for publication',
     },
+    {
+      name: '--fileCache',
+      value: '[fileCache]',
+      transformer: (value) => value !== 'false',
+      description: 'Enable/disable persistent file cache for used cli builder',
+    },
   ];
 
   alias = 'b';

package/src/commands/new/steps/initializationGit.ts

@@ -2,6 +2,7 @@ import execa from 'execa';
 import chalk from 'chalk';
 
 export async function initializationGit(localDir) {
-  console.log(chalk.blue('[START]'), 'Initializing git');
-  await execa('git', ['init'], { cwd: localDir }).then(() => 'git is initialized');
+  console.log(`${chalk.blue('[GIT]')} Initializing git`);
+
+  await execa('git', ['init'], { cwd: localDir, stdio: 'inherit' });
 }

package/src/commands/new/steps/installDependencies.ts

@@ -1,6 +1,6 @@
+import type { Options } from 'execa';
 import execa from 'execa';
 import chalk from 'chalk';
-import ora from 'ora';
 import type { PackageManagers } from '../questions/packageManager';
 import type { TestingFrameworks } from '../questions/testingFramework';
 import type { Type } from '../questions/type';
@@ -92,23 +92,30 @@ export async function installDependencies({
   packageManager: PackageManagers;
   testingFramework: TestingFrameworks;
 }) {
-  const spinner = ora({
-    prefixText: `${chalk.blue('[START]')} Install dependencies`,
-  }).start();
-
   const installCommands = packagesInstallCommands[packageManager];
-  const options = { cwd: localDir, env: { SKIP_TRAMVAI_MIGRATIONS: 'true' } };
+  const options: Options = {
+    cwd: localDir,
+    env: {
+      SKIP_TRAMVAI_MIGRATIONS: 'true',
+    },
+    stdio: 'inherit',
+  };
+
+  console.log(`${chalk.blue('[DEPENDENCIES]')} Installing app dependencies`);
 
   await execa(packageManager, [...installCommands.deps, ...DEPS[type].dependencies], options);
+
+  console.log(`${chalk.blue('[DEPENDENCIES]')} Installing dev dependencies`);
+
   await execa(packageManager, [...installCommands.devDeps, ...devDependencies], options);
 
   if (testingFramework === 'jest') {
+    console.log(`${chalk.blue('[DEPENDENCIES]')} Installing jest dependencies`);
+
     await execa(
       packageManager,
       [...installCommands.devDeps, ...DEPS[type].jestDevDependencies],
       options
     );
   }
-
-  spinner.stop();
 }

package/src/commands/new/steps/renderTemplate.ts

@@ -2,6 +2,6 @@ import chalk from 'chalk';
 import { applyTemplate } from '../utils/applyTemplate';
 
 export async function renderTemplate(templateDir: string, projectDir: string, templateData) {
-  console.log(chalk.blue('[START]'), 'Copying files');
+  console.log(chalk.blue('[TEMPLATE]'), 'Copying files');
   return applyTemplate(templateDir, projectDir, templateData);
 }

package/src/commands/new/templates/app/monorepo/tramvai.json.hbs

@@ -26,10 +26,8 @@
               "~processes": "./apps/{{configEntry.name}}/processes",
               "~app": "./apps/{{configEntry.name}}/app"
             },
-            "experiments": {
-              "fileSystemPages": {
-                "enable": true
-              }
+            "fileSystemPages": {
+              "enable": true
             }
           }
         },

package/src/commands/new/templates/app/multirepo/tramvai.json.hbs

@@ -26,10 +26,8 @@
               "~processes": "./src/processes",
               "~app": "./src/app"
             },
-            "experiments": {
-              "fileSystemPages": {
-                "enable": true
-              }
+            "fileSystemPages": {
+              "enable": true
             }
           }
         },

package/src/commands/new/templates/shared/_npmrc.hbs

@@ -1,3 +1,2 @@
 registry = https://registry.npmjs.org/
 strict-ssl = false
-ca = ''

package/src/commands/new/utils/applyTemplate.ts

@@ -125,7 +125,11 @@ export function applyTemplate(
   let warnings = 0;
   templateFiles.forEach((templateFile) => {
     if (processFileFromTemplate(templateFile, templateDir, projectDir, templateData)) {
-      console.log(chalk.green('CREATE'), transformOutputPath(replaceHbs(templateFile)));
+      console.log(
+        chalk.blue('[TEMPLATE]'),
+        chalk.green('CREATE'),
+        transformOutputPath(replaceHbs(templateFile))
+      );
       ++processed;
     } else {
       ++warnings;

package/src/commands/start/command.ts

@@ -98,6 +98,12 @@ export class StartCommand extends CLICommand<Params> {
       description:
         'Specify the names of the bundles that need to be collected, other bundles will not be collected and their request will fail with an error',
     },
+    {
+      name: '--fileCache',
+      value: '[fileCache]',
+      transformer: (value) => value !== 'false',
+      description: 'Enable/disable persistent file cache for used cli builder',
+    },
   ];
 
   alias = 's';

package/src/commands/start-prod/command.ts

@@ -72,6 +72,12 @@ export class StartProdCommand extends CLICommand<Params> {
       value: '[showConfig]',
       description: 'Show config with which cli was launched',
     },
+    {
+      name: '--fileCache',
+      value: '[fileCache]',
+      transformer: (value) => value !== 'false',
+      description: 'Enable/disable persistent file cache for used cli builder',
+    },
   ];
 
   alias = 'sp';

package/src/commands/static/command.ts

@@ -40,6 +40,12 @@ export class StaticCommand extends CLICommand<Params> {
       transformer: (value: string) => value.split(','),
       description: 'Specify the comma separated paths list for static HTML generation',
     },
+    {
+      name: '--fileCache',
+      value: '[fileCache]',
+      transformer: (value) => value !== 'false',
+      description: 'Enable/disable persistent file cache for used cli builder',
+    },
   ];
 
   alias = 'st';

package/src/commands/update/dependantLibs.ts

@@ -0,0 +1,49 @@
+import { getLatestPackageVersion } from '../../utils/commands/dependencies/getLatestPackageVersion';
+import { getPackageInfo } from '../../utils/commands/dependencies/getPackageInfo';
+
+// map of packages that is not in unified versioning
+// but we still want to update it
+// actual version to update will be calculated from the some of the @tramvai/module
+const DEPENDANT_LIBS_MAP = new Map([
+  ['@tinkoff/logger', '@tramvai/module-log'],
+  ['@tinkoff/dippy', '@tramvai/core'],
+  ['@tinkoff/router', '@tramvai/module-router'],
+  ['@tinkoff/url', '@tramvai/module-common'],
+  ['@tinkoff/errors', '@tramvai/module-common'],
+  ['@tinkoff/roles', '@tramvai/module-authenticate'],
+  ['@tinkoff/pubsub', '@tramvai/module-common'],
+  ['@tinkoff/hook-runner', '@tramvai/module-common'],
+  ['@tinkoff/htmlpagebuilder', '@tramvai/module-render'],
+  ['@tinkoff/browser-timings', '@tramvai/module-metrics'],
+  ['@tinkoff/meta-tags-generate', '@tramvai/module-render'],
+  ['@tinkoff/pack-polyfills', ''],
+  ['@tinkoff/browserslist-config', '@tramvai/cli'],
+]);
+
+export const isDependantLib = (name: string) => {
+  return DEPENDANT_LIBS_MAP.has(name);
+};
+
+export const getLibPackageVersion = async (
+  name: string,
+  unifiedVersion: string
+): Promise<string | undefined> => {
+  const unifiedModule = DEPENDANT_LIBS_MAP.get(name);
+
+  if (!unifiedModule) {
+    return getLatestPackageVersion(name);
+  }
+
+  const deps = await getPackageInfo(`${unifiedModule}@${unifiedVersion}`, 'dependencies');
+
+  if (!deps[name]) {
+    console.warn(
+      `⚠️ cannot resolve proper version for the "${name}" package.
+You have to update this package by yourself.`
+    );
+
+    return;
+  }
+
+  return deps[name];
+};

package/src/commands/update/updatePackageJson.spec.ts

@@ -0,0 +1,99 @@
+import { updatePackageJson } from './updatePackageJson';
+
+const LATEST_TRAMVAI_VERSION = '1.115.6';
+const LATEST_LIB_VERSION = '0.8.23';
+
+let mockPackageJson: Record<string, any>;
+const mockFsWrite = jest.fn();
+const mockPackageInfoDependencies = jest.fn<Record<string, string | undefined>, [string]>();
+
+jest.mock('../../utils/commands/dependencies/packageHasVersion', () => ({
+  packageHasVersion: () => true,
+}));
+jest.mock('../../utils/commands/dependencies/getLatestPackageVersion', () => ({
+  getLatestPackageVersion: (dep: string) => {
+    if (dep.startsWith('@tramvai')) {
+      return LATEST_TRAMVAI_VERSION;
+    }
+
+    return LATEST_LIB_VERSION;
+  },
+}));
+
+jest.mock('../../utils/commands/dependencies/getPackageInfo', () => ({
+  getPackageInfo: (packageName: string, field?: string) => {
+    if (field === 'dependencies') {
+      return mockPackageInfoDependencies(packageName);
+    }
+  },
+}));
+
+jest.mock('fs', () => ({
+  readFileSync: () => JSON.stringify(mockPackageJson),
+  writeFileSync: (...args: string[]) => mockFsWrite(...args),
+}));
+
+beforeEach(() => {
+  mockFsWrite.mockClear();
+  mockPackageInfoDependencies.mockClear();
+});
+
+it('should update tramvai deps to latest versions', async () => {
+  mockPackageJson = {
+    dependencies: {
+      '@tramvai/core': '1.93.2',
+      '@tramvai/module-common': '1.93.2',
+      '@tinkoff/router': '^0.2.3',
+      '@tinkoff/url': '0.3.2',
+    },
+    devDependencies: {
+      '@tramvai/cli': '1.93.2',
+    },
+    peerDependencies: {
+      '@tinkoff/dippy': '0.7.10',
+    },
+  };
+
+  mockPackageInfoDependencies.mockImplementation((dep) => {
+    switch (dep) {
+      case '@tramvai/core@1.115.6':
+        return { '@tinkoff/dippy': '0.7.44', '@tinkoff/utils': '^2.1.0' };
+      case '@tramvai/module-common@1.115.6':
+        return {
+          '@tinkoff/error': '0.6.1',
+          '@tinkoff/url': '0.4.1',
+        };
+      case '@tramvai/cli@1.115.6':
+        return {};
+      case '@tramvai/module-router@1.115.6':
+        return {
+          '@tinkoff/router': '0.4.3',
+          '@tinkoff/url': '0.4.1',
+        };
+    }
+
+    return {};
+  });
+
+  await updatePackageJson(LATEST_TRAMVAI_VERSION);
+
+  expect(mockFsWrite.mock.calls[0]).toMatchInlineSnapshot(`
+    Array [
+      "package.json",
+      "{
+      \\"dependencies\\": {
+        \\"@tramvai/core\\": \\"1.115.6\\",
+        \\"@tramvai/module-common\\": \\"1.115.6\\",
+        \\"@tinkoff/router\\": \\"0.4.3\\",
+        \\"@tinkoff/url\\": \\"0.4.1\\"
+      },
+      \\"devDependencies\\": {
+        \\"@tramvai/cli\\": \\"1.115.6\\"
+      },
+      \\"peerDependencies\\": {
+        \\"@tinkoff/dippy\\": \\"0.7.44\\"
+      }
+    }",
+    ]
+  `);
+});

package/src/commands/update/updatePackageJson.ts

@@ -1,29 +1,11 @@
 import { parse, minVersion } from 'semver';
 import fs from 'fs';
 import pMap from 'p-map';
-import { getLatestPackageVersion } from '../../utils/commands/dependencies/getLatestPackageVersion';
 import { packageHasVersion } from '../../utils/commands/dependencies/packageHasVersion';
+import { getLibPackageVersion, isDependantLib } from './dependantLibs';
 
-// Список пакетов, не начинающихся с @tramvai,
-// которые мы также хотим обновить
-const packagesToUpdate = [
-  '@tinkoff/logger',
-  '@tinkoff/dippy',
-  '@tinkoff/router',
-  '@tinkoff/url',
-  '@tinkoff/errors',
-  '@tinkoff/roles',
-  '@tinkoff/pubsub',
-  '@tinkoff/hook-runner',
-  '@tinkoff/htmlpagebuilder',
-  '@tinkoff/browser-timings',
-  '@tinkoff/meta-tags-generate',
-  '@tinkoff/pack-polyfills',
-  '@tinkoff/browserslist-config',
-];
-
-const shouldUpdateDependency = (name: string) => {
-  return name.startsWith('@tramvai') || packagesToUpdate.includes(name);
+const isUnifiedVersion = (name: string) => {
+  return name.startsWith('@tramvai');
 };
 
 const getVersionFromDep = (dep) => parse(dep)?.version || minVersion(dep)?.version;
@@ -35,11 +17,11 @@ const updateEntry = async (
 ) => {
   let nextVersion: string;
 
-  if (dep.startsWith('@tramvai') && getVersionFromDep(deps[dep]) === currentVersion) {
+  if (isUnifiedVersion(dep) && getVersionFromDep(deps[dep]) === currentVersion) {
     nextVersion = version;
-  } else if (shouldUpdateDependency(dep)) {
-    const latestPackageVersion = await getLatestPackageVersion(dep);
-    nextVersion = latestPackageVersion;
+  } else if (isDependantLib(dep)) {
+    const libVersion = await getLibPackageVersion(dep, version);
+    nextVersion = libVersion;
   }
 
   if (nextVersion) {

package/src/config/configManager.ts

@@ -3,7 +3,7 @@ import prop from '@tinkoff/utils/object/prop';
 import { resolve } from 'path';
 import type { ProjectType, BuildType } from '../typings/projectType';
 import type { Env } from '../typings/Env';
-import type { ConfigEntry, Experiments } from '../typings/configEntry/common';
+import type { ConfigEntry } from '../typings/configEntry/common';
 import { validate } from './validate';
 import moduleVersion from '../utils/moduleVersion';
 import { packageVersion } from '../utils/packageVersion';
@@ -32,6 +32,7 @@ export interface Settings<E extends Env> {
   showConfig?: boolean;
   onlyBundles?: string[];
   disableProdOptimization?: boolean;
+  fileCache?: boolean;
 }
 
 const getOption = <T>(optionName: string, cfgs: any[], dflt?: T): T => {
@@ -108,6 +109,8 @@ export class ConfigManager<T extends ConfigEntry = ConfigEntry, E extends Env =
 
   public target: Target;
 
+  public fileCache: boolean;
+
   public experiments: T['commands'][E extends 'development'
     ? 'serve'
     : 'build']['configurations']['experiments'];
@@ -120,7 +123,7 @@ export class ConfigManager<T extends ConfigEntry = ConfigEntry, E extends Env =
     this.type = configEntry.type;
     this.root = configEntry.root;
     this.build = configEntry.commands.build || {};
-    this.serve = configEntry.commands.serve || configEntry.serve || {};
+    this.serve = configEntry.commands.serve || {};
 
     this.settings = settings;
     this.env = settings.env || ('development' as E);
@@ -156,7 +159,7 @@ export class ConfigManager<T extends ConfigEntry = ConfigEntry, E extends Env =
         settings,
         this.env === 'development' ? this.serve.configurations : this.build.configurations,
       ],
-      false
+      true
     );
     this.dedupe = this.build.configurations?.dedupe;
     this.dedupeIgnore = this.build.configurations?.dedupeIgnore?.map(
@@ -168,6 +171,9 @@ export class ConfigManager<T extends ConfigEntry = ConfigEntry, E extends Env =
     this.disableProdOptimization = settings.disableProdOptimization ?? false;
     this.onlyBundles = settings.onlyBundles;
     this.target = this.resolveTarget();
+    // according to measures fileCache in webpack doesn't affect
+    // performance much so enable it by default as it always was before
+    this.fileCache = settings.fileCache ?? true;
     this.experiments =
       (this.env === 'development'
         ? this.serve.configurations?.experiments

package/src/external/pages.ts

@@ -1,12 +1,10 @@
-export interface Page {
-  default?: any;
-}
+import type { LazyComponentWrapper, PageComponent } from '@tramvai/react';
 
 // eslint-disable-next-line import/no-default-export
 export default {
   routes: {},
   pages: {},
 } as {
-  routes: Record<string, Page>;
-  pages: Record<string, Page>;
+  routes: Record<string, LazyComponentWrapper<PageComponent>>;
+  pages: Record<string, LazyComponentWrapper<PageComponent>>;
 };

package/src/library/webpack/application/client/common.ts

@@ -22,9 +22,7 @@ import { configToEnv } from '../../blocks/configToEnv';
 export default (configManager: ConfigManager<ApplicationConfigEntry>) => (config: Config) => {
   const {
     options: { polyfill = '' } = {},
-    configurations: {
-      experiments: { fileSystemPages },
-    },
+    configurations: { fileSystemPages },
   } = configManager.build;
 
   config.name('client');

package/src/library/webpack/application/server/common.ts

@@ -22,9 +22,7 @@ import { extractCssPluginFactory } from '../../blocks/extractCssPlugin';
 export default (configManager: ConfigManager<ApplicationConfigEntry>) => (config: Config) => {
   const {
     options: { server = '', outputServer = '' } = {},
-    configurations: {
-      experiments: { fileSystemPages },
-    },
+    configurations: { fileSystemPages },
   } = configManager.build;
 
   config.name('server');

package/src/library/webpack/blocks/configToEnv.ts

@@ -4,7 +4,7 @@ import type { ConfigEntry } from '../../../typings/configEntry/common';
 import { shouldUseReactRoot } from '../../../utils/shouldUseReactRoot';
 
 export const configToEnv = (configManager: ConfigManager<ConfigEntry>) => (config: Config) => {
-  const { fileSystemPages } = configManager.build.configurations.experiments;
+  const { fileSystemPages } = configManager.build.configurations;
 
   config.plugin('define').tap((args) => [
     {

package/src/library/webpack/blocks/filesClient.ts

@@ -1,3 +1,4 @@
+import path from 'path';
 import type Config from 'webpack-chain';
 import SparkMD5 from 'spark-md5';
 import type { ConfigManager } from '../../../config/configManager';
@@ -33,9 +34,11 @@ export const filesClientWebackRulesFactory = (configManager: ConfigManager) => (
     });
 
   config.module
-    .rule('image')
+    .rule('tramvai-image')
     .test(/\.(png|jpe?g|gif|webp)$/)
-    .set('type', 'asset');
+    .use('file')
+    .loader(path.resolve(__dirname, '../loaders/image-loader'))
+    .end();
 
   config.module
     .rule('video')

package/src/library/webpack/blocks/filesServer.ts

@@ -1,3 +1,4 @@
+import path from 'path';
 import type Config from 'webpack-chain';
 import type { ConfigManager } from '../../../config/configManager';
 
@@ -28,12 +29,14 @@ export default (configManager: ConfigManager) => (config: Config) => {
     });
 
   config.module
-    .rule('image')
+    .rule('tramvai-image')
     .test(/\.(png|jpe?g|gif|webp)$/)
-    .set('type', 'asset')
-    .set('generator', {
-      emit: false,
-    });
+    .use('file')
+    .loader(path.resolve(__dirname, '../loaders/image-loader'))
+    .options({
+      emitFile: false,
+    })
+    .end();
 
   config.module
     .rule('video')

package/src/library/webpack/blocks/pagesResolve.ts

@@ -6,7 +6,7 @@ import type { ApplicationConfigEntry } from '../../../typings/configEntry/applic
 export const pagesResolve = (configManager: ConfigManager<ApplicationConfigEntry>) => (
   config: Config
 ) => {
-  const { fileSystemPages } = configManager.build.configurations.experiments;
+  const { fileSystemPages } = configManager.build.configurations;
 
   config.module
     .rule('file-system-pages')

package/src/library/webpack/common/main.ts

@@ -42,24 +42,25 @@ export default (configManager: ConfigManager) => (config: Config) => {
   // https://webpack.js.org/configuration/output/#outputhashfunction . When release webpack 6 would need to remove
   config.output.set('hashFunction', 'xxhash64');
 
-  // TODO: отключать в CI
-  config.cache({
-    type: 'filesystem',
-    name: `${env}-${configManager.type}-${configManager.buildType}-${configManager.name}${
-      configManager.buildType === 'client' && configManager.modern ? '-modern' : ''
-    }`,
-    cacheDirectory: findCacheDir({ cwd: configManager.rootDir, name: 'webpack' }),
-    buildDependencies: {
-      cli: ['@tramvai/cli'],
-      webpack: ['webpack/lib'],
-      // first check that config exists. If it is passed to webpack, but file is not exist the cache will not be created at all.
-      // It may be missing in cases when cli is running programmaticaly
-      config: filterNonExisted([path.resolve(configManager.rootDir, 'tramvai.json')]),
-      css: filterNonExisted([
-        postcssConfig && safeRequireResolve(path.resolve(configManager.rootDir, postcssConfig)),
-      ]),
-    },
-  });
+  if (configManager.fileCache) {
+    config.cache({
+      type: 'filesystem',
+      name: `${env}-${configManager.type}-${configManager.buildType}-${configManager.name}${
+        configManager.buildType === 'client' && configManager.modern ? '-modern' : ''
+      }`,
+      cacheDirectory: findCacheDir({ cwd: configManager.rootDir, name: 'webpack' }),
+      buildDependencies: {
+        cli: ['@tramvai/cli'],
+        webpack: ['webpack/lib'],
+        // first check that config exists. If it is passed to webpack, but file is not exist the cache will not be created at all.
+        // It may be missing in cases when cli is running programmaticaly
+        config: filterNonExisted([path.resolve(configManager.rootDir, 'tramvai.json')]),
+        css: filterNonExisted([
+          postcssConfig && safeRequireResolve(path.resolve(configManager.rootDir, postcssConfig)),
+        ]),
+      },
+    });
+  }
 
   config.set('snapshot', {
     // отключаем дефолты для managedPaths т.к. из-за них нельзя дебажить node_modules,

package/src/library/webpack/loaders/image-loader/index.ts

@@ -0,0 +1,26 @@
+import sizeOf from 'image-size';
+
+/**
+ * Reuse file-loader logic, but return a object with src and size of image
+ */
+export default function (content) {
+  const result = require('file-loader').call(this, content);
+
+  const dimensions = sizeOf(this.resourcePath);
+
+  // @todo: image blur placeholder in Base64, sharp or imagemin or jimp?
+  return result.replace(
+    /^export default (__webpack_public_path__ \+ .+);$/,
+    `const path = $1;
+
+export default path;
+
+export const image = {
+  src: $1,
+  width: ${JSON.stringify(dimensions.width)},
+  height: ${JSON.stringify(dimensions.height)},
+};`
+  );
+}
+
+export const raw = true;