arui-scripts 23.1.0 → 23.3.0

package/.turbo/turbo-test.log

@@ -1,23 +1,24 @@
 ts-jest[versions] (WARN) Version 6.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <6.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions.
 ts-jest[versions] (WARN) Version 6.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <6.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions.
 ts-jest[versions] (WARN) Version 6.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <6.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions.
-PASS src/configs/app-configs/__tests__/update-with-presets.tests.ts (23.818 s)
+PASS src/bin/__tests__/create-cli.tests.ts (32.447 s)
+PASS src/configs/app-configs/__tests__/update-with-presets.tests.ts
 PASS src/configs/util/__tests__/create-watch-ignore-regex.tests.ts
+PASS src/plugins/postcss-global-variables/utils/__tests__/add-global-variable.tests.ts (32.626 s)
 PASS src/configs/util/__tests__/apply-overrides.tests.ts
 PASS src/configs/app-configs/__tests__/update-with-env.tests.ts
-PASS src/plugins/postcss-global-variables/utils/__tests__/add-global-variable.tests.ts (24.667 s)
 PASS src/configs/app-configs/__tests__/update-with-package.tests.ts
 PASS src/configs/util/__tests__/compress-with-dcb.test.ts
 PASS src/configs/util/__tests__/get-polyfills.tests.ts
 PASS src/plugins/postcss-global-variables/utils/__tests__/parse-variables.tests.ts
 PASS src/plugins/postcss-global-variables/utils/__tests__/get-media-query-name.tests.ts
 PASS src/configs/app-configs/__tests__/validate-settings-keys.tests.ts
-PASS src/configs/__tests__/webpack-client-modules.tests.ts (15.828 s)
-PASS src/configs/util/__tests__/find-plugin.tests.ts (41.64 s)
+PASS src/configs/__tests__/webpack-client-modules.tests.ts (9.936 s)
+PASS src/configs/util/__tests__/find-plugin.tests.ts (43.865 s)
 A worker process has failed to exit gracefully and has been force exited. This is likely caused by tests leaking due to improper teardown. Try running with --detectOpenHandles to find leaks. Active timers can also cause this, ensure that .unref() was called on them.
 
-Test Suites: 13 passed, 13 total
-Tests:       31 passed, 31 total
+Test Suites: 14 passed, 14 total
+Tests:       37 passed, 37 total
 Snapshots:   0 total
-Time:        43.267 s
+Time:        45.272 s
 Ran all test suites.

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # arui-scripts
 
