chore: fix lint

sxzz · sxzz · commit 6ed62e4a300e · 2025-08-23T09:50:01.000+08:00
diff --git a/README.md b/README.md
@@ -159,7 +159,7 @@ import { setApiConfig } from 'jike-sdk'
 [API Reference](https://jike-sdk.sxzz.moe/)
 
 ```ts
-import { ApiClient, api, setAccessToken, setApiConfig } from 'jike-sdk'
+import { api, ApiClient, setAccessToken, setApiConfig } from 'jike-sdk'
 
 // 自行在 GitHub 搜索「jike endpoint」探索配置
 const apiConfig = {
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,6 +1,7 @@
+// @ts-check
 import { sxzz } from '@sxzz/eslint-config'
 
-export default sxzz([
+export default sxzz().append([
   {
     ignores: ['playground/**', 'docs/**', 'tests/deno/**'],
   },
diff --git a/src/api-client.ts b/src/api-client.ts
@@ -1,5 +1,5 @@
-import { type Api, api } from './api'
-import { type ApiConfig, setApiConfig } from './request'
+import { api, type Api } from './api'
+import { setApiConfig, type ApiConfig } from './request'
 
 /**
  * API 客户端
diff --git a/src/api/comments.ts b/src/api/comments.ts
@@ -1,12 +1,12 @@
 import { request, toResponse } from '../request'
+import type { Comments } from '../types/api-responses'
 import type { PostTypeRaw } from '../types/entity'
 import type {
   AddCommentOption,
   ListCommentMoreKey,
   ListPrimaryCommentOption,
   PaginationOption,
 } from '../types/options'
-import type { Comments } from '../types/api-responses'
 
 export const add = <T = Comments.AddResponse>(
   targetType: PostTypeRaw,
diff --git a/src/api/index.ts b/src/api/index.ts
@@ -1,14 +1,14 @@
-import * as users from './users'
-import * as userRelation from './user-relation'
+import * as comments from './comments'
+import * as mediaMeta from './media-meta'
+import * as notifications from './notifications'
+import * as personalUpdate from './personal-update'
 import * as posts from './posts'
 import * as recommendFeed from './recommend-feed'
-import * as personalUpdate from './personal-update'
-import * as notifications from './notifications'
-import * as comments from './comments'
-import * as upload from './upload'
 import * as stories from './stories'
-import * as mediaMeta from './media-meta'
 import * as topics from './topics'
+import * as upload from './upload'
+import * as userRelation from './user-relation'
+import * as users from './users'
 
 /**
  * API
diff --git a/src/api/media-meta.ts b/src/api/media-meta.ts
@@ -1,6 +1,6 @@
 import { request, toResponse } from '../request'
-import type { LiteralUnion } from '../utils'
 import type { InteractiveResponse } from '../types/api-responses'
+import type { LiteralUnion } from '../utils'
 
 /**
  * 获取视频地址
diff --git a/src/api/notifications.ts b/src/api/notifications.ts
@@ -1,7 +1,7 @@
 import { request, toResponse } from '../request'
-import type { PaginationOption } from '../types/options'
 import type { Notifications } from '../types/api-responses'
 import type { Notification } from '../types/entity'
+import type { PaginationOption } from '../types/options'
 
 /**
  * 获取通知列表
@@ -23,7 +23,7 @@ export const list = <T = Notifications.ListResponse>(
 
 /**
  * 获取合并通知的列表
- * @param option 起始通知 ID
+ * @param id 起始通知 ID
  */
 export const listMergedMentions = <
   T = Notifications.ListMergedMentionsResponse,
diff --git a/src/api/personal-update.ts b/src/api/personal-update.ts
@@ -1,7 +1,7 @@
 import { request, toResponse } from '../request'
+import type { PersonalUpdate } from '../types/api-responses'
 import type { PostTypeRaw } from '../types/entity'
 import type { PaginationOption } from '../types/options'
-import type { PersonalUpdate } from '../types/api-responses'
 
 /**
  * 获取用户动态
diff --git a/src/api/posts.ts b/src/api/posts.ts
@@ -1,13 +1,14 @@
 import { request, toResponse } from '../request'
+import type { Posts } from '../types/api-responses'
 import type {
   CreatePostOption,
   PaginationOption,
   PostType,
 } from '../types/options'
-import type { Posts } from '../types/api-responses'
 
 /**
  * 发送动态
+ * @param type 动态类型
  * @param content 内容
  * @param options 其他选项
  */
@@ -30,6 +31,7 @@ export const create = <T = Posts.CreateResponse>(
 
 /**
  * 获取动态详情
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const get = <T = Posts.GetResponse>(type: PostType, id: string) =>
@@ -41,9 +43,9 @@ export const get = <T = Posts.GetResponse>(type: PostType, id: string) =>
 
 /**
  * 分享动态
+ * @param type 动态类型
  * @param id 动态ID
  * @param method 分享方式
- * @returns
  */
 export const share = <T = {}>(type: PostType, id: string, method: string) =>
   toResponse<T>(
@@ -57,6 +59,7 @@ export const share = <T = {}>(type: PostType, id: string, method: string) =>
 
 /**
  * 点赞动态
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const like = <T = {}>(type: PostType, id: string) =>
@@ -68,6 +71,7 @@ export const like = <T = {}>(type: PostType, id: string) =>
 
 /**
  * 取消点赞动态
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const unlike = <T = {}>(type: PostType, id: string) =>
@@ -79,6 +83,7 @@ export const unlike = <T = {}>(type: PostType, id: string) =>
 
 /**
  * 删除动态
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const remove = <T = Posts.RemoveResponse>(type: PostType, id: string) =>
@@ -90,6 +95,7 @@ export const remove = <T = Posts.RemoveResponse>(type: PostType, id: string) =>
 
 /**
  * 获取点赞用户列表
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const listLikedUsers = <T = Posts.ListLikedUsersResponse>(
@@ -109,6 +115,7 @@ export const listLikedUsers = <T = Posts.ListLikedUsersResponse>(
 
 /**
  * 隐藏动态（仅会员）
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const hide = <T = Posts.HideResponse>(type: PostType, id: string) =>
@@ -120,6 +127,7 @@ export const hide = <T = Posts.HideResponse>(type: PostType, id: string) =>
 
 /**
  * 转为公开动态（仅会员）
+ * @param type 动态类型
  * @param id 动态ID
  */
 export const recover = <T = Posts.HideResponse>(type: PostType, id: string) =>
diff --git a/src/api/recommend-feed.ts b/src/api/recommend-feed.ts
@@ -1,6 +1,6 @@
 import { request, toResponse } from '../request'
-import type { ListRecommendFeedOption } from '../types/options'
 import type { RecommendFeed } from '../types/api-responses'
+import type { ListRecommendFeedOption } from '../types/options'
 
 /**
  * 获取动态广场
diff --git a/src/api/topics.ts b/src/api/topics.ts
@@ -1,7 +1,7 @@
 import { request, toResponse } from '../request'
-import type { LiteralUnion } from '../utils'
 import type { Topics } from '../types/api-responses'
 import type { PaginationOption } from '../types/options'
+import type { LiteralUnion } from '../utils'
 
 /**
  * 获取圈子动态
diff --git a/src/api/upload.ts b/src/api/upload.ts
@@ -1,8 +1,8 @@
 /* eslint-disable node/prefer-global/buffer */
 import ky from 'ky'
 import { request, toResponse } from '../request'
-import type { Buffer, Blob as NodeBlob } from 'node:buffer'
 import type { Upload } from '../types/api-responses'
+import type { Buffer, Blob as NodeBlob } from 'node:buffer'
 
 export const token = <T = Upload.TokenResponse>(md5: string) =>
   toResponse<T>(
diff --git a/src/api/user-relation.ts b/src/api/user-relation.ts
@@ -47,7 +47,8 @@ export const getFollowerList = <T = UserRelation.GetFollowerListResponse>(
 /**
  * 关注用户
  * @param username 用户名
- * @param pageName 页面名称，可选
+ * @param options
+ * @param options.pageName 页面名称，可选
  */
 export const follow = <T = UserRelation.FollowResponse>(
   username: string,
@@ -66,7 +67,9 @@ export const follow = <T = UserRelation.FollowResponse>(
 /**
  * 取消关注用户
  * @param username 用户名
- * @param option 选项，可选
+ * @param options 选项，可选
+ * @param options.pageName 页面名称，可选
+ * @param options.ref 来源页面名称，可选
  */
 export const unfollow = <T = UserRelation.UnfollowResponse>(
   username: string,
diff --git a/src/api/users.ts b/src/api/users.ts
@@ -1,6 +1,6 @@
 import { getApiConfig, request, toResponse } from '../request'
-import type { EditProfilePayload } from '../types/options'
 import type { Users } from '../types/api-responses'
+import type { EditProfilePayload } from '../types/options'
 
 /**
  * 获取用户信息
@@ -66,7 +66,7 @@ export const loginWithSmsCode = <T = Users.LoginResponse>(
       json: {
         areaCode,
         mobilePhoneNumber: mobile,
-        smsCode: `${smsCode}`,
+        smsCode: String(smsCode),
       },
       headers: {
         [`x-${getApiConfig().endpointId}-access-token`]: '',
diff --git a/src/client/client.ts b/src/client/client.ts
@@ -1,32 +1,32 @@
-import { HTTPError } from 'ky'
 import EventEmitter from 'eventemitter3'
+import { HTTPError } from 'ky'
+import { ApiClient } from '../api-client'
 import {
+  resolveApiConfig,
   type ApiConfig,
   type ApiConfigResolved,
-  resolveApiConfig,
 } from '../request'
-import { ApiClient } from '../api-client'
+import { PostType, type CreatePostOption } from '../types/options'
 import { objectPick } from '../utils'
-import { type CreatePostOption, PostType } from '../types/options'
-import { isSuccess, throwRequestFailureError } from './utils/response'
-import { resolveAreaCode } from './utils/user'
-import { JikeUser } from './user'
-import {
-  type PaginatedFetcher,
-  type PaginatedOption,
-  fetchPaginated,
-} from './utils/paginate'
-import { AuthorizationError } from './errors/AuthorizationError'
-import { JikePost, JikePostWithDetail } from './post'
 import type { Api } from '../api'
 import type {
   FollowingUpdate,
   Notification,
   PersonalUpdate,
   Post,
 } from '../types/entity'
-import type { BeforeRetryState } from 'ky/distribution/types/hooks'
+import { AuthorizationError } from './errors/AuthorizationError'
+import { JikePost, JikePostWithDetail } from './post'
+import { JikeUser } from './user'
+import {
+  fetchPaginated,
+  type PaginatedFetcher,
+  type PaginatedOption,
+} from './utils/paginate'
+import { isSuccess, throwRequestFailureError } from './utils/response'
+import { resolveAreaCode } from './utils/user'
 import type { FollowingUpdatesMoreKey, JikeClientJSON } from './types'
+import type { BeforeRetryState } from 'ky/distribution/types/hooks'
 
 export interface EventMap {
   renewToken: () => void
diff --git a/src/client/index.ts b/src/client/index.ts
@@ -4,7 +4,7 @@ export { limit }
 export * from './client'
 export * from './user'
 export * from './post'
-export type { JikeClientJSON, FollowingUpdatesMoreKey } from './types'
+export type { FollowingUpdatesMoreKey, JikeClientJSON } from './types'
 export { RequestFailureError } from './errors/RequestFailureError'
 export { AuthorizationError } from './errors/AuthorizationError'
 export type { PaginatedOption } from './utils/paginate'
diff --git a/src/client/post.ts b/src/client/post.ts
@@ -1,17 +1,17 @@
-import { isSuccess, throwRequestFailureError } from './utils/response'
-import { enumTypeToRaw } from './utils/post'
-import {
-  type PaginatedFetcher,
-  type PaginatedOption,
-  fetchPaginated,
-} from './utils/paginate'
 import type { Comment, Post, User } from '../types/entity'
 import type {
   AddCommentOption,
   ListPrimaryCommentMoreKey,
   ListPrimaryCommentOption,
   PostType,
 } from '../types/options'
+import {
+  fetchPaginated,
+  type PaginatedFetcher,
+  type PaginatedOption,
+} from './utils/paginate'
+import { enumTypeToRaw } from './utils/post'
+import { isSuccess, throwRequestFailureError } from './utils/response'
 import type { JikeClient } from './client'
 
 /**
diff --git a/src/client/user.ts b/src/client/user.ts
@@ -1,13 +1,13 @@
-import { isSuccess, throwRequestFailureError } from './utils/response'
+import type { Users } from '../types/api-responses'
+import type { PersonalPost, User } from '../types/entity'
+import type { UserUnfollowOption } from '../types/options'
 import {
+  fetchPaginated,
   type PaginatedFetcher,
   type PaginatedOption,
-  fetchPaginated,
 } from './utils/paginate'
 import { rawTypeToEnum } from './utils/post'
-import type { UserUnfollowOption } from '../types/options'
-import type { PersonalPost, User } from '../types/entity'
-import type { Users } from '../types/api-responses'
+import { isSuccess, throwRequestFailureError } from './utils/response'
 import type { JikeClient } from './client'
 
 export interface FollowerWithTime {
diff --git a/src/index.ts b/src/index.ts
@@ -1,26 +1,26 @@
-import * as ApiOptions from './types/options'
 import * as ApiResponses from './types/api-responses'
 import * as Entity from './types/entity'
+import * as ApiOptions from './types/options'
 
 export { ApiOptions, ApiResponses, Entity }
 
 export type { BeforeRequestHook } from 'ky'
 
 export {
-  request,
   getAccessToken,
-  setAccessToken,
   getApiConfig,
-  setApiConfig,
+  request,
   resolveApiConfig,
+  setAccessToken,
+  setApiConfig,
 } from './request'
 export * from './api'
 export * from './api-client'
 export * from './client'
 export type {
   ApiConfig,
   ApiConfigResolved,
+  ApiFailureResponse,
   ApiResponse,
   ApiSuccessResponse,
-  ApiFailureResponse,
 } from './request'
diff --git a/src/request.ts b/src/request.ts
@@ -1,13 +1,13 @@
 import ky, {
-  type BeforeRequestHook,
   HTTPError,
+  type BeforeRequestHook,
   type Options,
   type ResponsePromise,
 } from 'ky'
-import { generateUUID } from './utils'
 import { defaultEnvironment } from './constants'
-import type { KyInstance } from 'ky/distribution/types/ky'
+import { generateUUID } from './utils'
 import type { BeforeRetryState } from 'ky/distribution/types/hooks'
+import type { KyInstance } from 'ky/distribution/types/ky'
 
 /**
  * API 配置
diff --git a/src/types/entity/notification.ts b/src/types/entity/notification.ts
diff --git a/src/types/entity/other.ts b/src/types/entity/other.ts
diff --git a/src/types/entity/user.ts b/src/types/entity/user.ts
diff --git a/src/utils/uuid.ts b/src/utils/uuid.ts
diff --git a/tests/api/upload.test.ts b/tests/api/upload.test.ts
diff --git a/tests/request.test.ts b/tests/request.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
	`1`	`+// @ts-check`
`1`	`2`	`import { sxzz } from '@sxzz/eslint-config'`
`2`	`3`
`3`		`-export default sxzz([`
	`4`	`+export default sxzz().append([`
`4`	`5`	`{`
`5`	`6`	`ignores: ['playground/', 'docs/', 'tests/deno/**'],`
`6`	`7`	`},`