feat: enhance README.md with usage examples and roadmap; update package.json keywords; refactor ESLint configs

Author: andrewmolyuk

README.md

@@ -28,6 +28,13 @@ npm install eslint-plugin-vue-fsd --save-dev
 
 ## Usage
 
+We provide two predefined configurations to help enforce FSD principles in your Vue.js projects.
+
+- recommended - enables the rules that recommended best practices for FSD and Vue.js development.
+- all - enables all of the rules shipped with eslint-plugin-vue-fsd.
+
+Eslint v9+ configuration (Recommended):
+
 ```javascript
 import vueFsdPlugin from 'eslint-plugin-vue-fsd'
 
@@ -37,12 +44,44 @@ module.exports = {
 }
 ```
 
+Legacy Eslint v8 configuration:
+
+```javascript
+import vueFsdPlugin from 'eslint-plugin-vue-fsd'
+
+// .eslintrc.js
+module.exports = {
+  extends: ['plugin:vue-fsd/legacy/recommended'],
+}
+```
+
 ## Rules
 
+The plugin provides the rules to enforce [Feature-Sliced Design](https://feature-sliced.design/) principles in [Vue.js](https://vuejs.org/) projects.
+
 | Rule                                                     | Description                                    |
 | -------------------------------------------------------- | ---------------------------------------------- |
 | [no-processes-layer](./docs/rules/no-processes-layer.md) | Ensure deprecated processes layer is not used. |
 
+## Roadmap
+
+As the plugin evolves, we plan to implement the following rules:
+
+- no-higher-level-imports: Forbid imports from higher layers.
+- no-cross-slice-imports: Forbid cross-imports between slices on the same layer.
+- no-layer-public-api: Forbid exposing public APIs from a layer.
+- no-segments-without-slices: Forbid segments without slices.
+- public-api: Enforce consistent public API on slices.
+- no-ui-in-app: Forbid using UI segment in the app layer.
+- no-direct-imports: Forbid direct imports from outside the slice.
+- enforce-slice-relative-path: Imports within one slice should be relative.
+- slice-naming: Enforce consistent naming conventions for slices.
+- composables-naming: Enforce consistent naming conventions for composables.
+- components-naming: Enforce consistent naming conventions for components.
+- sfc-sections-order: Enforce consistent order of top-level sections in single-file components.
+
+We are always open to suggestions and contributions for new rules and improvements.
+
 ## Contribution
 
 Pull requests and issues are welcome! Please follow the code style and add tests for new rules.

package.json

@@ -11,8 +11,9 @@
   },
   "keywords": [
     "eslint",
-    "vue3",
+    "vue",
     "fsd",
+    "feature-sliced-design",
     "boundaries",
     "architecture"
   ],

src/configs.js

@@ -0,0 +1,27 @@
+export const getConfigs = (plugin) => {
+  const recommendedRules = { 'vue-fsd/no-processes-layer': 'error' }
+  const allRules = { ...recommendedRules }
+
+  const languageOptions = {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  }
+
+  const pluginConfig = (plugin, rules) => ({
+    plugins: { 'vue-fsd': plugin },
+    rules,
+    languageOptions,
+  })
+
+  const legacyConfig = (rules) => ({
+    plugins: ['vue-fsd'],
+    rules,
+  })
+
+  return {
+    recommended: [pluginConfig(plugin, recommendedRules)],
+    all: [pluginConfig(plugin, allRules)],
+    'legacy/recommended': legacyConfig(recommendedRules),
+    'legacy/all': legacyConfig(allRules),
+  }
+}

src/index.js

@@ -1,5 +1,6 @@
 import meta from './meta.js'
 import noProcessesLayer from './rules/no-processes-layer.js'
+import { getConfigs } from './configs.js'
 
 const plugin = {
   meta,
@@ -11,44 +12,6 @@ const plugin = {
   utils: {},
 }
 
-// Flat config for ESLint v9+
-plugin.configs.recommended = [
-  {
-    plugins: {
-      'vue-fsd': plugin,
-    },
-    rules: { 'vue-fsd/no-processes-layer': 'error' },
-    languageOptions: {
-      ecmaVersion: 2022,
-      sourceType: 'module',
-    },
-  },
-]
-
-// Strict config with all rules enabled
-plugin.configs.strict = [
-  {
-    plugins: {
-      'vue-fsd': plugin,
-    },
-    rules: { 'vue-fsd/no-processes-layer': 'error' },
-    languageOptions: {
-      ecmaVersion: 2022,
-      sourceType: 'module',
-    },
-  },
-]
-
-// Classic config for legacy support
-plugin.configs['legacy/recommended'] = {
-  plugins: ['vue-fsd'],
-  rules: { 'vue-fsd/no-processes-layer': 'error' },
-}
-
-// Strict config with all rules enabled (legacy)
-plugin.configs['legacy/strict'] = {
-  plugins: ['vue-fsd'],
-  rules: { 'vue-fsd/no-processes-layer': 'error' },
-}
+plugin.configs = getConfigs(plugin)
 
 export default plugin