lint: добавление линтера

Reviewed-on: #5
Co-authored-by: Arswarog <arswarog@yandex.ru>
Co-committed-by: Arswarog <arswarog@yandex.ru>

.docuservix.yml

@@ -1,4 +1,4 @@
-title: "Title example"
+title: 'Title example'
 project:
-  org: "example"
+    org: 'example'
-  repo: "example"
+    repo: 'example'

.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged

.prettierignore

@@ -0,0 +1,7 @@
+dist
+coverage
+*.d.ts
+node_modules
+.idea
+logs
+report

.prettierrc.json

@@ -0,0 +1,29 @@
+{
+    "printWidth": 100,
+    "useTabs": false,
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "singleAttributePerLine": true,
+    "overrides": [
+        {
+            "files": [
+                "*.json"
+            ],
+            "options": {
+                "printWidth": 10
+            }
+        },
+        {
+            "files": [
+                "*.md",
+                "*.mdx"
+            ],
+            "options": {
+                "proseWrap": "always"
+            }
+        }
+    ]
+}

README.md

@@ -14,7 +14,8 @@ yarn
 yarn start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens up a browser window. Most changes are
+reflected live without having to restart the server.
 
 ## Build
 
@@ -22,4 +23,5 @@ This command starts a local development server and opens up a browser window. Mo
 yarn build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the `build` directory and can be served using any static
+contents hosting service.

action.yml

@@ -2,120 +2,120 @@ name: 'Docusaurus Deploy'
 description: 'Builds Docusaurus docs from repo and deploys to S3'
 
 inputs:
-  docs-path:
+    docs-path:
-    description: 'Path to docs directory in calling repo'
+        description: 'Path to docs directory in calling repo'
-    default: 'docs'
+        default: 'docs'
-  on-broken-links:
+    on-broken-links:
-    description: 'Behavior on broken links: throw, warn, or ignore'
+        description: 'Behavior on broken links: throw, warn, or ignore'
-    default: 'throw'
+        default: 'throw'
-  prefix:
+    prefix:
-    description: 'Prefix for S3 path'
+        description: 'Prefix for S3 path'
-    default: ''
+        default: ''
 
 runs:
-  using: 'composite'
+    using: 'composite'
-  steps:
+    steps:
-    - name: Compute target URL
+        - name: Compute target URL
-      shell: bash
+          shell: bash
-      run: |
+          run: |
-        REF="${{ github.head_ref || github.ref_name }}"
+              REF="${{ github.head_ref || github.ref_name }}"
-        REPO="${{ github.event.repository.name }}"
+              REPO="${{ github.event.repository.name }}"
-        ORG="${{ github.repository_owner }}"
+              ORG="${{ github.repository_owner }}"
 
-        if [[ "$REF" == "main" || "$REF" == "master" ]]; then
+              if [[ "$REF" == "main" || "$REF" == "master" ]]; then
-          URL="http://${REPO}.${ORG}.jt4d-wiki.ru.net"
+                URL="http://${REPO}.${ORG}.jt4d-wiki.ru.net"
-          S3_PATH="${ORG}.${REPO}"
+                S3_PATH="${ORG}.${REPO}"
-        else
+              else
-          URL="http://${REF}.${REPO}.${ORG}.jt4d-wiki.ru.net"
+                URL="http://${REF}.${REPO}.${ORG}.jt4d-wiki.ru.net"
-          S3_PATH="${ORG}.${REPO}.${REF}"
+                S3_PATH="${ORG}.${REPO}.${REF}"
-        fi
+              fi
 
-        PREFIX="${{ inputs.prefix }}"
+              PREFIX="${{ inputs.prefix }}"
-        if [[ -n "$PREFIX" ]]; then
+              if [[ -n "$PREFIX" ]]; then
-          S3_PATH="${PREFIX}/${S3_PATH}"
+                S3_PATH="${PREFIX}/${S3_PATH}"
-        fi
+              fi
 
