Skip to content

Latest commit

 

History

History
128 lines (83 loc) · 3.91 KB

README-en.md

File metadata and controls

128 lines (83 loc) · 3.91 KB
Raw

[-_@] sultana-inter

中文 | English

NPM

NPM version Downloads

🌎 An auto-i18n tool, based on kiwi+google_cn

😃 How to use?

1.Install

npm install sultana-inter
  1. create i18n.json in your project path. it looks like:
{
  "include": ["src/**/*.(ts*|js*)"],
  "exclude": ["**/i18n/**","**/test/*","**/*.test.*"],
  "importPath":"./src/i18n/language",
  "importFormat": {
    "ts":"import {i18n_lang_package,i18n_lang_format} from \"{{importPath}}\";",
    "js":"const {i18n_lang_package,i18n_lang_format} = reuqire(\"{{importPath}}\");",
    "html":"<script src=\"{{importPath}}/index.js\"></script>"
  },
  "translate":{
    "from":"zh",
    "to":"en"
  },
  "templateFunction":"i18n_lang_format",
  "templateObj":"i18n_lang_package",
  "exportPath": "./src/i18n/{{lang}}/{{filename}}.js",
  "ignoreComments": "@i18n-ignore",
  "excludeDirName":["components","pages","constants","containers","models","services","src"],
  "defaultDirName":"common"
}
  1. Exec i18n command and input your project directory.
su-inter -p /path/to/your/project/

📝 Configuration

  • include string[]

    The included folder matches the micromatch syntax.

    Ex: ["src/**/*.(ts*|js*)"]

  • exclude string[]

    The excluded folder matches the ·micromatch` syntax.

    Ex: ["**/i18n/**","**/test/*"]

  • importPath string

    Path or file name import in your code.

    Ex: "./src/i18n/language"

  • importFormat

    • ts string importing template of *.ts*files，"{{importpath}}" is used as the template variable of configuration importpath.

      Ex: "import {i18n_lang_package,i18n_lang_format} from \"{{importPath}}\";"

    • js string *.js*files

      Ex: "const {i18n_lang_package,i18n_lang_format} = reuqire(\"{{importPath}}\");"

    • html string *.htmlfiles

      Ex: "<script src=\"{{importPath}}/index.js\"></script>"

  • translate

  • templateFunction string

    The function name used for formatting, such as "I18N. Format" will be compiled into I18N. Format (I18N. Lang.xxx, {val1: XXX, val2: XXX})})

  • templateObj string

    The variable name of the language pack in use, such as configuration "I18N. Lang", will be compiled into I18N. Lang.xxx

  • exportPath string

    The output language directory uses{{Lang}and{{filename}as the language folder name and file name.

    Ex: "./src/i18n/{{lang}}/{{filename}}.js"

  • ignoreComments string

    Ignore flag. When configuring '@ I18N ignore', translation will be ignored in the following situations:

    // @i18n-ignore
const title="我和我的祖国"

  • excludeDirName string[]

    The tool uses the folder name as {{filename}} of the exportpath. Configure this to ignore the configured text when recursively looking for folders.

    Ex: ["components","models","services","src"]

  • defaultDirName string

    This configuration item is used instead of {{filename}} when there is no suitable folder name.

    Ex: common

💡 TODO

  • ignoreComments
  • importFomat html header