poveste 0.1.0

package/src/node/util/vendors.ts

@@ -0,0 +1,27 @@
+import path from 'node:path'
+import { fileURLToPath, pathToFileURL } from 'node:url'
+
+// Resolve an absolute path to e.g. node_modules/.pnpm/histoire@0.11.7_vite@3.2.4/node_modules/histoire/dist/node/vendors/controls.js
+// https://github.com/histoire-dev/histoire/issues/282
+export const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+// https://github.com/vitejs/vite/issues/9661
+const alias = {
+  '@poveste/vendors/vue': path.resolve(__dirname, '../vendors/vue.js'),
+  '@poveste/controls': path.resolve(__dirname, '../vendors/controls.js'),
+}
+
+export function getInjectedImport(request: string) {
+  let id: string = request
+
+  if (alias[id]) {
+    id = alias[id]
+  }
+
+  if (path.isAbsolute(id)) {
+    return JSON.stringify(pathToFileURL(id).href)
+  }
+  else {
+    return JSON.stringify(id)
+  }
+}

package/src/node/vendors/controls.ts

@@ -0,0 +1 @@
+export * from '@poveste/controls'

package/src/node/vendors/vue.ts

@@ -0,0 +1 @@
+export * from '@poveste/vendors/vue'

package/src/node/virtual/index.ts

@@ -0,0 +1,50 @@
+// @TODO wait for virtual modules HMR to work in vite to use `virtual:` and `\0` prefix
+// https://github.com/vitejs/vite/pull/10313
+export const STORIES_ID = 'virtual:$histoire-stories'
+export const RESOLVED_STORIES_ID = `/__resolved__${STORIES_ID}`
+// export const RESOLVED_STORIES_ID = `\0${STORIES_ID}`
+export const SETUP_ID = 'virtual:$histoire-setup'
+export const NOOP_ID = 'virtual:$histoire-noop'
+export const CONFIG_ID = 'virtual:$histoire-config'
+// export const RESOLVED_CONFIG_ID = `/__resolved__${CONFIG_ID}`
+export const RESOLVED_CONFIG_ID = `\0${CONFIG_ID}`
+export const THEME_ID = 'virtual:$histoire-theme'
+// export const RESOLVED_THEME_ID = `/__resolved__${THEME_ID}.css`
+export const RESOLVED_THEME_ID = `\0${THEME_ID}.css`
+export const SEARCH_TITLE_DATA_ID = 'virtual:$histoire-search-title-data'
+// export const RESOLVED_SEARCH_TITLE_DATA_ID = `/__resolved__${SEARCH_TITLE_DATA_ID}`
+export const RESOLVED_SEARCH_TITLE_DATA_ID = `\0${SEARCH_TITLE_DATA_ID}`
+export const SEARCH_DOCS_DATA_ID = 'virtual:$histoire-search-docs-data'
+// export const RESOLVED_SEARCH_DOCS_DATA_ID = `/__resolved__${SEARCH_DOCS_DATA_ID}`
+export const RESOLVED_SEARCH_DOCS_DATA_ID = `\0${SEARCH_DOCS_DATA_ID}`
+export const GENERATED_GLOBAL_SETUP = 'virtual:$histoire-generated-global-setup'
+// export const RESOLVED_GENERATED_GLOBAL_SETUP = `/__resolved__${GENERATED_GLOBAL_SETUP}`
+export const RESOLVED_GENERATED_GLOBAL_SETUP = `\0${GENERATED_GLOBAL_SETUP}`
+export const GENERATED_SETUP_CODE = 'virtual:$histoire-generated-setup-code'
+// export const RESOLVED_GENERATED_SETUP_CODE = `/__resolved__${GENERATED_SETUP_CODE}`
+export const RESOLVED_GENERATED_SETUP_CODE = `\0${GENERATED_SETUP_CODE}`
+export const SUPPORT_PLUGINS_CLIENT = 'virtual:$histoire-support-plugins-client'
+// export const RESOLVED_SUPPORT_PLUGINS_CLIENT = `/__resolved__${SUPPORT_PLUGINS_CLIENT}`
+export const RESOLVED_SUPPORT_PLUGINS_CLIENT = `\0${SUPPORT_PLUGINS_CLIENT}`
+export const SUPPORT_PLUGINS_COLLECT = 'virtual:$histoire-support-plugins-collect'
+// export const RESOLVED_SUPPORT_PLUGINS_COLLECT = `/__resolved__${SUPPORT_PLUGINS_COLLECT}`
+export const RESOLVED_SUPPORT_PLUGINS_COLLECT = `\0${SUPPORT_PLUGINS_COLLECT}`
+export const MARKDOWN_FILES = 'virtual:$histoire-markdown-files'
+// export const RESOLVED_MARKDOWN_FILES = `/__resolved__${MARKDOWN_FILES}`
+export const RESOLVED_MARKDOWN_FILES = `\0${MARKDOWN_FILES}`
+export const COMMANDS = 'virtual:$histoire-commands'
+export const RESOLVED_COMMANDS = `/__resolved__${COMMANDS}`
+
+export * from './markdown.js'
+export * from './noop.js'
+export * from './resolved-commands.js'
+export * from './resolved-config.js'
+export * from './resolved-generated-global-setup.js'
+export * from './resolved-generated-setup-code.js'
+export * from './resolved-markdown-files.js'
+export * from './resolved-stories.js'
+export * from './resolved-support-plugins-client.js'
+export * from './resolved-support-plugins-collect.js'
+export * from './resolved-theme.js'
+export * from './story-source.js'
+export * from './story.js'

