feat: Add case conversion option

pocka · Dec 11, 2019 · 0ea4b53 · 0ea4b53
1 parent f9ab4e2
commit 0ea4b53
Show file tree

Hide file tree

Showing 9 changed files with 233 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -126,17 +126,47 @@ For more details, see [live examples].
 
 ## Options
 
-| Name               | Data type                             | Default value                                       | Description                                                                        |
-| ------------------ | ------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `header`           | `boolean`                             | `true`                                              | Whether to show header or not.                                                     |
-| `source`           | `boolean`                             | `true`                                              | Whether to show source(usage) or not.                                              |
-| `wrapperComponent` | `Component`                           | [default wrapper](src/components/Wrapper/index.vue) | Override inline docs component.                                                    |
-| `previewClassName` | `string`                              | `undefined`                                         | Class name passed down to preview container.                                       |
-| `previewStyle`     | Style object                          | `undefined`                                         | Style passed down to preview container.                                            |
-| `summary`          | `string`                              | `''`                                                | Summary for the story. Accepts Markdown.                                           |
-| `components`       | `{ [name: string]: Component }\|null` | `null`                                              | Display info for these components. Same type as component's `components` property. |
-| `docsInPanel`      | `boolean`                             | `true`                                              | Whether to show docs in addon panel.                                               |
-| `useDocgen`        | `boolean`                             | `true`                                              | Whether to use result of vue-docgen-api.                                           |
+| Name               | Data type                                     | Default value                                       | Description                                                                        |
+| ------------------ | --------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `header`           | `boolean`                                     | `true`                                              | Whether to show header or not.                                                     |
+| `source`           | `boolean`                                     | `true`                                              | Whether to show source(usage) or not.                                              |
+| `wrapperComponent` | `Component`                                   | [default wrapper](src/components/Wrapper/index.vue) | Override inline docs component.                                                    |
+| `previewClassName` | `string`                                      | `undefined`                                         | Class name passed down to preview container.                                       |
+| `previewStyle`     | Style object                                  | `undefined`                                         | Style passed down to preview container.                                            |
+| `summary`          | `string`                                      | `''`                                                | Summary for the story. Accepts Markdown.                                           |
+| `components`       | `{ [name: string]: Component }\|null`         | `null`                                              | Display info for these components. Same type as component's `components` property. |
+| `docsInPanel`      | `boolean`                                     | `true`                                              | Whether to show docs in addon panel.                                               |
+| `useDocgen`        | `boolean`                                     | `true`                                              | Whether to use result of vue-docgen-api.                                           |
+| `casing`           | `"kebab" \| "camel" \| "pascal" \| undefined` | `undefined`                                         | Which case to use. For detailed usage, see below.                                  |
+
+### Valid `casing` options
+
+```js
+{
+  // Don't convert names
+  casing: undefined
+}
+
+{
+  // Show names in kebab-case
+  casing 'kebab'
+}
+
+{
+  // Show prop names in camelCase and
+  // Show component names in PascalCase
+  casing: 'camel' // or 'pascal'
+}
+
+{
+  // Show prop names in camelCase and
+  // Show component names in kebab-case
+  casing: {
+    props: 'camel',
+    component: 'kebab'
+  }
+}
+```
 
 In addition to addon options, we have a component option.
 

diff --git a/example/.storybook/config.js b/example/.storybook/config.js
@@ -13,10 +13,4 @@ Vue.use(VueI18n)
 
 addDecorator(withInfo)
 
