fix: lint errors and typing

Yukaii · Yukaii · commit 70adf3b9ac2c · 2023-04-28T23:35:04.000+08:00
diff --git a/src/command.ts b/src/command.ts
@@ -7,7 +7,7 @@ import {setAccessTokenConfig} from './utils'
 export default abstract class HackMDCommand extends Command {
   async getAPIClient() {
     const token = config.accessToken || await ux.prompt('Enter your access token', {
-      type: 'hide'
+      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,
   }
 
   async run() {
@@ -29,9 +29,9 @@ export default class Export extends HackMDCommand {
       const APIClient = await this.getAPIClient()
       const note = await APIClient.getNote(noteId)
       this.log(note.content)
-    } catch (e) {
+    } catch (error) {
       this.log('Export note content failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/history.ts b/src/commands/history.ts
@@ -31,18 +31,18 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null                   C
         },
         title: {},
         userPath: {
-          header: 'User Path'
+          header: 'User Path',
         },
         teamPath: {
-          header: 'Team Path'
+          header: 'Team Path',
         },
       }, {
         printLine: this.log.bind(this),
-        ...flags
+        ...flags,
       })
-    } catch (e) {
+    } catch (error) {
       this.log('Fetch history failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/login.ts b/src/commands/login.ts
@@ -11,20 +11,20 @@ export default class Login extends HackMDCommand {
 Enter your access token: MY_ACCESS_TOKEN
 
 Login successfully
-`
+`,
   ]
 
   static flags = {
-    help: Flags.help({char: 'h'})
+    help: Flags.help({char: 'h'}),
   }
 
   async run() {
     try {
       await this.getAPIClient()
       this.log('Login successfully')
-    } catch (err) {
+    } catch (error) {
       this.log('Login failed')
-      this.error(err as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/logout.ts b/src/commands/logout.ts
@@ -10,19 +10,19 @@ export default class Logout extends HackMDCommand {
     `$ hackmd-cli logout
 
 You've logged out successfully
-`
+`,
   ]
 
   static flags = {
-    help: Flags.help({char: 'h'})
+    help: Flags.help({char: 'h'}),
   }
 
   async run() {
     try {
       setAccessTokenConfig('')
       this.log("You've logged out successfully")
-    } catch (err) {
-      this.error(String(err))
+    } catch (error) {
+      this.error(String(error))
     }
   }
 }
diff --git a/src/commands/notes/create.ts b/src/commands/notes/create.ts
@@ -4,7 +4,7 @@ import {
   NotePermissionRole,
 } from '@hackmd/api/dist/type'
 import {Flags, ux} from '@oclif/core'
-import * as fs from 'fs'
+import * as fs from 'node:fs'
 
 import HackMDCommand from '../../command'
 import {
@@ -60,8 +60,8 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
         await openEditor(mdFile)
 
         options.content = fs.readFileSync(mdFile).toString()
-      } catch (e) {
-        this.error(e as Error)
+      } catch (error) {
+        this.error(error as Error)
       }
     }
 
@@ -86,11 +86,11 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
         {
           printLine: this.log.bind(this),
           ...flags,
-        }
+        },
       )
-    } catch (e) {
+    } catch (error) {
       this.log('Create note failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/notes/delete.ts b/src/commands/notes/delete.ts
@@ -7,7 +7,7 @@ export default class Delete extends HackMDCommand {
   static description = 'Delete a note'
 
   static examples = [
-    '$ hackmd-cli notes delete --noteId=WNkLM6gkS0Cg2cQ8rv7bYA'
+    '$ hackmd-cli notes delete --noteId=WNkLM6gkS0Cg2cQ8rv7bYA',
   ]
 
   static flags = {
@@ -26,9 +26,9 @@ export default class Delete extends HackMDCommand {
     try {
       const APIClient = await this.getAPIClient()
       await APIClient.deleteNote(noteId)
-    } catch (e) {
+    } catch (error) {
       this.log('Delete note failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/notes/index.ts b/src/commands/notes/index.ts
@@ -32,18 +32,18 @@ raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q n
         },
         title: {},
         userPath: {
-          header: 'User Path'
+          header: 'User Path',
         },
         teamPath: {
-          header: 'Team Path'
+          header: 'Team Path',
         },
       }, {
         printLine: this.log.bind(this),
-        ...flags
+        ...flags,
       })
-    } catch (e) {
+    } catch (error) {
       this.log('Fetch user notes failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/notes/update.ts b/src/commands/notes/update.ts
@@ -7,13 +7,13 @@ export default class Update extends HackMDCommand {
   static description = 'Update note content'
 
   static examples = [
-    "$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'"
+    "$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'",
   ]
 
   static flags = {
     help: Flags.help({char: 'h'}),
     noteId,
-    content: noteContent
+    content: noteContent,
   }
 
   async run() {
@@ -27,9 +27,9 @@ export default class Update extends HackMDCommand {
     try {
       const APIClient = await this.getAPIClient()
       await APIClient.updateNoteContent(noteId, content)
-    } catch (e) {
+    } catch (error) {
       this.log('Update note content failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/team-notes/create.ts b/src/commands/team-notes/create.ts
@@ -1,6 +1,6 @@
 import {CommentPermissionType, CreateNoteOptions, NotePermissionRole} from '@hackmd/api/dist/type'
 import {Flags, ux} from '@oclif/core'
-import fs from 'fs'
+import fs from 'node:fs'
 
 import HackMDCommand from '../../command'
 import {commentPermission, editor, noteContent, notePermission, noteTitle, teamPath} from '../../flags'
@@ -17,7 +17,7 @@ ID                     Title                            User Path              T
 raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q null     `,
 
     'Or you can pipe content via Unix pipeline:',
-    'cat README.md | hackmd-cli notes create --teamPath=CLI-test'
+    'cat README.md | hackmd-cli notes create --teamPath=CLI-test',
   ]
 
   static flags = {
@@ -36,13 +36,13 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q n
     const {flags} = await this.parse(Create)
     const pipeString = safeStdinRead()
 
-    const {teamPath} = flags
+    const {teamPath, title, content, readPermission, writePermission, commentPermission} = flags
     const options: CreateNoteOptions = {
-      title: flags.title,
-      content: pipeString || flags.content,
-      readPermission: flags.readPermission as NotePermissionRole,
-      writePermission: flags.writePermission as NotePermissionRole,
-      commentPermission: flags.commentPermission as CommentPermissionType
+      title: title,
+      content: pipeString || content,
+      readPermission: readPermission as NotePermissionRole,
+      writePermission: writePermission as NotePermissionRole,
+      commentPermission: commentPermission as CommentPermissionType,
     }
 
     if (!teamPath) {
@@ -55,8 +55,8 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q n
         await openEditor(mdFile)
 
         options.content = fs.readFileSync(mdFile).toString()
-      } catch (e) {
-        this.error(e as Error)
+      } catch (error) {
+        this.error(error as Error)
       }
     }
 
@@ -70,18 +70,18 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q n
         },
         title: {},
         userPath: {
-          header: 'User path'
+          header: 'User path',
         },
         teamPath: {
-          header: 'Team path'
-        }
+          header: 'Team path',
+        },
       }, {
         printLine: this.log.bind(this),
-        ...flags
+        ...flags,
       })
-    } catch (e) {
+    } catch (error) {
       this.log('Create team note failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/team-notes/delete.ts b/src/commands/team-notes/delete.ts
@@ -7,7 +7,7 @@ export default class Delete extends HackMDCommand {
   static description = 'Delete a team note'
 
   static examples = [
-    '$ hackmd-cli team-notes delete --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA'
+    '$ hackmd-cli team-notes delete --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA',
   ]
 
   static flags = {
@@ -31,9 +31,9 @@ export default class Delete extends HackMDCommand {
     try {
       const APIClient = await this.getAPIClient()
       await APIClient.deleteTeamNote(teamPath, noteId)
-    } catch (e) {
+    } catch (error) {
       this.log('Delete team note failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/team-notes/index.ts b/src/commands/team-notes/index.ts
@@ -37,18 +37,18 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null     CLI-test`,
         },
         title: {},
         userPath: {
-          header: 'User path'
+          header: 'User path',
         },
         teamPath: {
-          header: 'Team path'
-        }
+          header: 'Team path',
+        },
       }, {
         printLine: this.log.bind(this),
-        ...flags
+        ...flags,
       })
-    } catch (e) {
+    } catch (error) {
       this.log('Fetch team notes failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/team-notes/update.ts b/src/commands/team-notes/update.ts
@@ -7,7 +7,7 @@ export default class Update extends HackMDCommand {
   static description = 'Update team note content'
 
   static examples = [
-    "$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'"
+    "$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'",
   ]
 
   static flags = {
@@ -32,9 +32,9 @@ export default class Update extends HackMDCommand {
     try {
       const APIClient = await this.getAPIClient()
       await APIClient.updateTeamNoteContent(teamPath, noteId, content)
-    } catch (e) {
+    } catch (error) {
       this.log('Update team note content failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/teams.ts b/src/commands/teams.ts
@@ -31,15 +31,15 @@ f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8
         name: {},
         path: {},
         ownerId: {
-          header: 'Owner ID'
-        }
+          header: 'Owner ID',
+        },
       }, {
         printLine: this.log.bind(this),
-        ...flags
+        ...flags,
       })
-    } catch (e) {
+    } catch (error) {
       this.log('Fetch teams failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/commands/whoami.ts b/src/commands/whoami.ts
@@ -31,15 +31,15 @@ ID                                   Name           Email User path
         name: {},
         email: {},
         userPath: {
-          header: 'User Path'
+          header: 'User Path',
         },
       }, {
         printLine: this.log.bind(this),
-        ...flags
+        ...flags,
       })
-    } catch (e) {
+    } catch (error) {
       this.log('Fetch user info failed')
-      this.error(e as Error)
+      this.error(error as Error)
     }
   }
 }
diff --git a/src/config.ts b/src/config.ts
diff --git a/src/flags.ts b/src/flags.ts
diff --git a/src/open-editor.ts b/src/open-editor.ts
diff --git a/src/utils.ts b/src/utils.ts
diff --git a/test/config.test.ts b/test/config.test.ts
diff --git a/test/utils.ts b/test/utils.ts

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`
	`17`	`+ noteId,`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`async run() {`
`@@ -29,9 +29,9 @@ export default class Export extends HackMDCommand {`
`29`	`29`	`const APIClient = await this.getAPIClient()`
`30`	`30`	`const note = await APIClient.getNote(noteId)`
`31`	`31`	`this.log(note.content)`
`32`		`- } catch (e) {`
	`32`	`+ } catch (error) {`
`33`	`33`	`this.log('Export note content failed')`
`34`		`- this.error(e as Error)`
	`34`	`+ this.error(error as Error)`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,20 +11,20 @@ export default class Login extends HackMDCommand {`
`11`	`11`	`Enter your access token: MY_ACCESS_TOKEN`
`12`	`12`
`13`	`13`	`Login successfully`
`14`		-`
	`14`	+`,
`15`	`15`	`]`
`16`	`16`
`17`	`17`	`static flags = {`
`18`		`- help: Flags.help({char: 'h'})`
	`18`	`+ help: Flags.help({char: 'h'}),`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`async run() {`
`22`	`22`	`try {`
`23`	`23`	`await this.getAPIClient()`
`24`	`24`	`this.log('Login successfully')`
`25`		`- } catch (err) {`
	`25`	`+ } catch (error) {`
`26`	`26`	`this.log('Login failed')`
`27`		`- this.error(err as Error)`
	`27`	`+ this.error(error as Error)`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,19 +10,19 @@ export default class Logout extends HackMDCommand {`
`10`	`10`	`$ hackmd-cli logout
`11`	`11`
`12`	`12`	`You've logged out successfully`
`13`		-`
	`13`	+`,
`14`	`14`	`]`
`15`	`15`
`16`	`16`	`static flags = {`
`17`		`- help: Flags.help({char: 'h'})`
	`17`	`+ help: Flags.help({char: 'h'}),`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`async run() {`
`21`	`21`	`try {`
`22`	`22`	`setAccessTokenConfig('')`
`23`	`23`	`this.log("You've logged out successfully")`
`24`		`- } catch (err) {`
`25`		`- this.error(String(err))`
	`24`	`+ } catch (error) {`
	`25`	`+ this.error(String(error))`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import {`
`4`	`4`	`NotePermissionRole,`
`5`	`5`	`} from '@hackmd/api/dist/type'`
`6`	`6`	`import {Flags, ux} from '@oclif/core'`
`7`		`-import * as fs from 'fs'`
	`7`	`+import * as fs from 'node:fs'`
`8`	`8`
`9`	`9`	`import HackMDCommand from '../../command'`
`10`	`10`	`import {`
`@@ -60,8 +60,8 @@ raUuSTetT5uQbqQfLnz9lA A new note gvfz2UB5THiKABQJQnLs6Q`
`60`	`60`	`await openEditor(mdFile)`
`61`	`61`
`62`	`62`	`options.content = fs.readFileSync(mdFile).toString()`
`63`		`- } catch (e) {`
`64`		`- this.error(e as Error)`
	`63`	`+ } catch (error) {`
	`64`	`+ this.error(error as Error)`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`
`@@ -86,11 +86,11 @@ raUuSTetT5uQbqQfLnz9lA A new note gvfz2UB5THiKABQJQnLs6Q`
`86`	`86`	`{`
`87`	`87`	`printLine: this.log.bind(this),`
`88`	`88`	`...flags,`
`89`		`- }`
	`89`	`+ },`
`90`	`90`	`)`
`91`		`- } catch (e) {`
	`91`	`+ } catch (error) {`
`92`	`92`	`this.log('Create note failed')`
`93`		`- this.error(e as Error)`
	`93`	`+ this.error(error as Error)`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ export default class Delete extends HackMDCommand {`
`7`	`7`	`static description = 'Delete a note'`
`8`	`8`
`9`	`9`	`static examples = [`
`10`		`- '$ hackmd-cli notes delete --noteId=WNkLM6gkS0Cg2cQ8rv7bYA'`
	`10`	`+ '$ hackmd-cli notes delete --noteId=WNkLM6gkS0Cg2cQ8rv7bYA',`
`11`	`11`	`]`
`12`	`12`
`13`	`13`	`static flags = {`
`@@ -26,9 +26,9 @@ export default class Delete extends HackMDCommand {`
`26`	`26`	`try {`
`27`	`27`	`const APIClient = await this.getAPIClient()`
`28`	`28`	`await APIClient.deleteNote(noteId)`
`29`		`- } catch (e) {`
	`29`	`+ } catch (error) {`
`30`	`30`	`this.log('Delete note failed')`
`31`		`- this.error(e as Error)`
	`31`	`+ this.error(error as Error)`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,13 @@ export default class Update extends HackMDCommand {`
`7`	`7`	`static description = 'Update note content'`
`8`	`8`
`9`	`9`	`static examples = [`
`10`		`- "$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'"`
	`10`	`+ "$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'",`
`11`	`11`	`]`
`12`	`12`
`13`	`13`	`static flags = {`
`14`	`14`	`help: Flags.help({char: 'h'}),`
`15`	`15`	`noteId,`
`16`		`- content: noteContent`
	`16`	`+ content: noteContent,`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`async run() {`
`@@ -27,9 +27,9 @@ export default class Update extends HackMDCommand {`
`27`	`27`	`try {`
`28`	`28`	`const APIClient = await this.getAPIClient()`
`29`	`29`	`await APIClient.updateNoteContent(noteId, content)`
`30`		`- } catch (e) {`
	`30`	`+ } catch (error) {`
`31`	`31`	`this.log('Update note content failed')`
`32`		`- this.error(e as Error)`
	`32`	`+ this.error(error as Error)`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`	`}`