@mrktg/project-generator 1.0.0 → 1.1.0

package/README.md

@@ -10,14 +10,18 @@
 ## Что делает движок
 
 1. Вопросы (`@clack/prompts`): имя проекта (или `.` — текущая папка), бренд из реестра,
-   путь после `/journey/`, ставить ли зависимости, делать ли `git init`. Любой ответ можно передать
-   флагом (`--brand`, `--path`, `--install`/`--no-install`, `--git`/`--no-git`), тогда вопрос не задаётся.
+   путь после `/journey/`, флюидная ли вёрстка (по умолчанию нет), ставить ли зависимости,
+   делать ли `git init`. Любой ответ можно передать флагом (`--brand`, `--path`,
+   `--fluid`/`--no-fluid`, `--install`/`--no-install`, `--git`/`--no-git`), тогда вопрос не задаётся.
 2. `buildVars`: из бренда и региона собирает словарь для шаблона — прод-урл
    `https://<хост бренда>/journey/<путь>/`, `base` для Astro, фавиконка и язык бренда, урлы
    инфраструктуры региона (лоадер футера, clamp-scaling, лоадер аналитики), пакет и версия компонентов.
 3. `scaffold`: копирует `template/base` движка, поверх — `config.templateDir` регионального генератора.
-   Плейсхолдеры `{{KEY}}` подставляются, неизвестный ключ — ошибка. Файлы `_gitignore`, `_nvmrc`,
-   `_editorconfig` переименовываются в dot-файлы (npm выкидывает их при публикации).
+   Плейсхолдеры `{{KEY}}` подставляются, неизвестный ключ — ошибка. Блок `{{#KEY}}…{{/KEY}}`
+   на отдельных строках остаётся только при истинном значении (`{{^KEY}}` — наоборот): так
+   региональный шаблон подключает css из clamp-scaling только при флюидной вёрстке.
+   Файлы `_gitignore`, `_nvmrc`, `_editorconfig` переименовываются в dot-файлы
+   (npm выкидывает их при публикации).
 
 ## Конфиг регионального генератора
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrktg/project-generator",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Движок генератора лендингов: вопросы, шаблон Astro, подстановка. Бренды, регионы и региональные оверлеи приходят от региональных генераторов.",
   "type": "module",
   "files": [

package/src/args.js

@@ -15,6 +15,8 @@ export const readArgs = (argv) => {
       'no-install': { type: 'boolean' },
       git: { type: 'boolean' },
       'no-git': { type: 'boolean' },
+      fluid: { type: 'boolean' },
+      'no-fluid': { type: 'boolean' },
       help: { type: 'boolean', short: 'h' },
     },
   });
@@ -27,6 +29,7 @@ export const readArgs = (argv) => {
       projectName: positionals[0],
       brandId: values.brand,
       landingPath: values.path,
+      fluid: flag('fluid', 'no-fluid'),
       install: flag('install', 'no-install'),
       git: flag('git', 'no-git'),
     },
@@ -35,11 +38,12 @@ export const readArgs = (argv) => {
 
 export const buildHelp = ({ command, registry }) => `
 Использование:
-  npm create ${command.replace(/^create-/, '')} [имя-проекта | .] [-- флаги]
+  npm create ${command.replace(/(^|\/)create-/, '$1')} [имя-проекта | .] [-- флаги]
 
 Флаги (каждый заменяет соответствующий вопрос):
   --brand <id>       бренд: ${registry.brands.map((brand) => `${brand.id} (${brand.title.en})`).join(', ')}
   --path <slug>      путь лендинга после /journey/ (прод-урл: https://<хост бренда>/journey/<slug>/)
+  --fluid / --no-fluid   флюидная вёрстка (clamp-scaling); по умолчанию нет
   --install / --no-install
   --git / --no-git
   -h, --help

package/src/cli.js

@@ -18,7 +18,7 @@ const run = (cmd, args, cwd) =>
  * всё это приходит в config от регионального пакета.
  *
  * config:
- *   command           имя команды для справки, например create-xx-project
+ *   command           имя пакета генератора, например @scope/create-project: печатается в шапке и в справке
  *   registry          реестр брендов региона (brands-core IRegistry)
  *   region            регион с host, bucketHost, componentsPackage
  *   templateDir       папка регионального оверлея шаблона (кладётся поверх template/base движка)

package/src/questions.js

@@ -58,6 +58,14 @@ export const buildQuestions = ({ registry }) => [
       }),
     validate: validateLandingPath,
   },
+  {
+    id: 'fluid',
+    ask: () =>
+      p.confirm({
+        message: 'Флюидная вёрстка (1rem = 1px макета, clamp-scaling)?',
+        initialValue: false,
+      }),
+  },
   {
     id: 'install',
     ask: () => p.confirm({ message: 'Установить зависимости (npm install)?', initialValue: true }),

package/src/render.js

@@ -1,10 +1,23 @@
+/** Блок вида {{#KEY}} … {{/KEY}} на отдельных строках: остаётся, если vars.KEY истинно. {{^KEY}} — наоборот. */
+const SECTION_RE = /^[ \t]*\{\{([#^])([A-Z0-9_]+)\}\}[ \t]*\r?\n([\s\S]*?)^[ \t]*\{\{\/\2\}\}[ \t]*\r?\n/gm;
+
 const PLACEHOLDER_RE = /\{\{([A-Z0-9_]+)\}\}/g;
 
-/** Подставляет {{KEY}} из vars. Неизвестный ключ — ошибка, чтобы шаблон не разъезжался с vars.js. */
+const requireVar = (vars, key, fileName) => {
+  if (!(key in vars)) {
+    throw new Error(`В шаблоне ${fileName} плейсхолдер {{${key}}}, которого нет в buildVars()`);
+  }
+  return vars[key];
+};
+
+/**
+ * Сначала раскрывает условные блоки, потом подставляет {{KEY}} из vars.
+ * Неизвестный ключ — ошибка, чтобы шаблон не разъезжался с vars.js.
+ */
 export const render = (source, vars, fileName = '') =>
-  source.replace(PLACEHOLDER_RE, (_, key) => {
-    if (!(key in vars)) {
-      throw new Error(`В шаблоне ${fileName} плейсхолдер {{${key}}}, которого нет в buildVars()`);
-    }
-    return String(vars[key]);
-  });
+  source
+    .replace(SECTION_RE, (_, kind, key, body) => {
+      const keep = kind === '#' ? Boolean(requireVar(vars, key, fileName)) : !requireVar(vars, key, fileName);
+      return keep ? body : '';
+    })
+    .replace(PLACEHOLDER_RE, (_, key) => String(requireVar(vars, key, fileName)));

package/src/vars.js

@@ -31,6 +31,8 @@ export const buildVars = async (config, answers) => {
     FAVICON_TYPE: brand.favicon.type,
     COMPONENTS_PACKAGE: region.componentsPackage,
     COMPONENTS_VERSION: await componentsVersion(region.componentsPackage),
+    // Флюидная вёрстка: подключать ли css из clamp-scaling
+    FLUID: answers.fluid === true,
     ANALYTICS_LOADER_URL: analyticsLoaderUrl(region),
     CLAMP_SCALING_BASE_URL: clampScalingBaseUrl(region),
     FOOTER_LOADER_URL: footerLoaderUrl(region),

package/template/base/src/site.config.ts

@@ -9,4 +9,5 @@ export const SITE = {
   lang: "{{LANG}}",
   prodUrl: "{{PROD_URL}}",
   assetsHost: "{{ASSETS_HOST}}",
+  fluid: {{FLUID}},
 } as const;