@storybook/csf 0.0.2--canary.51.768ca23.0 → 0.0.2--canary.51.26e6539.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/csf",
-  "version": "0.0.2--canary.51.768ca23.0",
+  "version": "0.0.2--canary.51.26e6539.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",
@@ -24,45 +24,58 @@
     "*.d.ts"
   ],
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "babel src --out-dir dist --extensions \".ts\" && tsc --emitDeclarationOnly",
-    "lint": "eslint src --ext .js,.ts",
+    "build": "tsup ./src/index.ts --format esm,cjs --dts",
+    "check": "tsc",
+    "lint": "eslint src --ext .ts",
     "test": "jest",
     "release": "yarn build && auto shipit"
   },
   "eslintConfig": {
     "extends": [
       "@storybook/eslint-config-storybook"
-    ]
+    ],
+    "rules": {
+      "jest/expect-expect": [
+        "warn",
+        {
+          "assertFunctionNames": [
+            "expect",
+            "expectTypeOf"
+          ]
+        }
+      ]
+    }
   },
   "prettier": "@storybook/linter-config/prettier.config",
   "jest": {
+    "preset": "ts-jest",
     "testEnvironment": "node",
     "roots": [
       "<rootDir>/src"
     ]
   },
   "dependencies": {
+    "expect-type": "^0.14.2",
     "lodash": "^4.17.15",
     "type-fest": "^2.19.0"
   },
   "devDependencies": {
     "@auto-it/released": "^10.37.1",
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
-    "@babel/preset-typescript": "^7.9.0",
     "@storybook/eslint-config-storybook": "^2.1.0",
-    "@types/jest": "^24.0.23",
+    "@types/jest": "^29.2.0",
     "@types/lodash": "^4.14.149",
+    "@types/node": "^18.11.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "auto": "^10.31.0",
-    "babel-core": "7.0.0-bridge.0",
-    "babel-jest": "^24.9.0",
     "common-tags": "^1.8.0",
     "eslint": "^6.7.1",
-    "jest": "^24.9.0",
+    "jest": "^29.2.0",
     "prettier": "^2.7.1",
+    "ts-jest": "^29.0.3",
+    "tsup": "^6.3.0",
     "typescript": "^4.8.4"
   },
   "auto": {

package/.babelrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  presets: [
-    '@babel/preset-env',
-    '@babel/preset-typescript',
-  ],
-};

package/dist/SBType.d.ts

@@ -1,33 +0,0 @@
-interface SBBaseType {
-    required?: boolean;
-    raw?: string;
-}
-export declare type SBScalarType = SBBaseType & {
-    name: 'boolean' | 'string' | 'number' | 'function' | 'symbol';
-};
-export declare type SBArrayType = SBBaseType & {
-    name: 'array';
-    value: SBType;
-};
-export declare type SBObjectType = SBBaseType & {
-    name: 'object';
-    value: Record<string, SBType>;
-};
-export declare type SBEnumType = SBBaseType & {
-    name: 'enum';
-    value: (string | number)[];
-};
-export declare type SBIntersectionType = SBBaseType & {
-    name: 'intersection';
-    value: SBType[];
-};
-export declare type SBUnionType = SBBaseType & {
-    name: 'union';
-    value: SBType[];
-};
-export declare type SBOtherType = SBBaseType & {
-    name: 'other';
-    value: string;
-};
-export declare type SBType = SBScalarType | SBEnumType | SBArrayType | SBObjectType | SBIntersectionType | SBUnionType | SBOtherType;
-export {};

package/dist/SBType.js

@@ -1 +0,0 @@
-"use strict";

package/dist/includeConditionalArg.d.ts

@@ -1,3 +0,0 @@
-import { Args, Globals, InputType, Conditional } from './story';
-export declare const testValue: (cond: Omit<Conditional, 'arg' | 'global'>, value: any) => boolean;
-export declare const includeConditionalArg: (argType: InputType, args: Args, globals: Globals) => boolean;

package/dist/includeConditionalArg.js

