arui-scripts 14.0.0 → 14.1.1

package/README.md

@@ -1,10 +1,7 @@
 ARUI-scripts
 ===
 
-Приложение на нашем стеке без какой либо конфигурации билдеров.
-
-Во многом пакет аналогичен `react-scripts` из `create-react-app`, разница заключается
-в немного отличающихся настройках для `babel`, поддержки `ts` и возможности работы с серверным кодом.
+Простой и гибкий инструмент для одновременной сборки клиентской и серверной части react-приложений.
 
 Использование
 ===
@@ -78,7 +75,7 @@ npm install arui-scripts --save-dev
 - `devSourceMaps` - какой вид source-map использовать в режиме разработки. По умолчанию `eval`. Эта настройка может сильно влиять на время сборки. Подробнее можно почитать [здесь](https://webpack.js.org/configuration/devtool/).
 **Внимание**. При использовании любых source-map на основании `eval` webpack-dev-server будет модифицировать заголовок `Content-Security-Policy` (при наличии) и добавлять в него `unsafe-eval`. [Подробнее тут](#dev-csp).
 - `useTscLoader` -  использовать ts-loader вместо babel-loader для обработки ts файлов. У babel-loader есть [ряд ограничений](https://blogs.msdn.microsoft.com/typescript/2018/08/27/typescript-and-babel-7/). По умолчанию `false`.
-- `componentsTheme` - путь к css файлу с темой для [core-components](https://alfa-laboratory.github.io/core-components). Используется для настройки [postcss-custom-properties](https://github.com/postcss/postcss-custom-properties#importfrom).
+- `componentsTheme` - путь к css файлу с темой для [core-components](https://github.com/core-ds/core-components). Используется для настройки [postcss-custom-properties](https://github.com/postcss/postcss-custom-properties#importfrom).
 - `keepCssVars` - отключает `postcss-custom-properties`, css переменные будут оставаться в бандле.
 - `removeDevDependenciesDuringDockerBuild` - отключает удаление devDependencies из node_modules при сборке докер образа. Используется когда вам не нужно удалять devDependencies, т.к. в своём Dockerfile вы не переносите node_modules в докер-контейнер
 
@@ -294,7 +291,7 @@ docker
 
 Команда `arui-scripts docker-build` запускает компиляцию продакшн версии и сборку докер образа.
 
-Образ основан на [alpine-node-nginx](https://github.com/alfa-laboratory/arui-scripts/blob/master/packages/alpine-node-nginx/).
+Образ основан на [alpine-node-nginx](../alpine-node-nginx).
 
 Имя контейнера определяется как `{configs.dockerRegistry}/{name}:{version}`. Переменные `name` и `version` по умолчанию берутся из package.json,
 но вы так же можете переопределить их из командной строки, например
@@ -320,6 +317,12 @@ docker run -p 8080:8080 container-name:version ./start.sh
 
 `Dockerfile` в корне проекта имеет приоритет над overrides.
 
+Чтобы переопределить скрипт запуска, воспользуйтесь механизмом [overrides](#тонкая-настройка)
+или создайте в корневой директории проекта `start.sh` файл содержащий необходимый набор инструкций.
+Пример [start.sh](src/templates/start.template.ts).
+
+`start.sh` в корне проекта имеет приоритет над overrides.
+
 docker compiled
 ---
 Команда `arui-scripts docker-build:compiled` во многом аналогична `docker-build`, но вместо сборки проекта использует уже скомпилированный в папку `.build` код.

package/build/commands/docker-build/index.js

@@ -30,8 +30,9 @@ const yarn_1 = require("../util/yarn");
             pathToTempDir,
             dockerfileTemplate: dockerfile_template_1.default,
             nginxConfTemplate: nginx_conf_template_1.default,
-            startScript: start_template_1.default,
+            startScriptTemplate: start_template_1.default,
             allowLocalDockerfile: true,
+            allowLocalStartScript: true,
         });
         yield fs_extra_1.default.remove(app_configs_1.default.buildPath);
         console.timeEnd('Setting up time');

package/build/commands/docker-build-compiled/index.js

@@ -28,8 +28,9 @@ const docker_build_1 = require("../util/docker-build");
             pathToTempDir,
             dockerfileTemplate: dockerfile_compiled_template_1.default,
             nginxConfTemplate: nginx_conf_template_1.default,
-            startScript: start_template_1.default,
+            startScriptTemplate: start_template_1.default,
             allowLocalDockerfile: false,
+            allowLocalStartScript: false,
         });
         yield (0, exec_1.default)('echo "node_modules" >> .dockerignore');
         yield (0, exec_1.default)(`docker build -f "./${tempDirName}/Dockerfile" \\

package/build/commands/util/docker-build.d.ts

@@ -6,9 +6,10 @@ export declare function getBuildParamsFromArgs(): {
 type PrepareFilesForDockerParams = {
     dockerfileTemplate: string;
     nginxConfTemplate: string;
-    startScript: string;
+    startScriptTemplate: string;
     pathToTempDir: string;
     allowLocalDockerfile: boolean;
+    allowLocalStartScript: boolean;
 };
-export declare function prepareFilesForDocker({ dockerfileTemplate, nginxConfTemplate, startScript, pathToTempDir, allowLocalDockerfile, }: PrepareFilesForDockerParams): Promise<void>;
+export declare function prepareFilesForDocker({ dockerfileTemplate, nginxConfTemplate, startScriptTemplate, pathToTempDir, allowLocalDockerfile, allowLocalStartScript }: PrepareFilesForDockerParams): Promise<void>;
 export {};

package/build/commands/util/docker-build.js

@@ -49,7 +49,7 @@ function getBuildParamsFromArgs() {
     };
 }
 exports.getBuildParamsFromArgs = getBuildParamsFromArgs;
-function prepareFilesForDocker({ dockerfileTemplate, nginxConfTemplate, startScript, pathToTempDir, allowLocalDockerfile, }) {
+function prepareFilesForDocker({ dockerfileTemplate, nginxConfTemplate, startScriptTemplate, pathToTempDir, allowLocalDockerfile, allowLocalStartScript }) {
     return __awaiter(this, void 0, void 0, function* () {
         yield fs_extra_1.default.emptyDir(pathToTempDir);
         const nginxConf = app_configs_1.default.localNginxConf
@@ -58,6 +58,9 @@ function prepareFilesForDocker({ dockerfileTemplate, nginxConfTemplate, startScr
         const dockerfile = app_configs_1.default.localDockerfile && allowLocalDockerfile
             ? yield fs_extra_1.default.readFile(app_configs_1.default.localDockerfile, 'utf8')
             : dockerfileTemplate;
+        const startScript = app_configs_1.default.localStartScript && allowLocalStartScript
+            ? yield fs_extra_1.default.readFile(app_configs_1.default.localStartScript, 'utf8')
+            : startScriptTemplate;
         yield Promise.all([
             fs_extra_1.default.writeFile(path_1.default.join(pathToTempDir, 'Dockerfile'), dockerfile, 'utf8'),
             fs_extra_1.default.writeFile(path_1.default.join(pathToTempDir, 'nginx.conf'), nginxConf, 'utf8'),

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

@@ -21,6 +21,7 @@ function getDefaults() {
     const overridesPath = (0, resolve_1.tryResolve)(path_1.default.join(CWD, 'arui-scripts.overrides'));
     const nginxConfFilePath = path_1.default.join(CWD, 'nginx.conf');
     const dockerfileFilePath = path_1.default.join(CWD, 'Dockerfile');
+    const startScriptFilePath = path_1.default.join(CWD, 'start.sh');
     return {
         appPackage,
         name: appPackage.name,
@@ -50,6 +51,7 @@ function getDefaults() {
         tsconfig: fs_1.default.existsSync(projectTsConfigPath) ? projectTsConfigPath : null,
         localNginxConf: fs_1.default.existsSync(nginxConfFilePath) ? nginxConfFilePath : null,
         localDockerfile: fs_1.default.existsSync(dockerfileFilePath) ? dockerfileFilePath : null,
+        localStartScript: fs_1.default.existsSync(startScriptFilePath) ? startScriptFilePath : null,
         devSourceMaps: 'eval',
         useTscLoader: false,
         useServerHMR: false,

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

@@ -23,6 +23,7 @@ export type AppConfigs = {
     tsconfig: string | null;
     localNginxConf: string | null;
     localDockerfile: string | null;
+    localStartScript: string | null;
     devSourceMaps: string;
     useTscLoader: boolean;
     useServerHMR: boolean;

package/build/configs/util/get-entry.d.ts

@@ -1,7 +1,8 @@
 /**
  * @param {string|string[]|object} entryPoint Строка, массив строк или объект с энтрипоинтами
  * @param {Function} getSingleEntry Функция, возвращающая конфигурацию для одного entryPoint
+ * @param args Дополнительные аргументы, которые будут переданы в getSingleEntry функцию
  * @returns {*}
  */
-declare function getEntry(entryPoint: string | string[] | Record<string, string | string[]>, getSingleEntry: (entry: string[]) => string[]): string[] | Record<string, string | string[]>;
+declare function getEntry<AdditionalArgs extends unknown[]>(entryPoint: string | string[] | Record<string, string | string[]>, getSingleEntry: (entry: string[], ...args: AdditionalArgs) => string[], ...args: AdditionalArgs): string[] | Record<string, string | string[]>;
 export default getEntry;

package/build/configs/util/get-entry.js

@@ -3,18 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * @param {string|string[]|object} entryPoint Строка, массив строк или объект с энтрипоинтами
  * @param {Function} getSingleEntry Функция, возвращающая конфигурацию для одного entryPoint
+ * @param args Дополнительные аргументы, которые будут переданы в getSingleEntry функцию
  * @returns {*}
  */
-function getEntry(entryPoint, getSingleEntry) {
+function getEntry(entryPoint, getSingleEntry, ...args) {
     if (typeof entryPoint === 'string') {
-        return getSingleEntry([entryPoint]);
+        return getSingleEntry([entryPoint], ...args);
     }
     if (Array.isArray(entryPoint)) {
-        return getSingleEntry(entryPoint);
+        return getSingleEntry(entryPoint, ...args);
     }
     // client entry also can be an object, so we must add hot loader to each entry point
     return Object.keys(entryPoint).reduce((result, entryPointName) => {
-        const entry = getEntry(entryPoint[entryPointName], getSingleEntry);
+        const entry = getEntry(entryPoint[entryPointName], getSingleEntry, ...args);
         return Object.assign(Object.assign({}, result), { [entryPointName]: entry });
     }, {});
 }

package/build/configs/webpack.client.d.ts

@@ -0,0 +1,2 @@
+import { Configuration } from 'webpack';
+export declare const createClientWebpackConfig: (mode: 'dev' | 'prod') => Configuration;

package/build/configs/webpack.client.dev.d.ts

@@ -1,3 +1,2 @@
-import webpack from 'webpack';
-declare const webpackClientDev: webpack.Configuration;
-export default webpackClientDev;
+declare const config: import("webpack").Configuration;
+export default config;

package/build/configs/webpack.client.dev.js

@@ -3,297 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const webpack_1 = __importDefault(require("webpack"));
-const case_sensitive_paths_webpack_plugin_1 = __importDefault(require("case-sensitive-paths-webpack-plugin"));
-const fork_ts_checker_webpack_plugin_1 = __importDefault(require("fork-ts-checker-webpack-plugin"));
-const assets_webpack_plugin_1 = __importDefault(require("assets-webpack-plugin"));
-const tsconfig_paths_webpack_plugin_1 = __importDefault(require("tsconfig-paths-webpack-plugin"));
-const getCSSModuleLocalIdent_1 = __importDefault(require("react-dev-utils/getCSSModuleLocalIdent"));
-const PnpWebpackPlugin = require('pnp-webpack-plugin');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
-const ReactRefreshTypeScript = require('react-refresh-typescript');
-const app_configs_1 = __importDefault(require("./app-configs"));
-const babel_client_1 = __importDefault(require("./babel-client"));
-const babel_dependencies_1 = require("./babel-dependencies");
-const postcss_1 = __importDefault(require("./postcss"));
 const apply_overrides_1 = __importDefault(require("./util/apply-overrides"));
-const get_entry_1 = __importDefault(require("./util/get-entry"));
-// style files regexes
-const cssRegex = /\.css$/;
-const cssModuleRegex = /\.module\.css$/;
-function getSingleEntry(clientEntry) {
-    return [
-        ...(Array.isArray(app_configs_1.default.clientPolyfillsEntry) ? app_configs_1.default.clientPolyfillsEntry : [app_configs_1.default.clientPolyfillsEntry]),
-        require.resolve('webpack/hot/dev-server'),
-        // Finally, this is your app's code:
-        ...clientEntry,
-        // We include the app code last so that if there is a runtime error during
-        // initialization, it doesn't blow up the WebpackDevServer client, and
-        // changing JS code would still trigger a refresh.
-    ].filter(Boolean);
-}
-// This is the development configuration.
-// It is focused on developer experience and fast rebuilds.
-// The production configuration is different and lives in a separate file.
-const webpackClientDev = (0, apply_overrides_1.default)(['webpack', 'webpackClient', 'webpackDev', 'webpackClientDev'], {
-    target: 'web',
-    mode: 'development',
-    devtool: app_configs_1.default.devSourceMaps,
-    // These are the "entry points" to our application.
-    // This means they will be the "root" imports that are included in JS bundle.
-    entry: (0, get_entry_1.default)(app_configs_1.default.clientEntry, getSingleEntry),
-    context: app_configs_1.default.cwd,
-    output: {
-        // Add /* filename */ comments to generated require()s in the output.
-        pathinfo: true,
-        path: app_configs_1.default.clientOutputPath,
-        publicPath: app_configs_1.default.publicPath,
-        filename: '[name].js',
-        chunkFilename: '[name].js',
-        // Point sourcemap entries to original disk location (format as URL on Windows)
-        devtoolModuleFilenameTemplate: (info) => path_1.default
-            .relative(app_configs_1.default.appSrc, info.absoluteResourcePath)
-            .replace(/\\/g, '/'),
-    },
-    resolve: {
-        // This allows you to set a fallback for where Webpack should look for modules.
-        // We placed these paths second because we want `node_modules` to "win"
-        // if there are any conflicts. This matches Node resolution mechanism.
-        // https://github.com/facebookincubator/create-react-app/issues/253
-        modules: ['node_modules', app_configs_1.default.appNodeModules],
-        // These are the reasonable defaults supported by the Node ecosystem.
-        // We also include JSX as a common component filename extension to support
-        // some tools, although we do not recommend using it, see:
-        // https://github.com/facebookincubator/create-react-app/issues/290
-        // `web` extension prefixes have been added for better support
-        // for React Native Web.
-        extensions: ['.web.js', '.mjs', '.js', '.json', '.web.jsx', '.jsx', '.ts', '.tsx'],
-        plugins: ([
-            (app_configs_1.default.tsconfig && new tsconfig_paths_webpack_plugin_1.default({
-                configFile: app_configs_1.default.tsconfig,
-                extensions: ['.web.js', '.mjs', '.js', '.json', '.web.jsx', '.jsx', '.ts', '.tsx']
-            }))
-        ].filter(Boolean)),
-    },
-    resolveLoader: {
-        plugins: [
-            PnpWebpackPlugin.moduleLoader(module),
-        ],
-    },
-    cache: {
-        type: 'filesystem',
-        buildDependencies: {
-            config: [__filename],
-        },
-    },
-    module: {
-        // typescript interface will be removed from modules, and we will get an error on correct code
-        // see https://github.com/webpack/webpack/issues/7378
-        strictExportPresence: !app_configs_1.default.tsconfig,
-        rules: [
-            {
-                // "oneOf" will traverse all following loaders until one will
-                // match the requirements. When no loader matches it will fall
-                // back to the "file" loader at the end of the loader list.
-                oneOf: ([
-                    {
-                        test: [/\.svg$/],
-                        loader: require.resolve('svg-url-loader'),
-                        options: {
-                            limit: 10000,
-                            iesafe: true,
-                            name: '[name].[hash:8].[ext]',
-                        },
-                    },
-                    // "url" loader works like "file" loader except that it embeds assets
-                    // smaller than specified limit in bytes as data URLs to avoid requests.
-                    // A missing `test` is equivalent to a match.
-                    {
-                        test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/],
-                        loader: require.resolve('url-loader'),
-                        options: {
-                            limit: 10000,
-                            name: '[name].[hash:8].[ext]',
-                        },
-                    },
-                    // Process JS with Babel.
-                    {
-                        test: app_configs_1.default.useTscLoader ? /\.(js|jsx|mjs|cjs)$/ : /\.(js|jsx|mjs|ts|tsx|cjs)$/,
-                        include: app_configs_1.default.appSrc,
-                        use: [
-                            {
-                                loader: require.resolve('babel-loader'),
-                                options: Object.assign({
-                                    // This is a feature of `babel-loader` for webpack (not Babel itself).
-                                    // It enables caching results in ./node_modules/.cache/babel-loader/
-                                    // directory for faster rebuilds.
-                                    cacheDirectory: true,
-                                    plugins: require.resolve('react-refresh/babel')
-                                }, babel_client_1.default)
-                            }
-                        ]
-                    },
-                    (app_configs_1.default.tsconfig && app_configs_1.default.useTscLoader) && {
-                        test: /\.tsx?$/,
-                        use: [
-                            {
-                                loader: require.resolve('babel-loader'),
-                                options: Object.assign({
-                                    // This is a feature of `babel-loader` for webpack (not Babel itself).
-                                    // It enables caching results in ./node_modules/.cache/babel-loader/
-                                    // directory for faster rebuilds.
-                                    cacheDirectory: true,
-                                    cacheCompression: false,
-                                    plugins: require.resolve('react-refresh/babel')
-                                }, babel_client_1.default)
-                            },
-                            {
-                                loader: require.resolve('ts-loader'),
-                                options: {
-                                    getCustomTransformers: () => ({
-                                        before: [ReactRefreshTypeScript()],
-                                    }),
-                                    onlyCompileBundledFiles: true,
-                                    transpileOnly: true,
-                                    happyPackMode: true,
-                                    configFile: app_configs_1.default.tsconfig
-                                }
-                            }
-                        ]
-                    },
-                    // Process any JS outside of the app with Babel.
-                    // Unlike the application JS, we only compile the standard ES features.
-                    {
-                        test: /\.(js|mjs)$/,
-                        exclude: /@babel(?:\/|\\{1,2})runtime/,
-                        loader: require.resolve('babel-loader'),
-                        options: Object.assign(Object.assign({}, babel_dependencies_1.babelDependencies), { babelrc: false, configFile: false, compact: false, cacheDirectory: true, cacheCompression: false }),
-                    },
-                    // "postcss" loader applies autoprefixer to our CSS.
-                    // "css" loader resolves paths in CSS and adds assets as dependencies.
-                    // "style" loader turns CSS into JS modules that inject <style> tags.
-                    // In production, we use a plugin to extract that CSS to a file, but
-                    // in development "style" loader enables hot editing of CSS.
-                    {
-                        test: cssRegex,
-                        exclude: cssModuleRegex,
-                        use: [
-                            {
-                                loader: MiniCssExtractPlugin.loader,
-                                options: {
-                                    publicPath: './',
-                                },
-                            },
-                            {
-                                loader: require.resolve('css-loader'),
-                                options: {
-                                    importLoaders: 1,
-                                },
-                            },
-                            {
-                                loader: require.resolve('postcss-loader'),
-                                options: {
-                                    // Necessary for external CSS imports to work
-                                    // https://github.com/facebookincubator/create-react-app/issues/2677
-                                    ident: 'postcss',
-                                    plugins: () => postcss_1.default,
-                                },
-                            },
-                        ],
-                    },
-                    {
-                        test: cssModuleRegex,
-                        use: [
-                            {
-                                loader: MiniCssExtractPlugin.loader,
-                                options: {
-                                    publicPath: './',
-                                },
-                            },
-                            {
-                                loader: require.resolve('css-loader'),
-                                options: {
-                                    importLoaders: 1,
-                                    modules: {
-                                        getLocalIdent: getCSSModuleLocalIdent_1.default
-                                    },
-                                },
-                            },
-                            {
-                                loader: require.resolve('postcss-loader'),
-                                options: {
-                                    // Necessary for external CSS imports to work
-                                    // https://github.com/facebookincubator/create-react-app/issues/2677
-                                    ident: 'postcss',
-                                    plugins: () => postcss_1.default,
-                                },
-                            },
-                        ],
-                    },
-                    // "file" loader makes sure those assets get served by WebpackDevServer.
-                    // When you `import` an asset, you get its (virtual) filename.
-                    // In production, they would get copied to the `build` folder.
-                    // This loader doesn't use a "test" so it will catch all modules
-                    // that fall through the other loaders.
-                    {
-                        // Exclude `js` files to keep "css" loader working as it injects
-                        // its runtime that would otherwise processed through "file" loader.
-                        // Also exclude `html` and `json` extensions so they get processed
-                        // by webpacks internal loaders.
-                        exclude: [/\.(js|jsx|mjs|ts|tsx)$/, /\.(html|ejs)$/, /\.json$/],
-                        loader: require.resolve('file-loader'),
-                        options: {
-                            name: 'static/media/[name].[hash:8].[ext]',
-                        },
-                    },
-                ].filter(Boolean)),
-            },
-            // ** STOP ** Are you adding a new loader?
-            // Make sure to add the new loader(s) before the "file" loader.
-        ],
-    },
-    plugins: ([
-        new assets_webpack_plugin_1.default({ path: app_configs_1.default.serverOutputPath }),
-        new webpack_1.default.DefinePlugin({
-            'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'development'),
-            // Tell Webpack to provide empty mocks for process.env.
-            'process.env': '{}'
-        }),
-        new ReactRefreshWebpackPlugin({
-            overlay: {
-                sockIntegration: 'whm',
-            },
-        }),
-        // Watcher doesn't work well if you mistype casing in a path so we use
-        // a plugin that prints an error when you attempt to do this.
-        // See https://github.com/facebookincubator/create-react-app/issues/240
-        new case_sensitive_paths_webpack_plugin_1.default(),
-        app_configs_1.default.tsconfig !== null && new fork_ts_checker_webpack_plugin_1.default(),
-        new MiniCssExtractPlugin(),
-    ].filter(Boolean)),
-    // Turn off performance hints during development because we don't do any
-    // splitting or minification in interest of speed. These warnings become
-    // cumbersome.
-    performance: {
-        hints: false,
-    },
-    optimization: {
-        minimize: false,
-        nodeEnv: false,
-        // Оптимизации времени билда, см https://webpack.js.org/guides/build-performance/
-        removeAvailableModules: false,
-        removeEmptyChunks: false,
-        splitChunks: false
-    },
-    experiments: {
-        backCompat: app_configs_1.default.webpack4Compatibility,
-    },
-    // Без этого комиляция трирегилась на изменение в node_modules и приводила к утечке памяти
-    watchOptions: {
-        ignored: new RegExp(app_configs_1.default.watchIgnorePath.join('|')),
-        aggregateTimeout: 100,
-    }
-});
-exports.default = webpackClientDev;
+const webpack_client_1 = require("./webpack.client");
+const config = (0, apply_overrides_1.default)(['webpack', 'webpackClient', 'webpackDev', 'webpackClientDev'], (0, webpack_client_1.createClientWebpackConfig)('dev'));
+exports.default = config;