@uppo/next-translate-spreadsheet-i18n-tool
v1.1.3
Published
a next-translate's tool for google spreadsheet, it can flatten 2D locale-key array to multi 1D JSON.
Downloads
4
Readme
next-translate-spreadsheet-i18n-tool
a next-translate's tool for google spreadsheet, it can flatten 2D locale-key array to multi 1D JSON.
Usage
$ npm install -g @uppo/next-translate-spreadsheet-i18n-tool
$ ntsit COMMAND
running command...
$ ntsit (--version)
@uppo/next-translate-spreadsheet-i18n-tool/1.1.3 darwin-x64 node-v16.14.2
$ ntsit --help [COMMAND]
USAGE
$ ntsit COMMAND
...
Tutorial
1. Prepare your spreadsheet
demo template: https://docs.google.com/spreadsheets/d/1mBFh5E2LzF66hV4bw-pVyCA0CvvqBJrk9-A8XntbG64/edit?usp=sharing
2. GCP setup
reference: google cloud platform
- create a project(link)
- enable google sheets api
- create a service account
- download the crediential json file
- share your spreadsheet to the service account email
3. Run the command
$ ntsit gen
4. Get your sheet id
e.g. https://docs.google.com/spreadsheets/d/[spreadsheetId]/edit#gid=0
Commands
ntsit gen
ntsit help [COMMANDS]
ntsit plugins
ntsit plugins:install PLUGIN...
ntsit plugins:inspect PLUGIN...
ntsit plugins:install PLUGIN...
ntsit plugins:link PLUGIN
ntsit plugins:uninstall PLUGIN...
ntsit plugins:uninstall PLUGIN...
ntsit plugins:uninstall PLUGIN...
ntsit plugins update
ntsit gen
Start generating your files
USAGE
$ ntsit gen
DESCRIPTION
Start generating your files
See code: dist/commands/gen/index.ts
ntsit help [COMMANDS]
Display help for ntsit.
USAGE
$ ntsit help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for ntsit.
See code: @oclif/plugin-help
ntsit plugins
List installed plugins.
USAGE
$ ntsit plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ntsit plugins
See code: @oclif/plugin-plugins
ntsit plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ntsit plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ ntsit plugins add
EXAMPLES
$ ntsit plugins:install myplugin
$ ntsit plugins:install https://github.com/someuser/someplugin
$ ntsit plugins:install someuser/someplugin
ntsit plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ntsit plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ntsit plugins:inspect myplugin
ntsit plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ntsit plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ ntsit plugins add
EXAMPLES
$ ntsit plugins:install myplugin
$ ntsit plugins:install https://github.com/someuser/someplugin
$ ntsit plugins:install someuser/someplugin
ntsit plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ ntsit plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ ntsit plugins:link myplugin
ntsit plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ntsit plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ntsit plugins unlink
$ ntsit plugins remove
ntsit plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ntsit plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ntsit plugins unlink
$ ntsit plugins remove
ntsit plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ntsit plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ntsit plugins unlink
$ ntsit plugins remove
ntsit plugins update
Update installed plugins.
USAGE
$ ntsit plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
Todos
- [ ] Optimize code: writeFile timing, logic, etc.
- [ ] Add tests(btw: How to test a cli that results in some generated file ?)
- [ ] Upgrade google-spredsheet to v4.
- [ ] Beautify console output: spinner, color, etc.