mirror of
https://gitea.com/gitea/docs.git
synced 2026-07-21 18:27:41 +00:00
Add wrong submittion doc (#16)
copied from https://github.com/go-gitea/gitea/pull/31521/files#diff-9b5d4cdddaeeb1b9a0f6aab7ea1964c5e59c7823d9966229c387a3f6a107b9c6 Contributor: @silverwind Reviewed-on: https://gitea.com/gitea/docs/pulls/16 Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
This commit is contained in:
committed by
techknowlogick
parent
81d1f77b2d
commit
ac6de8756f
@@ -1,6 +1,5 @@
|
|||||||
---
|
---
|
||||||
date: "2021-10-13T16:00:00+02:00"
|
date: "2021-10-13T16:00:00+02:00"
|
||||||
title: "Guidelines for Frontend Development"
|
|
||||||
slug: "guidelines-frontend"
|
slug: "guidelines-frontend"
|
||||||
sidebar_position: 30
|
sidebar_position: 30
|
||||||
aliases:
|
aliases:
|
||||||
@@ -71,6 +70,22 @@ We use htmx for simple interactions. You can see an example for simple interacti
|
|||||||
Although mixing different frameworks is discouraged,
|
Although mixing different frameworks is discouraged,
|
||||||
it should also work if the mixing is necessary and the code is well-designed and maintainable.
|
it should also work if the mixing is necessary and the code is well-designed and maintainable.
|
||||||
|
|
||||||
|
### Typescript
|
||||||
|
|
||||||
|
Gitea is in the process of migrating to type-safe Typescript. Here are some specific guidelines regarding Typescript in the codebase:
|
||||||
|
|
||||||
|
#### Use type aliases instead of interfaces
|
||||||
|
|
||||||
|
Prefer to use type aliases because they can represent any type and are generally more flexible to use than interfaces.
|
||||||
|
|
||||||
|
#### Use separate type imports
|
||||||
|
|
||||||
|
We use `verbatimModuleSyntax` so type and non-type imports from the same file must be split into two `import type` statements. This enables the typescript compiler to completely eliminate the type import statements during compilation.
|
||||||
|
|
||||||
|
#### Use `@ts-expect-error` instead of `@ts-ignore`
|
||||||
|
|
||||||
|
Both annotations should be avoided, but if you have to use them, use `@ts-expect-error` because it will not leave ineffective statements after the issue is fixed.
|
||||||
|
|
||||||
### `async` Functions
|
### `async` Functions
|
||||||
|
|
||||||
Only mark a function as `async` if and only if there are `await` calls
|
Only mark a function as `async` if and only if there are `await` calls
|
||||||
|
|||||||
Reference in New Issue
Block a user