package/src/node/virtual/markdown.ts

@@ -0,0 +1,21 @@
+import type { Context } from '../context.js'
+
+export function markdown(ctx: Context, id: string) {
+  const fileId = id.slice('/__resolved__virtual:md:'.length)
+  const file = ctx.markdownFiles.find(f => f.id === fileId)
+  if (!file) {
+    throw new Error(`Markdown file not found: ${fileId}`)
+  }
+  const { html, frontmatter, relativePath } = file
+  return `export const html = ${JSON.stringify(html)}
+export const frontmatter = ${JSON.stringify(frontmatter)}
+export const relativePath = ${JSON.stringify(relativePath)}
+
+if (import.meta.hot) {
+  import.meta.hot.accept(newModule => {
+    if (newModule) {
+      window.__hst_md_hmr(newModule)
+    }
+  })
+}`
+}

package/src/node/virtual/noop.ts

@@ -0,0 +1 @@
+export const noop = () => `export default () => {}`

package/src/node/virtual/resolved-commands.ts

@@ -0,0 +1,42 @@
+import type { PluginCommand } from '@poveste/shared'
+import type { Context } from '../context.js'
+
+const serializedFields: Readonly<(keyof PluginCommand)[]> = ['id', 'label', 'prompts', 'icon', 'searchText'] as const
+
+export function resolvedCommands(ctx: Context) {
+  const imports: string[] = []
+  const commands: string[] = []
+
+  for (const command of ctx.registeredCommands) {
+    const fields = getCommandFields(command, imports)
+    commands.push(`{ ${fields.join(', ')} }`)
+  }
+
+  return `${imports.join('\n')}
+export const registeredCommands = [${commands.join(', ')}]
+`
+}
+
+function getCommandFields(command: PluginCommand, imports: string[]) {
+  const fields: string[] = []
+
+  for (const field of serializedFields) {
+    if (command[field] != null) {
+      fields.push(`${field}: ${JSON.stringify(command[field])}`)
+    }
+  }
+
+  // Add client-side data
+  if (command.clientSetupFile) {
+    const importedVar = `__setup${imports.length}__`
+    if (typeof command.clientSetupFile === 'string') {
+      imports.push(`import ${importedVar} from '${command.clientSetupFile}'`)
+    }
+    else {
+      imports.push(`import { ${command.clientSetupFile.importName} as ${importedVar} } from '${command.clientSetupFile.file}'`)
+    }
+    fields.push(`...${importedVar}`)
+  }
+
+  return fields
+}

