# vite-plugin-i18next-extract

> A [vite](https://github.com/vitejs/vite) plugin that automatically extracts i18next strings during development.

Latest version **1.1.1** (published 2023-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install vite-plugin-i18next-extract
pnpm add vite-plugin-i18next-extract
yarn add vite-plugin-i18next-extract
bun add vite-plugin-i18next-extract
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2023-08-01 |
| First published | 2023-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 41.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | andyhite |
| Maintainers | andyhite |
| Keywords | vite, i18n, i18next, i18next-scanner |

## Links

- npm: https://www.npmjs.com/package/vite-plugin-i18next-extract
- Repository: https://github.com/andyhite/vite-plugin-i18next-extract
- Homepage: https://github.com/andyhite/vite-plugin-i18next-extract#readme
- Issues: https://github.com/andyhite/vite-plugin-i18next-extract/issues
- npm.io page: https://npm.io/package/vite-plugin-i18next-extract

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^4.3.4
- [typescript](https://npm.io/package/typescript.md) ^5.1.6
- [i18next-scanner](https://npm.io/package/i18next-scanner.md) ^4.3.0

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2023-08-01
- 1.1.0 — 2023-07-20
- 1.0.3 — 2023-07-19
- 1.0.2 — 2023-07-19
- 1.0.1 — 2023-07-19
- 1.0.0 — 2023-07-19

## README

# vite-plugin-i18next-extract

A [vite](https://github.com/vitejs/vite) plugin that automatically extracts i18next strings during development.

## Install

```bash
pnpm add -D vite-plugin-i18next-extract # using pnpm
yarn add -D vite-plugin-i18next-extract # using yarn
npm install --save-dev vite-plugin-i18next-extract # using npm
```

## Usage

In `vite.config.ts`:

```ts
import { defineConfig } from "vite";
import i18nExtract from "vite-plugin-i18next-extract";

export default defineConfig({
  plugins: [
    i18nExtract({
      /* options */
    }),
  ],
});
```

## Options

`vite-plugin-i18next-extract` accepts all options available to the [`i18next-scanner`](https://github.com/i18next/i18next-scanner) library:

```ts
interface ResourceExtractorOptions {
  allowDynamicKeys?: boolean;
  attr?: {
    extensions?: string[];
    list?: string[];
  };
  contextDefaultValues?: string[];
  contextSeparator?: string;
  debug?: boolean;
  defaultLng?: string;
  defaultNs?: string;
  defaultValue?: string;
  func?: {
    extensions?: string[];
    list?: string[];
  };
  interpolation?: {
    prefix?: string;
    suffix?: string;
  };
  keySeparator?: string;
  lngs?: string[];
  metadata?: Record<string, unknown>;
  ns?: string[];
  nsSeparator?: string;
  pluralSeparator?: string;
  removeUnusedKeys?: boolean;
  resource?: {
    jsonIndent?: number;
    lineEnding?: string;
    loadPath?: string;
    savePath?: string;
  };
  sort?: boolean;
  trans?: {
    acorn?: {
      ecmaVersion?: number | string;
      sourceType?: "module" | "script";
    };
    component?: string;
    defaultsKey?: string;
    extensions?: string[];
    fallbackKey?: boolean | ((ns: string, value: string) => string);
    i18nKey?: string;
    keepBasicHtmlNodesFor?: string[];
    supportBasicHtmlNodes?: true;
  };
}
```

---
_Source: https://npm.io/package/vite-plugin-i18next-extract · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._