unplugin-sheet-i18n

unplugin-sheet-i18n

unplugin-sheet-i18n enables doing your i18n in a [spread]sheet for a better collaborative experience with non-coders and maintainability.

Features

• Supports CSV, TSV, DSV, Excel/Spreadsheets (XLS[XMB], ODT), powered by SheetJS and papaparse
• File-to-file convert: en.csv -> en.json
• File-to-multiple convert: i18n.csv -> en.json, vi.json, fr.json,...
• Output merging: i18n_a.csv + i18n_b.csv -> en.json
• Preserve structure: a/i18n.csv -> a/en.json | a/i18n/en.json | a/i18n_en.json
• File generation: i18n_files.csv -> cloud_en.json, cloud_fr.json, template_en.html, template_fr.html
• And more!

Usage

>See a few examples usage here<

Install package:

# npm
npm install unplugin-sheet-i18n

# yarn
yarn add unplugin-sheet-i18n

# pnpm (recommended)
pnpm install unplugin-sheet-i18n

Setup:

Vite

// vite.config.ts
import SheetI18n from 'unplugin-sheet-i18n/vite'

export default defineConfig({
  plugins: [
    SheetI18n({ /* options */ }),
  ],
})

Rollup

// rollup.config.js
import SheetI18n from 'unplugin-sheet-i18n/rollup'

export default {
  plugins: [
    SheetI18n({ /* options */ }),
  ],
}

Webpack

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require('unplugin-sheet-i18n/webpack')({ /* options */ })
  ]
}

Nuxt

// nuxt.config.js
export default defineNuxtConfig({
  modules: [
    ['unplugin-sheet-i18n/nuxt', { /* options */ }],
  ],
})

This module works for both Nuxt 2 and Nuxt Vite

Vue CLI

// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require('unplugin-sheet-i18n/webpack')({ /* options */ }),
    ],
  },
}

esbuild

// esbuild.config.js
import { build } from 'esbuild'
import SheetI18n from 'unplugin-sheet-i18n/esbuild'

build({
  plugins: [SheetI18n()],
})

unbuild

// build.config.ts
import { defineBuildConfig } from 'unbuild'
import SheetI18n from 'unplugin-sheet-i18n/rollup'

export default defineBuildConfig({
  hooks: {
    'rollup:options': function (ctx, options) {
      options.plugins = [options.plugins, SheetI18n({
      })]
    },
  },
})

programmatic

See it in action at starter-fullstack

// index.ts
import { createContext } from 'unplugin-sheet-i18n'

createContext({
  outDir: 'dist',
}).scanConvert()

Options:

See Options

Roadmap

• Add example repos
• Add tests

License

MIT License © 2024 NamesMT

Changelog

v0.4.13

compare changes

📖 Documentation

• README: Correct feature describe (6b3b51c)

❤️ Contributors

• Trung Dang (@NamesMT)