refactor: change username option to argument

Author: sxzz

README.md

@@ -2,12 +2,30 @@
 
 [![Unit Test](https://github.com/open-jike/jike-cli/actions/workflows/unit-test.yml/badge.svg)](https://github.com/open-jike/jike-cli/actions/workflows/unit-test.yml)
 
-## Install
+## Installation
 
 ```bash
-npm i jike-cli
+$ npm i -g jike-cli
 ```
 
+## Usage
+
+```bash
+$ jike-cli --help
+```
+
+### User
+
+```bash
+$ jike-cli user login # 登录
+$ jike-cli user logout # 退出
+$ jike-cli user renew # 刷新 token
+$ jike-cli user profile # 查看用户主页
+$ jike-cli user view # 在浏览器中打开网页版
+```
+
+For more details, please use `help` command.
+
 ## License
 
 [AGPL-3.0](./LICENSE) License © 2022-PRESENT [三咲智子](https://github.com/sxzz)

src/modules/user/index.ts

@@ -7,7 +7,18 @@ import { renew } from './renew'
 import { view } from './view'
 
 export const user = createCommand('user')
-  .description('manager users')
+  .description('user-related operations')
+  .addHelpText(
+    'after',
+    `
+
+Example call:
+  $ jike-cli user login
+  $ jike-cli user profile 82D23B32-CF36-4C59-AD6F-D05E3552CBF3
+  $ jike-cli user renew
+  $ jike-cli user view 82D23B32-CF36-4C59-AD6F-D05E3552CBF3
+`
+  )
   .usage('<command> [flags]')
   .addCommand(renew)
   .addCommand(login)

src/modules/user/profile.ts

@@ -17,7 +17,7 @@ export interface ProfileOptions {
 }
 
 export const profile = createCommand('profile')
-  .argument('[username]')
+  .argument('[username]', 'the username of user')
   .description('query user profile')
   .option('-r, --raw', 'output raw data')
   .option('-p, --pretty', 'pretty raw data')

src/modules/user/view.ts

@@ -3,14 +3,19 @@ import { createCommand } from 'commander'
 import open from 'open'
 import { createClient, filterUsers } from '../../utils/user'
 
+interface ViewOptions {
+  username: string
+  mobile: boolean
+}
+
 export const view = createCommand('view')
-  .description('query user view')
-  .option('-U, --username <username>', 'the username of user')
+  .argument('[username]', 'the username of user')
+  .description('open user profile in browser')
   .option('-m, --mobile', 'view page for mobile phone')
-  .action(() => viewUser())
+  .action((username?: string) => viewUser(username))
 
-export const viewUser = async () => {
-  let { username, mobile } = view.opts<{ username: string; mobile: boolean }>()
+export const viewUser = async (username?: string) => {
+  const { mobile } = view.opts<Omit<ViewOptions, 'username'>>()
   if (!username) {
     const [user] = filterUsers()
     const client = createClient(user)