-        echo "TARGET_URL=$URL" >> $GITHUB_ENV
+              echo "TARGET_URL=$URL" >> $GITHUB_ENV
-        echo "S3_PATH=$S3_PATH" >> $GITHUB_ENV
+              echo "S3_PATH=$S3_PATH" >> $GITHUB_ENV
 
-    - name: Set docs status pending
+        - name: Set docs status pending
-      shell: bash
+          shell: bash
-      run: |
+          run: |
-        curl -s -X POST \
+              curl -s -X POST \
-          -H "Authorization: token ${{ github.token }}" \
+                -H "Authorization: token ${{ github.token }}" \
-          -H "Content-Type: application/json" \
+                -H "Content-Type: application/json" \
-          -d '{
+                -d '{
-            "state": "pending",
+                  "state": "pending",
-            "context": "Docs",
+                  "context": "Docs",
-            "description": "building",
+                  "description": "building",
-            "target_url": "${{ env.TARGET_URL }}"
+                  "target_url": "${{ env.TARGET_URL }}"
-          }' \
+                }' \
-          "${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"
+                "${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"
 
-    - name: Copy docs into Docusaurus
+        - name: Copy docs into Docusaurus
-      shell: bash
+          shell: bash
-      run: |
+          run: |
-        DOCUSAURUS_DIR="${{ github.action_path }}"
+              DOCUSAURUS_DIR="${{ github.action_path }}"
-        rm -rf "${DOCUSAURUS_DIR}/docs"
+              rm -rf "${DOCUSAURUS_DIR}/docs"
-        cp -r "${{ inputs.docs-path }}" "${DOCUSAURUS_DIR}/docs"
+              cp -r "${{ inputs.docs-path }}" "${DOCUSAURUS_DIR}/docs"
-        cp "${{ github.workspace }}/.docuservix.yml" "${DOCUSAURUS_DIR}"
+              cp "${{ github.workspace }}/.docuservix.yml" "${DOCUSAURUS_DIR}"
 
-    - name: Prepare docs
+        - name: Prepare docs
-      shell: bash
+          shell: bash
-      working-directory: ${{ github.action_path }}
+          working-directory: ${{ github.action_path }}
-      run: node scripts/prepare-docs.mjs
+          run: node scripts/prepare-docs.mjs
 
-    - name: Install Docusaurus dependencies
+        - name: Install Docusaurus dependencies
-      shell: bash
+          shell: bash
-      working-directory: ${{ github.action_path }}
+          working-directory: ${{ github.action_path }}
-      run: yarn install --frozen-lockfile
+          run: yarn install --frozen-lockfile
 
-    - name: Build docs
+        - name: Build docs
-      shell: bash
+          shell: bash
-      working-directory: ${{ github.action_path }}
+          working-directory: ${{ github.action_path }}
-      env:
+          env:
-        DOCUSERVIX_ON_BROKEN_LINKS: ${{ inputs.on-broken-links }}
+              DOCUSERVIX_ON_BROKEN_LINKS: ${{ inputs.on-broken-links }}
-        DOCUSERVIX_URL: ${{ env.TARGET_URL }}
+              DOCUSERVIX_URL: ${{ env.TARGET_URL }}
-      run: yarn docusaurus build --out-dir ${{ github.workspace }}/generated-docs
+          run: yarn docusaurus build --out-dir ${{ github.workspace }}/generated-docs
 
-    - name: Upload to S3
+        - name: Upload to S3
-      shell: bash
+          shell: bash
-      env:
+          env:
-        AWS_ACCESS_KEY_ID: ${{ vars.DOCUSERVIX_S3_ACCESS }}
+              AWS_ACCESS_KEY_ID: ${{ vars.DOCUSERVIX_S3_ACCESS }}
-        AWS_SECRET_ACCESS_KEY: ${{ vars.DOCUSERVIX_S3_SECRET }}
+              AWS_SECRET_ACCESS_KEY: ${{ vars.DOCUSERVIX_S3_SECRET }}
-      run: |
+          run: |
-        aws s3 sync generated-docs/ \
+              aws s3 sync generated-docs/ \
-          s3://${{ vars.DOCUSERVIX_S3_BUCKET }}/${{ env.S3_PATH }}\
+                s3://${{ vars.DOCUSERVIX_S3_BUCKET }}/${{ env.S3_PATH }}\
-          --endpoint-url ${{ vars.DOCUSERVIX_S3_URL }} \
+                --endpoint-url ${{ vars.DOCUSERVIX_S3_URL }} \
-          --acl public-read \
+                --acl public-read \
-          --delete
+                --delete
 