+## 23.3.0
+
+### Minor Changes
+
+-   [#561](https://github.com/core-ds/arui-scripts/pull/561) [`98a2da5`](https://github.com/core-ds/arui-scripts/commit/98a2da587e1f0bc1d9b053cf509d96379b2e9af2) Thanks [@heymdall-legal](https://github.com/heymdall-legal)! - Добавлена настройка `jestTransformNodeModules` — список пакетов из `node_modules`, которые нужно прогонять
+    через трансформер при запуске тестов. Нужна для зависимостей, публикующихся только в формате ESM: рантайм jest
+    работает в CommonJS, а его нативный ESM-режим до сих пор требует `--experimental-vm-modules`.
+    По умолчанию `[]`, поведение не меняется.
+
+## 23.2.0
+
+### Minor Changes
+
+-   [#552](https://github.com/core-ds/arui-scripts/pull/552) [`3658e49`](https://github.com/core-ds/arui-scripts/commit/3658e49b0b752c592e738726aa8056569e28e19b) Thanks [@dmitrbrvsk](https://github.com/dmitrbrvsk)! - Добавлен пакет `create-arui-scripts-app` для генерации нового приложения через CLI. В `arui-scripts` CLI был переведен на commander.
+
 ## 23.1.0
 
 ### Minor Changes

package/README.md

@@ -3,7 +3,24 @@ ARUI-scripts
 
 Простой и гибкий инструмент для одновременной сборки клиентской и серверной части react-приложений.
 
+Быстрый старт
+
+===
+
+Самый быстрый способ начать - запустить интерактивный CLI [`create-arui-scripts-app`](../create-arui-scripts-app/README.md):
+
+```bash
+npx create-arui-scripts-app my-app
+cd my-app
+yarn
+yarn start
+```
+
+CLI `arui-scripts` поддерживает глобальные флаги `--help`, `--version` и справку по командам
+`arui-scripts <команда> --help`. Подробнее в [CLI](docs/cli.md).
+
 Использование
+
 ===
 
 0. Пакет требует использовать следующие версии:
@@ -19,12 +36,15 @@ ARUI-scripts
 ```bash
 yarn add arui-scripts --dev
 ```
+
 или
+
 ```bash
 npm install arui-scripts --save-dev
 ```
 
 2. Создайте необходимые файлы
+
 - `src/index.{js,jsx,ts,tsx}` - входная точка для клиентского приложения.
 - `src/server/index.{js,jsx,tsx}` - входная точка для серверного приложения.
 Если нужен только клиент, смотреть [Режим clientOnly](./docs/client-only.md).
@@ -44,8 +64,11 @@ npm install arui-scripts --save-dev
 3. Используйте команды из `arui-scripts`!
 
 Документация
+
 ===
 - [Список актуальных версий docker-образов](../alpine-node-nginx/README.md)
+- [Генерация проекта (`create-arui-scripts-app`)](../create-arui-scripts-app/README.md)
+- [CLI](docs/cli.md)
 - [Настройки](docs/settings.md)
 - [Команды](docs/commands.md)
 - [Примеры входных точек](docs/examples.md)

package/build/bin/commands-registry.d.ts

@@ -0,0 +1,8 @@
+export type CliCommand = {
+    name: string;
+    description: string;
+    help?: string;
+    passthrough?: boolean;
+    load: () => void;
+};
+export declare const commands: CliCommand[];

package/build/bin/commands-registry.js

@@ -0,0 +1,80 @@
+"use strict";
+/* eslint-disable global-require */
+/* eslint import/no-dynamic-require: 0 */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commands = void 0;
+exports.commands = [
+    {
+        name: 'start',
+        description: 'Dev сервер для клиента и серверный код в watch режиме',
+        load: () => require('../commands/start'),
+    },
+    {
+        name: 'start:prod',
+        description: 'То же, что команда start, но с production конфигурацией rspack',
+        load: () => require('../commands/start-prod'),
+    },
+    {
+        name: 'build',
+        description: 'Production сборка клиентского и серверного кода',
+        load: () => require('../commands/build'),
+    },
+    {
+        name: 'docker-build',
+        description: 'Production сборка, создание docker образа и пуш в registry',
+        help: [
+            'Имя образа формируется как {dockerRegistry}/{name}:{version}.',
+            'name и version по умолчанию берутся из package.json, но их можно переопределить:',
+            '  arui-scripts docker-build name=container-name version=0.1-beta',
+        ].join('\n'),
+        passthrough: true,
+        load: () => require('../commands/docker-build'),
+    },
+    {
+        name: 'docker-build:compiled',
+        description: 'Как docker-build, но использует уже скомпилированный код из папки .build (для CI/CD)',
+        help: [
+            'Поддерживает те же опции, что и docker-build (name=, version=).',
+            'Внимание: не работает в clientOnly-режиме.',
+        ].join('\n'),
+        passthrough: true,
+        load: () => require('../commands/docker-build-compiled'),
+    },
+    {
+        name: 'test',
+        description: 'Запускает jest с конфигурацией arui-scripts',
+        help: 'Все аргументы после команды пробрасываются в jest (например: arui-scripts test --watch).',
+        passthrough: true,
+        load: () => require('../commands/test'),
+    },
+    {
+        name: 'test:vitest',
+        description: 'Запускает unit тесты через vitest',
+        help: [
+            'Использует vitest.config.* из корня проекта, иначе конфигурацию arui-scripts.',
+            'Все аргументы после команды пробрасываются в vitest.',
+        ].join('\n'),
+        passthrough: true,
+        load: () => require('../commands/test-vitest'),
+    },
+    {
+        name: 'ensure-yarn',
+        description: 'Завершается с кодом 1, если проект запущен не через yarn',
+        load: () => require('../commands/ensure-yarn'),
+    },
+    {
+        name: 'archive-build',
+        description: 'Собирает tar-архив с production-сборкой (.build, node_modules, package.json, config)',
+        load: () => require('../commands/archive-build'),
+    },
+    {
+        name: 'bundle-analyze',
+        description: 'Запускает webpack-bundle-analyzer и rsdoctor для анализа бандла и сборки',
+        load: () => require('../commands/bundle-analyze'),
+    },
+    {
+        name: 'changelog',
+        description: 'postchangelog-хук standard-version: формирует описание версии в CHANGELOG.md',
+        load: () => require('../commands/changelog'),
+    },
+];

package/build/bin/create-cli.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function createCli(): Command;

package/build/bin/create-cli.js

@@ -0,0 +1,34 @@
+"use strict";
+/* eslint-disable global-require */
+/* eslint-disable @typescript-eslint/no-var-requires */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCli = createCli;
+const chalk_1 = __importDefault(require("chalk"));
+const commander_1 = require("commander");
+const commands_registry_1 = require("./commands-registry");
+const { version } = require('../../package.json');
+function createCli() {
+    const program = new commander_1.Command('arui-scripts');
+    program
+        .description('Инструмент для сборки клиентской и серверной части react приложений')
+        .version(version, '-v, --version', 'Показать версию')
+        .showHelpAfterError('(используйте --help для списка команд)')
+        .showSuggestionAfterError();
+    program.addHelpText('beforeAll', ({ command }) => command === program
+        ? `\n  ${chalk_1.default.bgCyan.black(' arui-scripts ')}  ${chalk_1.default.dim(`v${version}`)}\n`
+        : '');
+    commands_registry_1.commands.forEach((cmd) => {
+        const command = program.command(cmd.name).description(cmd.description).action(cmd.load);
+        if (cmd.passthrough) {
+            // --help/-h пробрасываем в jest/vitest/docker, а не показываем help commander.
+            command.allowUnknownOption().allowExcessArguments().helpOption(false);
+        }
+        if (cmd.help) {
+            command.addHelpText('after', `\n${chalk_1.default.dim(cmd.help)}`);
+        }
+    });
+    return program;
+}

package/build/bin/index.js

@@ -1,26 +1,5 @@
 #! /usr/bin/env node
 "use strict";
-/* eslint-disable global-require */
-/* eslint import/no-dynamic-require: 0 */
 Object.defineProperty(exports, "__esModule", { value: true });
-const commands = {
-    start: () => require('../commands/start'),
-    'start:prod': () => require('../commands/start-prod'),
-    build: () => require('../commands/build'),
-    'docker-build': () => require('../commands/docker-build'),
-    'docker-build:compiled': () => require('../commands/docker-build-compiled'),
-    test: () => require('../commands/test'),
-    'test:vitest': () => require('../commands/test-vitest'),
-    'ensure-yarn': () => require('../commands/ensure-yarn'),
-    'archive-build': () => require('../commands/archive-build'),
-    'bundle-analyze': () => require('../commands/bundle-analyze'),
-    changelog: () => require('../commands/changelog'),
-};
-const command = process.argv[2];
-if (!command || !commands[command]) {
-    console.error(`Please specify one of available commands: ${Object.keys(commands)
-        .map((c) => `"${c}"`)
-        .join(' ')}`);
-    process.exit(-1);
-}
-commands[command]();
+const create_cli_1 = require("./create-cli");
+(0, create_cli_1.createCli)().parse(process.argv);

package/build/configs/app-configs/get-defaults.js

@@ -58,6 +58,7 @@ function getDefaultAppConfig() {
         installServerSourceMaps: false,
         disableDevRspackTypecheck: true,
         jestCodeTransformer: 'swc',
+        jestTransformNodeModules: [],
         collectCoverage: process.env.NODE_ENV === 'cypress' || process.env.USE_ISTANBUL === 'enabled',
         // image processing
         dataUrlMaxSize: 1536,

package/build/configs/app-configs/types.d.ts

@@ -48,6 +48,7 @@ export type AppConfigs = {
     /** @deprecated используйте `disableDevRspackTypecheck` */
     disableDevWebpackTypecheck?: boolean;
     jestCodeTransformer: 'babel' | 'tsc' | 'swc';
+    jestTransformNodeModules: string[];
     collectCoverage: boolean;
     dataUrlMaxSize?: number;
     imageMinimizer?: {

package/build/configs/jest/settings.d.ts

@@ -10,6 +10,7 @@ export let transform: {
     '^.+\\.tsx?$': string | (string | import("@swc/types").Options)[];
     '^(?!.*\\.(js|jsx|ts|tsx|css|json)$)': string;
 };
+export let transformIgnorePatterns: string[];
 export let moduleNameMapper: {
     '\\.css$': string;
 };

package/build/configs/jest/settings.js

@@ -9,6 +9,9 @@ const { pathsToModuleNameMapper } = require('ts-jest');
 const { parseConfigFileTextToJson } = require('typescript');
 const { swcJestConfig } = require('../swc');
 const { configs } = require('../app-configs');
+// Значения по умолчанию из самого jest, см. https://jestjs.io/docs/configuration#transformignorepatterns-arraystring
+const PNP_TRANSFORM_IGNORE_PATTERN = '\\.pnp\\.[^\\\\/]+$';
+const DEFAULT_TRANSFORM_IGNORE_PATTERNS = ['/node_modules/', PNP_TRANSFORM_IGNORE_PATTERN];
 module.exports = {
     testRegex: 'src/.*(((/__test__/|/__tests__/).*)|(test|spec|tests)).(jsx?|tsx?)$',
     moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
@@ -22,6 +25,7 @@ module.exports = {
         '^.+\\.tsx?$': getTsTransformer(),
         '^(?!.*\\.(js|jsx|ts|tsx|css|json)$)': require.resolve('./file-transform'),
     },
+    transformIgnorePatterns: getTransformIgnorePatterns(),
     moduleNameMapper: Object.assign({ 
         // replace all css files with simple empty exports
         '\\.css$': require.resolve('./css-mock') }, pathsToModuleNameMapper(getPathMapping(), { prefix: '<rootDir>/' })),
@@ -56,3 +60,17 @@ function getJsTransformer() {
     }
     return require.resolve('./babel-transform');
 }
+function getTransformIgnorePatterns() {
+    const packages = configs.jestTransformNodeModules;
+    if (!packages || packages.length === 0) {
+        return DEFAULT_TRANSFORM_IGNORE_PATTERNS;
+    }
+    const list = packages.map((name) => name.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|');
+    // Игнорируем всё в node_modules, кроме путей, содержащих /node_modules/<пакет>/.
+    // Вхождение ищется в любом месте пути, чтобы работали вложенные установки
+    // вида node_modules/foo/node_modules/uuid.
+    return [
+        `^(?!.*[\\\\/]node_modules[\\\\/](?:${list})[\\\\/]).*[\\\\/]node_modules[\\\\/]`,
+        PNP_TRANSFORM_IGNORE_PATTERN,
+    ];
+}

package/docs/cli.md

@@ -0,0 +1,23 @@
+# CLI arui-scripts
+
+`arui-scripts` предоставляет CLI для сборки, запуска и тестирования react-приложений.
+После установки пакета команды доступны через `arui-scripts <команда>`
+
+Для генерации нового проекта используйте отдельный пакет
+[`create-arui-scripts-app`](../../create-arui-scripts-app/README.md):
+
+```bash
+npx create-arui-scripts-app my-app
+```
+
+## Глобальные флаги
+
+- `arui-scripts --help` — список всех команд с описаниями.
+- `arui-scripts --version` (`-v`) - версия пакета.
+- `arui-scripts <команда> --help` - справка по конкретной команде.
+
+## Команды
+
+Полный список и описание — в [docs/commands.md](commands.md):
+`start`, `start:prod`, `build`, `docker-build`, `docker-build:compiled`, `test`, `test:vitest`,
+`archive-build`, `bundle-analyze`, `ensure-yarn`, `changelog`.

package/docs/commands.md

@@ -1,33 +1,45 @@
-Доступные команды
+# Доступные команды
+
 ===
 
-### start
+CLI `arui-scripts` поддерживает глобальные флаги:
+
+- `arui-scripts --help` - список всех команд с описаниями.
+- `arui-scripts --version` (`-v`) - версия пакета.
+- `arui-scripts <command> --help` - справка по конкретной команде.
+
+## start
+
 Запускает dev-сервер для клиентского кода и серверный код в watch-режиме.
 
 **Как запустить?**
+
 ```bash
 arui-scripts start
 ```
 
-### start:prod
+## start:prod
+
 Запускает dev-сервер для клиентского кода и серверный код в watch-режиме. При этом использует production-конфигурацию для rspack.
 Может быть полезна для сбора метрик производительности.
 
 **Как запустить?**
+
 ```bash
 arui-scripts start:prod
 ```
 
-### build
+## build
+
 Собирает клиентский и серверный код в production-режиме.
 
 **Как запустить?**
+
 ```bash
 arui-scripts build
 ```
 
-### test
-Команда `arui-scripts test` внутри запускает jest с дополнительной конфигурацией.
+## test
 
 Конфигурация включает в себя:
 - Использование `jest-snapshot-serializer-class-name-to-string` для правильной работы с `cn`
@@ -36,6 +48,8 @@ arui-scripts build
 - Компиляцию .ts/.tsx файлов используя tsc
 - Замену импортов остальных типов файлов на импорт строк с названием файла
 
+Команда `arui-scripts test` внутри запускает jest с дополнительной конфигурацией.
+
 По умолчанию под маску для поиска тестов попадают все файлы `*test*.(js|jsx|ts|tsx)`, `*spec*.((js|jsx|ts|tsx))`, `*/__test__/*.(js|jsx|ts|tsx)`.
 
 Вы можете переопределять любые настройки jest в `package.json`, [документация](https://facebook.github.io/jest/docs/en/configuration.html).
@@ -53,11 +67,13 @@ _package.json_
 ```
 
 **Как запустить?**
+
 ```bash
 arui-scripts test
 ```
 
-### test:vitest
+## test:vitest
+
 Команда `arui-scripts test:vitest` запускает unit тесты через [Vitest](https://vitest.dev/).
 
 Если в корне проекта есть `vitest.config.ts` (или `.js`, `.mjs`, `.cjs`), то используется он.
@@ -91,10 +107,12 @@ export default mergeConfig(aruiConfig, defineConfig({
 arui-scripts test:vitest
 ```
 
-### docker-build
+## docker-build
+
 Собирает клиентский и серверный код в production-режиме, создает docker-образ и пушит его в docker-репозиторий.
 
 **Как запустить?**
+
 ```bash
 arui-scripts docker-build
 ```
@@ -115,7 +133,7 @@ yarn будет использоваться когда в рутовой пап
 docker run -p 8080:8080 container-name:version ./start.sh
 ```
 
-### docker-build:compiled
+## docker-build:compiled
 
 Команда `arui-scripts docker-build:compiled` во многом аналогична `docker-build`, но вместо сборки проекта использует уже скомпилированный в папку `.build` код.
 При этом в контейнер будут устанавливаться только production зависимости.
@@ -130,11 +148,12 @@ Dockerfile при этом будет сгенерирован автомати
 Локальный `Dockerfile` в корне проекта в данном случае полностью игнорируется.
 
 **Как запустить?**
+
 ```bash
 arui-scripts docker-build:compiled
 ```
 
-### archive-build
+## archive-build
 
 Собирает архив с production сборкой.
 
@@ -147,11 +166,12 @@ yarn будет использоваться когда в рутовой пап
 Итоговый архив будет содержать в себе `.build`, `node_modules`, `package.json` и `config` папки вашего проекта.
 
 **Как запустить?**
+
 ```bash
 arui-scripts archive-build
 ```
 
-### bundle-analyze
+## bundle-analyze
 
 Запускает [webpack-bundle-analyzer](https://www.npmjs.com/package/webpack-bundle-analyzer) и [rsdoctor](https://rsdoctor.dev/) для анализа бандла и сборки.
 Так же при запуске будет генерироваться [stats-файл](https://webpack.js.org/api/stats/), который можно использовать в

package/docs/settings.md

@@ -271,6 +271,28 @@ const packageSettings = {
 - `swc` - для всего кода будет использоваться `@swc/jest`.
   Swc более строго следует спецификациям и [не дает возможности](https://github.com/swc-project/swc/issues/5059) делать `spyOn` для экспортов из esm модулей.
 
+#### jestTransformNodeModules
+Список пакетов из `node_modules`, которые нужно прогонять через трансформер при запуске тестов. По умолчанию `[]`.
+
+```js
+module.exports = {
+    jestTransformNodeModules: ['uuid', '@scope/some-package'],
+};
+```
+
+Нужно для пакетов, которые публикуются только в формате ESM (`"type": "module"` без CommonJS сборки).
+По умолчанию jest не трансформирует ничего внутри `node_modules`, а его рантайм — CommonJS: он оборачивает
+файл в `function(module, exports, require, ...)` и выполняет его, поэтому на ESM-коде падает с
+`SyntaxError: Unexpected token 'export'`. Собственный `require(esm)` из Node тут не помогает — jest его не использует,
+а нативный ESM-режим самого jest до сих пор требует запуска ноды с `--experimental-vm-modules`.
+
+Настройка добавляет перечисленные пакеты в исключения `transformIgnorePatterns`, так что их код будет обработан
+тем же трансформером, который выбран в [jestCodeTransformer](#jestcodetransformer). Вложенные установки
+(`node_modules/foo/node_modules/uuid`) тоже учитываются.
+
+Если нужно что-то более тонкое, `transformIgnorePatterns` по-прежнему можно задать напрямую — через ключ `jest`
+в `package.json` или через `jest.config.js`, настройки приложения имеют приоритет над пресетом.
+
 #### collectCoverage
 Добавлять ли инструменты для сборки coverage при сборке. По умолчанию определяется по env переменным - будет выставлено в `true` если `NODE_ENV = 'cypress'` или `USE_ISTANBUL = 'enabled'`.
 Сбор coverage не будет работать при использовании `codeLoader=tsc`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arui-scripts",
-  "version": "23.1.0",
+  "version": "23.3.0",
   "main": "./build/index.js",
   "typings": "./build/index.d.ts",
   "exports": {
@@ -63,6 +63,7 @@
     "brotli-dict": "^1.1.4",
     "case-sensitive-paths-webpack-plugin": "2.4.0",
     "chalk": "^2.4.2",
+    "commander": "^12",
     "compression-webpack-plugin": "9.2.0",
     "core-js": "3.32.0",
     "css-loader": "6.8.1",
@@ -115,7 +116,7 @@
     "style-loader": "3.3.3",
     "swc-loader": "^0.2.6",
     "swc-plugin-coverage-instrument": "0.0.32",
-    "tar": "7.5.16",
+    "tar": "7.5.21",
     "terser-webpack-plugin": "5.3.14",
     "ts-checker-rspack-plugin": "^1.3.0",
     "ts-jest": "29.1.0",
@@ -151,6 +152,7 @@
   },
   "scripts": {
     "build": "sh bin/build.sh",
+    "cli": "node build/bin/index.js",
     "test": "jest",
     "test:vitest": "vitest",
     "lint:scripts": "arui-presets-lint scripts",