@storybook/csf 0.0.1

package/.babelrc.js

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

package/README.md

@@ -0,0 +1,33 @@
+# Storybook Component Story Format (CSF)
+
+A minimal set of utility functions for dealing with Storybook [Component Story Format (CSF)](https://storybook.js.org/docs/formats/component-story-format/).
+
+## Install
+
+```sh
+yarn add @storybook/csf
+```
+
+## API
+
+See package source for function definitions and types:
+
+- `isExportStory(key, { includeStories, excludeStories })` - Does a named export match CSF inclusion/exclusion options?
+
+- `parseKind(kind, { rootSeparator, groupSeparator })` - Parse out the component/kind name from a path, using the given separator config.
+
+- `sanitize(string)` - Remove punctuation and illegal characters from a story ID.
+
+- `toId(kind, name)` - Generate a storybook ID from a component/kind and story name.
+
+## Contributing
+
+If you have any suggestions, please open an issue or a PR.
+
+All contributions are welcome!
+
+### run tests:
+
+```sh
+yarn test
+```

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+export declare const sanitize: (string: string) => string;
+export declare const toId: (kind: string, name: string) => string;
+export declare const storyNameFromExport: (key: string) => string;
+declare type StoryDescriptor = string[] | RegExp;
+export interface IncludeExcludeOptions {
+    includeStories?: StoryDescriptor;
+    excludeStories?: StoryDescriptor;
+}
+export declare function isExportStory(key: string, { includeStories, excludeStories }: IncludeExcludeOptions): boolean | null;
+export interface SeparatorOptions {
+    rootSeparator: string | RegExp;
+    groupSeparator: string | RegExp;
+}
+export declare const parseKind: (kind: string, { rootSeparator, groupSeparator }: SeparatorOptions) => {
+    root: string | null;
+    groups: string[];
+};
+export {};

package/dist/index.js

@@ -0,0 +1,105 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isExportStory = isExportStory;
+exports.parseKind = exports.storyNameFromExport = exports.toId = exports.sanitize = void 0;
+
+var _startCase = _interopRequireDefault(require("lodash/startCase"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); }
+
+function _iterableToArrayLimit(arr, i) { if (!(Symbol.iterator in Object(arr) || Object.prototype.toString.call(arr) === "[object Arguments]")) { 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; }
+
+/**
+ * Remove punctuation and illegal characters from a story ID.
+ *
+ * See https://gist.github.com/davidjrice/9d2af51100e41c6c4b4a
+ */
+var sanitize = function sanitize(string) {
+  return string.toLowerCase() // eslint-disable-next-line no-useless-escape
+  .replace(/[ ’–—―′¿'`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, '-').replace(/-+/g, '-').replace(/^-+/, '').replace(/-+$/, '');
+};
+
+exports.sanitize = sanitize;
+
+var sanitizeSafe = function sanitizeSafe(string, part) {
+  var sanitized = sanitize(string);
+
+  if (sanitized === '') {
+    throw new Error("Invalid ".concat(part, " '").concat(string, "', must include alphanumeric characters"));
+  }
+
+  return sanitized;
+};
+/**
+ * Generate a storybook ID from a component/kind and story name.
+ */
+
+
+var toId = function toId(kind, name) {
+  return "".concat(sanitizeSafe(kind, 'kind'), "--").concat(sanitizeSafe(name, 'name'));
+};
+/**
+ * Transform a CSF named export into a readable story name
+ */
+
+
+exports.toId = toId;
+
+var storyNameFromExport = function storyNameFromExport(key) {
+  return (0, _startCase["default"])(key);
+};
+
+exports.storyNameFromExport = storyNameFromExport;
+
+function matches(storyKey, arrayOrRegex) {
+  if (Array.isArray(arrayOrRegex)) {
+    return arrayOrRegex.includes(storyKey);
+  }
+
+  return storyKey.match(arrayOrRegex);
+}
+/**
+ * Does a named export match CSF inclusion/exclusion options?
+ */
+
+
+function isExportStory(key, _ref) {
+  var includeStories = _ref.includeStories,
+      excludeStories = _ref.excludeStories;
+  return (// https://babeljs.io/docs/en/babel-plugin-transform-modules-commonjs
+    key !== '__esModule' && (!includeStories || matches(key, includeStories)) && (!excludeStories || !matches(key, excludeStories))
+  );
+}
+
+/**
+ * Parse out the component/kind name from a path, using the given separator config.
+ */
+var parseKind = function parseKind(kind, _ref2) {
+  var rootSeparator = _ref2.rootSeparator,
+      groupSeparator = _ref2.groupSeparator;
+
+  var _kind$split = kind.split(rootSeparator, 2),
+      _kind$split2 = _slicedToArray(_kind$split, 2),
+      root = _kind$split2[0],
+      remainder = _kind$split2[1];
+
+  var groups = (remainder || kind).split(groupSeparator).filter(function (i) {
+    return !!i;
+  }); // when there's no remainder, it means the root wasn't found/split
+
+  return {
+    root: remainder ? root : null,
+    groups: groups
+  };
+};
+
+exports.parseKind = parseKind;

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,137 @@
+"use strict";
+
+var _ = require(".");
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); }
+
+function _iterableToArrayLimit(arr, i) { if (!(Symbol.iterator in Object(arr) || Object.prototype.toString.call(arr) === "[object Arguments]")) { 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 () {
+  [// name, kind, story, output
+  ['handles simple cases', 'kind', 'story', 'kind--story'], ['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']].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('does not allow empty story', function () {
+    expect(function () {
+      return (0, _.toId)('kind', '');
+    }).toThrow("Invalid name '', must include alphanumeric characters");
+  });
+});
+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();
+  });
+});

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@storybook/csf",
+  "version": "0.0.1",
+  "description": "Storybook Component Story Format (CSF) utilities",
+  "keywords": [
+    "storybook",
+    "component story format",
+    "csf",
+    "stories"
+  ],
+  "homepage": "https://github.com/storybookjs/csf",
+  "bugs": {
+    "url": "https://github.com/storybookjs/csf/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/storybookjs/csf.git"
+  },
+  "license": "MIT",
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "*.js",
+    "*.d.ts"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "babel src --out-dir dist --extensions \".ts\" && tsc --emitDeclarationOnly",
+    "lint": "eslint src --ext .js,.ts",
+    "prepublish": "yarn build",
+    "test": "jest"
+  },
+  "eslintConfig": {
+    "extends": [
+      "@storybook/eslint-config-storybook"
+    ]
+  },
+  "prettier": "@storybook/linter-config/prettier.config",
+  "jest": {
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "lodash": "^4.17.15"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.7.4",
+    "@babel/core": "^7.7.4",
+    "@babel/preset-env": "^7.7.4",
+    "@babel/preset-typescript": "^7.7.4",
+    "@storybook/eslint-config-storybook": "^2.1.0",
+    "@types/jest": "^24.0.23",
+    "@types/lodash": "^4.14.149",
+    "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",
+    "prettier": "^1.19.1",
+    "typescript": "^3.7.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}