feat: add hackmd-api flag descriptions

Author: James Tsai

src/commands/notes/create.ts

@@ -2,6 +2,7 @@ import {CommentPermissionType, CreateNoteOptions, NotePermissionRole} from '@hac
 import {CliUx, Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {commentPermission, noteContent, notePermission, noteTitle} from '../../flags'
 import readStdin from '../../read-stdin-stream'
 
 export default class Create extends Command {
@@ -20,11 +21,11 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    title: Flags.string(),
-    content: Flags.string(),
-    readPermission: Flags.string(),
-    writePermission: Flags.string(),
-    commentPermission: Flags.string(),
+    title: noteTitle(),
+    content: noteContent(),
+    readPermission: notePermission(),
+    writePermission: notePermission(),
+    commentPermission: commentPermission(),
     ...CliUx.ux.table.flags(),
   }
 

src/commands/notes/delete.ts

@@ -1,6 +1,7 @@
 import {Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {noteId} from '../../flags'
 
 export default class Delete extends Command {
   static description = 'Delete a note'
@@ -11,7 +12,7 @@ export default class Delete extends Command {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: Flags.string(),
+    noteId: noteId(),
   }
 
   async run() {

src/commands/notes/index.ts

@@ -1,6 +1,7 @@
 import {CliUx, Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {noteId} from '../../flags'
 
 export default class IndexCommand extends Command {
   static description = 'HackMD notes commands'
@@ -14,7 +15,7 @@ raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q n
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: Flags.string(),
+    noteId: noteId(),
     ...CliUx.ux.table.flags(),
   }
 

src/commands/notes/update.ts

@@ -1,6 +1,7 @@
 import {Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {noteContent, noteId} from '../../flags'
 
 export default class Update extends Command {
   static description = 'Update note content'
@@ -11,8 +12,8 @@ export default class Update extends Command {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    noteId: Flags.string(),
-    content: Flags.string()
+    noteId: noteId(),
+    content: noteContent()
   }
 
   async run() {

src/commands/team-notes/create.ts

@@ -2,6 +2,7 @@ import {CommentPermissionType, CreateNoteOptions, NotePermissionRole} from '@hac
 import {CliUx, Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {commentPermission, noteContent, notePermission, noteTitle, teamPath} from '../../flags'
 import readStdin from '../../read-stdin-stream'
 
 export default class Create extends Command {
@@ -19,12 +20,12 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q n
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: Flags.string(),
-    title: Flags.string(),
-    content: Flags.string(),
-    readPermission: Flags.string(),
-    writePermission: Flags.string(),
-    commentPermission: Flags.string(),
+    teamPath: teamPath(),
+    title: noteTitle(),
+    content: noteContent(),
+    readPermission: notePermission(),
+    writePermission: notePermission(),
+    commentPermission: commentPermission(),
     ...CliUx.ux.table.flags(),
   }
 

src/commands/team-notes/delete.ts

@@ -1,6 +1,7 @@
 import {Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {noteId, teamPath} from '../../flags'
 
 export default class Delete extends Command {
   static description = 'Delete a team note'
@@ -11,8 +12,8 @@ export default class Delete extends Command {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: Flags.string(),
-    noteId: Flags.string(),
+    teamPath: teamPath(),
+    noteId: noteId(),
   }
 
   async run() {

src/commands/team-notes/index.ts

@@ -1,6 +1,7 @@
 import {CliUx, Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {teamPath} from '../../flags'
 
 export default class IndexCommand extends Command {
   static description = 'HackMD team-notes commands'
@@ -15,7 +16,7 @@ BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null     CLI-test`,
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: Flags.string(),
+    teamPath: teamPath(),
     ...CliUx.ux.table.flags(),
   }
 

src/commands/team-notes/update.ts

@@ -1,6 +1,7 @@
 import {Command, Flags} from '@oclif/core'
 
 import {APIClient} from '../../api'
+import {noteContent, noteId, teamPath} from '../../flags'
 
 export default class Update extends Command {
   static description = 'Update team note content'
@@ -11,9 +12,9 @@ export default class Update extends Command {
 
   static flags = {
     help: Flags.help({char: 'h'}),
-    teamPath: Flags.string(),
-    noteId: Flags.string(),
-    content: Flags.string()
+    teamPath: teamPath(),
+    noteId: noteId(),
+    content: noteContent()
   }
 
   async run() {

src/flags.ts

@@ -0,0 +1,24 @@
+import {Flags} from '@oclif/core'
+export const noteId = Flags.build({
+  description: 'hackmd note id'
+})
+
+export const teamPath = Flags.build({
+  description: 'hackmd team path'
+})
+
+export const noteContent = Flags.build({
+  description: 'new note content'
+})
+
+export const noteTitle = Flags.build({
+  description: 'new note title'
+})
+
+export const notePermission = Flags.build({
+  description: 'set note permission: owner, signed_in, guest'
+})
+
+export const commentPermission = Flags.build({
+  description: 'set comment permission: disabled, forbidden, owners, signed_in_users, everyone'
+})