Skip to content

Commit ffdf35d

Browse files
Fix markdownlint issues in all markdown files
1 parent 6a79e2b commit ffdf35d

14 files changed

Lines changed: 77 additions & 37 deletions

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ For faster debugging, try to reproduce the issue using our minimal configuration
5757
```bash
5858
nvim --clean -u minimal-init.lua
5959
```
60-
4. Try to reproduce the issue with this minimal setup
60+
4. Try to reproduce the issue with this minimal setup

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Describe how this feature would be used and who would benefit from it.
2525

2626
## Additional Context
2727

28-
Add any other context, screenshots, or examples about the feature request here.
28+
Add any other context, screenshots, or examples about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ Add screenshots to help explain your changes if they include visual elements.
3434

3535
## Additional Notes
3636

37-
Add any other context about the PR here.
37+
Add any other context about the PR here.

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [Unreleased]
99

1010
### Added
11+
1112
- New `split_ratio` config option to replace `height_ratio` for better handling of both horizontal and vertical splits
1213

1314
### Fixed
15+
1416
- Fixed vertical split behavior when the window position is set to a vertical split command
1517

1618
## [0.4.2] - 2025-03-03
1719

1820
### Changed
21+
1922
- Moved documentation validation to a dedicated workflow for better standardization
2023

2124
### Fixed
25+
2226
- Fixed test runner not properly exiting after tests
2327
- Improved which-key handling in test environment
2428
- Fixed window focus issues in terminal split
2529

2630
## [0.4.1] - 2025-03-03
2731

2832
### Changed
33+
2934
- Improved GitHub workflows with consolidated documentation checks
3035
- Enhanced release workflow with more reliable changelog generation
3136
- Updated dependency handling in CI workflows
3237
- Refined workflow trigger conditions for better performance
3338

3439
### Fixed
40+
3541
- Fixed deprecated changelog generator in release workflow
3642
- Fixed documentation validation in CI pipeline
3743
- Resolved Markdown linting and validation issues
@@ -40,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4046
## [0.4.0] - 2025-03-02
4147

4248
### Added
49+
4350
- GitHub Discussions integration
4451
- Release automation workflow
4552
- Acknowledgements section in README
@@ -50,11 +57,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5057
- Keymap tests for custom key mappings
5158

5259
### Changed
60+
5361
- Improved README organization and structure
5462
- Standardized GitHub workflow naming conventions
5563
- Enhanced test infrastructure with accurate test counting
5664

5765
### Fixed
66+
5867
- Renamed test initialization file for consistency (minimal_init.lua → minimal-init.lua)
5968
- Test script execution in pre-commit hooks
6069
- References to test initialization files in documentation

CLAUDE.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# Project: Claude Code Plugin
22

33
## Overview
4+
45
Claude Code Plugin provides seamless integration between the Claude Code AI assistant and Neovim. It enables direct communication with the Claude Code CLI from within the editor, context-aware interactions, and various utilities to enhance AI-assisted development within Neovim.
56

67
## Essential Commands
8+
79
- Run Tests: `env -C /home/gregg/Projects/neovim/plugins/claude-code lua tests/run_tests.lua`
810
- Check Formatting: `env -C /home/gregg/Projects/neovim/plugins/claude-code stylua lua/ -c`
911
- Format Code: `env -C /home/gregg/Projects/neovim/plugins/claude-code stylua lua/`
1012
- Run Linter: `env -C /home/gregg/Projects/neovim/plugins/claude-code luacheck lua/`
1113
- Build Documentation: `env -C /home/gregg/Projects/neovim/plugins/claude-code mkdocs build`
1214

1315
## Project Structure
16+
1417
- `/lua/claude-code`: Main plugin code
1518
- `/lua/claude-code/cli`: Claude Code CLI integration
1619
- `/lua/claude-code/ui`: UI components for interactions
@@ -20,13 +23,15 @@ Claude Code Plugin provides seamless integration between the Claude Code AI assi
2023
- `/doc`: Vim help documentation
2124

2225
## Current Focus
26+
2327
- Integrating nvim-toolkit for shared utilities
2428
- Adding hooks-util as git submodule for development workflow
2529
- Enhancing bidirectional communication with Claude Code CLI
2630
- Implementing better context synchronization
2731
- Adding buffer-specific context management
2832

2933
## Multi-Instance Support
34+
3035
The plugin supports running multiple Claude Code instances, one per git repository root:
3136

3237
- Each git repository maintains its own Claude instance
@@ -37,6 +42,7 @@ The plugin supports running multiple Claude Code instances, one per git reposito
3742
- Buffer names include the git root path for easy identification
3843

