@cherepanov.pavel/shareable-config 1.0.0

package/tools/stylelint-config/rules/property-groups.js

@@ -0,0 +1,404 @@
+/**
+ * @typedef {Object} Group
+ * @property {Array<string>} properties
+ */
+
+/** @type {Group[]} */
+export const propertyGroups = [
+  {
+    /**
+     * Compose rules from other selectors in CSS Modules.
+     * @see https://github.com/css-modules/css-modules#composition
+     */
+    properties: ['composes'],
+  },
+  {
+    // Must be first (unless using the above).
+    properties: [
+      'all',
+      'content',
+    ],
+  },
+  {
+    // Position.
+    properties: [
+      'position',
+      'inset',
+      'inset-block',
+      'inset-block-start',
+      'inset-block-end',
+      'inset-inline',
+      'inset-inline-start',
+      'inset-inline-end',
+      'top',
+      'right',
+      'bottom',
+      'left',
+      'z-index',
+    ],
+  },
+  {
+    // Display mode.
+    properties: ['box-sizing', 'display'],
+  },
+  {
+    // Flexible boxes.
+    properties: [
+      'flex',
+      'flex-basis',
+      'flex-direction',
+      'flex-flow',
+      'flex-grow',
+      'flex-shrink',
+      'flex-wrap',
+      'grid',
+      'grid-area',
+      'grid-template',
+      'grid-template-areas',
+      'grid-template-rows',
+      'grid-template-columns',
+      'grid-row',
+      'grid-row-start',
+      'grid-row-end',
+      'grid-column',
+      'grid-column-start',
+      'grid-column-end',
+      'grid-auto-rows',
+      'grid-auto-columns',
+      'grid-auto-flow',
+      'grid-gap',
+      'grid-row-gap',
+      'grid-column-gap',
+      'gap',
+      'row-gap',
+      'column-gap',
+      'place-content',
+      'place-items',
+      'place-self',
+      'align-content',
+      'align-items',
+      'align-self',
+      'justify-content',
+      'justify-items',
+      'justify-self',
+      'order',
+    ],
+  },
+  {
+    // Box model.
+    properties: [
+      'float',
+      'inline-size',
+      'min-inline-size',
+      'max-inline-size',
+      'width',
+      'min-width',
+      'max-width',
+      'inline-size',
+      'min-inline-size',
+      'max-inline-size',
+      'height',
+      'min-height',
+      'max-height',
+      'aspect-ratio',
+      'padding',
+      'padding-block',
+      'padding-block-start',
+      'padding-block-end',
+      'padding-inline',
+      'padding-inline-start',
+      'padding-inline-end',
+      'padding-top',
+      'padding-right',
+      'padding-bottom',
+      'padding-left',
+      'margin',
+      'margin-block',
+      'margin-block-start',
+      'margin-block-end',
+      'margin-inline',
+      'margin-inline-start',
+      'margin-inline-end',
+      'margin-top',
+      'margin-right',
+      'margin-bottom',
+      'margin-left',
+      'overflow',
+      'overflow-block',
+      'overflow-inline',
+      'overflow-x',
+      'overflow-y',
+      '-webkit-overflow-scrolling',
+      '-ms-overflow-x',
+      '-ms-overflow-y',
+      '-ms-overflow-style',
+      'overscroll-behavior',
+      'overscroll-behavior-inline',
+      'overscroll-behavior-block',
+      'overscroll-behavior-x',
+      'overscroll-behavior-y',
+      'clip',
+      'clip-path',
+      'clear',
+    ],
+  },
+  {
+    // Typography.
+    properties: [
+      'font',
+      'font-family',
+      'font-size',
+      'font-variation-settings',
+      'font-style',
+      'font-weight',
+      'font-feature-settings',
+      'font-optical-sizing',
+      'font-kerning',
+      'font-variant',
+      'font-variant-ligatures',
+      'font-variant-caps',
+      'font-variant-alternates',
+      'font-variant-numeric',
+      'font-variant-east-asian',
+      'font-variant-position',
+      'font-size-adjust',
+      'font-stretch',
+      'font-effect',
+      'font-emphasize',
+      'font-emphasize-position',
+      'font-emphasize-style',
+      '-webkit-font-smoothing',
+      '-moz-osx-font-smoothing',
+      'font-smooth',
+      'hyphens',
+      'line-height',
+      'color',
+      'text-align',
+      'text-align-last',
+      'text-emphasis',
+      'text-emphasis-color',
+      'text-emphasis-style',
+      'text-emphasis-position',
+      'text-decoration',
+      'text-decoration-line',
+      'text-decoration-thickness',
+      'text-decoration-style',
+      'text-decoration-color',
+      'text-underline-position',
+      'text-underline-offset',
+      'text-indent',
+      'text-justify',
+      'text-outline',
+      '-ms-text-overflow',
+      'text-overflow',
+      'text-overflow-ellipsis',
+      'text-overflow-mode',
+      'text-shadow',
+      'text-transform',
+      'text-wrap',
+      '-webkit-text-size-adjust',
+      '-ms-text-size-adjust',
+      'letter-spacing',
+      'word-break',
+      'word-spacing',
+      'word-wrap', // Legacy name for `overflow-wrap`
+      'overflow-wrap',
+      'tab-size',
+      'white-space',
+      'vertical-align',
+
+      'list-style',
+      'list-style-position',
+      'list-style-type',
+      'list-style-image',
+
+      'src',
+      'font-display',
+      'unicode-range',
+      'size-adjust',
+      'ascent-override',
+      'descent-override',
+      'line-gap-override',
+    ],
+  },
+  {
+    // Accessibility & Interactions.
+    properties: [
+      'appearance',
+      'accent-color',
+      'color-scheme',
+      'pointer-events',
+      '-ms-touch-action',
+      'touch-action',
+      'cursor',
+      'caret-color',
+      'visibility',
+      'zoom',
+      'table-layout',
+      'empty-cells',
+      'caption-side',
+      'border-spacing',
+      'border-collapse',
+      'quotes',
+      'counter-reset',
+      'counter-set',
+      'counter-increment',
+      'resize',
+      'user-select',
+      'nav-index',
+      'nav-up',
+      'nav-right',
+      'nav-down',
+      'nav-left',
+    ],
+  },
+  {
+    // Background & Borders.
+    properties: [
+      'background',
+      'background-color',
+      'background-image',
+      "-ms-filter:\\'progid:DXImageTransform.Microsoft.gradient",
+      'filter:progid:DXImageTransform.Microsoft.gradient',
+      'filter:progid:DXImageTransform.Microsoft.AlphaImageLoader',
+      'filter',
+      'background-repeat',
+      'background-attachment',
+      'background-position',
+      'background-position-x',
+      'background-position-y',
+      'background-clip',
+      'background-origin',
+      'background-size',
+      'background-blend-mode',
+      'isolation',
+      'backdrop-filter',
+      'border',
+      'border-color',
+      'border-style',
+      'border-width',
+      'border-block',
+      'border-block-start',
+      'border-block-start-color',
+      'border-block-start-style',
+      'border-block-start-width',
+      'border-block-end',
+      'border-block-end-color',
+      'border-block-end-style',
+      'border-block-end-width',
+      'border-inline',
+      'border-inline-start',
+      'border-inline-start-color',
+      'border-inline-start-style',
+      'border-inline-start-width',
+      'border-inline-end',
+      'border-inline-end-color',
+      'border-inline-end-style',
+      'border-inline-end-width',
+      'border-top',
+      'border-top-color',
+      'border-top-style',
+      'border-top-width',
+      'border-right',
+      'border-right-color',
+      'border-right-style',
+      'border-right-width',
+      'border-bottom',
+      'border-bottom-color',
+      'border-bottom-style',
+      'border-bottom-width',
+      'border-left',
+      'border-left-color',
+      'border-left-style',
+      'border-left-width',
+      'border-radius',
+      'border-start-start-radius',
+      'border-start-end-radius',
+      'border-end-start-radius',
+      'border-end-end-radius',
+      'border-top-left-radius',
+      'border-top-right-radius',
+      'border-bottom-right-radius',
+      'border-bottom-left-radius',
+      'border-image',
+      'border-image-source',
+      'border-image-slice',
+      'border-image-width',
+      'border-image-outset',
+      'border-image-repeat',
+      'outline',
+      'outline-width',
+      'outline-style',
+      'outline-color',
+      'outline-offset',
+      'box-shadow',
+      'mix-blend-mode',
+      'filter:progid:DXImageTransform.Microsoft.Alpha(Opacity',
+      "-ms-filter:\\'progid:DXImageTransform.Microsoft.Alpha",
+      'opacity',
+      '-ms-interpolation-mode',
+    ],
+  },
+  {
+    // SVG Presentation Attributes.
+    properties: [
+      'alignment-baseline',
+      'baseline-shift',
+      'dominant-baseline',
+      'text-anchor',
+      'word-spacing',
+      'writing-mode',
+
+      'fill',
+      'fill-opacity',
+      'fill-rule',
+      'stroke',
+      'stroke-dasharray',
+      'stroke-dashoffset',
+      'stroke-linecap',
+      'stroke-linejoin',
+      'stroke-miterlimit',
+      'stroke-opacity',
+      'stroke-width',
+
+      'color-interpolation',
+      'color-interpolation-filters',
+      'color-profile',
+      'color-rendering',
+      'flood-color',
+      'flood-opacity',
+      'image-rendering',
+      'lighting-color',
+      'marker-start',
+      'marker-mid',
+      'marker-end',
+      'mask',
+      'shape-rendering',
+      'stop-color',
+      'stop-opacity',
+    ],
+  },
+  {
+    // Transitions & Animation.
+    properties: [
+      'transition',
+      'transition-delay',
+      'transition-timing-function',
+      'transition-duration',
+      'transition-property',
+      'transform',
+      'transform-origin',
+      'rotate',
+      'scale',
+      'translate',
+      'animation',
+      'animation-name',
+      'animation-duration',
+      'animation-play-state',
+      'animation-timing-function',
+      'animation-delay',
+      'animation-iteration-count',
+      'animation-direction',
+    ],
+  },
+];

