eslint-plugin-storybook 0.6.0 → 0.6.2

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# v0.6.2 (Tue Aug 02 2022)
+
+### Release Notes
+
+#### feat(no-uninstalled-addons): add option for a custom package.json location ([#102](https://github.com/storybookjs/eslint-plugin-storybook/pull/102))
+
+#### feat(no-uninstalled-addons): add option for a custom package.json location ([#102](https://github.com/storybookjs/eslint-plugin-storybook/pull/102))
+
+---
+
+#### 🐛 Bug Fix
+
+- feat(no-uninstalled-addons): add option for a custom package.json location [#102](https://github.com/storybookjs/eslint-plugin-storybook/pull/102) ([@andrelas1](https://github.com/andrelas1) [@yannbf](https://github.com/yannbf))
+
+#### Authors: 2
+
+- Andre Luis Araujo Santos ([@andrelas1](https://github.com/andrelas1))
+- Yann Braga ([@yannbf](https://github.com/yannbf))
+
+---
+
+# v0.6.1 (Tue Jul 12 2022)
+
+#### 🐛 Bug Fix
+
+- fix(no-uninstalled-addons): ignore local addons [#98](https://github.com/storybookjs/eslint-plugin-storybook/pull/98) ([@yannbf](https://github.com/yannbf))
+
+#### Authors: 1
+
+- Yann Braga ([@yannbf](https://github.com/yannbf))
+
+---
+
 # v0.6.0 (Sun Jul 10 2022)
 
 #### 🚀 Enhancement

package/dist/configs/addon-interactions.js

@@ -13,7 +13,7 @@ module.exports = {
             },
         },
         {
-            files: ['main.@(js|cjs|mjs|ts)'],
+            files: ['.storybook/main.@(js|cjs|mjs|ts)'],
             rules: {
                 'storybook/no-uninstalled-addons': 'error',
             },

package/dist/configs/csf.js

@@ -14,7 +14,7 @@ module.exports = {
             },
         },
         {
-            files: ['main.@(js|cjs|mjs|ts)'],
+            files: ['.storybook/main.@(js|cjs|mjs|ts)'],
             rules: {
                 'storybook/no-uninstalled-addons': 'error',
             },

package/dist/configs/recommended.js

@@ -18,7 +18,7 @@ module.exports = {
             },
         },
         {
-            files: ['main.@(js|cjs|mjs|ts)'],
+            files: ['.storybook/main.@(js|cjs|mjs|ts)'],
             rules: {
                 'storybook/no-uninstalled-addons': 'error',
             },

package/dist/rules/no-uninstalled-addons.js

@@ -3,7 +3,11 @@
  * @fileoverview This rule identifies storybook addons that are invalid because they are either not installed or contain a typo in their name.
  * @author Andre "andrelas1" Santos
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 const fs_1 = require("fs");
+const ts_dedent_1 = __importDefault(require("ts-dedent"));
 const path_1 = require("path");
 const create_storybook_rule_1 = require("../utils/create-storybook-rule");
 const constants_1 = require("../utils/constants");
@@ -19,12 +23,24 @@ module.exports = (0, create_storybook_rule_1.createStorybookRule)({
             recommended: 'error', // or 'error'
         },
         messages: {
-            addonIsNotInstalled: `The {{ addonName }} is not installed. Did you forget to install it?`,
+            addonIsNotInstalled: `The {{ addonName }} is not installed in {{packageJsonPath}}. Did you forget to install it or is your package.json in a different location?`,
         },
-        schema: [], // Add a schema if the rule has options. Otherwise remove this
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    packageJsonLocation: {
+                        type: 'string',
+                    },
+                },
+            },
+        ], // Add a schema if the rule has options. Otherwise remove this
     },
     create(context) {
         // variables should be defined here
+        const packageJsonLocation = context.options.reduce((acc, val) => {
+            return val['packageJsonLocation'] || acc;
+        }, '');
         //----------------------------------------------------------------------
         // Helpers
         //----------------------------------------------------------------------
@@ -38,12 +54,17 @@ module.exports = (0, create_storybook_rule_1.createStorybookRule)({
             return [...deps, ...devDeps];
         };
         const isAddonInstalled = (addon, installedAddons) => {
-            // cleanup /register or /preset from registered addon
-            const addonName = addon.replace(/\/register$/, '').replace(/\/preset$/, '');
+            // cleanup /register or /preset + file extension from registered addon
+            const addonName = addon
+                .replace(/\.[mc]?js$/, '')
+                .replace(/\/register$/, '')
+                .replace(/\/preset$/, '');
             return installedAddons.includes(addonName);
         };
         const areThereAddonsNotInstalled = (addons, installedSbAddons) => {
             const result = addons
+                // remove local addons (e.g. ./my-addon/register.js)
+                .filter((addon) => !addon.startsWith('.'))
                 .filter((addon) => !isAddonInstalled(addon, installedSbAddons))
                 .map((addon) => ({ name: addon }));
             return result.length ? result : false;
@@ -60,7 +81,10 @@ module.exports = (0, create_storybook_rule_1.createStorybookRule)({
                 packageJson.devDependencies = parsedFile.devDependencies || {};
             }
             catch (e) {
-                throw new Error('Could not fetch package.json - it is probably not in the same directory as the .storybook folder');
+                throw new Error((0, ts_dedent_1.default) `The provided path in your eslintrc.json - ${path} is not a valid path to a package.json file or your package.json file is not in the same folder as ESLint is running from.
+
+          Read more at: https://github.com/storybookjs/eslint-plugin-storybook/blob/main/docs/rules/no-uninstalled-addons.md
+          `);
             }
             return packageJson;
         };
@@ -89,30 +113,30 @@ module.exports = (0, create_storybook_rule_1.createStorybookRule)({
             return { listOfAddons: [], listOfAddonElements: [] };
         };
         function reportUninstalledAddons(addonsProp) {
-            // when this is running for .storybook/main.js, we get the path to the folder which contains the package.json of the
-            // project. This will be handy for monorepos that may be running ESLint in a node process in another folder.
-            const projectRoot = context.getPhysicalFilename
-                ? (0, path_1.resolve)(context.getPhysicalFilename(), '../../')
-                : './';
+            const packageJsonPath = (0, path_1.resolve)(packageJsonLocation || `./package.json`);
             let packageJsonObject;
             try {
-                packageJsonObject = getPackageJson(`${projectRoot}/package.json`);
+                packageJsonObject = getPackageJson(packageJsonPath);
             }
             catch (e) {
                 // if we cannot find the package.json, we cannot check if the addons are installed
-                console.error(e);
-                return;
+                throw new Error(e);
             }
             const depsAndDevDeps = mergeDepsWithDevDeps(packageJsonObject);
             const { listOfAddons, listOfAddonElements } = extractAllAddonsFromTheStorybookConfig(addonsProp);
             const result = areThereAddonsNotInstalled(listOfAddons, depsAndDevDeps);
             if (result) {
                 const elemsWithErrors = listOfAddonElements.filter((elem) => !!result.find((addon) => addon.name === elem.value));
+                const rootDir = process.cwd().split('/').pop();
+                const packageJsonPath = `${rootDir}/${(0, path_1.relative)(process.cwd(), packageJsonLocation)}`;
                 elemsWithErrors.forEach((elem) => {
                     context.report({
                         node: elem.node,
                         messageId: 'addonIsNotInstalled',
-                        data: { addonName: elem.value },
+                        data: {
+                            addonName: elem.value,
+                            packageJsonPath,
+                        },
                     });
                 });
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-storybook",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Best practice rules for Storybook",
   "keywords": [
     "eslint",