3944
Example configuration to disable multi-instance mode:
45+
4046
```lua
4147
require('claude-code').setup({
4248
git = {
@@ -46,5 +52,6 @@ require('claude-code').setup({
4652
```
4753

4854
## Documentation Links
55+
4956
- Tasks: `/home/gregg/Projects/docs-projects/neovim-ecosystem-docs/tasks/claude-code-tasks.md`
50-
- Project Status: `/home/gregg/Projects/docs-projects/neovim-ecosystem-docs/project-status.md`
57+
- Project Status: `/home/gregg/Projects/docs-projects/neovim-ecosystem-docs/project-status.md`

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Instances of unacceptable behavior may be reported by contacting the project tea
3535

3636
## Attribution
3737

38-
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
38+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at [Contributor Covenant v2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

CONTRIBUTING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,20 @@ To set up a development environment:
5353

5454
1. Read the [DEVELOPMENT.md](DEVELOPMENT.md) guide to ensure you have all necessary tools installed
5555
2. Clone your fork of the repository
56-
```bash
57-
git clone https://github.com/greggh/claude-code.nvim.git
58-
```
56+
57+
```bash
58+
git clone https://github.com/greggh/claude-code.nvim.git
59+
```
5960

6061
3. Link the repository to your Neovim plugins directory or use your plugin manager's development mode
6162

6263
4. Make sure you have the Claude Code CLI tool installed and properly configured
6364

6465
5. Set up the Git hooks for automatic code formatting:
65-
```bash
66-
./scripts/setup-hooks.sh
67-
```
66+
67+
```bash
68+
./scripts/setup-hooks.sh
69+
```
6870

6971
This will set up pre-commit hooks to automatically format Lua code using StyLua before each commit.
7072

@@ -90,6 +92,7 @@ The [DEVELOPMENT.md](DEVELOPMENT.md) file contains detailed information about:
9092
We use [StyLua](https://github.com/JohnnyMorganz/StyLua) to enforce consistent formatting of the codebase. The formatting is done automatically via pre-commit hooks if you've set them up using the script provided.
9193

9294
Key style guidelines:
95+
9396
- Configuration is in `stylua.toml` at the project root
9497
- Maximum line length is 120 characters
9598
- Use 2 spaces for indentation
@@ -144,4 +147,4 @@ By contributing to Claude-Code.nvim, you agree that your contributions will be l
144147

145148
If you have any questions about contributing, please open an issue with your question.
146149

147-
Thank you for contributing to Claude-Code.nvim!
150+
Thank you for contributing to Claude-Code.nvim!

DEVELOPMENT.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,13 @@ luarocks install luacheck
134134
### Setting Up the Environment
135135

136136
1. Clone the repository:
137+
137138
```bash
138139
git clone https://github.com/greggh/claude-code.nvim.git
139140
```
140141

141142
2. Install Git hooks:
143+
142144
```bash
143145
cd claude-code.nvim
144146
./scripts/setup-hooks.sh
@@ -154,11 +156,13 @@ luarocks install luacheck
154156
### Pre-commit Hooks
155157

156158
The pre-commit hook automatically runs:
159+
157160
1. Code formatting with stylua
158161
2. Linting with luacheck
159162
3. Basic tests
160163

161164
If you need to bypass these checks, use:
165+
162166
```bash
163167
git commit --no-verify
164168
```
@@ -209,6 +213,7 @@ Understanding why we use each tool helps in appreciating their role in the devel
209213
### Neovim
210214

211215
Neovim is the primary development platform and runtime environment. We use version 0.10.0+ because it provides:
216+
212217
- Better API support for plugin development
213218
- Improved performance for larger codebases
214219
- Enhanced LSP integration
@@ -217,6 +222,7 @@ Neovim is the primary development platform and runtime environment. We use versi
217222
### StyLua
218223

219224
StyLua is a Lua formatter specifically designed for Neovim configurations. It:
225+
220226
- Ensures consistent code style across all contributors
221227
- Formats according to Lua best practices
222228
- Handles Neovim-specific formatting conventions
@@ -227,6 +233,7 @@ Our configuration uses 2-space indentation and 100-character line length limits.
227233
### LuaCheck
228234

229235
LuaCheck is a static analyzer that helps catch issues before they cause problems:
236+
230237
- Identifies syntax errors and semantic issues
231238
- Flags unused variables and unused function parameters
232239
- Detects global variable access without declaration
@@ -238,6 +245,7 @@ We configure LuaCheck with `.luacheckrc` files that define project-specific glob
238245
### Ripgrep & FD
239246

240247
These tools improve development efficiency:
248+
241249
- **Ripgrep**: Extremely fast code searching to find patterns and references
242250
- **FD**: Fast alternative to `find` for locating files in complex directory structures
243251

@@ -250,7 +258,9 @@ These tools improve development efficiency:
250258

251259
All our Neovim projects follow a similar structure:
252260

261+
```plaintext
253262
```
263+
254264
.
255265
├── .github/ # GitHub-specific files and workflows
256266
├── .githooks/ # Git hooks for pre-commit validation
@@ -259,10 +269,16 @@ All our Neovim projects follow a similar structure:
259269
├── test/ # Basic test modules
260270
├── tests/ # Extended test suites
261271
├── .luacheckrc # LuaCheck configuration
272+
273+
```plaintext
274+
```
275+
262276
├── .stylua.toml # StyLua configuration
263277
├── Makefile # Common commands
264278
├── CHANGELOG.md # Project version history
265279
└── README.md # Project overview
280+
281+
```plaintext
266282
```
267283

268284
## Troubleshooting
@@ -272,14 +288,15 @@ All our Neovim projects follow a similar structure:
272288
- **stylua not found**: Make sure it's installed and in your PATH
273289
- **luacheck errors**: Run `make lint` to see specific issues
274290
- **Test failures**: Use `make test-verbose` for detailed output
275-
- **Module not found errors**: Check that you're using the correct module name and path
291+
- **Module not found errors**: Check that you're using the correct module name and path
276292
- **Plugin functionality not loading**: Verify your Neovim version is 0.10.0 or higher
277293

278294
### Getting Help
279295

280296
If you encounter issues:
297+
281298
1. Check the error messages carefully
282299
2. Verify all dependencies are correctly installed
283300
3. Check that your Neovim version is 0.10.0 or higher
284301
4. Review the project's issues on GitHub for similar problems
285-
5. Open a new issue with detailed reproduction steps if needed
302+
5. Open a new issue with detailed reproduction steps if needed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
<div align="center">
2-
31
# Claude Code Neovim Plugin
42

53
[![GitHub License](https://img.shields.io/github/license/greggh/claude-code.nvim?style=flat-square)](https://github.com/greggh/claude-code.nvim/blob/main/LICENSE)
@@ -13,17 +11,15 @@
1311

1412
*A seamless integration between [Claude Code](https://github.com/anthropics/claude-code) AI assistant and Neovim*
1513

16-
[Features](#features)
17-
[Requirements](#requirements)
18-
[Installation](#installation)
19-
[Configuration](#configuration)
20-
[Usage](#usage)
21-
[Contributing](#contributing)
14+
[Features](#features)
15+
[Requirements](#requirements)
16+
[Installation](#installation)
17+
[Configuration](#configuration)
18+
[Usage](#usage)
19+
[Contributing](#contributing)
2220
[Discussions](https://github.com/greggh/claude-code.nvim/discussions)
2321

24-
<img src="https://github.com/greggh/claude-code.nvim/blob/main/assets/claude-code.png?raw=true" alt="Claude Code in Neovim" width="800" />
25-
26-
</div>
22+
![Claude Code in Neovim](https://github.com/greggh/claude-code.nvim/blob/main/assets/claude-code.png?raw=true)
2723

2824
This plugin was built entirely with Claude Code in a Neovim terminal, and then inside itself using Claude Code for everything!
2925

@@ -120,7 +116,7 @@ require("claude-code").setup({
120116
-- Conversation management
121117
continue = "--continue", -- Resume the most recent conversation
122118
resume = "--resume", -- Display an interactive conversation picker
123-
119+
124120
-- Output options
125121
verbose = "--verbose", -- Enable verbose logging with full turn-by-turn output
126122
},
@@ -209,7 +205,7 @@ This plugin:
209205
4. Provides convenient keymaps and commands for toggling the terminal
210206
5. Automatically detects git repositories and sets working directory to the git root
211207

212-
## Contributing
208+
## Contributing
213209

214210
Contributions are welcome! Please check out our [contribution guidelines](CONTRIBUTING.md) for details on how to get started.
215211

@@ -264,6 +260,4 @@ make format
264260

265261
---
266262

267-
<div align="center">
268-
<p>Made with ❤️ by <a href="https://github.com/greggh">Gregg Housh</a></p>
269-
</div>
263+
Made with ❤️ by [Gregg Housh](https://github.com/greggh)

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ If you have feature requests or would like to contribute to the roadmap, please:
6565
2. If not, open a new issue with the "enhancement" label
6666
3. Explain how your idea would improve the Claude Code plugin experience
6767

68-
We welcome community contributions to help achieve these goals! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute.
68+
We welcome community contributions to help achieve these goals! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute.

0 commit comments

Comments
 (0)