feat(init): add main package and command execution #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduce main package and cmd package for command execution in gic. - Rename `cmd/gic/main.go` to `cmd/root.go` for a clearer command structure. - Add command execution logic and persistent flags. chore(devcontainer): update devcontainer settings - Update `.devcontainer/devcontainer.json` with Golang tooling settings and editor preferences. - Minor cleanup and commenting out unnecessary lines. chore(gitignore): update gitignore rules - Add `gic` to `.gitignore` to prevent tracking of the binary. ci(linter): enable revive linter - Update `.golangci.yml` to include `revive` linter. refactor(modules): update go module references - Change module reference from `github.com/jsburckhardt/gic` to `gic`. - Adjust dependencies in `go.mod` accordingly. docs(goreleaser): comment out go generate step - Comment out the `go generate` step in `.goreleaser.yaml`. test(git): update import paths in git tests - Adjust import paths in `internal/git/git_test.go` to match the updated module structure.
- Added package-level documentation to clarify the purpose and functionality of the `cli`, `config`, `git`, and `llm` packages. - Documented functions in the `cli`, `config`, `git`, and `llm` packages for better code understanding and maintainability. - Corrected capitalization in `config.Config` struct and relevant functions. Add new `fmt` target to Makefile for code formatting.
- Added package-level documentation for `cmd` package. - Documented `Execute` function in `cmd/root.go`. - Added documentation for functions `GenerateCommitMessageAzure`, `GenerateCommitMessageAzureAD`, and `GenerateCommitMessageOpenAI` in `llm.go`. No functionality changes, purely documentation updates.
The CI workflow `ci.yaml` now specifies that the test job requires the lint job to complete first. refactor(config): improve code readability and maintainability - Introduced constants for emptyString, zeroTokens, and defaultTokens. - Adjusted functions to use these constants where applicable. - Validation functions now have improved logging. refactor(root): simplify command execution and error handling - Introduced a new constant for exitCodeFailure. - Refactored the root command to remove unnecessary variable declarations and use more concise logic. - Updated error handling to use log.Fatal for more consistent behavior. refactor(cli): handle errors in LoadEnv function The `LoadEnv` function now returns an error instead of causing a fatal log. fix(linter): update colored output format Changed the output format of the linter to use `colored-tab` instead of `colored-line-number`. feat(linter): enforce maximum line length of 120 characters Added a new rule to the `revive` linter settings to enforce a maximum line length of 120 characters. fix(llm): handle empty git diff in commit message generation The `GenerateCommitMessage` function now correctly handles cases where there are no staged changes.
Refactor the root command's execution to handle errors gracefully instead of using log.Fatal. Update the function signature to return an error for better error propagation. Additionally, simplify file paths in launch configuration. Related to error handling improvements and general code cleanliness.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cmd/gic/main.gotocmd/root.gofor a clearer command structure.chore(devcontainer): update devcontainer settings
.devcontainer/devcontainer.jsonwith Golang tooling settings and editor preferences.chore(gitignore): update gitignore rules
gicto.gitignoreto prevent tracking of the binary.ci(linter): enable revive linter
.golangci.ymlto includerevivelinter.refactor(modules): update go module references
github.com/jsburckhardt/gictogic.go.modaccordingly.docs(goreleaser): comment out go generate step
go generatestep in.goreleaser.yaml.test(git): update import paths in git tests
internal/git/git_test.goto match the updated module structure.