Skip to content

Commit a4d0f7c

Browse files
committed
docs(vim-openvox): major honesty and completeness pass
- Added clear 'Current Status' section in doc/openvox.txt - Added 'Differences from vim-puppet' section - Updated introduction and style guide claims to match reality + ongoing port - README: Made 'Replacing Other Plugins' table accurate and added status note - Removed overpromises on indentation/alignment while highlighting active improvements Part of the full gold-standard alignment effort. Assisted By: Grok AI (Sonny)
1 parent bbf3c5e commit a4d0f7c

2 files changed

Lines changed: 45 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ plugins with a single, cohesive solution built around the official
99
| Feature | Description |
1010
|---------|-------------|
1111
| **Syntax Highlighting** | Full Puppet 8 language — resource types, 90+ built-in functions, data types, heredocs, string interpolation, regex, operators, EPP templates |
12-
| **Indentation** | 2-space soft tabs with improved resource/conditional handling (actively being aligned to gold-standard vim-puppet behavior) |
13-
| **openvox-lint** | Async linting with puppet-lint (preferred) + openvox-lint, quickfix + signs, auto-fix |
12+
| **Indentation** | 2-space soft tabs with significantly improved resource and conditional handling (actively ported toward gold-standard vim-puppet behavior) |
13+
| **Arrow Alignment** | Manual + block alignment for `=>` (improved safety against strings/comments) |
1414
| **metadata-json-lint** | Validates module `metadata.json` files |
1515
| **yamllint** | Lints Hiera YAML data files |
1616
| **Omni-completion** | Context-aware completion for types, attributes, functions, variables, ensure values |
@@ -118,15 +118,16 @@ let g:openvox_fold = 1
118118

119119
## Replacing Other Plugins
120120

121-
vim-openvox is designed to replace:
121+
vim-openvox aims to be a strong modern replacement. Current replacement quality:
122122

123-
| Old Plugin | vim-openvox Replacement |
124-
|------------|----------------------|
125-
| `puppet-syntax-vim` / `vim-puppet` (rodjek) | Full syntax, indent, ftdetect, ftplugin |
126-
| `vim-puppet-lint` | Async puppet-lint + quickfix |
127-
| Syntastic (puppet checker) | Async puppet-lint + puppet validate |
128-
| ALE (puppet linters) | puppet-lint, metadata-json-lint, yamllint |
129-
| Tabular / vim-easy-align (for `=>`) | Built-in arrow alignment |
123+
| Old Plugin | Replacement Quality in vim-openvox | Notes |
124+
|-----------------------------|-----------------------------------------------------|-------|
125+
| `puppet-syntax-vim` / rodjek/vim-puppet | Good (syntax, folding, basic indent) | Indent & alignment still being hardened to full gold-standard level |
126+
| `vim-puppet-lint` + Syntastic/ALE | Excellent (async, multi-linter, fix, signs) | One of the strongest parts |
127+
| Tabular / vim-easy-align | Good (manual + block alignment) | Safer now (skips strings/comments) |
128+
| Various snippet plugins | Basic boilerplate generators | Good starting point; pair with UltiSnips/LuaSnip if desired |
129+
130+
Full feature parity on indent/alignment with the gold-standard vim-puppet is the current active focus.
130131

131132
To disable old plugins with Pathogen:
132133
```vim

doc/openvox.txt

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ vim-openvox is a comprehensive Puppet IDE plugin for Vim that provides:
2929

3030
- Full Puppet 8 syntax highlighting (resource types, functions, data types,
3131
operators, heredocs, interpolation, EPP templates)
32-
- Style-guide-compliant indentation (2-space soft tabs, arrow alignment)
32+
- 2-space soft tabs with improving resource/conditional indentation (actively being aligned to gold-standard behavior)
3333
- Async linting via puppet-lint, metadata-json-lint, and yamllint
3434
- Context-aware omni-completion (Ctrl-X Ctrl-O)
3535
- Code navigation (go-to-definition, block jumping)
@@ -42,6 +42,39 @@ It is designed to replace multiple Puppet-related plugins with a single,
4242
cohesive solution following the official Puppet Style Guide:
4343
https://help.puppet.com/core/8/Content/PuppetCore/style_guide.htm
4444

45+
CURRENT STATUS *openvox-status*
46+
47+
vim-openvox is under active development toward gold-standard quality
48+
(closely tracking the battle-tested vim-puppet plugin).
49+
50+
Current state (as of v0.9+):
51+
- Excellent: Syntax, async linting (puppet-lint + others), completion,
52+
navigation, snippets/boilerplate, EPP support.
53+
- Good & improving rapidly: Indentation and arrow alignment (major
54+
refactors have been applied to match vim-puppet behavior).
55+
- Documentation is being brought into alignment with actual behavior.
56+
57+
For the absolute latest on indent/alignment robustness, see the
58+
git history or the companion `vim-puppet` repository (the reference
59+
implementation this plugin is being aligned to).
60+
61+
DIFFERENCES FROM VIM-PUPPET (RODJEK) *openvox-vim-puppet*
62+
63+
vim-openvox started as a rebrand/fork of the excellent rodjek/vim-puppet
64+
and its modern successors. The goal is to keep the best parts while
65+
adding OpenVox-specific branding, expanded linting (openvox-lint), and
66+
deeper integration features.
67+
68+
Key differences and current alignment status:
69+
- Indentation and arrow alignment: Being actively ported to match the
70+
battle-tested logic from the vim-puppet gold standard.
71+
- Linting: Stronger multi-linter async support (puppet-lint + openvox-lint
72+
+ metadata + yamllint).
73+
- Naming: All commands, functions, and variables use the `openvox` prefix
74+
instead of `puppet`.
75+
- Documentation: Being updated to be strictly accurate about current
76+
capabilities (see |openvox-status|).
77+
4578
==============================================================================
4679
2. INSTALLATION *openvox-installation*
4780

0 commit comments

Comments
 (0)