-const req = require.context('../stories', true, /\.stories\.js$/)
-
-function loadStories() {
-  req.keys().forEach(req)
-}
-
-configure(loadStories, module)
+configure(require.context('../stories', true, /\.stories\.js$/), module)
diff --git a/example/stories/issues/122/camel.vue b/example/stories/issues/122/camel.vue
@@ -0,0 +1,14 @@
+<script>
+export default {
+  props: {
+    tooLongCamelProps: {
+      type: String,
+      default: 'foo'
+    }
+  }
+}
+</script>
+
+<template>
+  <p>camelCase</p>
+</template>
diff --git a/example/stories/issues/122/index.stories.js b/example/stories/issues/122/index.stories.js
@@ -0,0 +1,80 @@
+import CamelComponent from './camel.vue'
+import KebabComponent from './kebab.vue'
+import MixedComponent from './mixed.vue'
+
+export default {
+  title: 'Issues/#122'
+}
+
+export const camelToKebab = () => {
+  return {
+    components: { CamelComponent },
+    template: '<CamelComponent />'
+  }
+}
+camelToKebab.story = {
+  title: 'Convert camelCase to kebab-case',
+  parameters: {
+    info: {
+      casing: 'kebab'
+    }
+  }
+}
+
+export const kebabToCamel = () => {
+  return {
+    components: { KebabComponent },
+    template: '<kebab-component />'
+  }
+}
+kebabToCamel.story = {
+  title: 'Convert kebab-case to camelCase',
+  parameters: {
+    info: {
+      casing: 'camel'
+    }
+  }
+}
+
+export const mixedToKebab = () => {
+  return {
+    components: { MixedComponent },
+    template: '<mixed-component/>'
+  }
+}
+mixedToKebab.story = {
+  title: 'Convert to kebab-case (mixed)',
+  parameters: {
+    info: {
+      casing: 'kebab'
+    }
+  }
+}
+
+export const mixedToCamel = () => {
+  return {
+    components: { MixedComponent },
+    template: '<mixed-component/>'
+  }
+}
+mixedToCamel.story = {
+  title: 'Convert to camelCase (mixed)',
+  parameters: {
+    info: {
+      casing: 'camel'
+    }
+  }
+}
+
+export const preserve = () => {
+  return {
+    components: { MixedComponent },
+    template: '<mixed-component/>'
+  }
+}
+preserve.story = {
+  title: 'Preserve casing when undefined',
+  parameters: {
+    info: {}
+  }
+}
diff --git a/example/stories/issues/122/kebab.vue b/example/stories/issues/122/kebab.vue
@@ -0,0 +1,14 @@
+<script>
+export default {
+  props: {
+    'too-long-kebab-props': {
+      type: String,
+      default: 'foo'
+    }
+  }
+}
+</script>
+
+<template>
+  <p>kebab-case</p>
+</template>
diff --git a/example/stories/issues/122/mixed.vue b/example/stories/issues/122/mixed.vue
@@ -0,0 +1,18 @@
+<script>
+export default {
+  props: {
+    tooLongCamelProps: {
+      type: String,
+      default: 'foo'
+    },
+    'too-long-kebab-props': {
+      type: String,
+      default: 'foo'
+    }
+  }
+}
+</script>
+
+<template>
+  <p>mIxeD-CaSE</p>
+</template>
diff --git a/src/components/Component/index.vue b/src/components/Component/index.vue
@@ -1,4 +1,5 @@
 <script>
+import { paramCase, camelCase, pascalCase } from 'change-case'
 import XTable from '../Table/index.vue'
 
 export default {
@@ -11,11 +12,35 @@ export default {
     component: {
       type: Object,
       required: true
+    },
+    /**
+     * Case conversion
+     * See components/Wrapper/index.vue
+     */
+    casing: {
+      type: Object,
+      required: true
     }
   },
   computed: {
     title() {
-      return `# <${this.component.name}/>`
+      return `# <${this.normalizeCase(this.component.name, 'component')}/>`
+    }
+  },
+  methods: {
+    normalizeCase(name, attr) {
+      switch (this.casing[attr]) {
+        case void 0:
+          return name
+        case 'kebab':
+        case 'kebab-case':
+          return paramCase(name)
+        case 'camel':
+        case 'camelCase':
+        case 'pascalCase':
+        case 'PascalCase':
+          return attr === 'component' ? pascalCase(name) : camelCase(name)
+      }
     }
   }
 }
@@ -36,7 +61,7 @@ export default {
       <tbody>
         <tr v-for="prop in component.props" :key="prop.name">
           <td>
-            {{ prop.name }}
+            {{ normalizeCase(prop.name, 'props') }}
             <sup v-if="prop.required" :class="$style.required">*</sup>
           </td>
           <td>{{ prop.type }}</td>

diff --git a/src/components/Wrapper/index.vue b/src/components/Wrapper/index.vue
@@ -26,6 +26,20 @@ export default {
       type: Object,
       required: true
     }
+  },
+  computed: {
+    casing() {
+      return {
+        component:
+          typeof this.options.casing === 'string' || !this.options.casing
+            ? this.options.casing
+            : this.options.casing.component,
+        props:
+          typeof this.options.casing === 'string' || !this.options.casing
+            ? this.options.casing
+            : this.options.casing.props
+      }
+    }
   }
 }
 </script>
@@ -51,7 +65,12 @@ export default {
       :lang="info.jsxStory ? 'jsx' : 'html'"
     />
     <x-separator />
-    <x-component v-for="c in info.components" :key="c.name" :component="c" />
+    <x-component
+      v-for="c in info.components"
+      :key="c.name"
+      :component="c"
+      :casing="casing"
+    />
   </x-docs>
 </template>
 

diff --git a/src/options.ts b/src/options.ts
@@ -9,9 +9,19 @@ export const defaultOptions: InfoAddonOptions = {
   components: null,
   wrapperComponent: DefaultWrapper,
   docsInPanel: true,
-  useDocgen: true
+  useDocgen: true,
+  casing: undefined
 }
 
+type Casing =
+  | undefined
+  | 'camel'
+  | 'camelCase'
+  | 'kebab'
+  | 'kebab-case'
+  | 'pascal'
+  | 'PascalCase'
+
 /**
  * Addon options
  */
@@ -53,4 +63,11 @@ export interface InfoAddonOptions {
    * Whether to use component infomation generated by vue-docgen-api
    */
   useDocgen: boolean
+
+  casing:
+    | Casing
+    | {
+        props: Casing
+        component: Casing
+      }
 }