-    - name: Set docs status success
+        - name: Set docs status success
-      if: success()
+          if: success()
-      shell: bash
+          shell: bash
-      run: |
+          run: |
-        curl -s -X POST \
+              curl -s -X POST \
-          -H "Authorization: token ${{ github.token }}" \
+                -H "Authorization: token ${{ github.token }}" \
-          -H "Content-Type: application/json" \
+                -H "Content-Type: application/json" \
-          -d '{
+                -d '{
-            "state": "success",
+                  "state": "success",
-            "context": "Docs",
+                  "context": "Docs",
-            "description": "deployed",
+                  "description": "deployed",
-            "target_url": "${{ env.TARGET_URL }}"
+                  "target_url": "${{ env.TARGET_URL }}"
-          }' \
+                }' \
-          "${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"
+                "${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"
 
-    - name: Set docs status failure
+        - name: Set docs status failure
-      if: failure()
+          if: failure()
-      shell: bash
+          shell: bash
-      run: |
+          run: |
-        curl -s -X POST \
+              curl -s -X POST \
-          -H "Authorization: token ${{ github.token }}" \
+                -H "Authorization: token ${{ github.token }}" \
-          -H "Content-Type: application/json" \
+                -H "Content-Type: application/json" \
-          -d '{
+                -d '{
-            "state": "failure",
+                  "state": "failure",
-            "context": "Docs",
+                  "context": "Docs",
-            "description": "build failed",
+                  "description": "build failed",
-            "target_url": "${{ env.TARGET_URL }}"
+                  "target_url": "${{ env.TARGET_URL }}"
-          }' \
+                }' \
-          "${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"
+                "${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"

docs/index.md

@@ -1,3 +1,3 @@
 # Добро пожаловать в Docuservix!
 
-Вам надо настроить публикацию документации по инструкции в https://git.jt4d.ru/jt4d/docuservix
+Вам надо настроить публикацию документации по инструкции в https://git.jt4d.ru/jt4d/docuservix

docusaurus.config.ts

@@ -1,9 +1,10 @@
 import fs from 'fs';
