oxlint-plugin-import-zod
v1.0.1
Published
Oxlint plugin to enforce namespace imports for zod
Maintainers
Readme
oxlint-plugin-import-zod
Oxlint plugin to enforce namespace imports for zod. This plugin provides a rule that ensures all imports of zod use the namespace import style (import * as z from "zod";) instead of named imports or default imports to promote better tree-shaking and reduce bundle sizes. See this Zod issue comment for a more detailed explanation.
This plugin is written using Oxlint's JS plugin API and is a rewrite of eslint-plugin-import-zod.
Installation
pnpm add -D oxlint-plugin-import-zodUsage
Add the plugin to your .oxlintrc.json, under jsPlugins, then enable the rule under rules:
// .oxlintrc.json
{
"jsPlugins": ["oxlint-plugin-import-zod"],
"rules": {
"import-zod/prefer-zod-namespace": "error",
},
}Or, if you're using the TypeScript config format:
// oxlint.config.ts
import { defineConfig } from 'oxlint';
export default defineConfig({
jsPlugins: ['oxlint-plugin-import-zod'],
rules: {
'import-zod/prefer-zod-namespace': 'error',
},
});Rules
prefer-zod-namespace
This rule enforces using namespace imports for zod instead of named imports or default imports.
❌ Invalid
// Importing z directly
import { z } from "zod";
// Default imports (any name)
import z from "zod";
import zod from "zod";
import zodSchema from "zod";
// Type default imports
import type z from "zod";
import type zod from "zod";
// Mixed default and named imports
import z, { toJSONSchema } from "zod";
import zod, { ZodError } from "zod";
// Importing z from 'zod/v4'
import { z } from "zod/v4";
import z from "zod/v4";
// Importing z from 'zod/v4-mini'
import { z } from "zod/v4-mini";
// Type-only imports
import type { z } from "zod";
// Importing z along with other exports
import { ZodError, z } from "zod";
// Type-only imports with multiple exports
import type { ZodError, z } from "zod";
// Importing z with type modifiers
import { type ZodError, z } from "zod";
// Importing submodules from zod/v4
import { core } from "zod/v4";✅ Valid
// Using namespace import
import * as z from "zod";
// Using namespace import with any name
import * as zod from "zod";
import * as zodSchema from "zod";
// Importing z from 'zod/v4'
import * as z from "zod/v4";
// Importing z from 'zod/v4-mini'
import * as z from "zod/v4-mini";
// Using type namespace import
import type * as z from "zod";
import type * as zod from "zod";
// Other imports from zod that don't include 'z'
import { ZodError } from "zod";
// Type imports that don't include 'z'
import type { ZodError } from "zod";
// Importing submodule as namespace with proper path
import * as core from "zod/v4/core";Auto-fix
This rule is automatically fixable. When using --fix, Oxlint will:
- Convert
import { z } from 'zod';toimport * as z from 'zod'; - Convert
import z from 'zod';toimport * as z from 'zod'; - Convert
import zod from 'zod';toimport * as zod from 'zod'; - Convert
import type z from 'zod';toimport type * as z from 'zod'; - Convert
import type { z } from 'zod';toimport type * as z from 'zod'; - Convert
import { core } from 'zod/v4';toimport * as core from 'zod/v4/core'; - Split mixed imports like
import { ZodError, z } from 'zod';into:import * as z from 'zod'; import { ZodError } from 'zod'; - Split default and named imports like
import z, { toJSONSchema } from 'zod';into:import * as z from 'zod'; import { toJSONSchema } from 'zod'; - Split type imports like
import type { ZodError, z } from 'zod';into:import type * as z from "zod"; import type { ZodError } from "zod"; - Preserve type modifiers in mixed imports like
import { type ZodError, z } from 'zod';:import * as z from "zod"; import { type ZodError } from "zod";
