🎉 Initial commit

Author: samturrell

.eslintrc

@@ -0,0 +1,3 @@
+{
+    "extends": ["@netsells"]
+}

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,2 @@
+# @netsells/vue-storybook-test-utils
+

index.js

@@ -0,0 +1,136 @@
+import { render as vRender } from '@vue/server-test-utils';
+import { mount as vMount, shallowMount as vShallowMount, createLocalVue } from '@vue/test-utils';
+import merge from 'lodash.merge';
+
+/**
+ * Generate a local vue instance for testing environment.
+ *
+ * @param {Function} callback
+ *
+ * @returns {VueConstructor<Vue>}
+ */
+const makeLocalVue = (callback = undefined) => {
+    const localVue = createLocalVue();
+
+    if (callback && typeof callback === 'function') {
+        callback(localVue);
+    }
+
+    return localVue;
+};
+
+/**
+ * Generate a vue component from a story.
+ *
+ * @param {Function} story
+ *
+ * @returns {object}
+ */
+export const generateStory = (story) => story(story.args, {
+    argTypes: story.args,
+});
+
+/**
+ * Generate the config for the mounting methods.
+ *
+ * @param {object} config
+ *
+ * @returns {object}
+ */
+const generateConfig = (config) => merge({
+    stubs: {
+        icon: true,
+        'nuxt-link': true,
+    },
+    localVue: makeLocalVue(),
+}, config);
+
+/**
+ * Generate the config for the story mounting methods.
+ *
+ * @param {object} story
+ * @param {object} options
+ *
+ * @returns {object}
+ */
+const generateConfigForStory = (story, options) => merge(generateConfig(options), {
+    propsData: {
+        ...story.args,
+        ...options.propsData,
+    },
+    localVue: makeLocalVue(options.localVue),
+});
+
+/**
+ * Render a story using `@vue/server-test-utils`.
+ *
+ * @param {Function} story
+ * @param {object} config
+ *
+ * @returns {Promise<Cheerio>}
+ */
+export const renderStory = (story, config = {}) => {
+    return vRender(generateStory(story), generateConfigForStory(story, config));
+};
+
+/**
+ * Mount a story using `@vue/test-utils`.
+ *
+ * @param {Function} story
+ * @param {object} config
+ *
+ * @returns {Promise<Cheerio>}
+ */
+export const mountStory = (story, config = {}) => {
+    return vMount(generateStory(story), generateConfigForStory(story, config));
+};
+
+/**
+ * Shallow mount a story using `@vue/test-utils`.
+ *
+ * @param {Function} story
+ * @param {object} config
+ * @param {object} config.propsData
+ * @param {object} config.options
+ *
+ * @returns {Promise<Cheerio>}
+ */
+export const shallowMountStory = (story, config = {}) => {
+    return vShallowMount(generateStory(story), generateConfigForStory(story, config));
+};
+
+/**
+ * Render a component using `@vue/server-test-utils`.
+ *
+ * @param {object} component
+ * @param {object} config
+ *
+ * @returns {Promise<Cheerio>}
+ */
+export const render = (component, config = {}) => {
+    return vRender(component, generateConfig(config));
+};
+
+/**
+ * Mount a component using `@vue/test-utils`.
+ *
+ * @param {object} component
+ * @param {object} config
+ *
+ * @returns {Promise<Cheerio>}
+ */
+export const mount = (component, config = {}) => {
+    return vMount(component, generateConfig(config));
+};
+
+/**
+ * Shallow mount a component using `@vue/test-utils`.
+ *
+ * @param {object} component
+ * @param {object} config
+ *
+ * @returns {Promise<Cheerio>}
+ */
+export const shallowMount = (component, config = {}) => {
+    return vShallowMount(component, generateConfig(config));
+};

package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@netsells/vue-storybook-test-utils",
+    "version": "0.1.0",
+    "main": "index.js",
+    "license": "MIT",
+    "dependencies": {
+        "@vue/server-test-utils": "^1.1.0",
+        "@vue/test-utils": "^1.1.0",
+        "lodash.merge": "^4.6.2"
+    },
+    "devDependencies": {
+        "@netsells/eslint-config": "^4.0.0"
+    },
+    "repository": {
+        "url": "https://github.com/netsells/vue-storybook-test-utils"
+    },
+    "author": {
+        "name": "Sam Turrell",
+        "url": "https://samturrell.co.uk",
+        "email": "[email protected]"
+    }
+}