-import yaml from 'js-yaml';
+
-import {themes as prismThemes} from 'prism-react-renderer';
-import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
-import type {NavbarItem} from '@docusaurus/theme-common'
+import type { NavbarItem } from '@docusaurus/theme-common';
+import type { Config } from '@docusaurus/types';
+import yaml from 'js-yaml';
+import { themes as prismThemes } from 'prism-react-renderer';
 
 interface DocsConfig {
     title: string;
@@ -13,24 +14,17 @@ interface DocsConfig {
 
 const docsConfig = yaml.load(fs.readFileSync('./.docuservix.yml', 'utf8')) as DocsConfig;
 
-const {
+const { title } = docsConfig;
-    title,
-} = docsConfig
 
 const url = process.env.DOCUSERVIX_URL;
 
-const {
+const { org, repo } = docsConfig.project;
-    org,
-    repo
-} = docsConfig.project
 
-const {
+const { docs: _docsDir = 'docs', blog: blogDir } = docsConfig.dirs || {};
-    docs: docsDir = 'docs',
-    blog: blogDir
-} = docsConfig.dirs || {}
 
 const giteaUrl = 'https://git.jt4d.ru';
-const onBrokenLinks = (process.env.DOCUSERVIX_ON_BROKEN_LINKS as Config['onBrokenLinks']) || 'throw';
+const onBrokenLinks =
+    (process.env.DOCUSERVIX_ON_BROKEN_LINKS as Config['onBrokenLinks']) || 'throw';
 
 const config: Config = {
     title,
@@ -107,11 +101,13 @@ const config: Config = {
                     label: 'Документация',
                     position: 'left',
                 },
-                blogDir ? {
+                blogDir
-                    to: '/blog',
+                    ? {
-                    label: 'Блог',
+                          to: '/blog',
-                    position: 'left'
+                          label: 'Блог',
-                } : undefined,
+                          position: 'left',
+                      }
+                    : undefined,
                 {
                     href: `${giteaUrl}/${org}/${repo}`,
                     label: 'Gitea',
@@ -121,7 +117,8 @@ const config: Config = {
         },
         footer: {
             style: 'dark',
-            copyright: `Проект хостится на JT4D.ru, документация собрана с использованием Docuservix и Docusaurus.`,
+            copyright:
+                'Проект хостится на JT4D.ru, документация собрана с использованием Docuservix и Docusaurus.',
         },
         prism: {
             theme: prismThemes.github,

eslint.config.mjs

@@ -0,0 +1,351 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { fixupPluginRules } from '@eslint/compat';
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import etc from 'eslint-plugin-etc';
+import _import from 'eslint-plugin-import';
+import noOnlyTests from 'eslint-plugin-no-only-tests';
+import noSkipTests from 'eslint-plugin-no-skip-tests';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import unusedImports from 'eslint-plugin-unused-imports';
+import globals from 'globals';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all,
+});
+
+export default [
+    {
+        ignores: [
+            '**/.eslintrc.js',
+            '**/node_modules',
+            '**/coverage',
+            '**/build',
+            '**/.docusaurus',
+            '**/vite.config.*.timestamp*',
+            '**/vitest.config.*.timestamp*',
+        ],
+    },
+    ...compat.extends(
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+        'prettier',
+        'plugin:eslint-comments/recommended',
+    ),
+    {
+        plugins: {
+            import: fixupPluginRules(_import),
+            react,
+            'react-hooks': fixupPluginRules(reactHooks),
+            '@typescript-eslint': typescriptEslint,
+            etc,
+            'no-only-tests': noOnlyTests,
+            'no-skip-tests': noSkipTests,
+            'unused-imports': unusedImports,
+        },
+
+        languageOptions: {
+            globals: {
+                ...globals.node,
+                ...globals.jest,
+            },
+
+            parser: tsParser,
+            ecmaVersion: 6,
+            sourceType: 'module',
+
+            parserOptions: {
+                ecmaFeatures: {
+                    modules: true,
+                },
+            },
+        },
+
+        settings: {
+            'import/resolver': {
+                node: {
+                    extensions: ['.js', '.ts', '.tsx', '.json'],
+                },
+
+                typescript: {
+                    alwaysTryTypes: true,
+                },
+            },
+
+            react: {
+                version: 'detect',
+            },
+        },
+
+        rules: {
+            '@typescript-eslint/interface-name-prefix': 'off',
+            '@typescript-eslint/explicit-function-return-type': 'off',
+            '@typescript-eslint/explicit-module-boundary-types': 'off',
+
+            curly: ['error', 'all'],
+            'max-params': 'off',
+
+            'no-console': [
+                'error',
+                {
+                    allow: ['warn', 'error'],
+                },
+            ],
+
+            'no-warning-comments': [
+                'error',
+                {
+                    terms: ['fixme'],
+                    location: 'anywhere',
+                },
+            ],
+
+            'no-unused-vars': 'off',
+            'space-before-blocks': 'error',
+
+            'padding-line-between-statements': [
+                'error',
+                {
+                    blankLine: 'always',
+                    prev: '*',
+                    next: ['break', 'continue', 'return'],
+                },
+                {
+                    blankLine: 'always',
+                    prev: ['const', 'let'],
+                    next: '*',
+                },
+                {
+                    blankLine: 'any',
+                    prev: ['const', 'let'],
+                    next: ['const', 'let'],
+                },
+                {
+                    blankLine: 'always',
+                    prev: 'directive',
+                    next: '*',
+                },
+                {
+                    blankLine: 'any',
+                    prev: 'directive',
+                    next: 'directive',
+                },
+                {
+                    blankLine: 'always',
+                    prev: 'block-like',
+                    next: '*',
+                },
+                {
+                    blankLine: 'always',
+                    prev: '*',
+                    next: 'block-like',
+                },
+            ],
+
+            'import/order': [
+                'error',
+                {
+                    pathGroups: [
+                        {
+                            pattern: 'react,bem-css-modules',
+                            group: 'builtin',
+                            position: 'before',
+                        },
+                        {
+                            pattern: '@docuservix/**',
+                            group: 'internal',
+                        },
+                    ],
+
+                    pathGroupsExcludedImportTypes: ['react'],
+                    'newlines-between': 'always',
+                    groups: ['builtin', 'external', 'internal', 'parent', ['sibling', 'index']],
+
+                    alphabetize: {
+                        order: 'asc',
+                        caseInsensitive: true,
+                    },
+                },
+            ],
+
+            'react/no-direct-mutation-state': 'error',
+            'react/no-deprecated': 'error',
+            'react/no-unsafe': 'error',
+            'react/jsx-uses-vars': 'error',
+            'react/jsx-uses-react': 'error',
+            'react/jsx-curly-brace-presence': ['error', 'never'],
+            'react-hooks/rules-of-hooks': 'error',
+            'react-hooks/exhaustive-deps': 'warn',
+
+            quotes: [
+                'error',
+                'single',
+                {
+                    avoidEscape: true,
+                },
+            ],
+
+            'quote-props': ['warn', 'as-needed'],
+
+            '@typescript-eslint/no-explicit-any': [
+                'warn',
+                {
+                    ignoreRestArgs: true,
+                },
+            ],
+
+            '@typescript-eslint/member-ordering': [
+                'error',
+                {
+                    default: [
+                        'public-static-field',
+                        'protected-static-field',
+                        'private-static-field',
+
+                        'public-instance-field',
+                        'protected-instance-field',
+                        'private-instance-field',
+
+                        'constructor',
+
+                        'public-instance-method',
+                        'protected-instance-method',
+                        'private-instance-method',
+
+                        'public-static-method',
+                        'protected-static-method',
+                        'private-static-method',
+
+                        'signature',
+                    ],
+                },
+            ],
+
+            'etc/prefer-interface': [
+                'warn',
+                {
+                    allowLocal: true,
+                },
+            ],
+
+            '@typescript-eslint/ban-ts-comment': [
+                'error',
+                {
+                    'ts-ignore': 'allow-with-description',
+                    'ts-nocheck': 'allow-with-description',
+                    'ts-check': false,
+                    'ts-expect-error': false,
+                },
+            ],
+
+            '@typescript-eslint/no-empty-interface': 'warn',
+            '@typescript-eslint/no-empty-function': 'warn',
+            '@typescript-eslint/no-unused-vars': 'off',
+            // todo изучить и включить
+            '@typescript-eslint/no-unused-expressions': 'off',
+
+            // todo изучить и включить
+            '@typescript-eslint/no-empty-object-type': 'off',
+
+            'no-restricted-imports': [
+                'error',
+                {
+                    paths: [
+                        {
+                            name: '@nestjs/swagger',
+                            importNames: ['PartialType'],
+                            message:
+                                "Please import 'PartialType' from '@src/server/common/nest' instead.",
+                        },
+                        {
+                            name: 'react-bootstrap',
+                            importNames: [
+                                'Card',
+                                'CardHeader',
+                                'CardBody',
+                                'CardFooter',
+                                'Row',
+                                'Col',
+                                'Modal',
+                            ],
+                            message: "Please use project's components with same name",
+                        },
+                        {
+                            name: 'react-bootstrap/Modal',
+                            message: "Please use project's components with same name",
+                        },
+                        {
+                            name: '@nestjs/common',
+                            importNames: ['Logger'],
+                            message: "Please import 'Logger' from '@src/server/logger' instead.",
+                        },
+                        {
+                            name: 'nestjs-pino',
+                            importNames: ['Logger', 'PinoLogger'],
+                            message: "Please import 'Logger' from '@src/server/logger' instead.",
+                        },
+                    ],
+                },
+            ],
+
+            'unused-imports/no-unused-imports': 'error',
+
+            'unused-imports/no-unused-vars': [
+                'error',
+                {
+                    vars: 'all',
+                    args: 'after-used',
+                    ignoreRestSiblings: true,
+                    argsIgnorePattern: '^_',
+                    varsIgnorePattern: '^_',
+                    caughtErrorsIgnorePattern: '^_',
+                },
+            ],
+
+            'eslint-comments/require-description': [
+                'error',
+                {
+                    ignore: ['eslint-enable'],
+                },
+            ],
+
+            'eslint-comments/disable-enable-pair': [
+                'error',
+                {
+                    allowWholeFile: true,
+                },
+            ],
+
+            complexity: ['warn', 10],
+            eqeqeq: ['error'],
+            'func-style': ['warn', 'declaration'],
+        },
+    },
+    {
+        files: ['**/*.spec.{js,jsx,ts,tsx}'],
+
+        rules: {
+            'no-only-tests/no-only-tests': 'error',
+            'no-skip-tests/no-skip-tests': 'warn',
+
+            'no-console': [
+                'warn',
+                {
+                    allow: ['warn', 'error'],
+                },
+            ],
+
+            '@typescript-eslint/no-non-null-assertion': 'off',
+        },
+    },
+];

package.json

@@ -1,52 +1,85 @@
 {
-  "name": "docusaurus",
+    "name": "docusaurus",
-  "version": "0.0.0",
+    "version": "0.0.0",
-  "private": true,
+    "private": true,
-  "scripts": {
+    "scripts": {
-    "docusaurus": "docusaurus",
+        "build": "docusaurus build",
-    "start": "docusaurus start",
+        "clear": "docusaurus clear",
-    "build": "docusaurus build",
+        "deploy": "docusaurus deploy",
-    "swizzle": "docusaurus swizzle",
+        "docusaurus": "docusaurus",
-    "deploy": "docusaurus deploy",
+        "eslint:check": "yarn eslint",
-    "clear": "docusaurus clear",
+        "eslint:fix": "yarn eslint --fix",
-    "serve": "docusaurus serve",
+        "lint": "run-s eslint:fix prettier:fix",
-    "write-translations": "docusaurus write-translations",
+        "lint:check": "run-s eslint:check prettier:check",
-    "write-heading-ids": "docusaurus write-heading-ids",
+        "prepare": "husky",
-    "typecheck": "tsc"
+        "prettier:check": "prettier --check \"**/*.{ts,tsx,js,mjs,json,yml,yaml,md,mdx}\"",
-  },
+        "prettier:fix": "prettier --write \"**/*.{ts,tsx,js,mjs,json,yml,yaml,md,mdx}\"",
-  "dependencies": {
+        "serve": "docusaurus serve",
-    "@docusaurus/core": "3.10.1",
+        "start": "docusaurus start",
-    "@docusaurus/faster": "3.10.1",
+        "swizzle": "docusaurus swizzle",
-    "@docusaurus/preset-classic": "3.10.1",
+        "typecheck": "tsc",
-    "@docusaurus/theme-mermaid": "3.10.1",
+        "write-heading-ids": "docusaurus write-heading-ids",
-    "@mdx-js/react": "^3.0.0",
+        "write-translations": "docusaurus write-translations"
-    "clsx": "^2.0.0",
+    },
-    "js-yaml": "^4.2.0",
+    "lint-staged": {
-    "prism-react-renderer": "^2.3.0",
+        "*.{json,ts,tsx,js,jsx,js,mjs,md,mdx,yaml,yml}": "prettier --write",
-    "react": "^19.0.0",
+        "{src,e2e}/**/*.{ts,tsx}": "eslint --quiet --fix"
-    "react-dom": "^19.0.0"
+    },
-  },
+    "browserslist": {
-  "devDependencies": {
+        "production": [
-    "@docusaurus/module-type-aliases": "3.10.1",
+            ">0.5%",
-    "@docusaurus/tsconfig": "3.10.1",
+            "not dead",
-    "@docusaurus/types": "3.10.1",
+            "not op_mini all"
-    "@types/js-yaml": "^4.0.9",
+        ],
-    "@types/react": "^19.0.0",
+        "development": [
-    "typescript": "~6.0.2"
+            "last 3 chrome version",
-  },
+            "last 3 firefox version",
-  "browserslist": {
+            "last 5 safari version"
-    "production": [
+        ]
-      ">0.5%",
+    },
-      "not dead",
+    "dependencies": {
-      "not op_mini all"
+        "@docusaurus/core": "3.10.1",
-    ],
+        "@docusaurus/faster": "3.10.1",
-    "development": [
+        "@docusaurus/preset-classic": "3.10.1",
-      "last 3 chrome version",
+        "@docusaurus/theme-mermaid": "3.10.1",
-      "last 3 firefox version",
+        "@mdx-js/react": "^3.0.0",
-      "last 5 safari version"
+        "clsx": "^2.0.0",
-    ]
+        "js-yaml": "^4.2.0",
-  },
+        "prism-react-renderer": "^2.3.0",
-  "engines": {
+        "react": "^19.0.0",
-    "node": ">=20.0"
+        "react-dom": "^19.0.0"
-  }
+    },
+    "devDependencies": {
+        "@docusaurus/module-type-aliases": "3.10.1",
+        "@docusaurus/tsconfig": "3.10.1",
+        "@docusaurus/types": "3.10.1",
+        "@eslint/compat": "^1.1.1",
+        "@eslint/eslintrc": "^3.1.0",
+        "@eslint/js": "^9.8.0",
+        "@types/js-yaml": "^4.0.9",
+        "@types/react": "^19.0.0",
+        "@typescript-eslint/eslint-plugin": "^8.0.0",
+        "@typescript-eslint/parser": "^8.0.0",
+        "eslint": "^9.8.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-import-resolver-typescript": "^4.4.5",
+        "eslint-plugin-eslint-comments": "^3.2.0",
+        "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-no-only-tests": "^3.1.0",
+        "eslint-plugin-no-skip-tests": "^1.1.0",
+        "eslint-plugin-prettier": "^5.2.1",
+        "eslint-plugin-react": "^7.37.5",
+        "eslint-plugin-react-hooks": "^7.1.1",
+        "eslint-plugin-unused-imports": "^4.0.1",
+        "globals": "^17.6.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^17.0.7",
+        "npm-run-all": "^4.1.5",
+        "prettier": "^3.8.4",
+        "typescript": "~6.0.2"
+    },
+    "engines": {
+        "node": ">=20.0"
+    }
 }

scripts/prepare-docs.mjs

@@ -1,3 +1,5 @@
+/* eslint-disable no-console -- logs required */
+
 import fs from 'fs';
 import path from 'path';
 
@@ -9,23 +11,33 @@ pinIndexToTop();
  * Гарантирует наличие sidebar_position: 0 в front matter файла index.md
  */
 function pinIndexToTop() {
-  const indexPath = path.join(docsDir, 'index.md');
+    const indexPath = path.join(docsDir, 'index.md');
-  if (!fs.existsSync(indexPath)) return;
 
-  let content = fs.readFileSync(indexPath, 'utf8');
+    if (!fs.existsSync(indexPath)) {
+        return;
+    }
 
-  if (content.startsWith('---\n')) {
+    let content = fs.readFileSync(indexPath, 'utf8');
-    const endIdx = content.indexOf('\n---\n', 4);
-    if (endIdx === -1) return;
 
-    const frontMatter = content.slice(4, endIdx);
+    if (content.startsWith('---\n')) {
-    if (/^sidebar_position\s*:/m.test(frontMatter)) return;
+        const endIdx = content.indexOf('\n---\n', 4);
 
-    content = '---\nsidebar_position: 0\n' + frontMatter + '\n---\n' + content.slice(endIdx + 5);
+        if (endIdx === -1) {
-  } else {
+            return;
-    content = '---\nsidebar_position: 0\n---\n' + content;
+        }
-  }
 
-  fs.writeFileSync(indexPath, content);
+        const frontMatter = content.slice(4, endIdx);
-  console.log('prepare-docs: pinned index.md to sidebar top');
+
+        if (/^sidebar_position\s*:/m.test(frontMatter)) {
+            return;
+        }
+
+        content =
+            '---\nsidebar_position: 0\n' + frontMatter + '\n---\n' + content.slice(endIdx + 5);
+    } else {
+        content = '---\nsidebar_position: 0\n---\n' + content;
+    }
+
+    fs.writeFileSync(indexPath, content);
+    console.log('prepare-docs: pinned index.md to sidebar top');
 }

src/pages/index.tsx

@@ -1,40 +1,47 @@
-import type {ReactNode} from 'react';
-import clsx from 'clsx';
 import Link from '@docusaurus/Link';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import Layout from '@theme/Layout';
 import Heading from '@theme/Heading';
+import Layout from '@theme/Layout';
+import clsx from 'clsx';
+import type { ReactNode } from 'react';
 
 import styles from './index.module.css';
 
 function HomepageHeader() {
-  const {siteConfig} = useDocusaurusContext();
+    const { siteConfig } = useDocusaurusContext();
-  return (
+
-    <header className={clsx('hero hero--primary', styles.heroBanner)}>
+    return (
-      <div className="container">
+        <header className={clsx('hero hero--primary', styles.heroBanner)}>
-        <Heading as="h1" className="hero__title">
+            <div className="container">
-          {siteConfig.title}
+                <Heading
-        </Heading>
+                    as="h1"
-        <p className="hero__subtitle">{siteConfig.tagline}</p>
+                    className="hero__title"
-        <div className={styles.buttons}>
+                >
-          <Link
+                    {siteConfig.title}
-            className="button button--secondary button--lg"
+                </Heading>
-            to="/docs">
+                <p className="hero__subtitle">{siteConfig.tagline}</p>
-            Документация
+                <div className={styles.buttons}>
-          </Link>
+                    <Link
-        </div>
+                        className="button button--secondary button--lg"
-      </div>
+                        to="/docs"
-    </header>
+                    >
-  );
+                        Документация
+                    </Link>
+                </div>
+            </div>
+        </header>
+    );
 }
 
 export default function Home(): ReactNode {
-  const {siteConfig} = useDocusaurusContext();
+    const { siteConfig } = useDocusaurusContext();
-  return (
+
-    <Layout
+    return (
-      title={`Hello from ${siteConfig.title}`}
+        <Layout
-      description="Description will go into a meta tag in <head />">
+            title={`Hello from ${siteConfig.title}`}
-      <HomepageHeader />
+            description="Description will go into a meta tag in <head />"
-    </Layout>
+        >
-  );
+            <HomepageHeader />
+        </Layout>
+    );
 }

tsconfig.json

@@ -2,11 +2,14 @@
 // It is here to improve your IDE experience (type-checking, autocompletion...),
 // and can also run the package.json "typecheck" script manually.
 {
-  "extends": "@docusaurus/tsconfig",
+    "extends": "@docusaurus/tsconfig",
-  "compilerOptions": {
+    "compilerOptions": {
-    "baseUrl": ".",
+        "baseUrl": ".",
-    "ignoreDeprecations": "6.0",
+        "ignoreDeprecations": "6.0",
-    "strict": true
+        "strict": true
-  },
+    },
-  "exclude": [".docusaurus", "build"]
+    "exclude": [
+        ".docusaurus",
+        "build"
+    ]
 }