package/src/node/virtual/resolved-config.ts

@@ -0,0 +1,12 @@
+import type { Context } from '../context.js'
+
+export function resolvedConfig(ctx: Context) {
+  let js = `export const config = ${JSON.stringify(ctx.config)}\n`
+  if (ctx.config.theme?.logo) {
+    for (const key in ctx.config.theme.logo) {
+      js += `import Logo_${key} from '${ctx.config.theme.logo[key]}'\n`
+    }
+  }
+  js += `export const logos = {${Object.keys(ctx.config.theme?.logo ?? {}).map(key => `${key}: Logo_${key}`).join(', ')}}\n`
+  return js
+}

package/src/node/virtual/resolved-generated-global-setup.ts

@@ -0,0 +1,25 @@
+import type { Context } from '../context.js'
+import { GENERATED_SETUP_CODE } from './index.js'
+import { ID_SEPARATOR } from './util.js'
+
+export function resolvedGeneratedGlobalSetup(ctx: Context) {
+  if (ctx.config.setupCode) {
+    return [
+      // Import
+      `${ctx.config.setupCode.map((c, index) => `import * as setup_${index} from '${GENERATED_SETUP_CODE}${ID_SEPARATOR}${index}'`).join('\n')}`,
+      // List
+      `const setupList = [${ctx.config.setupCode.map((c, index) => `setup_${index}`).join(', ')}]`,
+      // Setups
+      ...ctx.supportPlugins.map(p => p.setupFn).flat().map(fnName => `export async function ${fnName} (payload) {
+        for (const setup of setupList) {
+          if (setup?.${fnName}) {
+            await setup.${fnName}(payload)
+          }
+        }
+      }`),
+    ].join('\n')
+  }
+  else {
+    return ''
+  }
+}

package/src/node/virtual/resolved-generated-setup-code.ts

@@ -0,0 +1,7 @@
+import type { Context } from '../context.js'
+import { ID_SEPARATOR } from './util.js'
+
+export function resolvedGeneratedSetupCode(ctx: Context, id: string) {
+  const [, index] = id.split(ID_SEPARATOR)
+  return ctx.config.setupCode?.[index] ?? ''
+}

package/src/node/virtual/resolved-markdown-files.ts

@@ -0,0 +1,19 @@
+import type { Context } from '../context.js'
+import { getInjectedImport } from '../util/vendors.js'
+
+export function resolvedMarkdownFiles(ctx: Context) {
+  const filesJs = ctx.markdownFiles.map(f => `${JSON.stringify(f.relativePath)}: () => import(${JSON.stringify(`virtual:md:${f.id}`)})`).join(',')
+  return `import { reactive } from ${process.env.HISTOIRE_DEV ? `'vue'` : getInjectedImport('@poveste/vendors/vue')}
+export const markdownFiles = reactive({${filesJs}})
+if (import.meta.hot) {
+  if (!window.__hst_md_hmr) {
+    window.__hst_md_hmr = (newModule) => {
+      markdownFiles[newModule.relativePath] = () => newModule
+    }
+  }
+
+  import.meta.hot.accept(newModule => {
+    Object.assign(markdownFiles, newModule.markdownFiles)
+  })
+}`
+}

package/src/node/virtual/resolved-stories.ts

