mirror of
https://github.com/ivuorinen/nvim-shellspec.git
synced 2026-01-26 11:34:04 +00:00
chore: fix formatting and linting issues
This commit is contained in:
@@ -1,6 +1,7 @@
|
|||||||
# Development Commands
|
# Development Commands
|
||||||
|
|
||||||
## Key Make Targets
|
## Key Make Targets
|
||||||
|
|
||||||
- `make help` - Show all available targets with descriptions
|
- `make help` - Show all available targets with descriptions
|
||||||
- `make check` - Quick health check (tools and version consistency)
|
- `make check` - Quick health check (tools and version consistency)
|
||||||
- `make test` - Run complete test suite
|
- `make test` - Run complete test suite
|
||||||
@@ -11,6 +12,7 @@
|
|||||||
- `make dev-setup` - Set up development environment
|
- `make dev-setup` - Set up development environment
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
- `make test-unit` - Lua unit tests only
|
- `make test-unit` - Lua unit tests only
|
||||||
- `make test-integration` - Integration tests
|
- `make test-integration` - Integration tests
|
||||||
- `make test-golden` - Golden master tests
|
- `make test-golden` - Golden master tests
|
||||||
@@ -18,6 +20,7 @@
|
|||||||
- Test runner: `./tests/run_tests.sh`
|
- Test runner: `./tests/run_tests.sh`
|
||||||
|
|
||||||
## Linting
|
## Linting
|
||||||
|
|
||||||
- Uses pre-commit hooks
|
- Uses pre-commit hooks
|
||||||
- ShellCheck for shell scripts
|
- ShellCheck for shell scripts
|
||||||
- StyLua for Lua formatting
|
- StyLua for Lua formatting
|
||||||
@@ -26,6 +29,7 @@
|
|||||||
- shfmt for shell script formatting
|
- shfmt for shell script formatting
|
||||||
|
|
||||||
## Version Management
|
## Version Management
|
||||||
|
|
||||||
- Three files must stay in sync:
|
- Three files must stay in sync:
|
||||||
- `lua/shellspec/init.lua` (M._VERSION)
|
- `lua/shellspec/init.lua` (M._VERSION)
|
||||||
- `plugin/shellspec.vim` (g:shellspec_version)
|
- `plugin/shellspec.vim` (g:shellspec_version)
|
||||||
|
|||||||
@@ -1,15 +1,18 @@
|
|||||||
# Release Process
|
# Release Process
|
||||||
|
|
||||||
## Command
|
## Command
|
||||||
|
|
||||||
Always use `make release` for releases, not manual version bumping.
|
Always use `make release` for releases, not manual version bumping.
|
||||||
|
|
||||||
## Available Release Commands
|
## Available Release Commands
|
||||||
|
|
||||||
- `make release` - Interactive release with menu (patch/minor/major)
|
- `make release` - Interactive release with menu (patch/minor/major)
|
||||||
- `make release-patch` - Bump patch version (X.Y.Z → X.Y.Z+1)
|
- `make release-patch` - Bump patch version (X.Y.Z → X.Y.Z+1)
|
||||||
- `make release-minor` - Bump minor version (X.Y.Z → X.Y+1.0)
|
- `make release-minor` - Bump minor version (X.Y.Z → X.Y+1.0)
|
||||||
- `make release-major` - Bump major version (X.Y.Z → X+1.0.0)
|
- `make release-major` - Bump major version (X.Y.Z → X+1.0.0)
|
||||||
|
|
||||||
## What make release does:
|
## What make release does
|
||||||
|
|
||||||
1. Checks git status is clean
|
1. Checks git status is clean
|
||||||
2. Verifies version consistency across files
|
2. Verifies version consistency across files
|
||||||
3. Runs complete test suite
|
3. Runs complete test suite
|
||||||
@@ -24,4 +27,5 @@ Always use `make release` for releases, not manual version bumping.
|
|||||||
9. Provides next steps for pushing
|
9. Provides next steps for pushing
|
||||||
|
|
||||||
## Manual Process (DO NOT USE)
|
## Manual Process (DO NOT USE)
|
||||||
|
|
||||||
The old manual process was error-prone and didn't update all version files consistently.
|
The old manual process was error-prone and didn't update all version files consistently.
|
||||||
Reference in New Issue
Block a user