Skip to content

Настройки: settings.weld ​

Настройки секции settings.weld общие для правил плагина и CLI. Их также можно переопределить в опциях конкретного правила.

js
export default [
    {
        settings: {
            weld: {
                // Схема слоев
                layers: ['app', 'pages', '@modules', 'common'],
                moduleLayers: ['widgets', 'features', 'entities'],

                // Конфигурация директорий
                flatModules: false,
                modulesDir: 'modules',
                srcDir: 'src',

                // Конфигурация репозитория
                aliases: { '@/*': ['src/*'] },
                aliasesBaseUrl: '.',
                repoRoot: '.',
                tsconfig: 'tsconfig.json',
            },
        },
    },
];

Схема слоев ​

Назначение опций описано в Слои модулей и слои приложения.

Имя слоя начинается с буквы и может содержать буквы, цифры, ., - и _.

Имя слоя не может совпадать с modulesDir.

layers ​

Слои приложения.

В layers также используются метки:

  • @modules — место слоев модулей в схеме, может встречаться только раз и задается вместе с moduleLayers
  • @unknown — место кода, не относящегося ни к одному слою проекта

moduleLayers ​

Слои модулей.

Настройка обязательна при наличии @modules в layers и недопустима без нее.

Конфигурация директорий ​

flatModules ​

Значение по умолчанию — false

При true корневые модули расположены прямо в srcDir; при false — в контейнере modulesDir. Вложенные модули в обоих случаях находятся в контейнере.

modulesDir ​

Значение по умолчанию — modules

Имя директории-контейнера модулей. Одно имя используется в корне проекта и внутри каждого модуля.

Значение — имя директории, без /, \, @, :.

srcDir ​

Значение по умолчанию — src

Директория исходного кода относительно корня репозитория.

Ведущий / также отсчитывается от корня репозитория.

При автоматическом определении корня он может отличаться для разных файлов монорепозитория, поэтому один и тот же srcDir может указывать на разные директории.

Конфигурация репозитория ​

aliases ​

По умолчанию — paths из tsconfig; при отсутствии — пустой список.

Алиасы для разрешения импортов.

Формат похож на compilerOptions.paths в tsconfig: ключу соответствует строка или массив путей.

js
aliases: {
    '@/*': ['src/*'],
    '@config': ['src/config/index.ts'],
}

Пути отсчитываются от aliasesBaseUrl. Поддерживаются ключи и пути без * либо с /* на конце; прочие записи со звездочкой пропускаются. Целью должна быть директория или ее точка входа index: запись на другой файл пропускается.

При проверке импортов WELD сопоставляет префикс целиком или с продолжением через /, в том числе для ключа без *. Это отличается от TypeScript, где такой ключ соответствует только точному импорту. Если подходят несколько записей, используется самый длинный префикс; при равной длине — запись, указанная раньше.

При построении пути импорта точный ключ подходит только для своего якоря, а ключ с /* — для его поддерева. Если подходящего алиаса нет, правило предлагает относительный путь, а weld inspect показывает путь от корня репозитория.

aliasesBaseUrl ​

Значение по умолчанию — . (корень репозитория).

База для путей из явно заданных aliases, относительно repoRoot. На алиасы из tsconfig эта настройка не влияет.

repoRoot ​

По умолчанию определяется по .git, package.json и якорям алиасов.

Корень репозитория, от которого отсчитываются виртуальные пути. Явный относительный путь отсчитывается от текущей директории запуска ESLint или CLI.

tsconfig ​

Значение по умолчанию — tsconfig.json.

Имя файла, в котором автоматически ищутся алиасы. Настройка не влияет на явно заданные aliases.

Переопределение в правилах ​

Каждую настройку можно переопределить в опциях конкретного правила. Опция целиком заменяет одноименное поле settings.weld, в том числе каждый из списков слоев. Незаданные поля берутся из settings.weld.

js
export default [
    {
        settings: {
            weld: {
                aliases: {
                    '@/*': ['src/*'],
                },
                repoRoot: '.',
            },
        },
        rules: {
            'weld/no-barrel-bypass': [
                'error',
                {
                    aliasesBaseUrl: 'src',
                },
            ],
        },
    },
];

Действующий aliasesBaseUrl применяется и к aliases из settings.weld, если переопределена только база.