@@ -0,0 +1,44 @@
+import type { Context } from '../context.js'
+import { makeTree } from '../tree.js'
+
+export function resolvedStories(ctx: Context) {
+  const resolvedStories = ctx.storyFiles.filter(s => !!s.story)
+  const files = resolvedStories.map((file, index) => {
+    return {
+      id: file.id,
+      path: file.treePath,
+      filePath: file.relativePath,
+      story: {
+        ...file.story,
+        docsText: undefined,
+      },
+      supportPluginId: file.supportPluginId,
+      docsFilePath: file.markdownFile?.relativePath,
+      index,
+    }
+  })
+  return `${ctx.supportPlugins.map(p => p.importStoriesPrepend).filter(Boolean).join('\n')}
+${resolvedStories.map((file, index) => {
+  const supportPlugin = ctx.supportPlugins.find(p => p.id === file.supportPluginId)
+  if (!supportPlugin) {
+    throw new Error(`Could not find support plugin for story ${file.path}: ${file.supportPluginId}`)
+  }
+  return supportPlugin.importStoryComponent(file, index)
+}).filter(Boolean).join('\n')}
+export let files = [${files.map(file => `{${JSON.stringify(file).slice(1, -1)}, component: Comp${file.index}, source: () => import('virtual:story-source:${file.story.id}')}`).join(',\n')}]
+export let tree = ${JSON.stringify(makeTree(ctx.config, resolvedStories))}
+const handlers = []
+export function onUpdate (cb) {
+  handlers.push(cb)
+}
+if (import.meta.hot) {
+  import.meta.hot.accept(newModule => {
+    files = newModule.files
+    tree = newModule.tree
+    handlers.forEach(h => {
+      h(newModule.files, newModule.tree)
+      newModule.onUpdate(h)
+    })
+  })
+}`
+}

package/src/node/virtual/resolved-support-plugins-client.ts

@@ -0,0 +1,14 @@
+import type { Context } from '../context.js'
+import { createRequire } from 'node:module'
+import { PLUGINS_HAVE_DEV } from './util.js'
+
+const require = createRequire(import.meta.url)
+
+export function resolvedSupportPluginsClient(ctx: Context) {
+  const plugins = ctx.supportPlugins.map(p => `'${p.id}': () => import(${JSON.stringify(require.resolve(`${p.moduleName}/client${process.env.HISTOIRE_DEV && PLUGINS_HAVE_DEV.includes(p.moduleName) ? '-dev' : ''}`, {
+    paths: [ctx.root, import.meta.url],
+  }))})`)
+  return `export const clientSupportPlugins = {
+    ${plugins.join(',\n  ')}
+  }`
+}

package/src/node/virtual/resolved-support-plugins-collect.ts

@@ -0,0 +1,14 @@
+import type { Context } from '../context.js'
+import { createRequire } from 'node:module'
+import { PLUGINS_HAVE_DEV } from './util.js'
+
+const require = createRequire(import.meta.url)
+
+export function resolvedSupportPluginsCollect(ctx: Context) {
+  const plugins = ctx.supportPlugins.map(p => `'${p.id}': () => import(${JSON.stringify(require.resolve(`${p.moduleName}/collect${process.env.HISTOIRE_DEV && PLUGINS_HAVE_DEV.includes(p.moduleName) ? '-dev' : ''}`, {
+    paths: [ctx.root, import.meta.url],
+  }))})`)
+  return `export const collectSupportPlugins = {
+    ${plugins.join(',\n  ')}
+  }`
+}

package/src/node/virtual/resolved-theme.ts

@@ -0,0 +1,14 @@
+import type { Context } from '../context.js'
+import { parseColor } from '../colors.js'
+
+export function resolvedTheme(ctx: Context) {
+  let css = '*, ::before, ::after {'
+  // Colors
+  for (const color in ctx.config.theme?.colors ?? {}) {
+    for (const key in ctx.config.theme.colors[color]) {
+      css += `--_histoire-color-${color}-${key}: ${parseColor(ctx.config.theme.colors[color][key]).color.join(' ')};`
+    }
+  }
+  css += '}'
+  return css
+}

