@advdominion/babel-plugin-nunjucks

packages/babel-plugin-nunjucks/README.md

@@ -0,0 +1,70 @@
+# babel-plugin-nunjucks
+
+Плагин для [babel-loader](https://github.com/babel/babel-loader), позволяющий использовать шаблонизатор [Nunjucks](https://mozilla.github.io/nunjucks/) внутри JS-файлов.
+
+## Установка
+
+```bash
+yarn add -D @advdominion/babel-plugin-nunjucks
+```
+
+## Использование
+
+Используются [Tagged templates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates) с тегом `njk`:
+
+```js
+njk`
+    {% from "./item.njk" import item as item %}
+
+    <div class="items">
+		{% for n in range(0, 10) %}
+			{{item()}}
+		{% endfor %}
+    </div>
+`;
+```
+
+Пример конфигурации Webpack:
+
+```js
+[
+    {
+        test: /\.js$/,
+        exclude: [/mocks\.js$/],
+        use: [
+            {
+                loader: 'babel-loader',
+                options: {
+                    cacheDirectory: true,
+                },
+            },
+        ],
+    },
+    {
+        test: /mocks\.js$/,
+        use: [
+            {
+                loader: 'babel-loader',
+                options: {
+                    compact: false,
+                    plugins: [
+                        [
+                            '@advdominion/babel-plugin-nunjucks',
+                            {
+                                templatesFolder: 'src/templates/',
+                            },
+                        ],
+                    ],
+                },
+            },
+        ],
+    },
+];
+```
+
+## Опции
+
+-   `templatesFolder` - строка, обязательный параметр. Путь до папки с файлами шаблонов
+-   `globals` - массив, необязательный параметр. Глобальные переменные для Nunjucks (например, `[{name: "message", value: "Hello, world!"}]`)
+
+**Важно:** Параметр `cacheDirectory` в опциях babel-loader должен быть отключён.