package/tools/stylelint-config/rules/scss.js

@@ -0,0 +1,8 @@
+export default {
+  rules: {
+    /* $-variables */
+    'scss/dollar-variable-empty-line-before': ['never', { ignore: 'after-dollar-variable' }],
+    // https://gitlab.kadnk.ru/frontend/configs/-/issues/1
+    'scss/load-partial-extension': 'always',
+  },
+};

package/tools/stylelint-config/rules/stylistic.js

@@ -0,0 +1,124 @@
+const INDENT_SIZE = 2;
+const MAX_EMPTY_LINES = 1;
+// const MAX_LINE_LENGTH = 80;
+
+const ALWAYS = 'always';
+const ALWAYS_MULTI_LINE = 'always-multi-line';
+const ALWAYS_SINGLE_LINE = 'always-single-line';
+
+const NEVER = 'never';
+const NEVER_MULTI_LINE = 'never-multi-line';
+const NEVER_SINGLE_LINE = 'never-single-line';
+
+const LOWER_CASE = 'lower';
+
+export default {
+  rules: {
+    /* == common == */
+    '@stylistic/indentation': INDENT_SIZE,
+    '@stylistic/linebreaks': 'unix',
+    '@stylistic/max-empty-lines': MAX_EMPTY_LINES,
+    // '@stylistic/max-line-length': [MAX_LINE_LENGTH, { ignorePattern: '/^@(import|use)\\s+/' }],
+    '@stylistic/no-empty-first-line': true,
+    '@stylistic/no-eol-whitespace': true,
+    '@stylistic/no-extra-semicolons': true,
+    '@stylistic/no-missing-end-of-source-newline': true,
+    '@stylistic/unicode-bom': NEVER,
+
+    /* == color == */
+    '@stylistic/color-hex-case': LOWER_CASE,
+
+    /* == function == */
+    '@stylistic/function-comma-newline-after': ALWAYS_MULTI_LINE,
+    '@stylistic/function-comma-newline-before': NEVER_MULTI_LINE,
+    '@stylistic/function-comma-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/function-comma-space-before': NEVER,
+    '@stylistic/function-max-empty-lines': 0,
+    '@stylistic/function-parentheses-space-inside': NEVER_SINGLE_LINE,
+    '@stylistic/function-whitespace-after': ALWAYS,
+
+    /* == number == */
+    '@stylistic/number-leading-zero': ALWAYS,
+    '@stylistic/number-no-trailing-zeros': true,
+
+    /* == string == */
+    '@stylistic/string-quotes': 'double',
+
+    /* == unit == */
+    '@stylistic/unit-case': LOWER_CASE,
+
+    /* == value list == */
+    '@stylistic/value-list-comma-newline-after': ALWAYS_MULTI_LINE,
+    '@stylistic/value-list-comma-newline-before': NEVER_MULTI_LINE,
+    '@stylistic/value-list-comma-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/value-list-comma-space-before': NEVER,
+    '@stylistic/value-list-max-empty-lines': 0,
+
+    /* == property == */
+    '@stylistic/property-case': LOWER_CASE,
+
+    /* == declaration == */
+    '@stylistic/declaration-bang-space-after': NEVER,
+    '@stylistic/declaration-bang-space-before': ALWAYS,
+    '@stylistic/declaration-colon-newline-after': ALWAYS_MULTI_LINE,
+    '@stylistic/declaration-colon-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/declaration-colon-space-before': NEVER,
+
+    /* == declaration block == */
+    '@stylistic/declaration-block-semicolon-newline-after': ALWAYS,
+    '@stylistic/declaration-block-semicolon-newline-before': NEVER_MULTI_LINE,
+    '@stylistic/declaration-block-semicolon-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/declaration-block-semicolon-space-before': NEVER,
+    '@stylistic/declaration-block-trailing-semicolon': ALWAYS,
+
+    /* == block == */
+    '@stylistic/block-closing-brace-empty-line-before': NEVER,
+    '@stylistic/block-closing-brace-newline-after': ALWAYS,
+    '@stylistic/block-closing-brace-newline-before': ALWAYS,
+    '@stylistic/block-closing-brace-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/block-closing-brace-space-before': ALWAYS_SINGLE_LINE,
+    '@stylistic/block-opening-brace-newline-after': ALWAYS,
+    '@stylistic/block-opening-brace-newline-before': null,
+    '@stylistic/block-opening-brace-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/block-opening-brace-space-before': ALWAYS,
+
+    /* == selector == */
+    '@stylistic/selector-attribute-brackets-space-inside': NEVER,
+    '@stylistic/selector-attribute-operator-space-after': NEVER,
+    '@stylistic/selector-attribute-operator-space-before': NEVER,
+    '@stylistic/selector-combinator-space-after': ALWAYS,
+    '@stylistic/selector-combinator-space-before': ALWAYS,
+    '@stylistic/selector-descendant-combinator-no-non-space': true,
+    '@stylistic/selector-max-empty-lines': 0,
+    '@stylistic/selector-pseudo-class-case': LOWER_CASE,
+    '@stylistic/selector-pseudo-class-parentheses-space-inside': NEVER,
+    '@stylistic/selector-pseudo-element-case': LOWER_CASE,
+
+    /* == selector list == */
+    '@stylistic/selector-list-comma-newline-after': ALWAYS,
+    '@stylistic/selector-list-comma-newline-before': NEVER_MULTI_LINE,
+    '@stylistic/selector-list-comma-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/selector-list-comma-space-before': NEVER,
+
+    /* == media features == */
+    '@stylistic/media-feature-colon-space-after': ALWAYS,
+    '@stylistic/media-feature-colon-space-before': NEVER,
+    '@stylistic/media-feature-name-case': LOWER_CASE,
+    '@stylistic/media-feature-parentheses-space-inside': NEVER,
+    '@stylistic/media-feature-range-operator-space-after': ALWAYS,
+    '@stylistic/media-feature-range-operator-space-before': ALWAYS,
+
+    /* == media query list == */
+    '@stylistic/media-query-list-comma-newline-after': ALWAYS_MULTI_LINE,
+    '@stylistic/media-query-list-comma-newline-before': NEVER_MULTI_LINE,
+    '@stylistic/media-query-list-comma-space-after': ALWAYS_SINGLE_LINE,
+    '@stylistic/media-query-list-comma-space-before': NEVER_SINGLE_LINE,
+
+    /* == at rule == */
+    '@stylistic/at-rule-name-case': LOWER_CASE,
+    '@stylistic/at-rule-name-newline-after': ALWAYS_MULTI_LINE,
+    '@stylistic/at-rule-name-space-after': ALWAYS,
+    '@stylistic/at-rule-semicolon-newline-after': ALWAYS,
+    '@stylistic/at-rule-semicolon-space-before': NEVER,
+  },
+};

