feat(v1.1.0): prompting input, credentials input

Author: fee-pg

.gitignore

@@ -9,3 +9,4 @@
 /tmp
 node_modules
 oclif.manifest.json
+*credentials.json

README.md

@@ -9,11 +9,14 @@ a next-translate's tool for google spreadsheet, it can flatten 2D locale-key arr
 <!-- toc -->
 * [Usage](#usage)
 * [Commands](#commands)
+* [Todos](#todos)
 <!-- tocstop -->
 # Usage
 <!-- usage -->
 ```sh-session
 $ npm install -g @uppo/next-translate-spreadsheet-i18n-tool
+or
+$ yarn add -g @uppo/next-translate-spreadsheet-i18n-tool
 $ ntsit COMMAND
 running command...
 $ ntsit (--version)
@@ -26,7 +29,7 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
-* [`ntsit gen SHEETID WORKSHEETS HSTARTCELL VSTARTCELL`](#ntsit-gen-sheetid-worksheets-hstartcell-vstartcell)
+* [`ntsit gen`](#ntsit-gen)
 * [`ntsit help [COMMANDS]`](#ntsit-help-commands)
 * [`ntsit plugins`](#ntsit-plugins)
 * [`ntsit plugins:install PLUGIN...`](#ntsit-pluginsinstall-plugin)
@@ -38,19 +41,13 @@ USAGE
 * [`ntsit plugins:uninstall PLUGIN...`](#ntsit-pluginsuninstall-plugin-2)
 * [`ntsit plugins update`](#ntsit-plugins-update)
 
-## `ntsit gen SHEETID WORKSHEETS HSTARTCELL VSTARTCELL`
+## `ntsit gen`
 
 Start generating your files
 
 ```
 USAGE
-  $ ntsit gen SHEETID WORKSHEETS HSTARTCELL VSTARTCELL
-
-ARGUMENTS
-  SHEETID     google spreadsheet id
-  WORKSHEETS  google spreadsheet worksheet id
-  HSTARTCELL  horizontal start cell. e.g. C1
-  VSTARTCELL  vertical start cell. e.g. B3
+  $ ntsit gen
 
 DESCRIPTION
   Start generating your files
@@ -314,3 +311,13 @@ DESCRIPTION
   Update installed plugins.
 ```
 <!-- commandsstop -->
+
+# Todos
+<!-- 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.
+- [ ] Change to Single Command CLI? (e.g. `ntsit` instead of `ntsit gen`).
+- [ ] Polish README.md: add demo gif, googlesheet template, tutorial for GCP(Google Cloud Platform) Authentication, etc.
+- [ ] Beautify console output: spinner, color, etc.
+<!-- todosstop -->

src/commands/gen/index.ts

@@ -1,4 +1,4 @@
-import {Args, Command} from '@oclif/core'
+import {Command, ux} from '@oclif/core'
 import main from '../../runs/gen'
 
 export default class Gen extends Command {
@@ -8,29 +8,6 @@ export default class Gen extends Command {
     '$ ntsit gen 1sdfU3AZuFPzP_sDeDdpwa21S0BcH-ETVwNViuU9GqlB 3 C1 B3(./src/commands/gen/index.ts)',
   ];
 
-  static args = {
-    sheetId: Args.string({
-      description: 'google spreadsheet id',
-      required: true,
-    }),
-    workSheets: Args.string({
-      description: 'google spreadsheet worksheet id',
-      required: true,
-      // parse: input => {
-      //   if (input.includes(',')) return input.split(',').map(item => Number.parseInt(item, 10))
-      //   return Array.from({length: Number.parseInt(input, 10)}, (_, i) => i)
-      // },
-    }),
-    hStartCell: Args.string({
-      description: 'horizontal start cell. e.g. C1',
-      required: true,
-    }),
-    vStartCell: Args.string({
-      description: 'vertical start cell. e.g. B3',
-      required: true,
-    }),
-  };
-
   static parsedWorkSheets = (input: string): number[] => {
     if (input.includes(',')) return input.split(',').map(item => Number.parseInt(item, 10))
     return Array.from({length: Number.parseInt(input, 10)}, (_, i) => i)
@@ -52,9 +29,18 @@ export default class Gen extends Command {
   }
 
   async run(): Promise<void> {
-    const {args} = await this.parse(Gen)
-    const {sheetId, workSheets, hStartCell, vStartCell} = args
-
-    await main(sheetId, Gen.parsedWorkSheets(workSheets), Gen.parsedCell(hStartCell), Gen.parsedCell(vStartCell))
+    const sheetId = await ux.prompt('google spreadsheet id?')
+    const workSheets = await ux.prompt('google spreadsheet worksheet id? count or indexs(e.g. 3 or 0,1,2)')
+    const hStartCell = await ux.prompt('horizontal start cell?(e.g. C1)')
+    const vStartCell = await ux.prompt('vertical start cell?(e.g. B3)')
+    const credentialsPath = await ux.prompt('google credentials path? based on the current directory, use relative path')
+
+    await main({
+      sheetId,
+      sheetIndexs: Gen.parsedWorkSheets(workSheets),
+      hStartCell: Gen.parsedCell(hStartCell),
+      vStartCell: Gen.parsedCell(vStartCell),
+      credentialsPath,
+    })
   }
 }

src/runs/gen/gs_credentials.ts

@@ -1,5 +1,4 @@
-import {GoogleSpreadsheet, GoogleSpreadsheetWorksheet} from 'google-spreadsheet' // version: ^3.3.0
-import credentials from './gs_credentials'
+import {GoogleSpreadsheet, GoogleSpreadsheetWorksheet, ServiceAccountCredentials} from 'google-spreadsheet' // version: ^3.3.0
 import fs from 'node:fs'
 import path from 'node:path'
 
@@ -19,16 +18,14 @@ const compose = (...fns: { (str: string): string; (str: string): string }[]) =>
   }
 }
 
-const validCredentials = (credentials: Record<string, string>) => {
-  const {private_key, client_email} = credentials
-  if (private_key === 'YOUR_PRIVATE_KEY' || client_email === 'YOUR_CLIENT_EMAIL') {
-    throw new Error('Please set your credentials in src/runs/gen/gs_credentials.ts')
+const sheetInit = async (sheetId: string, sheetIndex: number, credentials: ServiceAccountCredentials) => {
+  const doc = new GoogleSpreadsheet(sheetId)
+  try {
+    await doc.useServiceAccountAuth(credentials)
+  } catch (error) {
+    console.log('auth-error:', error)
   }
-}
 
-const sheetInit = async (sheetId: string, sheetIndex: number) => {
-  const doc = new GoogleSpreadsheet(sheetId)
-  await doc.useServiceAccountAuth(credentials)
   await doc.loadInfo()
   const sheet = doc.sheetsByIndex[sheetIndex]
   await sheet.loadCells()
@@ -78,28 +75,29 @@ const getKeys = async (sheet: GoogleSpreadsheetWorksheet, cell: {x: number, y: n
   return keys
 }
 
-/**
- *
- * @param {string} sheetId google sheet id
- * @param {number[]} sheetIndexs google worksheet index
- * @param {{x: number, y: number}} hStartCell horizontal start cell
- * @param {{x: number, y: number}} vStartCell vertical start cell
- * @returns {Promise<void>} void
- */
-const main = async (
+type MainArgs = {
   sheetId: string,
   sheetIndexs: number[],
-  hStartCell:{x: number, y: number},
-  vStartCell:{x: number, y: number},
-): Promise<void> => {
-  validCredentials(credentials)
-
+  hStartCell: {x: number, y: number},
+  vStartCell: {x: number, y: number},
+  credentialsPath: string
+}
+const main = async ({
+  sheetId,
+  sheetIndexs,
+  hStartCell,
+  vStartCell,
+  credentialsPath,
+}: MainArgs): Promise<void> => {
   const localesJsonMap: Record<string,  Record<string, string>> = {}
-  const firstSheet = await sheetInit(sheetId, sheetIndexs[0])
+  const resultPath = path.join(process.cwd(), credentialsPath)
+  console.log('resultPath:', resultPath)
+  const credentials = JSON.parse(fs.readFileSync(resultPath, 'utf-8'))
+  const firstSheet = await sheetInit(sheetId, sheetIndexs[0], credentials)
   const locales = await getLocales(firstSheet, hStartCell)
 
   sheetIndexs.forEach(async sheetIndex => {
-    const sheet = await sheetInit(sheetId, sheetIndex)
+    const sheet = await sheetInit(sheetId, sheetIndex, credentials)
     const keys = await getKeys(sheet, vStartCell)
 
     for (let i = 0; i < locales.length; i++) {