npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hono-zod-validator-i18n

v1.0.5

Published

This library is used to translate Zod's default error messages.

Downloads

14

Readme

npm version

Zod Internationalization

This library is used to translate Zod's default error messages.

Installation 💿

npm install hono-zod-validator-i18n @intlify/hono

This library depends on @intlify/hono.

Getting Started 🚀

import { Hono } from 'hono';
import {
  defineI18nMiddleware,
  detectLocaleFromAcceptLanguageHeader,
  useTranslation,
} from '@intlify/hono';
import { zValidatorI18n } from 'hono-zod-validator-i18n';
import zodEn from 'hono-zod-validator-i18n/locales/en/zod.json';
import zodJa from 'hono-zod-validator-i18n/locales/ja/zod.json';

const i18nMiddleware = defineI18nMiddleware({
  locale: detectLocaleFromAcceptLanguageHeader,
  messages: {
    en: {
      hello: 'Hello {name}!',
      zod: zodEn,
    },
    ja: {
      hello: 'こんにちは、{name}!',
      zod: zodJa,
    },
  },
});

const app = new Hono();

app.use('*', i18nMiddleware);

const schema = z.object({
  name: z.string(),
  age: z.number(),
});

app.post('/author', zValidatorI18n('json', schema), (c) => {
  const data = c.req.valid('json');
  return c.json({
    success: true,
    message: `${data.name} is ${data.age}`,
  });
});

export default app;

zValidatorI18n

The zValidatorI18n function works exactly the same as the original zValidator function from @hono/zod-validator so you can still add a custom hook function.

zValidatorI18n('json', schema, (result, c) => {
  // "result" and "c" are fully typed!
  console.log('This will run after the error translation.');
});

Custom Translations

You can define custom Zod error message translations like this:

import zodEn from 'hono-zod-validator-i18n/locales/en/zod.json';
import zodJa from 'hono-zod-validator-i18n/locales/ja/zod.json';

const i18nMiddleware = defineI18nMiddleware({
  locale: 'ja',
  messages: {
    en: {
      hello: 'Hello {name}!',
      // All custom error message translations should be inside: zod.custom
      zod: { ...zodEn, custom: { some_message: 'Some message' } },
    },
    ja: {
      hello: 'こんにちは、{name}!',
      zod: { ...zodJa, custom: { some_message: '何かのメッセージ' } },
    },
  },
});

And use it like this:

zValidatorI18n(
  'json',
  z.object({
    name: z.string({ message: 'zod.custom.some_message' }), // Will result in: '何かのメッセージ'
  })
),

Custom Zod error translations only work when prefixed with zod.custom.. If you do not use this prefix, the translation of the standard Zod error message will be used

Translation Files 🌐

hono-zod-validator-i18n contains translation files for several locales.

It is also possible to create and edit translation files. You can use this English translation file as a basis for rewriting it in your language.

If you have created a translation file for a language not yet in the repository, please send us a pull request.

Contributing 🤝

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License 🔖

This project is licensed under the MIT License.

Contributors ✨

Contributors icons

Special Thanks ❤️