feat: stabilize Velite 1.0 public API and Zod 4 pipeline #368
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import type { NextConfig } from 'next' | ||
| import type { Options as VeliteOptions } from 'velite' | ||
|
|
||
| export type Options = Omit<VeliteOptions, 'watch' | 'clean'> | ||
|
|
||
| type NextConfigFunction = (phase: string, options: { defaultConfig: NextConfig }) => Promise<NextConfig> | NextConfig | ||
| type NextConfigInput = NextConfig | NextConfigFunction | ||
|
|
||
| /** | ||
| * Create a Next.js plugin for integrating Velite | ||
| */ | ||
| declare const createNextPlugin: (options?: Options) => <T extends NextConfigInput>(nextConfig?: T) => Promise<T> | ||
|
|
||
| /** | ||
| * Next.js plugin for integrating Velite | ||
| */ | ||
| declare const withVelite: ReturnType<typeof createNextPlugin> | ||
|
Comment on lines
+12
to
+17
There was a problem hiding this comment. 🧩 Analysis chain🏁 Script executed: cat packages/next/index.js | head -80Repository: zce/velite Length of output: 1673 🏁 Script executed: cat packages/next/index.d.tsRepository: zce/velite Length of output: 722 Correct the type signature to reflect actual behavior. The generic 🤖 Prompt for AI Agents |
||
|
|
||
| export { createNextPlugin, withVelite, type Options } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /** | ||
| * Thanks to `https://github.com/sdorra/content-collections` for Next.js v16+ Velite integration. | ||
| */ | ||
|
|
||
| /** | ||
| * Create a Next.js plugin for integrating Velite | ||
| * @param {Omit<import('velite').Options, 'watch' | 'clean'>} pluginOptions | ||
| * @returns {import('next').NextConfig} Next.js plugin | ||
| */ | ||
| export const createNextPlugin = (pluginOptions = {}) => { | ||
| const [command] = process.argv.slice(2).filter(i => !i.startsWith('-')) | ||
|
|
||
| // typegen loads next.config.js | ||
| const isTypegen = command === 'typegen' | ||
|
|
||
| // the build step loads next.config.js | ||
| const isBuild = command === 'build' | ||
|
|
||
| // starting with v16 next dev doesn't load next.config.js | ||
| // next dev - calls next-start in a forked process | ||
| // next-start loads next.config.js | ||
| // process.argv are not visible by next-start | ||
| const isDev = | ||
| // to make this compatible with previous versions | ||
| // check if command is NOT set (next-start) and we are in development mode | ||
| typeof command === 'undefined' && process.env.NODE_ENV === 'development' | ||
|
|
||
| /** | ||
| * @param {import('next').NextConfig} nextConfig | ||
| * @returns {Promise<import('next').NextConfig>} | ||
| */ | ||
| return async (nextConfig = {}) => { | ||
| // prevent multiple calls | ||
| if (process.env.__VELITE_STARTED) return nextConfig | ||
|
|
||
| // if not dev, build, or typegen, return the next config | ||
| if (!isDev && !isBuild && !isTypegen) return nextConfig | ||
|
|
||
| // start velite | ||
| process.env.__VELITE_STARTED = '1' | ||
|
|
||
| const { build } = await import('velite') | ||
|
|
||
| await build({ ...pluginOptions, watch: isDev, clean: !isDev }) | ||
|
|
||
| return nextConfig | ||
| } | ||
| } | ||
|
|
||
| export const withVelite = createNextPlugin() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "name": "@velite/plugin-next", | ||
| "version": "0.0.1", | ||
| "description": "Next.js plugin for integrating Velite", | ||
| "type": "module", | ||
| "exports": "./index.js", | ||
| "types": "./index.d.ts", | ||
| "files": [ | ||
| "index.js", | ||
| "index.d.ts" | ||
| ], | ||
| "keywords": [ | ||
| "next-plugin", | ||
| "velite", | ||
| "content" | ||
| ], | ||
| "peerDependencies": { | ||
| "next": "^16.0.0", | ||
| "velite": "workspace:*" | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # @velite/plugin-next | ||
|
|
||
| A Next.js plugin for integrating Velite content processing. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install -D velite @velite/plugin-next | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```ts | ||
| // next.config.ts | ||
| import { withVelite } from '@velite/plugin-next' | ||
|
|
||
| export default withVelite({ | ||
| // other next config here... | ||
| }) | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](../../license) © [zce](https://zce.me) | ||
|
Comment on lines
+1
to
+42
There was a problem hiding this comment. Verify license link path/casing README content looks good. Please double-check that 🤖 Prompt for AI Agents |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same command injection risk as in the Vite example.
This
timestamp()helper has the same vulnerability where the file path is passed directly to a shell command without escaping.Apply the same fix using
execFileinstead ofexec:🤖 Prompt for AI Agents