npm.io
0.6.3 • Published 5 years ago

auto-imports-plugin

Licence
MIT
Version
0.6.3
Deps
1
Size
102 kB
Vulns
0
Weekly
0

auto-imports-plugin

auto resolver pug, scss e.t.c imports. for webpack

npm i -D auto-imports-plugin

автоматическое построение импортов до компонентов/блоков web-страницы которому нужен только список имён компонентов.

технически это генерация файлов заданного расширения с импортами. в резолвящем файле нужно импортить только этот сгенерированный файл.

ограничения (лёгкая версия БЭМ ограничений):

  • единое пространство имён блоков
  • блоки должны быть на одном уровне в их каталоге, но каталогов с блоками может быть много и где угодно
  • нужно в конфиге явно указать адреса каталогов с блоками
  • имя каталога блока == baseName импортируемого в нём файла
  • в коревом файле импортируется рядом лежащий файл для сгенерированных импортов (imports.pug например) куда плагин и сложит адреса до его импортов и всех вложенных импортов
  • если блоку нужны дополниетльные импорты:
    • в каталоге блока нужно положить json с массивом имён нужных блоков
options
{
  sources: string[], // components folders
  startDirs: string[], // pages folders
  basenameImportFiles: string, // example: imports
  importsExprGenerators: Map<string, (importPath: string) => string>,
  withoutExt?: boolean,
}

Keywords