mirror of
https://gitea.com/gitea/tea.git
synced 2026-10-26 11:01:25 +01:00
revert: tea 1.0 rewrite (#1122–#1126) (#1146)
Reverts #1126, #1125, #1124, #1123 and #1122. `go.mod` keeps the Go 1.26 line with toolchain `go1.26.9` (instead of the original `go1.26.6`) so the security fix from #1131 isn't lost. reopens #69 reopens #141 reopens #162 reopens #172 reopens #197 reopens #232 reopens #240 reopens #246 reopens #323 reopens #325 reopens #326 reopens #328 reopens #344 reopens #351 reopens #373 reopens #403 reopens #406 reopens #417 reopens #430 reopens #457 reopens #480 reopens #482 reopens #489 reopens #490 reopens #498 reopens #500 reopens #504 reopens #510 reopens #516 reopens #523 reopens #556 reopens #560 reopens #569 reopens #571 reopens #602 reopens #632 reopens #633 reopens #643 reopens #666 reopens #670 reopens #672 reopens #677 reopens #683 reopens #697 reopens #726 reopens #737 reopens #770 reopens #779 reopens #804 reopens #817 reopens #831 reopens #833 reopens #834 reopens #908 reopens #966 reopens #1023 reopens #1029 reopens #1032 reopens #1050 reopens #1052 reopens #1069 reopens #1073 reopens #1087 reopens #1091 reopens #1094 reopens #1110 reopens #1115 reopens #1116 reopens #1118 Reviewed-on: https://gitea.com/gitea/tea/pulls/1146 Reviewed-by: TheFox0x7 <95654+thefox0x7@noreply.gitea.com>
This commit is contained in:
1 parent
33bb12729e
commit
c5f674111a
604 files changed
+33711
-35545
No files matched your search
+36
-51
@@ -56,27 +56,9 @@ high-level discussions.
|
||||
|
||||
## Testing redux
|
||||
|
||||
Before sending code out for review, run the unit tests with `make test`.
|
||||
Before sending code out for review, run all the test by executing: `make test`
|
||||
Since TEA is an cli tool it should be obvious to test your feature locally first.
|
||||
|
||||
Tests live beside the packages they exercise. `make integration-test` runs the
|
||||
`TestGitea*` tests against a disposable Gitea instance with an administrator
|
||||
account named `integration` and a reviewer named `tea-reviewer`. Never point
|
||||
these tests at a production instance: they create and delete resources.
|
||||
|
||||
```sh
|
||||
GITEA_TEA_TEST_URL=http://127.0.0.1:3000 \
|
||||
GITEA_TEA_TEST_TOKEN_FILE=/private/path/admin-token \
|
||||
GITEA_TEA_TEST_REVIEWER_TOKEN_FILE=/private/path/reviewer-token \
|
||||
make integration-test
|
||||
```
|
||||
|
||||
Token files contain scoped PATs for their accounts and should be `0600`;
|
||||
`scripts/integration-tokens.py` creates them for the CI accounts. Optional
|
||||
coverage is enabled by `GITEA_TEA_TEST_REPOSITORY_ROOT` (the server's repository
|
||||
root, with `[repository] IMPORT_LOCAL_PATHS = true`, for migration) and
|
||||
`GITEA_TEA_TEST_SSH_ENDPOINT` (an SSH clone endpoint).
|
||||
|
||||
## Code review
|
||||
|
||||
Changes to TEA must be reviewed before they are accepted—no matter who
|
||||
@@ -99,49 +81,52 @@ Some of the key points:
|
||||
## Styleguide
|
||||
|
||||
### Commands
|
||||
- Subcommands should follow the following structure:
|
||||
```
|
||||
tea <noun> <verb> [<noun>] [<flags>]
|
||||
```
|
||||
|
||||
Use explicit singular noun/verb commands, such as `tea issue list` and
|
||||
`tea pr create`. Bare command groups show help. Commands validate input, collect
|
||||
missing fields when the shared prompting policy permits it, invoke services, and
|
||||
render results through injected streams. Destructive commands require confirmation
|
||||
or `--yes`; `--no-input` disables implicit interaction. JSON results go to stdout;
|
||||
diagnostics and prompts go to stderr. Lists register `--limit`/`--page` with
|
||||
`pageFlags` and print through `writeList`, which renders one `terminal.Table`
|
||||
(ID or number first, then title or name, then state) through the pager.
|
||||
for example:
|
||||
|
||||
### Internal Package Structure
|
||||
```
|
||||
tea issues list
|
||||
tea pulls create
|
||||
tea teams add user --team x --user y
|
||||
```
|
||||
- Commands should accept nouns as singular & plural by making use of the `Aliases` field.
|
||||
- The default action without a verb is `list`.
|
||||
- There is a standard set of verbs: `list/ls`, `create`, `edit`, `delete`
|
||||
- `ls` lists objects with filter options, and applies pagination where available.
|
||||
- `delete` should show info what is deleted and ask user again, if force flag`-y` is not set
|
||||
- Verbs that accept large numbers of flags provide an interactive mode when called without any arguments or flags.
|
||||
- Try to reuse as many flag definitions as possible, see `cmd/flags/flags.go`.
|
||||
- Always make sure that the help texts are properly set, and as concise as possible.
|
||||
|
||||
- `internal/app`: Cobra commands and application dependency construction.
|
||||
- `internal/services`: typed workflows over `gitea.dev/sdk`, independent of CLI flags
|
||||
and terminal I/O, including pagination policy. Services map SDK types to tea's
|
||||
output types; requests the SDK cannot make yet go through the raw helpers in
|
||||
`raw.go`, each marked `TODO(sdk)` with the missing SDK piece.
|
||||
- `internal/settings`: split configuration, validation, persistence, target resolution,
|
||||
and remote URL parsing.
|
||||
- `internal/auth`: secure credentials and OAuth lifecycle.
|
||||
- `internal/transport`: the tea HTTP client shared by the SDK and raw requests: TLS,
|
||||
timeouts, User-Agent, `--debug`, retries, token, Sudo and SSH-signature
|
||||
authentication, and sanitised API errors. Its raw requests serve `tea api`, signed
|
||||
downloads and log streaming.
|
||||
- `internal/git`: repository discovery and cancellable Git subprocesses.
|
||||
- `internal/terminal`: streams, input, editor, browser, and rendering.
|
||||
- `internal/clierr`: typed errors and executable exit codes.
|
||||
- `internal/aliases`: user command alias expansion.
|
||||
- `internal/filelock`: cross-process locks for configuration writes.
|
||||
- `internal/version`: build version metadata.
|
||||
|
||||
Unit and integration tests live beside their packages; see [Testing redux](#testing-redux).
|
||||
### Internal Module Structure
|
||||
- `cmd`: only contains command/flag options for `urfave/cli`
|
||||
- subcommands are in a subpackage named after its parent command
|
||||
- `modules/task`: contain func for doing something with gitea
|
||||
(e.g. create token by user/passwd)
|
||||
- `modules/print`: contain all functions that print to stdout
|
||||
- `modules/config`: config tea & login things
|
||||
- `modules/interact`: contain functions to interact with user by prompts
|
||||
- `modules/git`: do git related stuff (get info/push/pull/checkout/...)
|
||||
- `modules/utils`: helper functions used by other functions
|
||||
|
||||
### Code Style
|
||||
Use `make fmt`, check with `make lint`.
|
||||
Group imports into the standard library, then all other packages (local and
|
||||
external) in one sorted block, as gofumpt keeps them:
|
||||
For imports you should use the following format (_without_ the comments)
|
||||
```go
|
||||
import (
|
||||
// stdlib
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
"gitea.dev/tea/internal/services"
|
||||
// local packages
|
||||
"code.gitea.io/gitea/models"
|
||||
"gitea.dev/sdk"
|
||||
|
||||
// external packages
|
||||
"github.com/foo/bar"
|
||||
"gopkg.io/baz.v1"
|
||||
)
|
||||
|
||||
Reference in new issue
Block a user