graphql-go / graphql-go/compatibility-base

TODOs

Open
#3 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

#### TODOs
- [ ] https://github.com/graphql-go/compatibility-base/issues/34
- [ ] https://github.com/graphql-go/compatibility-base/issues/33
- [ ] https://github.com/graphql-go/compatibility-base/issues/30
- [x] https://github.com/graphql-go/compatibility-base/issues/29
- [x] https://github.com/graphql-go/compatibility-base/issues/26
- [ ] https://github.com/graphql-go/compatibility-base/issues/28
- [ ] Adds code comments to `types/*`.
- [ ] https://github.com/graphql-go/compatibility-base/issues/10.
- [ ] Isolate `ChoicesModel` into its own file: `bubbletea/choicesmodel.go`: https://github.com/graphql-go/compatibility-base/issues/15.
- [ ] Remove unused git branches.
- [ ] https://github.com/graphql-go/compatibility-base/issues/12

***
- [ ] Replace the following comments:
- `// Params represents the parameters for the `NewBubbleTea` function.` to `// Params represents the parameters for the `New` function.`
- `// baseStyle is the base styling of the BubbleTea component.` to `// baseStyle is the base styling of the ChoicesModel struct.`.
- ` // BaseStyle is the base styling parameter of the BubbleTea component.` to `// BaseStyle is the base styling parameter of the ChoicesModel component.`

File `bubbletea/bubbletea.go`:
```diff
-// BubbleTea represents the CLI component that wraps the `bubbletea` library.
+// BubbleTea represents the CLI component that wraps the external `bubbletea` go pkg.
```
***

- [ ] Add code comments:
- `ChoicesModel.WithBaseStyle`.

- [ ] Use tildes `` for the identifiers in the code blocks, Eg. From TableHeader to `TableHeader`, so it is clearer that when reading the code comment that identifier exists in the code base and also is simpler for code analyzers to index it.

- [ ] Updates the code comments in the following file: `bubbletea/bubbletea.go` of the following structs: `ChoicesModel`, `ChoicesModel.ui`.

***
File `bubbletea/bubbletea.go`:
Rename `TableModel.Run` to `TableModel.Resolve`

***

#### ChoicesModel View Update

**Issue:** https://github.com/graphql-go/compatibility-base/issues/22

##### Actual

Currently when running `./bin/dev.sh`, it shows a text message we want to update: **"(press q to quit)"**.

```
(base) chris@chris:~/Projects/graphql-compatibility/compatibility-base$ ./bin/dev.sh
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ Reference Implementation: https://github.com/graphql/graphql-js/releases/tag/v0.6.0 │
│ (•) Implementation: https://github.com/graphql-go/graphql/releases/tag/v0.8.1 │
│ │
│ │
│ (press q to quit) │
│ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```

##### Expected

Let's update the last message from: **"(press q to quit)"** to **"(press enter to continue)"**.

In order to tell library users that they can continue the program workflow by pressing enter.

```
(base) chris@chris:~/Projects/graphql-compatibility/compatibility-base$ ./bin/dev.sh
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ Reference Implementation: https://github.com/graphql/graphql-js/releases/tag/v0.6.0 │
│ (•) Implementation: https://github.com/graphql-go/graphql/releases/tag/v0.8.1 │
│ │
│ │
│ (press enter to continue) │
│ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```

***

#### TableModel View Update

Issue: https://github.com/graphql-go/compatibility-base/issues/24

##### Actual

Currently when running `./bin/dev.sh` the `TableModel` shows the following text:

```
(base) chris@chris:~/Projects/graphql-compatibility/compatibility-base$ ./bin/dev.sh
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ Metric Spec: https://… Impl: https://… Diff Ratio Max Diff Result │
│ ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── │
│ GitHub: │
│ License MIT MIT 0% 0% ✅ │
│ Number Of Stars Loading... Loading... Loading... Loading... Loading... │
│ Number Of Issues Open Loading... Loading... Loading... Loading... Loading... │
│ Number Of Issues Closed Loading... Loading... Loading... Loading... Loading... │
│ Number Of Pull Requests Open Loading... Loading... Loading... Loading... Loading... │
│ Number Of Pull Requests Closed Loading... Loading... Loading... Loading... Loading... │
│ Number Of Forks Loading... Loading... Loading... Loading... Loading... │
│ Last Commit Date Loading... Loading... Loading... Loading... Loading... │
│ Number Of Contributors Loading... Loading... Loading... Loading... Loading... │
│ GraphQL Compatibility Keywords: │
│ Number Of Comments Open Loading... Loading... Loading... Loading... Loading... │
│ Number Of Comments Closed Loading... Loading... Loading... Loading... Loading... │
│ GraphQL: │
│ Specification Version Loading... Loading... Loading... Loading... Loading... │
│ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```

##### Expected

We want to show the text: **(press enter to continue)** at the end of the current text.

In order to tell library users that they can continue the program workflow by pressing enter.

```
(base) chris@chris:~/Projects/graphql-compatibility/compatibility-base$ ./bin/dev.sh
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ Metric Spec: https://… Impl: https://… Diff Ratio Max Diff Result │
│ ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── │
│ GitHub: │
│ License MIT MIT 0% 0% ✅ │
│ Number Of Stars Loading... Loading... Loading... Loading... Loading... │
│ Number Of Issues Open Loading... Loading... Loading... Loading... Loading... │
│ Number Of Issues Closed Loading... Loading... Loading... Loading... Loading... │
│ Number Of Pull Requests Open Loading... Loading... Loading... Loading... Loading... │
│ Number Of Pull Requests Closed Loading... Loading... Loading... Loading... Loading... │
│ Number Of Forks Loading... Loading... Loading... Loading... Loading... │
│ Last Commit Date Loading... Loading... Loading... Loading... Loading... │
│ Number Of Contributors Loading... Loading... Loading... Loading... Loading... │
│ GraphQL Compatibility Keywords: │
│ Number Of Comments Open Loading... Loading... Loading... Loading... Loading... │
│ Number Of Comments Closed Loading... Loading... Loading... Loading... Loading... │
│ GraphQL: │
│ Specification Version Loading... Loading... Loading... Loading... Loading... │
│ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

(press enter to continue)

```

***

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.