package/src/node/virtual/story-source.ts

@@ -0,0 +1,18 @@
+import type { Context } from '../context.js'
+import fs from 'fs-extra'
+import { resolve } from 'pathe'
+
+export async function storySource(ctx: Context, id: string) {
+  const storyId = id.slice('/__resolved__virtual:story-source:'.length)
+  const storyFile = ctx.storyFiles.find(f => f.story?.id === storyId)
+  if (storyFile) {
+    let source: string
+    if (storyFile.virtual) {
+      source = storyFile.moduleCode
+    }
+    else {
+      source = await fs.readFile(resolve(ctx.root, storyFile.relativePath), 'utf-8')
+    }
+    return `export default ${JSON.stringify(source)}`
+  }
+}

package/src/node/virtual/story.ts

@@ -0,0 +1,9 @@
+import type { Context } from '../context.js'
+
+export function story(ctx: Context, id: string) {
+  const moduleId = id.replace('\0', '')
+  const storyFile = ctx.storyFiles.find(f => f.moduleId === moduleId && f.virtual)
+  if (storyFile) {
+    return storyFile.moduleCode
+  }
+}

package/src/node/virtual/util.ts

@@ -0,0 +1,5 @@
+export const ID_SEPARATOR = '__-__'
+
+export const PLUGINS_HAVE_DEV = [
+  '@poveste/plugin-vue',
+]

package/src/node/virtual/vite-plugin.ts

