feat: plugin feature

.github/renovate.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["github>zce/renovate-config"]
+}

.github/workflows/main.yml

@@ -1,7 +1,5 @@
 name: CI
-
 on: push
-
 jobs:
   publish:
     if: startsWith(github.ref, 'refs/tags')

.vscode/settings.json

@@ -1,22 +1,14 @@
 {
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
-  "editor.quickSuggestions": {
-    "strings": true
-  },
   "explorer.fileNesting.enabled": true,
   "explorer.fileNesting.expand": false,
   "explorer.fileNesting.patterns": {
     "package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml",
-    "readme.md": "license, changelog.md"
+    "readme.md": "license"
   },
-  // exclude files that are not frequently modified or built.
   "files.exclude": {
     "node_modules": true
   },
-  "javascript.preferences.quoteStyle": "single",
-  "javascript.updateImportsOnFileMove.enabled": "never",
-  "typescript.preferences.quoteStyle": "single",
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.updateImportsOnFileMove.enabled": "never"
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

package.json

@@ -25,7 +25,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsup",
+    "build": "tsc && tsup",
     "format": "prettier --write ."
   },
   "tsup": {

readme.md

@@ -10,6 +10,10 @@
 [![Dependency Status][dependency-img]][dependency-url]
 [![Code Style][style-img]][style-url]
 
+## TODOs
+
+- [ ] nextjs plugin
+
 ## Installation
 
 ```shell

src/config.ts

@@ -2,15 +2,14 @@ import { bundleRequire } from 'bundle-require'
 import JoyCon from 'joycon'
 
 import { name } from '../package.json'
-import { addLoader } from './loader'
+import { addLoader, addPlugin } from './loader'
 import { init } from './static'
 
-import type { Loader } from './loader'
+import type { Loader, Plugin } from './loader'
 import type { Collections } from './types'
 import type { ZodType } from 'zod'
 
 type Schema = {
-  name: string
   pattern: string
   single?: boolean
   fields: ZodType
@@ -29,6 +28,7 @@ type Config = {
   }
   schemas: { [name: string]: Schema }
   loaders?: Loader[]
+  plugins?: Plugin[]
   callback: (collections: Collections) => void | Promise<void>
 }
 
@@ -40,17 +40,17 @@ type Options = {
 
 const joycon = new JoyCon()
 
+joycon.addLoader({
+  test: /\.(js|cjs|mjs|ts)$/,
+  load: async filepath => {
+    const { mod: config } = await bundleRequire({ filepath })
+    return config.default || config
+  }
+})
+
 export const resolveConfig = async (options: Options = {}): Promise<Config> => {
   const configPaths = [options.filename, name + '.config.js', name + '.config.ts'].filter(Boolean) as string[]
 
-  joycon.addLoader({
-    test: /\.(js|cjs|mjs|ts)$/,
-    load: async filepath => {
-      const { mod: config } = await bundleRequire({ filepath })
-      return config.default || config
-    }
-  })
-
   const { data: config, path } = await joycon.load(configPaths)
 
   options.verbose && console.log(`using config '${path}'`)
@@ -61,6 +61,10 @@ export const resolveConfig = async (options: Options = {}): Promise<Config> => {
     config.loaders.forEach((loader: Loader) => addLoader(loader))
   }
 
+  if (config.plugins != null) {
+    config.plugins.forEach((plugin: Plugin) => addPlugin(plugin))
+  }
+
   init(config.output.static, config.output.base)
 
   return config

src/index.ts

@@ -1,5 +1,5 @@
 export { z, shared } from './shared'
 export { defineConfig } from './config'
-export { addLoader, removeLoader } from './loader'
+export { addLoader, removeLoader, addPlugin, removePlugin } from './loader'
 export { build } from './build'
 export { image } from './image'

src/loader.ts

@@ -18,8 +18,24 @@ export type Loader = {
   load: (file: VFile) => Promise<unknown>
 }
 
+type MdastPlugin = {
+  name: string
+  type: 'mdast'
+  apply: (mdast: ReturnType<typeof fromMarkdown>) => void | Promise<void>
+}
+
+type HastPlugin = {
+  name: string
+  type: 'hast'
+  apply: (hast: ReturnType<typeof toHast>) => void | Promise<void>
+}
+
+export type Plugin = MdastPlugin | HastPlugin
+
 const loaders: Loader[] = []
 
+const plugins: Plugin[] = []
+
 export const addLoader = (loader: Loader) => {
   loaders.unshift(loader)
 }
@@ -28,6 +44,14 @@ export const removeLoader = (name: string) => {
   const loader = loaders.find(loader => loader.name === name)
   loader && loaders.splice(loaders.indexOf(loader), 1)
 }
+export const addPlugin = (plugin: Plugin) => {
+  plugins.unshift(plugin)
+}
+
+export const removePlugin = (name: string) => {
+  const plugin = plugins.find(plugin => plugin.name === name)
+  plugin && plugins.splice(plugins.indexOf(plugin), 1)
+}
 
 export const load = (file: VFile) => {
   const loader = loaders.find(loader => loader.test.test(file.path))
@@ -118,10 +142,17 @@ addLoader({
     )
     // #endregion
 
+    // apply mdast plugins
+    await Promise.all(plugins.map(async p => p.type === 'mdast' && (await p.apply(mdast))))
+
     // generate markdown
     data.raw = toMarkdown(mdast, { extensions: [gfmToMarkdown()] })
     // parse to hast
     const hast = raw(toHast(mdast, { allowDangerousHtml: true }))
+
+    // apply hast plugins
+    await Promise.all(plugins.map(async p => p.type === 'hast' && (await p.apply(hast))))
+
     // console.log((await import('unist-util-inspect')).inspect(hast))
     const lines: string[] = []
     visit(hast, 'text', node => {

tsconfig.json

@@ -4,6 +4,7 @@
     "module": "es2022",
     "moduleResolution": "bundler",
     "esModuleInterop": true,
+    "noEmit": true,
     "strict": true
   }
 }

types.d.ts

@@ -0,0 +1 @@
+declare module 'load-tsconfig'