feat: Story title is now optional

histoire-dev · Apr 19, 2022 · e2e3921 · e2e3921
1 parent f1db6d1
commit e2e3921
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/examples/vue3/src/components/Introduction.story.vue b/examples/vue3/src/components/Introduction.story.vue
@@ -0,0 +1,5 @@
+<template>
+ <Story>
+ This is a demo book using Vue 3.
+ </Story>
+</template>
diff --git a/packages/histoire/src/client/server/Story.server.vue b/packages/histoire/src/client/server/Story.server.vue
@@ -8,7 +8,7 @@ export default defineComponent({
  props: {
  title: {
  type: String,
- required: true,
+ default: null,
  },
 
  layout: {
@@ -36,7 +36,7 @@ export default defineComponent({
 
  const story: Story = {
  id: attrs.data.id,
- title: props.title,
+ title: props.title ?? attrs.data.fileName,
  layout: props.layout,
  icon: props.icon,
  iconColor: props.iconColor,

diff --git a/packages/histoire/src/node/stories.ts b/packages/histoire/src/node/stories.ts
@@ -1,7 +1,7 @@
 import chokidar from 'chokidar'
 import { globby } from 'globby'
 import Case from 'case'
-import { join } from 'pathe'
+import { join, basename } from 'pathe'
 import { Context } from './context.js'
 import type { StoryFile } from './types.js'
 
@@ -47,10 +47,15 @@ function getAbsoluteFilePath (relativeFilePath: string) {
 function addStory (relativeFilePath: string) {
  const absoluteFilePath = getAbsoluteFilePath(relativeFilePath)
  const fileId = Case.kebab(relativeFilePath)
+ let fileName = basename(relativeFilePath)
+ if (fileName.includes('.')) {
+ fileName = fileName.substring(0, fileName.indexOf('.'))
+ }
 
  const file: StoryFile = {
  id: fileId,
  path: absoluteFilePath,
+ fileName,
  moduleId: `/${relativeFilePath}`,
  }
  context.storyFiles.push(file)

diff --git a/packages/histoire/src/node/types.ts b/packages/histoire/src/node/types.ts
@@ -4,6 +4,10 @@ export interface StoryFile {
  * Absolute path
  */
  path: string
+ /**
+ * File name without extension
+ */
+ fileName: string
  /**
  * Generated path for tree UI
  */