package/utils/communication.js

@@ -0,0 +1,33 @@
+import readline from 'readline';
+
+export async function askTypescript() {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+    rl.question(
+      'Вы используете typescript? (Enter - нет, любые символы + Enter - да):',
+      (answer) => {
+        rl.close();
+        resolve(Boolean(answer.trim().toLowerCase()));
+      },
+    );
+  });
+}
+
+export async function askFramework() {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+    rl.question(
+      'Какой фреймворк вы используете? (vue/nuxt/quasar, нажмите Enter, чтобы скопировать только framework-less): ',
+      (answer) => {
+        rl.close();
+        resolve(answer.trim().toLowerCase());
+      },
+    );
+  });
+}

package/utils/copy-with-override.js

@@ -0,0 +1,43 @@
+import { readFile } from 'fs/promises';
+import { getHeader } from '../utils/file-header.js'
+import { outputFile } from 'fs-extra';
+
+export async function copyFile({ destFile, srcFileData, fileLabel }){
+  // Если файла нет — просто создаём его
+  try {
+    await readFile(destFile, 'utf8');
+  } catch {
+    await outputFile(destFile, `${getHeader('#')}${srcFileData}`);
+    console.info(`${fileLabel} пересоздан`);
+    return {};
+  }
+
+  // Если файл есть — разбираем оба файла
+  const destFileData = await readFile(destFile, 'utf8')
+  // Ищем строку override (без учёта регистра)
+  const overrideRegex = /^# override.*$/im;
+  const match = destFileData.match(overrideRegex);
+  if (!match) {
+    await outputFile(destFile, `${getHeader('#')}${srcFileData}`);
+    console.info(`${fileLabel} пересоздан`);
+    return {};
+  }
+
+  return { destFileData, match }
+}
+
+export async function copyWithOverride({ destFile, srcFileData, fileLabel = '' }) {
+  try {
+    const { destFileData, match } = await copyFile({ destFile, srcFileData, fileLabel })
+    if(!destFileData) return
+
+    const overrideIndex = destFileData.indexOf(match[0]);
+    const preserved = destFileData.slice(overrideIndex);
+    const newContent = srcFileData.trimEnd() + '\n\n' + preserved.trimStart();
+
+    await outputFile(destFile, `${getHeader('#')}${newContent}`);
+    console.info(`${fileLabel} обновлён с учётом override`);
+  } catch (err) {
+    console.error(`Ошибка копирования ${fileLabel}:`, err.message);
+  }
+}

package/utils/env.js

@@ -0,0 +1,16 @@
+import { readFile } from 'fs/promises';
+import path from 'path';
+import JSON5 from 'json5';
+import { outputFile } from 'fs-extra';
+
+const envFileSrc = path.join(process.cwd(), 'frontend-configs.env.json5');
+
+export async function getEnvs() {
+  const srcFileData = await readFile(envFileSrc, 'utf8');
+  const parsedSrcFileData = JSON5.parse(srcFileData);
+  return parsedSrcFileData;
+}
+
+export async function setEnvs(envObj) {
+  await outputFile(envFileSrc, JSON5.stringify(envObj, null, 2));
+}

package/utils/file-header.js

@@ -0,0 +1,16 @@
+import { readFile } from 'fs/promises';
+
+const pkg = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8'));
+
+export function getHeader(comment = '//') {
+  const lines = [
+    'This file is generated with',
+    `${pkg.repository?.url || ''}`,
+    `Version: ${pkg.version || ''}`,
+    'File may contain override sections, see project README for more details',
+  ];
+
+  return `${lines.map((line) => {
+    return `${comment} ${line}`.trim();
+  }).join('\n')}\n`;
+}