Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uncenter/eleventy-plugin-validate
📋 A plugin for Eleventy to validate collection data.
https://github.com/uncenter/eleventy-plugin-validate
11ty eleventy zod
Last synced: 3 days ago
JSON representation
📋 A plugin for Eleventy to validate collection data.
- Host: GitHub
- URL: https://github.com/uncenter/eleventy-plugin-validate
- Owner: uncenter
- License: mit
- Created: 2024-01-04T15:59:43.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T04:28:57.000Z (4 months ago)
- Last Synced: 2024-05-28T10:07:22.319Z (4 months ago)
- Topics: 11ty, eleventy, zod
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/eleventy-plugin-validate
- Size: 202 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: changelogithub.config.json
- License: LICENSE
Awesome Lists containing this project
README
# eleventy-plugin-validate
## Installation
```
npm i eleventy-plugin-validate
pnpm add eleventy-plugin-validate
yarn add eleventy-plugin-validate
bun add eleventy-plugin-validate
```
## Usage
Setup the plugin in your [Eleventy configuration file](https://www.11ty.dev/docs/config/#default-filenames).
### CJS
```js
const pluginValidate = require('eleventy-plugin-validate');
const { z } = require('zod');
module.exports = (eleventyConfig) => {
eleventyConfig.addPlugin(pluginValidate, {
// Select the Zod library for schemas:
validator: 'zod',
schemas: [
{
// `collections: ['posts']` tells the plugin
// to run this schema on the 'posts' collection.
// If you omit this property, the schema will run against
// collection items from the 'all' collection (a default
// collection that Eleventy generates for you).
collections: ['posts'],
// `schema` should be a schema made with the validator
// library selected in the above 'validator' property.
schema: z
.object({
title: z.string(),
description: z.string(),
draft: z.boolean(),
})
// I suggest adding .strict() to your schema
// for even more accurate validation.
// With .strict(), extra properties
// you have not specified in the schema object
// will cause an error. For example, if you have an
// optional property "edited", but you misspell it as
// "edtied", .strict() will warn you!
.strict(),
},
],
});
};
```
### ESM (`@11ty/eleventy@v3` or later)
```js
import pluginValidate from 'eleventy-plugin-validate';
import { z } from 'zod';
export default (eleventyConfig) => {
eleventyConfig.addPlugin(pluginValidate, {
// Select the Zod library for schemas:
validator: 'zod',
schemas: [
{
// `collections: ['posts']` tells the plugin
// to run this schema on the 'posts' collection.
// If you omit this property, the schema will run against
// collection items from the 'all' collection (a default
// collection that Eleventy generates for you).
collections: ['posts'],
// `schema` should be a schema made with the validator
// library selected in the above 'validator' property.
schema: z
.object({
title: z.string(),
description: z.string(),
draft: z.boolean(),
})
// I suggest adding .strict() to your schema
// for even more accurate validation.
// With .strict(), extra properties
// you have not specified in the schema object
// will cause an error. For example, if you have an
// optional property "edited", but you misspell it as
// "edtied", .strict() will warn you!
.strict(),
},
],
});
};
```
Run Eleventy, and voila! The plugin will warn you about collection items that do not pass schema validation.
For example:
```
> eleventy --serve
[eleventy-plugin-validate][./posts/hello-world.md] title: expected a string but received boolean
[eleventy-plugin-validate][./posts/hello-world.md] description: expected a string but received number
[eleventy-plugin-validate][./posts/hello-world.md] draft: expected a boolean but received string
[11ty] Problem writing Eleventy templates: (more in DEBUG output)
[11ty] Invalid frontmatter data provided (via Error)
...
```
## Caveats
This plugin uses the `addCollection` callback to access the entire data cascade of your site, which unfortunately means it adds an extra collection with no items in it. If you have [tag pages](https://www.11ty.dev/docs/quicktips/tag-pages/) (or anything similar), you'll need to use [pagination filtering](https://www.11ty.dev/docs/pagination/#filtering-values) to hide the `eleventy-plugin-validate` collection. I'm open to suggestions if you have another way of doing this!
## License
[MIT](LICENSE)