feat: add flat config (#348)

* feat add flat config

* Create tidy-rockets-tap.md

Author: ota-meshi

.changeset/tidy-rockets-tap.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-lodash-template": minor
+---
+
+feat: add flat config

README.md

@@ -61,6 +61,18 @@ See [documents](https://ota-meshi.github.io/eslint-plugin-lodash-template/).
 
 Create `.eslintrc.*` file to configure rules. See also: [http://eslint.org/docs/user-guide/configuring](http://eslint.org/docs/user-guide/configuring).
 
+Example **eslint.config.js**:
+
+```js
+import lodashTemplate from 'eslint-plugin-lodash-template'
+export default [
+    {
+        files: ['**/*.html'],
+        ...lodashTemplate.configs['flat/recommended-with-html']
+    }
+]
+```
+
 Example **.eslintrc.js**:
 
 ```js
@@ -122,6 +134,20 @@ This plugin does special handling for the following rule warnings in the templat
 
 ## Configs
 
+### For `eslint.config.js`
+
+This plugin provides 7 predefined configs:
+
+- `*.configs['flat/base']` - Settings and rules to enable correct ESLint parsing
+- `*.configs['flat/base-with-ejs']` - Settings and rules to enable correct ESLint parsing for EJS
+- `*.configs['flat/best-practices']` - Above, plus rules to improve dev experience
+- `*.configs['flat/recommended']` - Above, plus rules to improve code readability
+- `*.configs['flat/recommended-with-html']` - Above, plus rules to improve code readability with HTML template
+- `*.configs['flat/recommended-with-script']` - `*.configs['flat/recommended']` config, plus to enable ESLint parsing of JavaScript templates (*This is an experimental feature*)
+- `*.configs['flat/all']` - All rules of this plugin are included
+
+### For `.eslintrc.*`
+
 This plugin provides 6 predefined configs:
 
 - `plugin:lodash-template/base` - Settings and rules to enable correct ESLint parsing

docs/index.md

@@ -47,6 +47,18 @@ npm install --save-dev eslint eslint-plugin-lodash-template
 
 Create `.eslintrc.*` file to configure rules. See also: [http://eslint.org/docs/user-guide/configuring](http://eslint.org/docs/user-guide/configuring).
 
+Example **eslint.config.js**:
+
+```js
+import lodashTemplate from 'eslint-plugin-lodash-template'
+export default [
+    {
+        files: ['**/*.html'],
+        ...lodashTemplate.configs['flat/recommended-with-html']
+    }
+]
+```
+
 Example **.eslintrc.js**:
 
 ```js
@@ -108,6 +120,20 @@ This plugin does special handling for the following rule warnings in the templat
 
 ## Configs
 
+### For `eslint.config.js`
+
+This plugin provides 7 predefined configs:
+
+- `*.configs['flat/base']` - Settings and rules to enable correct ESLint parsing
+- `*.configs['flat/base-with-ejs']` - Settings and rules to enable correct ESLint parsing for EJS
+- `*.configs['flat/best-practices']` - Above, plus rules to improve dev experience
+- `*.configs['flat/recommended']` - Above, plus rules to improve code readability
+- `*.configs['flat/recommended-with-html']` - Above, plus rules to improve code readability with HTML template
+- `*.configs['flat/recommended-with-script']` - `*.configs['flat/recommended']` config, plus to enable ESLint parsing of JavaScript templates (*This is an experimental feature*)
+- `*.configs['flat/all']` - All rules of this plugin are included
+
+### For `.eslintrc.*`
+
 This plugin provides 6 predefined configs:
 
 - `plugin:lodash-template/base` - Settings and rules to enable correct ESLint parsing

lib/configs/flat/all.js

@@ -0,0 +1,8 @@
+"use strict";
+
+const util = require("../../utils/rules");
+
+module.exports = {
+    ...require("./base"),
+    rules: util.collectRules(),
+};

lib/configs/flat/base-with-ejs.js

@@ -0,0 +1,21 @@
+"use strict";
+
+const base = require("./base");
+module.exports = {
+    ...base,
+    languageOptions: {
+        ...base.languageOptions,
+        parserOptions: {
+            templateSettings: {
+                evaluate: [
+                    ["<%", "<%_"],
+                    ["%>", "-%>", "_%>"],
+                ],
+                interpolate: ["<%-", ["%>", "-%>", "_%>"]],
+                escape: ["<%=", ["%>", "-%>", "_%>"]],
+                comment: ["<%#", ["%>", "-%>", "_%>"]],
+                literal: ["<%%"],
+            },
+        },
+    },
+};

lib/configs/flat/base.js

@@ -0,0 +1,15 @@
+"use strict";
+
+const util = require("../../utils/rules");
+
+module.exports = {
+    languageOptions: {
+        parser: require("../../parser/micro-template-eslint-parser"),
+    },
+    plugins: {
+        get "lodash-template"() {
+            return require("../../index");
+        },
+    },
+    rules: util.collectRules("base"),
+};

lib/configs/flat/best-practices.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const util = require("../../utils/rules");
+
+const base = require("./base");
+module.exports = {
+    ...base,
+    rules: {
+        ...base.rules,
+        ...util.collectRules("best-practices"),
+    },
+};

lib/configs/flat/recommended-with-html.js

@@ -0,0 +1,13 @@
+"use strict";
+
+const util = require("../../utils/rules");
+
+const recommended = require("./recommended");
+module.exports = {
+    ...recommended,
+    rules: {
+        ...recommended.rules,
+        ...util.collectRules("recommended-with-html"),
+    },
+    processor: "lodash-template/html",
+};

lib/configs/flat/recommended-with-script.js

@@ -0,0 +1,7 @@
+"use strict";
+
+const recommended = require("./recommended");
+module.exports = {
+    ...recommended,
+    processor: "lodash-template/script",
+};

lib/configs/flat/recommended.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const util = require("../../utils/rules");
+
+const bestPractices = require("./best-practices");
+module.exports = {
+    ...bestPractices,
+    rules: {
+        ...bestPractices.rules,
+        ...util.collectRules("recommended"),
+    },
+};