dots/nvim
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

tidy up and update documentation

Browse source
This commit is contained in:
Ray Elliott 2026-01-12 19:07:25 +00:00
commit 6aeb4ae913
6 changed files with 51 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

49
CONFORM_MIGRATION.md
View file

@ -1,14 +1,15 @@
# Migration Plan: none-ls → conform.nvim
**Date:** 2026-01-12
**Status:** ✅ **COMPLETED**
**Reason:** none-ls's phpcbf formatter is buggy (adds blank lines). conform.nvim is more modern, doesn't use LSP overhead, better maintained.
## Current State
**Formatting (none-ls):**
**Formatting (conform.nvim):**
- ✅ prettier (JS/TS/CSS/JSON/HTML/Markdown)
- ✅ stylua (Lua)
- ❌ phpcbf (PHP) - broken, using custom autocmd workaround
- ✅ phpcbf (PHP) with WordPress standard
**Linting (nvim-lint):**
- phpcs, eslint_d, markdownlint
@ -19,34 +20,34 @@
## Migration Checklist
### Phase 1: Setup conform.nvim
- [ ] Create `lua/plugins/conform.lua`
- [ ] Configure formatters:
- [ ] prettier (JS/TS/CSS/JSON/HTML/Markdown)
- [ ] stylua (Lua)
- [ ] phpcbf (PHP) with WordPress standard support
- [ ] Configure format-on-save behavior
- [ ] Set up project-local executable resolution (vendor/bin, node_modules/.bin, Mason, global)
- [ ] Add keymaps for manual formatting (`<leader>lf`, `<leader>lt`)
- [x] Create `lua/plugins/conform.lua`
- [x] Configure formatters:
- [x] prettier (JS/TS/CSS/JSON/HTML/Markdown)
- [x] stylua (Lua)
- [x] phpcbf (PHP) with WordPress standard support
- [x] Configure format-on-save behavior
- [x] Set up project-local executable resolution (vendor/bin, node_modules/.bin, Mason, global)
- [x] Add keymaps for manual formatting (`<leader>lf`, `<leader>lt`)
### Phase 2: Remove none-ls
- [ ] Delete `lua/plugins/none-ls.lua`
- [ ] Remove none-ls from lazy-lock.json (happens automatically on `:Lazy sync`)
- [ ] Remove the custom phpcbf autocmd workaround (no longer needed)
- [x] Delete `lua/plugins/none-ls.lua`
- [x] Remove none-ls from lazy-lock.json (happens automatically on `:Lazy sync`)
- [x] Remove the custom phpcbf autocmd workaround (no longer needed)
### Phase 3: Testing
- [ ] Test prettier formatting (JS/TS/CSS files)
- [ ] Test stylua formatting (Lua files)
- [ ] Test phpcbf formatting (PHP files) - **verify NO blank lines added**
- [ ] Test format-on-save toggle (`<leader>lt`)
- [ ] Test manual format (`<leader>lf`)
- [ ] Test project-local formatter detection
- [ ] Verify phpcs.xml is respected when present
- [x] Test prettier formatting (JS/TS/CSS files)
- [x] Test stylua formatting (Lua files)
- [x] Test phpcbf formatting (PHP files) - **verified NO blank lines added**
- [x] Test format-on-save toggle (`<leader>lt`)
- [x] Test manual format (`<leader>lf`)
- [x] Test project-local formatter detection
- [x] Verify phpcs.xml is respected when present
### Phase 4: Documentation
- [ ] Update README.md Configuration section
- [ ] Update AGENTS.md Process section (if needed)
- [ ] Update MIGRATION_PLAN.md status
- [ ] Update LOG.md with decision and rationale
- [x] Update README.md Configuration section
- [x] Update AGENTS.md Process section (plugin list, formatting tools)
- [x] Update MIGRATION_PLAN.md status (Phase 9.2)
- [x] Update LOG.md with decision and rationale
## Expected Benefits