happyz
/
memos
mirror of https://github.com/usememos/memos.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: fix lint

This commit is contained in:
Steven 2025-04-01 20:06:54 +08:00
parent b770042a8a
commit 4f39e00868
4 changed files with 130 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/frontend-tests.yml vendored
View File

@ -24,12 +24,9 @@ jobs:
cache-dependency-path: "web/pnpm-lock.yaml" cache-dependency-path: "web/pnpm-lock.yaml"
- run: pnpm install - run: pnpm install
working-directory: web working-directory: web
- name: Run eslint check - name: Run check
run: pnpm lint run: pnpm lint
working-directory: web working-directory: web
- name: Run type checks
run: pnpm type-check
working-directory: web
frontend-build: frontend-build:
runs-on: ubuntu-latest runs-on: ubuntu-latest

169
proto/gen/apidocs.swagger.yaml
View File

@ -305,7 +305,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos." description: |-
The parent is the owner of the memos.
If not specified or `users/-`, it will list all memos.
in: query in: query
required: false required: false
type: string type: string
@ -316,12 +318,16 @@ paths:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." description: |-
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in: query in: query
required: false required: false
type: string type: string
- name: state - name: state
description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos." description: |-
The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
in: query in: query
required: false required: false
type: string type: string
@ -331,12 +337,16 @@ paths:
- ARCHIVED - ARCHIVED
default: STATE_UNSPECIFIED default: STATE_UNSPECIFIED
- name: sort - name: sort
description: "What field to sort the results by.\r\nDefault to display_time." description: |-
What field to sort the results by.
Default to display_time.
in: query in: query
required: false required: false
type: string type: string
- name: direction - name: direction
description: "The direction to sort the results by.\r\nDefault to DESC." description: |-
The direction to sort the results by.
Default to DESC.
in: query in: query
required: false required: false
type: string type: string
@ -346,12 +356,16 @@ paths:
- DESC - DESC
default: DIRECTION_UNSPECIFIED default: DIRECTION_UNSPECIFIED
- name: filter - name: filter
description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`." description: |-
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
in: query in: query
required: false required: false
type: string type: string
- name: oldFilter - name: oldFilter
description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\"" description: |-
[Deprecated] Old filter contains some specific conditions to filter memos.
Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query in: query
required: false required: false
type: string type: string
@ -396,7 +410,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: id - name: id
description: "The id of the reaction.\r\nRefer to the `Reaction.id`." description: |-
The id of the reaction.
Refer to the `Reaction.id`.
in: path in: path
required: true required: true
type: integer type: integer
@ -662,7 +678,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The resource name of the workspace setting.\r\nFormat: settings/{setting}" description: |-
The resource name of the workspace setting.
Format: settings/{setting}
in: path in: path
required: true required: true
type: string type: string
@ -684,7 +702,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: setting.name - name: setting.name
description: "name is the name of the setting.\r\nFormat: settings/{setting}" description: |-
name is the name of the setting.
Format: settings/{setting}
in: path in: path
required: true required: true
type: string type: string
@ -806,13 +826,17 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: memo.name - name: memo.name
description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid." description: |-
The name of the memo.
Format: memos/{memo}, memo is the user defined id or uuid.
in: path in: path
required: true required: true
type: string type: string
pattern: memos/[^/]+ pattern: memos/[^/]+
- name: memo - name: memo
description: "The memo to update.\r\nThe `name` field is required." description: |-
The memo to update.
The `name` field is required.
in: body in: body
required: true required: true
schema: schema:
@ -822,7 +846,9 @@ paths:
$ref: '#/definitions/v1State' $ref: '#/definitions/v1State'
creator: creator:
type: string type: string
title: "The name of the creator.\r\nFormat: users/{user}" title: |-
The name of the creator.
Format: users/{user}
createTime: createTime:
type: string type: string
format: date-time format: date-time
@ -870,7 +896,9 @@ paths:
readOnly: true readOnly: true
parent: parent:
type: string type: string
title: "The name of the parent memo.\r\nFormat: memos/{id}" title: |-
The name of the parent memo.
Format: memos/{id}
readOnly: true readOnly: true
snippet: snippet:
type: string type: string
@ -879,7 +907,9 @@ paths:
location: location:
$ref: '#/definitions/apiv1Location' $ref: '#/definitions/apiv1Location'
description: The location of the memo. description: The location of the memo.
title: "The memo to update.\r\nThe `name` field is required." title: |-
The memo to update.
The `name` field is required.
required: required:
- memo - memo
tags: tags:
@ -1075,7 +1105,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the activity.\r\nFormat: activities/{id}, id is the system generated auto-incremented id." description: |-
The name of the activity.
Format: activities/{id}, id is the system generated auto-incremented id.
in: path in: path
required: true required: true
type: string type: string
@ -1434,7 +1466,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos." description: |-
The parent is the owner of the memos.
If not specified or `users/-`, it will list all memos.
in: path in: path
required: true required: true
type: string type: string
@ -1446,12 +1480,16 @@ paths:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." description: |-
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in: query in: query
required: false required: false
type: string type: string
- name: state - name: state
description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos." description: |-
The state of the memos to list.
Default to `NORMAL`. Set to `ARCHIVED` to list archived memos.
in: query in: query
required: false required: false
type: string type: string
@ -1461,12 +1499,16 @@ paths:
- ARCHIVED - ARCHIVED
default: STATE_UNSPECIFIED default: STATE_UNSPECIFIED
- name: sort - name: sort
description: "What field to sort the results by.\r\nDefault to display_time." description: |-
What field to sort the results by.
Default to display_time.
in: query in: query
required: false required: false
type: string type: string
- name: direction - name: direction
description: "The direction to sort the results by.\r\nDefault to DESC." description: |-
The direction to sort the results by.
Default to DESC.
in: query in: query
required: false required: false
type: string type: string
@ -1476,12 +1518,16 @@ paths:
- DESC - DESC
default: DIRECTION_UNSPECIFIED default: DIRECTION_UNSPECIFIED
- name: filter - name: filter
description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`." description: |-
Filter is a CEL expression to filter memos.
Refer to `Shortcut.filter`.
in: query in: query
required: false required: false
type: string type: string
- name: oldFilter - name: oldFilter
description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\"" description: |-
[Deprecated] Old filter contains some specific conditions to filter memos.
Format: "creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query in: query
required: false required: false
type: string type: string
@ -1619,7 +1665,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to delete all tags." description: |-
The parent, who owns the tags.
Format: memos/{id}. Use "memos/-" to delete all tags.
in: path in: path
required: true required: true
type: string type: string
@ -1650,7 +1698,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to rename all tags." description: |-
The parent, who owns the tags.
Format: memos/{id}. Use "memos/-" to rename all tags.
in: path in: path
required: true required: true
type: string type: string
@ -1677,7 +1727,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: resource.name - name: resource.name
description: "The name of the resource.\r\nFormat: resources/{resource}, resource is the user defined if or uuid." description: |-
The name of the resource.
Format: resources/{resource}, resource is the user defined if or uuid.
in: path in: path
required: true required: true
type: string type: string
@ -1763,7 +1815,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user.name - name: user.name
description: "The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id." description: |-
The name of the user.
Format: users/{id}, id is the system generated auto-incremented id.
in: path in: path
required: true required: true
type: string type: string
@ -2026,7 +2080,9 @@ definitions:
properties: properties:
memo: memo:
type: string type: string
description: "The memo name of comment.\r\nRefer to `Memo.name`." description: |-
The memo name of comment.
Refer to `Memo.name`.
relatedMemo: relatedMemo:
type: string type: string
description: The name of related memo. description: The name of related memo.
@ -2088,13 +2144,17 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid." description: |-
The name of the memo.
Format: memos/{memo}, memo is the user defined id or uuid.
readOnly: true readOnly: true
state: state:
$ref: '#/definitions/v1State' $ref: '#/definitions/v1State'
creator: creator:
type: string type: string
title: "The name of the creator.\r\nFormat: users/{user}" title: |-
The name of the creator.
Format: users/{user}
createTime: createTime:
type: string type: string
format: date-time format: date-time
@ -2142,7 +2202,9 @@ definitions:
readOnly: true readOnly: true
parent: parent:
type: string type: string
title: "The name of the parent memo.\r\nFormat: memos/{id}" title: |-
The name of the parent memo.
Format: memos/{id}
readOnly: true readOnly: true
snippet: snippet:
type: string type: string
@ -2228,7 +2290,10 @@ definitions:
weekStartDayOffset: weekStartDayOffset:
type: integer type: integer
format: int32 format: int32
description: "week_start_day_offset is the week start day offset from Sunday.\r\n0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\r\nDefault is Sunday." description: |-
week_start_day_offset is the week start day offset from Sunday.
0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday
Default is Sunday.
disallowChangeUsername: disallowChangeUsername:
type: boolean type: boolean
description: disallow_change_username disallows changing username. description: disallow_change_username disallows changing username.
@ -2281,7 +2346,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: "name is the name of the setting.\r\nFormat: settings/{setting}" title: |-
name is the name of the setting.
Format: settings/{setting}
generalSetting: generalSetting:
$ref: '#/definitions/apiv1WorkspaceGeneralSetting' $ref: '#/definitions/apiv1WorkspaceGeneralSetting'
storageSetting: storageSetting:
@ -2296,7 +2363,9 @@ definitions:
description: storage_type is the storage type. description: storage_type is the storage type.
filepathTemplate: filepathTemplate:
type: string type: string
title: "The template of file path.\r\ne.g. assets/{timestamp}_{filename}" title: |-
The template of file path.
e.g. assets/{timestamp}_{filename}
uploadSizeLimitMb: uploadSizeLimitMb:
type: string type: string
format: int64 format: int64
@ -2455,11 +2524,15 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: "The name of the activity.\r\nFormat: activities/{id}" title: |-
The name of the activity.
Format: activities/{id}
readOnly: true readOnly: true
creator: creator:
type: string type: string
title: "The name of the creator.\r\nFormat: users/{user}" title: |-
The name of the creator.
Format: users/{user}
type: type:
type: string type: string
description: The type of the activity. description: The type of the activity.
@ -2721,7 +2794,9 @@ definitions:
$ref: '#/definitions/apiv1Memo' $ref: '#/definitions/apiv1Memo'
nextPageToken: nextPageToken:
type: string type: string
description: "A token, which can be sent as `page_token` to retrieve the next page.\r\nIf this field is omitted, there are no subsequent pages." description: |-
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
v1ListNode: v1ListNode:
type: object type: object
properties: properties:
@ -2810,7 +2885,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: "The name of the memo.\r\nFormat: memos/{id}" title: |-
The name of the memo.
Format: memos/{id}
uid: uid:
type: string type: string
snippet: snippet:
@ -2996,7 +3073,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: "The name of the resource.\r\nFormat: resources/{resource}, resource is the user defined if or uuid." description: |-
The name of the resource.
Format: resources/{resource}, resource is the user defined if or uuid.
readOnly: true readOnly: true
createTime: createTime:
type: string type: string
@ -3130,7 +3209,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: "The name of the user.\r\nFormat: users/{id}, id is the system generated auto-incremented id." description: |-
The name of the user.
Format: users/{id}, id is the system generated auto-incremented id.
readOnly: true readOnly: true
role: role:
$ref: '#/definitions/UserRole' $ref: '#/definitions/UserRole'
@ -3180,7 +3261,9 @@ definitions:
items: items:
type: string type: string
format: date-time format: date-time
description: "The timestamps when the memos were displayed.\r\nWe should return raw data to the client, and let the client format the data with the user's timezone." description: |-
The timestamps when the memos were displayed.
We should return raw data to the client, and let the client format the data with the user's timezone.
memoTypeStats: memoTypeStats:
$ref: '#/definitions/UserStatsMemoTypeStats' $ref: '#/definitions/UserStatsMemoTypeStats'
description: The stats of memo types. description: The stats of memo types.
@ -3189,7 +3272,9 @@ definitions:
additionalProperties: additionalProperties:
type: integer type: integer
format: int32 format: int32
title: "The count of tags.\r\nFormat: \"tag1\": 1, \"tag2\": 2" title: |-
The count of tags.
Format: "tag1": 1, "tag2": 2
pinnedMemos: pinnedMemos:
type: array type: array
items: items:

