feat: upgrade oclif deps (#75)

Yukaii · web-flow · commit 8016c1cc23ec · 2023-04-28T21:48:10.000+08:00
* feat: upgrade oclif deps
* fix: lint
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -8,13 +8,13 @@
   "bugs": "https://github.com/hackmdio/hackmd-cli/issues",
   "dependencies": {
     "@hackmd/api": "^2.0.0",
-    "@oclif/core": "^1.3.6",
-    "@oclif/plugin-help": "^2.2.3",
-    "@oclif/plugin-version": "^1.0.4",
+    "@oclif/core": "2.8.2",
+    "@oclif/plugin-help": "5.2.9",
+    "@oclif/plugin-version": "1.3.3",
     "cli-ux": "^5.4.4",
     "fs-extra": "^8.1.0",
     "lodash.defaults": "^4.2.0",
-    "oclif": "^2.5.0",
+    "oclif": "3.8.1",
     "tslib": "^1.10.0"
   },
   "devDependencies": {
diff --git a/src/command.ts b/src/command.ts
@@ -1,12 +1,12 @@
 import API from '@hackmd/api'
-import {CliUx, Command} from '@oclif/core'
+import {Command, ux} from '@oclif/core'
 
 import config from './config'
 import {setAccessTokenConfig} from './utils'
 
 export default abstract class HackMDCommand extends Command {
   async getAPIClient() {
-    const token = config.accessToken || await CliUx.ux.prompt('Enter your access token', {
+    const token = config.accessToken || await ux.prompt('Enter your access token', {
       type: 'hide'
     })
     const APIClient = new API(token, config.hackmdAPIEndpointURL)
diff --git a/src/commands/export.ts b/src/commands/export.ts
@@ -14,7 +14,7 @@ export default class Export extends HackMDCommand {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: noteId()
+    noteId
   }
 
   async run() {
diff --git a/src/commands/history.ts b/src/commands/history.ts
@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 
 import HackMDCommand from '../command'
 
@@ -15,7 +15,7 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null                   C
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    ...CliUx.ux.table.flags(),
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -25,7 +25,7 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null                   C
       const APIClient = await this.getAPIClient()
       const history = await APIClient.getHistory()
 
-      CliUx.ux.table(history, {
+      ux.table(history, {
         id: {
           header: 'ID',
         },
diff --git a/src/commands/notes/create.ts b/src/commands/notes/create.ts
@@ -3,7 +3,7 @@ import {
   CreateNoteOptions,
   NotePermissionRole,
 } from '@hackmd/api/dist/type'
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 import * as fs from 'fs'
 
 import HackMDCommand from '../../command'
@@ -33,13 +33,13 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    title: noteTitle(),
-    content: noteContent(),
-    readPermission: notePermission(),
-    writePermission: notePermission(),
-    commentPermission: commentPermission(),
+    title: noteTitle,
+    content: noteContent,
+    readPermission: notePermission,
+    writePermission: notePermission,
+    commentPermission,
     editor,
-    ...CliUx.ux.table.flags(),
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -69,7 +69,7 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
       const APIClient = await this.getAPIClient()
       const note = await APIClient.createNote(options)
 
-      CliUx.ux.table(
+      ux.table(
         [note],
         {
           id: {
diff --git a/src/commands/notes/delete.ts b/src/commands/notes/delete.ts
@@ -12,7 +12,7 @@ export default class Delete extends HackMDCommand {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: noteId(),
+    noteId,
   }
 
   async run() {
diff --git a/src/commands/notes/index.ts b/src/commands/notes/index.ts
@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 
 import HackMDCommand from '../../command'
 import {noteId} from '../../flags'
@@ -15,8 +15,8 @@ raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q n
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: noteId(),
-    ...CliUx.ux.table.flags(),
+    noteId,
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -26,7 +26,7 @@ raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q n
       const APIClient = await this.getAPIClient()
       const notes = flags.noteId ? [await APIClient.getNote(flags.noteId)] : await APIClient.getNoteList()
 
-      CliUx.ux.table(notes, {
+      ux.table(notes, {
         id: {
           header: 'ID',
         },
diff --git a/src/commands/notes/update.ts b/src/commands/notes/update.ts
@@ -12,8 +12,8 @@ export default class Update extends HackMDCommand {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: noteId(),
-    content: noteContent()
+    noteId,
+    content: noteContent
   }
 
   async run() {
diff --git a/src/commands/team-notes/create.ts b/src/commands/team-notes/create.ts
@@ -1,5 +1,5 @@
 import {CommentPermissionType, CreateNoteOptions, NotePermissionRole} from '@hackmd/api/dist/type'
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 import fs from 'fs'
 
 import HackMDCommand from '../../command'
@@ -22,14 +22,14 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q n
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: teamPath(),
-    title: noteTitle(),
-    content: noteContent(),
-    readPermission: notePermission(),
-    writePermission: notePermission(),
-    commentPermission: commentPermission(),
+    teamPath,
+    title: noteTitle,
+    content: noteContent,
+    readPermission: notePermission,
+    writePermission: notePermission,
+    commentPermission,
     editor,
-    ...CliUx.ux.table.flags(),
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -64,7 +64,7 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q n
       const APIClient = await this.getAPIClient()
       const note = await APIClient.createTeamNote(teamPath, options)
 
-      CliUx.ux.table([note], {
+      ux.table([note], {
         id: {
           header: 'ID',
         },
diff --git a/src/commands/team-notes/delete.ts b/src/commands/team-notes/delete.ts
@@ -12,8 +12,8 @@ export default class Delete extends HackMDCommand {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: teamPath(),
-    noteId: noteId(),
+    teamPath,
+    noteId,
   }
 
   async run() {
diff --git a/src/commands/team-notes/index.ts b/src/commands/team-notes/index.ts
@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 
 import HackMDCommand from '../../command'
 import {teamPath} from '../../flags'
@@ -16,8 +16,8 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null     CLI-test`,
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: teamPath(),
-    ...CliUx.ux.table.flags(),
+    teamPath,
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -31,7 +31,7 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null     CLI-test`,
       const APIClient = await this.getAPIClient()
       const notes = await APIClient.getTeamNotes(flags.teamPath)
 
-      CliUx.ux.table(notes, {
+      ux.table(notes, {
         id: {
           header: 'ID',
         },
diff --git a/src/commands/team-notes/update.ts b/src/commands/team-notes/update.ts
@@ -12,9 +12,9 @@ export default class Update extends HackMDCommand {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: teamPath(),
-    noteId: noteId(),
-    content: noteContent()
+    teamPath,
+    noteId,
+    content: noteContent,
   }
 
   async run() {
diff --git a/src/commands/teams.ts b/src/commands/teams.ts
@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 
 import HackMDCommand from '../command'
 
@@ -14,7 +14,7 @@ f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    ...CliUx.ux.table.flags(),
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -24,7 +24,7 @@ f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8
       const APIClient = await this.getAPIClient()
       const notes = await APIClient.getTeams()
 
-      CliUx.ux.table(notes, {
+      ux.table(notes, {
         id: {
           header: 'ID',
         },
diff --git a/src/commands/whoami.ts b/src/commands/whoami.ts
@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core'
+import {Flags, ux} from '@oclif/core'
 
 import HackMDCommand from '../command'
 
@@ -14,7 +14,7 @@ ID                                   Name           Email User path
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    ...CliUx.ux.table.flags(),
+    ...ux.table.flags(),
   }
 
   async run() {
@@ -24,7 +24,7 @@ ID                                   Name           Email User path
       const APIClient = await this.getAPIClient()
       const user = await APIClient.getMe()
 
-      CliUx.ux.table([user], {
+      ux.table([user], {
         id: {
           header: 'ID',
         },
diff --git a/src/flags.ts b/src/flags.ts
@@ -1,25 +1,25 @@
 import {Flags} from '@oclif/core'
-export const noteId = Flags.build({
+export const noteId = Flags.string({
   description: 'HackMD note id'
 })
 
-export const teamPath = Flags.build({
+export const teamPath = Flags.string({
   description: 'HackMD team path'
 })
 
-export const noteContent = Flags.build({
+export const noteContent = Flags.string({
   description: 'new note content'
 })
 
-export const noteTitle = Flags.build({
+export const noteTitle = Flags.string({
   description: 'new note title'
 })
 
-export const notePermission = Flags.build({
+export const notePermission = Flags.string({
   description: 'set note permission: owner, signed_in, guest'
 })
 
-export const commentPermission = Flags.build({
+export const commentPermission = Flags.string({
   description: 'set comment permission: disabled, forbidden, owners, signed_in_users, everyone'
 })
 

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export default class Export extends HackMDCommand {`
`14`	`14`
`15`	`15`	`static flags = {`
`16`	`16`	`help: Flags.help({char: 'h'}),`
`17`		`- noteId: noteId()`
	`17`	`+ noteId`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`async run() {`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ export default class Delete extends HackMDCommand {`
`12`	`12`
`13`	`13`	`static flags = {`
`14`	`14`	`help: Flags.help({char: 'h'}),`
`15`		`- noteId: noteId(),`
	`15`	`+ noteId,`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`async run() {`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,8 @@ export default class Update extends HackMDCommand {`
`12`	`12`
`13`	`13`	`static flags = {`
`14`	`14`	`help: Flags.help({char: 'h'}),`
`15`		`- noteId: noteId(),`
`16`		`- content: noteContent()`
	`15`	`+ noteId,`
	`16`	`+ content: noteContent`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`async run() {`