Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 8 additions & 62 deletions packages/core/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,75 +1,21 @@
import { joinURL } from 'ufo'

import { libraryCollections as libraryCollectionsConfig } from '@compodium/examples'
import { collectionsPlugin } from './plugins/collections'
import { extendMetaPlugin, metaPlugin } from './plugins/meta'
import { examplePlugin } from './plugins/examples'
import { devtoolsPlugin } from './plugins/devtools'
import { colorsPlugin } from './plugins/colors'
import { iconifyPlugin } from './plugins/iconify'

import type { Collection, PluginConfig, PluginOptions } from './types'
import { resolve } from 'pathe'
import type { PluginOptions } from './types'

export * from './types'

export function resolveConfig(options: PluginOptions): PluginConfig {
const exampleDir = {
path: joinURL(options.rootDir, options.dir, 'examples'),
pattern: '**/*.{vue,tsx}'
}

const componentDirs = options?.componentDirs.map((dir) => {
const componentDir = typeof dir === 'string' ? { path: dir } : dir
return {
pattern: '**/*.{vue,tsx}',
...componentDir,
path: resolve(options.rootDir, componentDir.path),
ignore: (componentDir.ignore ?? []).concat(options.ignore ?? [])
}
}).filter(collection => !collection.path?.includes('node_modules/'))

const componentCollection: Collection = {
name: 'Components',
exampleDir,
dirs: componentDirs
}

const libraryCollections = options.includeLibraryCollections
? libraryCollectionsConfig.map(collection => ({
...collection,
exampleDir: {
path: collection.exampleDir,
pattern: '**/*.{vue,tsx}',
prefix: collection.prefix
},
dirs: [{
path: collection.path,
pattern: '**/*.{vue,tsx}',
ignore: collection.ignore,
prefix: collection.prefix
}]
}))
: []

return {
...options,
libraryCollections,
componentCollection,
baseUrl: '/'
}
}

export const compodium = /* #__PURE__ */ (options: PluginOptions) => {
const config = resolveConfig(options)

return [
collectionsPlugin(config),
metaPlugin(config),
extendMetaPlugin(config),
devtoolsPlugin(config),
examplePlugin(config),
iconifyPlugin(config),
colorsPlugin(config)
collectionsPlugin(options),
metaPlugin(options),
extendMetaPlugin(options),
devtoolsPlugin(options),
examplePlugin(options),
iconifyPlugin(options),
colorsPlugin(options)
]
}
81 changes: 71 additions & 10 deletions packages/core/src/plugins/collections.ts
Original file line number Diff line number Diff line change
@@ -1,24 +1,83 @@
import type { PluginConfig } from '../types'
import { libraryCollections as libraryCollectionsConfig } from '@compodium/examples'
import type { PluginOptions, Collection } from '../types'
import { scanComponents } from './utils'
import { watch } from 'chokidar'
import type { VitePlugin } from 'unplugin'
import { resolve } from 'pathe'
import { joinURL } from 'ufo'
import type { ResolvedConfig } from 'vite'

export function resolveCollections(options: PluginOptions, viteConfig: ResolvedConfig): Collection[] {
const rootDir = options.rootDir ?? viteConfig.root

const exampleDir = {
path: joinURL(rootDir, options.dir, 'examples'),
pattern: '**/*.{vue,tsx}'
}

const componentDirs = options?.componentDirs.map((dir) => {
const componentDir = typeof dir === 'string' ? { path: dir } : dir
return {
pattern: '**/*.{vue,tsx}',
...componentDir,
path: resolve(rootDir, componentDir.path),
ignore: (componentDir.ignore ?? []).concat(options.ignore ?? [])
}
}).filter(collection => !collection.path?.includes('node_modules/'))

const componentCollection: Collection = {
name: 'Components',
exampleDir,
dirs: componentDirs
}

const libraryCollections = options.includeLibraryCollections
? libraryCollectionsConfig.map(collection => ({
...collection,
exampleDir: {
path: collection.exampleDir,
pattern: '**/*.{vue,tsx}',
prefix: collection.prefix
},
dirs: [{
path: collection.path,
pattern: '**/*.{vue,tsx}',
ignore: collection.ignore,
prefix: collection.prefix
}]
}))
: []

return [
componentCollection,
...libraryCollections
]
}

