fix(no-uninstalled-addons): restrict rule to .storybook folder

And add a section on how to configure if users have a custom config directory

Co-authored-by: Andre Santos <[email protected]>

Author: yannbf

README.md

@@ -53,12 +53,11 @@ And finally, add this to your `.eslintignore` file:
 ```
 // Inside your .eslintignore file
 !.storybook
-!.storybook/*
 ```
 
 This allows for this plugin to also lint your configuration files inside the .storybook folder, so that you always have a correct configuration and don't face any issues regarding mistyped addon names, for instance.
 
-For more info on why these lines are required in the .eslintignore file, check this [ESLint documentation](https://eslint.org/docs/latest/user-guide/configuring/ignoring-code#:~:text=In%20addition%20to,contents%2C%20are%20ignored).
+> For more info on why this line is required in the .eslintignore file, check this [ESLint documentation](https://eslint.org/docs/latest/user-guide/configuring/ignoring-code#:~:text=In%20addition%20to,contents%2C%20are%20ignored).
 
 ## Usage
 

docs/rules/no-uninstalled-addons.md

@@ -19,8 +19,6 @@ Another very important side note: your ESLint config must allow the linting of t
 ```
 // Inside your .eslintignore file
 !.storybook
-.storybook/*
-!.storybook/main.js
 ```
 
 For more info, check this [ESLint documentation](https://eslint.org/docs/latest/user-guide/configuring/ignoring-code#:~:text=In%20addition%20to,contents%2C%20are%20ignored).
@@ -33,7 +31,7 @@ module.exports = {
   addons: [
     '@storybook/addon-links',
     '@storybook/addon-essentials',
-    '@storybook/addon-interactions',
+    '@storybook/addon-interactions', // <-- this addon is not listed in the package.json
   ],
 }
 
@@ -69,7 +67,22 @@ module.exports = {
 }
 ```
 
-### Options
+### Configure
+
+Some Storybook folders use a different name for their config directory other than `.storybook`. This rule will not be applied there by default. If you want to have it, then you must add an override in your `.eslintrc.js` file, defining your config directory:
+
+```js
+{
+  overrides: [
+      {
+        files: ['your-config-dir/main.@(js|cjs|mjs|ts)'],
+        rules: {
+          'storybook/no-uninstalled-addons': 'error',
+        },
+      },
+    ],
+}
+```
 
 ## When Not To Use It
 

lib/rules/no-uninstalled-addons.ts

@@ -1,6 +1,6 @@
 /**
  * @fileoverview This rule identifies storybook addons that are invalid because they are either not installed or contain a typo in their name.
- * @author Andre Santos
+ * @author Andre "andrelas1" Santos
  */
 
 import { readFileSync } from 'fs'

tools/update-configs.ts

@@ -46,7 +46,7 @@ const STORIES_GLOBS = [
 ]
 
 // Other files that will be linted
-const MAIN_JS_FILE = [`'main.@(js|cjs|mjs|ts)'`]
+const MAIN_JS_FILE = [`'.storybook/main.@(js|cjs|mjs|ts)'`]
 
 function formatCategory(category: TCategory) {
   const extendsCategoryId = extendsCategories[category.categoryId]