@@ -1,74 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.includeConditionalArg = exports.testValue = void 0;
-
-var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-var count = function count(vals) {
-  return vals.map(function (v) {
-    return typeof v !== 'undefined';
-  }).filter(Boolean).length;
-};
-
-var testValue = function testValue(cond, value) {
-  var _ref = cond,
-      exists = _ref.exists,
-      eq = _ref.eq,
-      neq = _ref.neq,
-      truthy = _ref.truthy;
-
-  if (count([exists, eq, neq, truthy]) > 1) {
-    throw new Error("Invalid conditional test ".concat(JSON.stringify({
-      exists: exists,
-      eq: eq,
-      neq: neq
-    })));
-  }
-
-  if (typeof eq !== 'undefined') {
-    return (0, _isEqual["default"])(value, eq);
-  }
-
-  if (typeof neq !== 'undefined') {
-    return !(0, _isEqual["default"])(value, neq);
-  }
-
-  if (typeof exists !== 'undefined') {
-    var valueExists = typeof value !== 'undefined';
-    return exists ? valueExists : !valueExists;
-  }
-
-  var shouldBeTruthy = typeof truthy === 'undefined' ? true : truthy;
-  return shouldBeTruthy ? !!value : !value;
-};
-/**
- * Helper function to include/exclude an arg based on the value of other other args
- * aka "conditional args"
- */
-
-
-exports.testValue = testValue;
-
-var includeConditionalArg = function includeConditionalArg(argType, args, globals) {
-  if (!argType["if"]) return true;
-  var _ref2 = argType["if"],
-      arg = _ref2.arg,
-      global = _ref2.global;
-
-  if (count([arg, global]) !== 1) {
-    throw new Error("Invalid conditional value ".concat(JSON.stringify({
-      arg: arg,
-      global: global
-    })));
-  }
-
-  var value = arg ? args[arg] : globals[global];
-  return testValue(argType["if"], value);
-};
-
-exports.includeConditionalArg = includeConditionalArg;

package/dist/includeConditionalArg.test.js

