Merge pull request #109 from happo/improve-detection

Improve storybook version detection

.eslintrc.js

@@ -3,6 +3,7 @@ module.exports = {
     browser: true,
     es2021: true,
     node: true,
+    'jest/globals': true,
   },
   extends: ['eslint:recommended', 'plugin:react/recommended'],
   parserOptions: {
@@ -12,6 +13,6 @@ module.exports = {
     ecmaVersion: 13,
     sourceType: 'module',
   },
-  plugins: ['react'],
+  plugins: ['react', 'jest'],
   rules: {},
 };

.github/workflows/test.yml

@@ -22,6 +22,7 @@ jobs:
       - run: corepack enable
       - run: yarn install --frozen-lockfile
       - run: yarn lint
+      - run: yarn test
       - run: yarn build && yarn happo run
       - run: yarn build-local-storybook && HAPPO_USE_PREBUILT_PACKAGE=yes yarn happo run
 

.npmignore

@@ -1,2 +1,3 @@
 node_modules
 .happo-out
+test

getStorybookVersionFromPackageJson.js

@@ -0,0 +1,29 @@
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function getStorybookVersionFromPackageJson(
+  packageJsonPath = path.join(process.cwd(), 'package.json'),
+) {
+  const data = fs.readFileSync(packageJsonPath, 'utf8');
+  const packageJson = JSON.parse(data);
+
+  const combinedDependencies = {
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies,
+  };
+
+  const storybookPackage = [
+    'storybook',
+    '@storybook/react',
+    '@storybook/angular',
+    '@storybook/vue',
+  ].find((pkg) => combinedDependencies[pkg]);
+
+  if (storybookPackage) {
+    const storybookVersion = combinedDependencies[storybookPackage];
+    const majorVersion = parseInt(storybookVersion.match(/\d/)[0], 10);
+    return majorVersion;
+  } else {
+    throw new Error('Storybook is not listed as a dependency in package.json');
+  }
+};

index.js

@@ -6,32 +6,10 @@ const path = require('path');
 const Archiver = require('archiver');
 const rimraf = require('rimraf');
 
-const { HAPPO_DEBUG, HAPPO_STORYBOOK_BUILD_COMMAND } = process.env;
-
-function getStorybookVersionFromPackageJson() {
-  const packageJsonPath = path.join(process.cwd(), 'package.json');
-  const data = fs.readFileSync(packageJsonPath, 'utf8');
-  const packageJson = JSON.parse(data);
-
-  const combinedDependencies = {
-    ...packageJson.dependencies,
-    ...packageJson.devDependencies,
-  };
+const getStorybookVersionFromPackageJson =
+  require('./getStorybookVersionFromPackageJson');
 
-  const storybookPackage = [
-    '@storybook/react',
-    '@storybook/angular',
-    '@storybook/vue',
-  ].find((pkg) => combinedDependencies[pkg]);
-
-  if (storybookPackage) {
-    const storybookVersion = combinedDependencies[storybookPackage];
-    const majorVersion = parseInt(storybookVersion.match(/\d/)[0], 10);
-    return majorVersion;
-  } else {
-    throw new Error('Storybook is not listed as a dependency in package.json');
-  }
-}
+const { HAPPO_DEBUG, HAPPO_STORYBOOK_BUILD_COMMAND } = process.env;
 
 function zipFolderToBuffer(outputDir) {
   return new Promise((resolve, reject) => {

package.json

@@ -63,9 +63,11 @@
     "@storybook/testing-library": "^0.2.2",
     "babel-loader": "^8.0.5",
     "eslint": "^8.6.0",
+    "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-react": "^7.28.0",
     "file-loader": "^3.0.1",
     "happo.io": "^5.1.3",
+    "jest": "^29.7.0",
     "raw-loader": "^1.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

test/getStorybookVersionFromPackageJson-test.js

@@ -0,0 +1,47 @@
+const path = require('path');
+
+const getStorybookVersionFromPackageJson = require('../getStorybookVersionFromPackageJson');
+
+describe('with project package.json', () => {
+  it('finds the right version', () => {
+    const version = getStorybookVersionFromPackageJson();
+    expect(version).toBe(7);
+  });
+});
+
+describe('with storybook 6', () => {
+  it('finds the right version', () => {
+    const version = getStorybookVersionFromPackageJson(
+      path.resolve(__dirname, 'v6-package.json'),
+    );
+    expect(version).toBe(6);
+  });
+});
+
+describe('with storybook 7', () => {
+  it('finds the right version', () => {
+    const version = getStorybookVersionFromPackageJson(
+      path.resolve(__dirname, 'v7-package.json'),
+    );
+    expect(version).toBe(7);
+  });
+});
+
+describe('with no dev dependencies', () => {
+  it('finds the right version', () => {
+    const version = getStorybookVersionFromPackageJson(
+      path.resolve(__dirname, 'no-devdeps-package.json'),
+    );
+    expect(version).toBe(7);
+  });
+});
+
+describe('with no storybook dependencies', () => {
+  it('throws', () => {
+    expect(() =>
+      getStorybookVersionFromPackageJson(
+        path.resolve(__dirname, 'no-storybook-package.json'),
+      ),
+    ).toThrow(/not listed/);
+  });
+});

test/no-devdeps-package.json

@@ -0,0 +1,8 @@
+{
+  "name": "test-project-no-storybook",
+  "version": "0.0.0",
+  "dependencies": {
+    "@babel/runtime": "7.23.8",
+    "storybook": "7"
+  }
+}

test/no-storybook-package.json

@@ -0,0 +1,10 @@
+{
+  "name": "test-project-no-storybook",
+  "version": "0.0.0",
+  "dependencies": {
+    "@babel/runtime": "7.23.8"
+  },
+  "devDependencies": {
+    "webpack-dev-server": "4.15.1"
+  }
+}

test/v6-package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test-project-v6",
+  "version": "0.0.0",
+  "dependencies": {
+    "@babel/runtime": "7.23.8"
+  },
+  "devDependencies": {
+    "@storybook/react": "^6.1.0",
+    "@storybook/testing-library": "0.2.2",
+    "storybook": "~6.1.0",
+    "webpack-dev-server": "4.15.1"
+  }
+}

test/v7-package.json

@@ -0,0 +1,11 @@
+{
+  "name": "test-project-v7",
+  "version": "0.0.0",
+  "dependencies": {
+    "@babel/runtime": "7.23.8"
+  },
+  "devDependencies": {
+    "@storybook/vue": "^7.1.0",
+    "webpack-dev-server": "4.15.1"
+  }
+}