npm 包 node-onesky-cli 使用教程

前言

在前端开发中，很多时候需要进行多语言国际化处理，而 Onesky 恰好提供了这样的解决方案，通过使用 Onesky 系统可以轻松管理文案并生成多语言文件，但是在实际应用中，如何将多语言文件应用到项目中并实现自动化构建，是一个值得探讨和研究的问题。而在这个问题的解决中，我们可以使用 npm 包 node-onesky-cli 这个工具来实现自动化构建，以及更便捷地实现多语言化。本文将详细讲解如何使用 npm 包 node-onesky-cli。

node-onesky-cli 简介

node-onesky-cli 是一个使用 Node.js 编写的命令行工具，旨在帮助开发者更快、更方便的使用 Onesky ，同时也可以实现自动化构建流程。node-onesky-cli 常用于以下场景：

1. 在编译构建过程中，自动抓取 Onesky 的语言资源，并对本地语言资源进行更新。
2. 通过命令行直接将本地语言文件上传至 Onesky。

常用命令

以下是 node-onesky-cli 常用的命令：

设置配置信息

one config

下载语言包至本地

one download

上传语言包至 Onesky

one upload

清空本地语言包

one clean

安装

使用 npm 安装 node-onesky-cli：

npm install node-onesky-cli --save-dev

配置

在运行 node-onesky-cli 命令之前，需要先进行配置，配置信息包括：

1. API Key 和 API Secret
2. Project ID
3. 本地语言包目录路径
4. 语言代码

在终端中输入配置命令：

one config

然后按照命令行提示一步步输入，例如：

API Key: xxxxxxxxxxxxxxxx

API Secret: xxxxxxxxxxxxxxxx

Project ID: 123456

Locale Path: ./locales

Language: zh-CN,en-US,jp-JP

以上配置信息可以通过 Onesky 的官方文档进行查找和获取。

使用

node-onesky-cli 的基本使用步骤如下：

1. 运行下载命令，将 Onesky 的语言资源下载到本地，例如：

one download

1. 在项目中通过 node-onesky-cli 的 API 将本地语言资源转化为 JSON（或者其他格式），例如：

const onesky = require('node-onesky-cli')
const en = onesky.getLocale('en-US')

1. 将 JSON 语言文件渲染到页面或者组件中，例如：

<div>{{en.title}}</div>

1. 在本地开发中遇到新增的多语言文案时，可以运行上传命令将新增的文案上传至 Onesky，例如：

one upload

这样就可以实现自动化管理多语言文案的效果。

示例代码

以下是使用 node-onesky-cli 在 Vue 项目中实现多语言化的示例代码：

1. 安装 node-onesky-cli：

npm install node-onesky-cli --save-dev

1. 在 src/locales/ 目录中创建一个 en-US.json 的语言文件，并在其中添加以下内容：

{
  "title": "Title"
}

1. 在 src/locales/ 目录中创建一个 onesky-config.json 的配置文件，并输入以下内容：

{
  "apiKey": "xxxxxxxxxxxxxxxx",
  "apiSecret": "xxxxxxxxxxxxxxxx",
  "projectId": "123456",
  "localePath": "./src/locales",
  "language": "en-US"
}

1. 在 main.js 中引入 node-onesky-cli 并进行初始化：

import onesky from 'node-onesky-cli'
const oneskyConfig = require('./locales/onesky-config.json')
onesky.config(oneskyConfig)
const en = onesky.getLocale('en-US')
Vue.prototype.$t = en

1. 在组件中使用多语言文案：

<template>
  <div>{{ $t.title }}</div>
</template>

总结

node-onesky-cli 是一个非常实用的工具，可以极大的简化多语言文案的管理以及构建流程，提高开发效率。本文通过介绍 node-onesky-cli 的安装、配置以及使用方法，希望能对前端开发者有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005663081e8991b448e2192