@@ -1,325 +0,0 @@
-"use strict";
-
-var _includeConditionalArg = require("./includeConditionalArg");
-
-/* eslint-disable @typescript-eslint/ban-ts-ignore */
-describe('testValue', function () {
-  describe('truthy', function () {
-    it.each([['implicit true', {}, true, true], ['implicit truthy', {}, 1, true], ['implicit falsey', {}, 0, false], ['truthy true', {
-      truthy: true
-    }, true, true], ['truthy truthy', {
-      truthy: true
-    }, 1, true], ['truthy falsey', {
-      truthy: true
-    }, 0, false], ['falsey true', {
-      truthy: false
-    }, true, false], ['falsey truthy', {
-      truthy: false
-    }, 1, false], ['falsey falsey', {
-      truthy: false
-    }, 0, true]])('%s', function (_name, cond, value, expected) {
-      // @ts-ignore
-      expect((0, _includeConditionalArg.testValue)(cond, value)).toBe(expected);
-    });
-  });
-  describe('exists', function () {
-    it.each([['exist', {
-      exists: true
-    }, 1, true], ['exist false', {
-      exists: true
-    }, undefined, false], ['nexist', {
-      exists: false
-    }, undefined, true], ['nexist false', {
-      exists: false
-    }, 1, false]])('%s', function (_name, cond, value, expected) {
-      // @ts-ignore
-      expect((0, _includeConditionalArg.testValue)(cond, value)).toBe(expected);
-    });
-  });
-  describe('eq', function () {
-    it.each([['true', {
-      eq: 1
-    }, 1, true], ['false', {
-      eq: 1
-    }, 2, false], ['undefined', {
-      eq: undefined
-    }, undefined, false], ['undefined false', {
-      eq: 1
-    }, undefined, false], ['object true', {
-      eq: {
-        x: 1
-      }
-    }, {
-      x: 1
-    }, true], ['object true', {
-      eq: {
-        x: 1
-      }
-    }, {
-      x: 2
-    }, false]])('%s', function (_name, cond, value, expected) {
-      // @ts-ignore
-      expect((0, _includeConditionalArg.testValue)(cond, value)).toBe(expected);
-    });
-  });
-  describe('neq', function () {
-    it.each([['true', {
-      neq: 1
-    }, 2, true], ['false', {
-      neq: 1
-    }, 1, false], ['undefined true', {
-      neq: 1
-    }, undefined, true], ['undefined false', {
-      neq: undefined
-    }, undefined, false], ['object true', {
-      neq: {
-        x: 1
-      }
-    }, {
-      x: 2
-    }, true], ['object false', {
-      neq: {
-        x: 1
-      }
-    }, {
-      x: 1
-    }, false]])('%s', function (_name, cond, value, expected) {
-      // @ts-ignore
-      expect((0, _includeConditionalArg.testValue)(cond, value)).toBe(expected);
-    });
-  });
-});
-describe('includeConditionalArg', function () {
-  describe('errors', function () {
-    it('should throw if neither arg nor global is specified', function () {
-      expect(function () {
-        return (0, _includeConditionalArg.includeConditionalArg)({
-          "if": {}
-        }, {}, {});
-      }).toThrowErrorMatchingInlineSnapshot("\"Invalid conditional value {}\"");
-    });
-    it('should throw if arg and global are both specified', function () {
-      expect(function () {
-        return (0, _includeConditionalArg.includeConditionalArg)({
-          "if": {
-            arg: 'a',
-            global: 'b'
-          }
-        }, {}, {});
-      }).toThrowErrorMatchingInlineSnapshot("\"Invalid conditional value {\\\"arg\\\":\\\"a\\\",\\\"global\\\":\\\"b\\\"}\"");
-    });
-    it('should throw if mulitiple exists / eq / neq are specified', function () {
-      expect(function () {
-        return (0, _includeConditionalArg.includeConditionalArg)({
-          "if": {
-            arg: 'a',
-            exists: true,
-            eq: 1
-          }
-        }, {}, {});
-      }).toThrowErrorMatchingInlineSnapshot("\"Invalid conditional test {\\\"exists\\\":true,\\\"eq\\\":1}\"");
-      expect(function () {
-        return (0, _includeConditionalArg.includeConditionalArg)({
-          "if": {
-            arg: 'a',
-            exists: false,
-            neq: 0
-          }
-        }, {}, {});
-      }).toThrowErrorMatchingInlineSnapshot("\"Invalid conditional test {\\\"exists\\\":false,\\\"neq\\\":0}\"");
-      expect(function () {
-        return (0, _includeConditionalArg.includeConditionalArg)({
-          "if": {
-            arg: 'a',
-            eq: 1,
-            neq: 0
-          }
-        }, {}, {});
-      }).toThrowErrorMatchingInlineSnapshot("\"Invalid conditional test {\\\"eq\\\":1,\\\"neq\\\":0}\"");
-    });
-  });
-  describe('args', function () {
-    describe('implicit', function () {
-      it.each([['implicit true', {
-        "if": {
-          arg: 'a'
-        }
-      }, {
-        a: 1
-      }, {}, true], ['truthy true', {
-        "if": {
-          arg: 'a',
-          truthy: true
-        }
-      }, {
-        a: 0
-      }, {}, false], ['truthy false', {
-        "if": {
-          arg: 'a',
-          truthy: false
-        }
-      }, {}, {}, true]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-    describe('exists', function () {
-      it.each([['exist', {
-        "if": {
-          arg: 'a',
-          exists: true
-        }
-      }, {
-        a: 1
-      }, {}, true], ['exist false', {
-        "if": {
-          arg: 'a',
-          exists: true
-        }
-      }, {}, {}, false]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-    describe('eq', function () {
-      it.each([['scalar true', {
-        "if": {
-          arg: 'a',
-          eq: 1
-        }
-      }, {
-        a: 1
-      }, {}, true], ['scalar false', {
-        "if": {
-          arg: 'a',
-          eq: 1
-        }
-      }, {
-        a: 2
-      }, {
-        a: 1
-      }, false]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-    describe('neq', function () {
-      it.each([['scalar true', {
-        "if": {
-          arg: 'a',
-          neq: 1
-        }
-      }, {
-        a: 2
-      }, {}, true], ['scalar false', {
-        "if": {
-          arg: 'a',
-          neq: 1
-        }
-      }, {
-        a: 1
-      }, {
-        a: 2
-      }, false]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-  });
-  describe('globals', function () {
-    describe('truthy', function () {
-      it.each([['implicit true', {
-        "if": {
-          global: 'a'
-        }
-      }, {}, {
-        a: 1
-      }, true], ['implicit undefined', {
-        "if": {
-          global: 'a'
-        }
-      }, {}, {}, false], ['truthy true', {
-        "if": {
-          global: 'a',
-          truthy: true
-        }
-      }, {}, {
-        a: 0
-      }, false], ['truthy false', {
-        "if": {
-          global: 'a',
-          truthy: false
-        }
-      }, {}, {
-        a: 0
-      }, true]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-    describe('exists', function () {
-      it.each([['implicit exist true', {
-        "if": {
-          global: 'a',
-          exists: true
-        }
-      }, {}, {
-        a: 1
-      }, true], ['implicit exist false', {
-        "if": {
-          global: 'a',
-          exists: true
-        }
-      }, {
-        a: 1
-      }, {}, false]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-    describe('eq', function () {
-      it.each([['scalar true', {
-        "if": {
-          global: 'a',
-          eq: 1
-        }
-      }, {}, {
-        a: 1
-      }, true], ['scalar false', {
-        "if": {
-          arg: 'a',
-          eq: 1
-        }
-      }, {
-        a: 2
-      }, {
-        a: 1
-      }, false]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-    describe('neq', function () {
-      it.each([['scalar true', {
-        "if": {
-          global: 'a',
-          neq: 1
-        }
-      }, {}, {
-        a: 2
-      }, true], ['scalar false', {
-        "if": {
-          global: 'a',
-          neq: 1
-        }
-      }, {
-        a: 2
-      }, {
-        a: 1
-      }, false]])('%s', function (_name, argType, args, globals, expected) {
-        // @ts-ignore
-        expect((0, _includeConditionalArg.includeConditionalArg)(argType, args, globals)).toBe(expected);
-      });
-    });
-  });
-});

package/dist/index.test.js

@@ -1,142 +0,0 @@
-"use strict";
-
-var _ = require(".");
-
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(n); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-describe('toId', function () {
-  var testCases = [// name, kind, story, output
-  ['handles simple cases', 'kind', 'story', 'kind--story'], ['handles kind without story', 'kind', undefined, 'kind'], ['handles basic substitution', 'a b$c?d😀e', '1-2:3', 'a-b-c-d😀e--1-2-3'], ['handles runs of non-url chars', 'a?&*b', 'story', 'a-b--story'], ['removes non-url chars from start and end', '?ab-', 'story', 'ab--story'], ['downcases', 'KIND', 'STORY', 'kind--story'], ['non-latin', 'Кнопки', 'нормальный', 'кнопки--нормальный'], ['korean', 'kind', '바보 (babo)', 'kind--바보-babo'], ['all punctuation', 'kind', 'unicorns,’–—―′¿`"<>()!.!!!{}[]%^&$*#&', 'kind--unicorns']];
-  testCases.forEach(function (_ref) {
-    var _ref2 = _slicedToArray(_ref, 4),
-        name = _ref2[0],
-        kind = _ref2[1],
-        story = _ref2[2],
-        output = _ref2[3];
-
-    it(name, function () {
-      expect((0, _.toId)(kind, story)).toBe(output);
-    });
-  });
-  it('does not allow kind with *no* url chars', function () {
-    expect(function () {
-      return (0, _.toId)('?', 'asdf');
-    }).toThrow("Invalid kind '?', must include alphanumeric characters");
-  });
-  it('does not allow empty kind', function () {
-    expect(function () {
-      return (0, _.toId)('', 'asdf');
-    }).toThrow("Invalid kind '', must include alphanumeric characters");
-  });
-  it('does not allow story with *no* url chars', function () {
-    expect(function () {
-      return (0, _.toId)('kind', '?');
-    }).toThrow("Invalid name '?', must include alphanumeric characters");
-  });
-  it('allows empty story', function () {
-    expect(function () {
-      return (0, _.toId)('kind', '');
-    }).not.toThrow();
-  });
-});
-describe('storyNameFromExport', function () {
-  it('should format CSF exports with sensible defaults', function () {
-    var testCases = {
-      name: 'Name',
-      someName: 'Some Name',
-      someNAME: 'Some NAME',
-      some_custom_NAME: 'Some Custom NAME',
-      someName1234: 'Some Name 1234',
-      someName1_2_3_4: 'Some Name 1 2 3 4'
-    };
-    Object.entries(testCases).forEach(function (_ref3) {
-      var _ref4 = _slicedToArray(_ref3, 2),
-          key = _ref4[0],
-          val = _ref4[1];
-
-      return expect((0, _.storyNameFromExport)(key)).toBe(val);
-    });
-  });
-});
-describe('isExportStory', function () {
-  it('should exclude __esModule', function () {
-    expect((0, _.isExportStory)('__esModule', {})).toBeFalsy();
-  });
-  it('should include all stories when there are no filters', function () {
-    expect((0, _.isExportStory)('a', {})).toBeTruthy();
-  });
-  it('should filter stories by arrays', function () {
-    expect((0, _.isExportStory)('a', {
-      includeStories: ['a']
-    })).toBeTruthy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: []
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: ['b']
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      excludeStories: ['a']
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      excludeStories: []
-    })).toBeTruthy();
-    expect((0, _.isExportStory)('a', {
-      excludeStories: ['b']
-    })).toBeTruthy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: ['a'],
-      excludeStories: ['a']
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: [],
-      excludeStories: []
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: ['a'],
-      excludeStories: ['b']
-    })).toBeTruthy();
-  });
-  it('should filter stories by regex', function () {
-    expect((0, _.isExportStory)('a', {
-      includeStories: /a/
-    })).toBeTruthy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: /.*/
-    })).toBeTruthy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: /b/
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      excludeStories: /a/
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      excludeStories: /.*/
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      excludeStories: /b/
-    })).toBeTruthy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: /a/,
-      excludeStories: ['a']
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: /.*/,
-      excludeStories: /.*/
-    })).toBeFalsy();
-    expect((0, _.isExportStory)('a', {
-      includeStories: /a/,
-      excludeStories: /b/
-    })).toBeTruthy();
-  });
-});