Skip to content

Commit

Permalink
refactor: rename 'comet-alt' -> 'cometary'
Browse files Browse the repository at this point in the history
  • Loading branch information
usrme committed Apr 18, 2023
1 parent 90d68e6 commit 4ca831b
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
builds:
- id: comet-alt
- id: cometary
main: .
binary: comet-alt
binary: cometary
goos:
- darwin
- linux
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Comet Alt
# Cometary

An alternatively configured [Comet](https://github.com/liamg/comet) to suit my own preferences.
An alternative to [Comet](https://github.com/liamg/comet) with additional features.

![Comet Alt - animated GIF demo](examples/demo.gif)
![Cometary - animated GIF demo](examples/demo.gif)

The way I've changed the original is for it to look and feel more like [Commitizen](https://github.com/commitizen-tools/commitizen) when invoking its sub-command `commit`. My only gripe was that the start-up speed was a tad on the slow side sometimes, given that it is Python, and that customizing the prompts wasn't as straight-forward as with Comet.

Expand All @@ -15,29 +15,29 @@ Other minor changes include a fix to the prompt that asks for a commit message b
- using `go install`:

```bash
go install github.com/usrme/comet-alt@latest
go install github.com/usrme/cometary@latest
```

- download a binary from the [releases](https://github.com/usrme/comet-alt/releases) page
- download a binary from the [releases](https://github.com/usrme/cometary/releases) page

- build it yourself (requires Go 1.17+):

```bash
git clone https://github.com/usrme/comet-alt.git
cd comet-alt
git clone https://github.com/usrme/cometary.git
cd cometary
go build
```

## Removal

```bash
rm -f "${GOPATH}/bin/comet-alt"
rm -rf "${GOPATH}/pkg/mod/github.com/usrme/comet-alt*"
rm -f "${GOPATH}/bin/cometary"
rm -rf "${GOPATH}/pkg/mod/github.com/usrme/cometary*"
```

## Usage

There is an additional `comet.json` file that includes the prefixes and descriptions that I most prefer myself, which can be added to either the root of a repository, to one's home directory as `.comet.json` or to `${XDG_CONFIG_HOME}/comet-alt/config.json`. Omitting this means that the same defaults are used as in the original.
There is an additional `comet.json` file that includes the prefixes and descriptions that I most prefer myself, which can be added to either the root of a repository, to one's home directory as `.comet.json` or to `${XDG_CONFIG_HOME}/cometary/config.json`. Omitting this means that the same defaults are used as in the original.

### Setting character limits

Expand Down
2 changes: 1 addition & 1 deletion config.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ var defaultPrefixes = []list.Item{
},
}

const applicationName = "comet-alt"
const applicationName = "cometary"

func loadConfig() ([]list.Item, bool, *config, error) {
nonXdgConfigFile := ".comet.json"
Expand Down
2 changes: 1 addition & 1 deletion examples/demo.tape
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Sleep 1
Enter

# Enter program
Type "comet-alt"
Type "cometary"
Sleep 500ms
Enter
Sleep 3
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/usrme/comet-alt
module github.com/usrme/cometary

go 1.17

Expand Down

0 comments on commit 4ca831b

Please sign in to comment.