3
web/package.json
View File

@ -4,8 +4,7 @@
"dev": "vite", "dev": "vite",
"build": "vite build", "build": "vite build",
"release": "vite build --mode release --outDir=../server/router/frontend/dist --emptyOutDir", "release": "vite build --mode release --outDir=../server/router/frontend/dist --emptyOutDir",
"lint": "eslint --ext .js,.ts,.tsx, src", "lint": "tsc --noEmit --skipLibCheck && eslint --ext .js,.ts,.tsx, src",
"type-check": "tsc --noEmit --skipLibCheck",
"postinstall": "cd ../proto && buf generate" "postinstall": "cd ../proto && buf generate"
}, },
"dependencies": { "dependencies": {

2
web/src/components/MemoContent/Renderer.tsx
View File

@ -70,7 +70,7 @@ interface Props {
const Renderer: React.FC<Props> = ({ index, node }: Props) => { const Renderer: React.FC<Props> = ({ index, node }: Props) => {
switch (node.type) { switch (node.type) {
case NodeType.LINE_BREAK: case NodeType.LINE_BREAK:
return <LineBreak index={index} />; return <LineBreak />;
case NodeType.PARAGRAPH: case NodeType.PARAGRAPH:
return <Paragraph index={index} {...(node.paragraphNode as ParagraphNode)} />; return <Paragraph index={index} {...(node.paragraphNode as ParagraphNode)} />;
case NodeType.CODE_BLOCK: case NodeType.CODE_BLOCK: