vite-plugin-compile-time
Use this plugin to generate code at compile time or get data at compile time in your Vite projects.
Install
npm i vite-plugin-compile-time -D
import { defineConfig } from "vite"
import compileTime from "vite-plugin-compile-time"
export default defineConfig({
plugins: [compileTime()],
})
Usage
Compile-time data:
// get-data.ts
import fs from "fs"
export default async () => {
const post = await fs.promises.readFile("./post.md", "utf8")
return {
data: { post },
}
}
// get the data at compile time
const data = import.meta.compileTime("./get-data.ts")
assert.deepEqual(data, { post: "....." })
Compile-time code:
// generate-code.ts
export default async () => {
return {
code: `count++`,
}
}
// insert the generated code at compile time
let count = 0
import.meta.compileTime("./generate-code.ts")
assert.equal(count, 1)
API
Use import.meta.compileTime to get compile-time data or code.
declare interface ImportMeta {
compileTime: <T>(file: string) => T
}
You should return a default export with object containing code or data property:
import {
CompileTimeFunctionArgs,
CompileTimeFunctionResult,
} from "vite-plugin-compile-time"
export default async (
args: CompileTimeFunctionArgs,
): CompileTimeFunctionResult => {
return {
data: {
hello: "world",
},
// Trigger rebuild when watched files change
watchFiles: ["/absolute/path"],
}
}
See the type docs on paka.dev.
Sponsors
License
MIT © EGOIST
10 Aug 2, 2022
95 Dec 15, 2022
6 Nov 13, 2022
13 Nov 13, 2022
61 Dec 23, 2022
3 Sep 26, 2022
13 Nov 26, 2022
49 Nov 26, 2022
84 Nov 28, 2022
3 Mar 26, 2022
6 Jun 25, 2022
8 Nov 11, 2022
9 Jul 16, 2022
31 Dec 13, 2022
2 Feb 8, 2022
6 Aug 1, 2022
64 Jan 4, 2023
3 Mar 11, 2022
2 Mar 26, 2022