@@ -0,0 +1,146 @@
+import type { Plugin as VitePlugin } from 'vite'
+import type { Context } from '../context.js'
+import { resolve } from 'pathe'
+import { generateDocSearchData, generateTitleSearchData, getSearchDataJS } from '../search.js'
+import * as VirtualFiles from './index.js'
+import { ID_SEPARATOR } from './util.js'
+
+export function createVirtualFilesPlugin(ctx: Context, isServer: boolean) {
+  return {
+    name: 'histoire-virtual-files',
+
+    async resolveId(id, importer) {
+      if (id.startsWith(VirtualFiles.STORIES_ID)) {
+        return VirtualFiles.RESOLVED_STORIES_ID
+      }
+      if (id.startsWith(VirtualFiles.SETUP_ID)) {
+        const setupFileConfig = ctx.config.setupFile
+        if (setupFileConfig) {
+          let file: string
+          if (typeof setupFileConfig === 'string') {
+            file = setupFileConfig
+          }
+          else if (isServer && 'server' in setupFileConfig) {
+            file = setupFileConfig.server
+          }
+          else if (!isServer && 'browser' in setupFileConfig) {
+            file = setupFileConfig.browser
+          }
+          if (file) {
+            return this.resolve(resolve(ctx.root, file), importer, {
+              skipSelf: true,
+            })
+          }
+        }
+        return VirtualFiles.NOOP_ID
+      }
+      if (id.startsWith(VirtualFiles.CONFIG_ID)) {
+        return VirtualFiles.RESOLVED_CONFIG_ID
+      }
+      if (id.startsWith(VirtualFiles.THEME_ID)) {
+        return VirtualFiles.RESOLVED_THEME_ID
+      }
+      if (id.startsWith(VirtualFiles.SEARCH_TITLE_DATA_ID)) {
+        return VirtualFiles.RESOLVED_SEARCH_TITLE_DATA_ID
+      }
+      if (id.startsWith(VirtualFiles.SEARCH_DOCS_DATA_ID)) {
+        return VirtualFiles.RESOLVED_SEARCH_DOCS_DATA_ID
+      }
+      if (id.startsWith(VirtualFiles.GENERATED_GLOBAL_SETUP)) {
+        return VirtualFiles.RESOLVED_GENERATED_GLOBAL_SETUP
+      }
+      if (id.startsWith(VirtualFiles.GENERATED_SETUP_CODE)) {
+        const [, index] = id.split(ID_SEPARATOR)
+        return `${VirtualFiles.RESOLVED_GENERATED_SETUP_CODE}${ID_SEPARATOR}${index}`
+      }
+      if (id.startsWith(VirtualFiles.SUPPORT_PLUGINS_CLIENT)) {
+        return VirtualFiles.RESOLVED_SUPPORT_PLUGINS_CLIENT
+      }
+      if (id.startsWith(VirtualFiles.SUPPORT_PLUGINS_COLLECT)) {
+        return VirtualFiles.RESOLVED_SUPPORT_PLUGINS_COLLECT
+      }
+      if (id.startsWith(VirtualFiles.MARKDOWN_FILES)) {
+        return VirtualFiles.RESOLVED_MARKDOWN_FILES
+      }
+      if (id.startsWith(VirtualFiles.COMMANDS)) {
+        return VirtualFiles.RESOLVED_COMMANDS
+      }
+      if (id.startsWith('virtual:story:')) {
+        return `\0${id}`
+      }
+      if (id.startsWith('virtual:story-source:')) {
+        return `/__resolved__${id}`
+      // @TODO
+      // return `\0${id}`
+      }
+
+      if (id.startsWith('virtual:md:')) {
+        return `/__resolved__${id}`
+      // @TODO
+      // return `\0${id}`
+      }
+    },
+
+    async load(id) {
+      if (id === VirtualFiles.RESOLVED_STORIES_ID) {
+        return VirtualFiles.resolvedStories(ctx)
+      }
+
+      if (id === VirtualFiles.NOOP_ID) {
+        return VirtualFiles.noop()
+      }
+
+      if (id === VirtualFiles.RESOLVED_CONFIG_ID) {
+        return VirtualFiles.resolvedConfig(ctx)
+      }
+
+      if (id === VirtualFiles.RESOLVED_THEME_ID) {
+        return VirtualFiles.resolvedTheme(ctx)
+      }
+
+      if (id === VirtualFiles.RESOLVED_SEARCH_TITLE_DATA_ID) {
+        return getSearchDataJS(await generateTitleSearchData(ctx))
+      }
+
+      if (id === VirtualFiles.RESOLVED_SEARCH_DOCS_DATA_ID) {
+        return getSearchDataJS(await generateDocSearchData(ctx))
+      }
+
+      if (id === VirtualFiles.RESOLVED_GENERATED_GLOBAL_SETUP) {
+        return VirtualFiles.resolvedGeneratedGlobalSetup(ctx)
+      }
+
+      if (id.startsWith(VirtualFiles.RESOLVED_GENERATED_SETUP_CODE)) {
+        return VirtualFiles.resolvedGeneratedSetupCode(ctx, id)
+      }
+
+      if (id === VirtualFiles.RESOLVED_SUPPORT_PLUGINS_CLIENT) {
+        return VirtualFiles.resolvedSupportPluginsClient(ctx)
+      }
+
+      if (id === VirtualFiles.RESOLVED_SUPPORT_PLUGINS_COLLECT) {
+        return VirtualFiles.resolvedSupportPluginsCollect(ctx)
+      }
+
+      if (id === VirtualFiles.RESOLVED_MARKDOWN_FILES) {
+        return VirtualFiles.resolvedMarkdownFiles(ctx)
+      }
+
+      if (id === VirtualFiles.RESOLVED_COMMANDS) {
+        return VirtualFiles.resolvedCommands(ctx)
+      }
+
+      if (id.startsWith('\0virtual:story:')) {
+        return VirtualFiles.story(ctx, id)
+      }
+
+      if (id.startsWith('/__resolved__virtual:story-source:')) {
+        return VirtualFiles.storySource(ctx, id)
+      }
+
+      if (id.startsWith('/__resolved__virtual:md:')) {
+        return VirtualFiles.markdown(ctx, id)
+      }
+    },
+  } as VitePlugin
+}