Add formatting tools and configs#223
Merged
Merged
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces project-wide formatting and linting configurations, including the addition of oxfmt for Markdown, JSON, and YAML files. It also adds VS Code workspace settings, recommended extensions, and updates configuration files like .editorconfig and .gitignore to support the new tooling. Feedback was provided regarding the VS Code settings, specifically suggesting the use of the standard golangci-lint binary name instead of golangci-lint-v2 to ensure environment compatibility for all contributors.
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
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.
Setup formatting tools and configs.
Formatting and Editor Configuration
.editorconfigto set specific formatting rules for different file types, such as maximum line length for Markdown files, single quotes for YAML, and 2-space indentation for YAML, shell, and JSON files..oxfmtrc.jsonto enforce Markdown line wrapping and includedoxfmtas a development dependency inpackage.jsonfor formatting support. [1] [2].vscode/extensions.jsonto recommend Go and Oxc extensions, and.vscode/settings.jsonto configure Go linting/formatting tools and set Oxc as the default formatter for Markdown, YAML, JSON, and JSONC files. [1] [2].golangci.ymlto use single quotes for the version field for consistency.Documentation Improvements
README.mdto wrap lines at 80 characters, improving readability and consistency, and updated command and configuration documentation for clarity. [1] [2] [3] [4] [5]Workflow and Dependency Updates