export function collectionsPlugin(options: PluginOptions): VitePlugin {
let collections: Collection[]

export function collectionsPlugin(config: PluginConfig): VitePlugin {
return {
name: 'compodium:collections',
apply: 'serve',
enforce: 'post',

configResolved(viteConfig) {
collections = resolveCollections(options, viteConfig)
},

configureServer(server) {
server.middlewares.use('/__compodium__/api/collections', async (_, res) => {
try {
const collections = await Promise.all([config.componentCollection, ...config.libraryCollections].map(async (col) => {
const components = await scanComponents(col.dirs, config.rootDir)
const examples = await scanComponents([col.exampleDir], config.rootDir)
const result = await Promise.all(collections.map(async (col) => {
const components = await scanComponents(col.dirs)
const examples = await scanComponents([col.exampleDir])

const collectionComponents = components.flatMap((c) => {
const componentExamples = examples?.filter(e => e.pascalName.startsWith(`${c.pascalName}Example`)).map(e => ({
...e,
isExample: true,
componentPath: resolve(config.rootDir, c.filePath)
componentPath: c.filePath
}))

const mainExample = componentExamples.find(e => e.pascalName === `${c.pascalName}Example`)
Expand All @@ -42,18 +101,20 @@ export function collectionsPlugin(config: PluginConfig): VitePlugin {
}))

res.setHeader('Content-Type', 'application/json')
res.write(JSON.stringify(collections))
res.write(JSON.stringify(result))
res.end()
} catch {
res.statusCode = 500
res.end(JSON.stringify({ error: 'Failed to fetch collections' }))
}
})

const componentCollection = collections.find(c => c.name === 'Components') as Collection

const watchedPaths = [
...config.componentCollection.dirs,
config.componentCollection.exampleDir
].map(d => resolve(config.rootDir, d.path))
...componentCollection.dirs,
componentCollection.exampleDir
].map(d => d.path)

// Watch for changes in example directory
const watcher = watch(watchedPaths, {
Expand Down
7 changes: 4 additions & 3 deletions packages/core/src/plugins/colors.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
import type { VitePlugin } from 'unplugin'
import type { PluginConfig } from '../types'
import type { PluginOptions } from '../types'

/**
* This plugin is responsible for getting the generated virtual templates and
* making them available to the Vue build.
*/
export function colorsPlugin(config: PluginConfig): VitePlugin {
export function colorsPlugin(options: PluginOptions): VitePlugin {
return {
name: 'compodium:colors',
apply: 'serve',
configureServer(server) {
server.middlewares.use('/__compodium__/api/colors', async (req, res) => {
try {
res.setHeader('Content-Type', 'application/json')
res.end(JSON.stringify(config.extras?.colors))
res.end(JSON.stringify(options.extras?.colors))
} catch (err) {
res.statusCode = 500
res.end(JSON.stringify({ error: `Failed to fetch iconify API: ${err}` }))
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/plugins/devtools.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
import type { VitePlugin } from 'unplugin'
import sirv from 'sirv'
import type { PluginConfig } from '../types'
import type { PluginOptions } from '../types'
import { resolve, dirname } from 'pathe'
import { fileURLToPath } from 'node:url'
import { existsSync } from 'node:fs'
import { joinURL } from 'ufo'
import { resolvePathSync } from 'mlly'

export function devtoolsPlugin(config: PluginConfig): VitePlugin {
const userPreview = resolve(joinURL(config.rootDir, config.dir, 'preview.vue'))
export function devtoolsPlugin(options: PluginOptions): VitePlugin {
let userPreview: string

return {
name: 'compodium:devtools',
apply: 'serve',

configResolved(viteConfig) {
userPreview = resolve(joinURL(options.rootDir ?? viteConfig.root, options.dir, 'preview.vue'))
},
config(config) {
if (process.env.COMPODIUM_DEVTOOLS_URL) {
config.server ||= {}
Expand Down
25 changes: 14 additions & 11 deletions packages/core/src/plugins/examples.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
import fs from 'node:fs/promises'
import type { VitePlugin } from 'unplugin'
import type { PluginConfig } from '../types'
import { resolve } from 'node:path'
import type { Collection, PluginOptions } from '../types'
import { resolveCollections } from './collections'

export function examplePlugin(options: PluginOptions): VitePlugin {
let collections: Collection[]

export function examplePlugin(config: PluginConfig): VitePlugin {
return {
name: 'compodium:examples',
apply: 'serve',

configureServer(server) {
const paths = [
config.componentCollection.exampleDir,
...config.libraryCollections.map(c => c.exampleDir)
].map(d => resolve(config.rootDir, d.path))
configResolved(viteConfig) {
collections = resolveCollections(options, viteConfig)
},

configureServer(server) {
const allowedPaths = collections.map(c => c.exampleDir.path)
server.middlewares.use('/__compodium__/api/example', async (req, res) => {
try {
const url = new URL(req.url!, `http://${req.headers.host}`)
Expand All @@ -24,9 +27,9 @@ export function examplePlugin(config: PluginConfig): VitePlugin {
return
}

if (!paths.find(p => path.startsWith(p))) {
if (!allowedPaths.find(p => path.startsWith(p))) {
res.statusCode = 403
res.end(JSON.stringify({ error: 'Forbidden' }))
res.end(JSON.stringify({ error: 'Forbidden', message: `${allowedPaths}\n ${path}` }))
return
}

Expand All @@ -35,7 +38,7 @@ export function examplePlugin(config: PluginConfig): VitePlugin {
let result = exampleCode.toString()
.replace(/extendCompodiumMeta\s*\([\s\S]*?\)\s*;?/g, '')

if (config._nuxt) {
if (options._nuxt) {
result = result
.replace(/import .* from 'vue'/, '')
}
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/plugins/iconify.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import type { VitePlugin } from 'unplugin'
import type { PluginConfig } from '../types'
import type { PluginOptions } from '../types'
import { joinURL } from 'ufo'

export function iconifyPlugin(_config: PluginConfig): VitePlugin {
export function iconifyPlugin(_options: PluginOptions): VitePlugin {
return {
name: 'compodium:iconify',

apply: 'serve',
configureServer(server) {
server.middlewares.use('/__compodium__/api/iconify', async (req, res) => {
try {
Expand Down
37 changes: 22 additions & 15 deletions packages/core/src/plugins/meta/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { readFile } from 'node:fs/promises'
import type { PluginConfig } from '../../types'
import type { Collection, PluginOptions } from '../../types'
import { createChecker } from './checker'
import { watch } from 'chokidar'
import type { VitePlugin } from 'unplugin'
import { resolve } from 'pathe'

import AST from 'unplugin-ast/vite'
import { resolveCollections } from '../collections'

export function extendMetaPlugin(_config: PluginConfig): VitePlugin {
export function extendMetaPlugin(_options: PluginOptions): VitePlugin {
return AST({
include: [/\.[jt]sx?$/, /\.vue$/],
enforce: 'post',
Expand All @@ -24,20 +24,25 @@ export function extendMetaPlugin(_config: PluginConfig): VitePlugin {
})
}

export function metaPlugin(config: PluginConfig): VitePlugin {
const checkerDirs = [
...config.componentCollection.dirs,
config.componentCollection.exampleDir,
...config.libraryCollections.flatMap(c => c.dirs),
...config.libraryCollections.map(c => c.exampleDir)
]

const checker = createChecker(checkerDirs)
export function metaPlugin(options: PluginOptions): VitePlugin {
let collections: Collection[]

return {
name: 'compodium:meta',
enforce: 'pre',
apply: 'serve',

configResolved(viteConfig) {
collections = resolveCollections(options, viteConfig)
},

configureServer(server) {
const checkerDirs = collections.flatMap(c => [
...c.dirs,
c.exampleDir
])
const checker = createChecker(checkerDirs)

server.middlewares.use('/__compodium__/api/meta', async (req, res) => {
try {
const url = new URL(req.url!, `http://${req.headers.host}`)
Expand Down Expand Up @@ -65,10 +70,12 @@ export function metaPlugin(config: PluginConfig): VitePlugin {
}
})

const componentCollection = collections.find(c => c.name === 'Components') as Collection

const watchedPaths = [
...config.componentCollection.dirs,
config.componentCollection.exampleDir
].map(d => resolve(config.rootDir, d.path))
...componentCollection.dirs,
componentCollection.exampleDir
].map(d => d.path)

// Watch for changes in example directory
const watcher = watch(watchedPaths, {
Expand Down
Loading