arui-scripts 14.0.0 → 14.1.0

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;