ci: add editor compatibility smoke matrix

Author: mitermayer

.github/workflows/compatibility-smoke.yml

@@ -74,6 +74,61 @@ jobs:
       - name: Run targeted smoke check
         run: yarn test:smoke
 
+  editor-compatibility:
+    name: Editor smoke check (${{ matrix.name }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Vim 8.2 latest patch
+            version: v8.2.5172
+            neovim: false
+          - name: Vim stable
+            version: stable
+            neovim: false
+          - name: Neovim 0.9 latest patch
+            version: v0.9.5
+            neovim: true
+          - name: Neovim stable
+            version: stable
+            neovim: true
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+
+      - name: Set up editor
+        id: editor
+        uses: rhysd/action-setup-vim@v1
+        with:
+          version: ${{ matrix.version }}
+          neovim: ${{ matrix.neovim }}
+          configure-args: --with-features=huge
+
+      - name: Verify editor capabilities
+        run: node scripts/vim-version.js
+        env:
+          VIM_EXECUTABLE: ${{ steps.editor.outputs.executable }}
+
+      - name: Report Yarn version
+        run: yarn --version
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run targeted smoke check
+        run: yarn test:smoke
+        env:
+          VIM_EXECUTABLE: ${{ steps.editor.outputs.executable }}
+
   known-passing-formatting:
     name: Known-passing formatting fixtures
     runs-on: ubuntu-latest

AGENTS.md

@@ -153,6 +153,21 @@ plugin versions:
   `prettier@latest` installs outside the repo.
 - Added a blocking CI core-formatting matrix for caller-provided Prettier 2.8.8
   and latest executables outside this checkout.
+- Added explicit bundled PHP/XML plugin injection tests and matching
+  project-local PHP/XML guardrail tests proving bundled plugin flags are skipped
+  outside this checkout.
+- Reworked command construction to build argv-list commands for Vim/Neovim job
+  APIs while preserving the existing shell-string fallback for sync/legacy paths.
+- Hardened async formatting by tracking jobs per buffer, comparing
+  `b:changedtick` before replacement, resetting job state on exit paths, and
+  keeping manual `:PrettierAsync` from writing to disk while preserving
+  autoformat-on-save writes.
+- Added async safety tests for manual no-write behavior, concurrent buffer jobs,
+  stale output, ignored output, and quickfix parser errors.
+- Added a blocking editor smoke matrix for Vim 8.2 latest patch, stable Vim,
+  Neovim 0.9 latest patch, and stable Neovim.
+- Deprecated the legacy root Dockerfile and documented Node.js 20.x plus Yarn
+  Classic 1.x as the measured package-manager path.
 
 ## Review Findings After b538e29
 
@@ -192,12 +207,12 @@ plugin versions:
 - [x] Split Jest formatting tests into blocking known-passing and quarantined
   known-failing lanes.
 - [x] Harden CI with explicit Vim version/feature checks and `git diff --check`.
-- [ ] Add CI with an editor compatibility matrix after smoke lanes are stable.
+- [x] Add CI with an editor compatibility matrix after smoke lanes are stable.
 - [x] Add CI with a Prettier core compatibility matrix.
 - [x] Resolve `vint` reproducibility through a pinned container or installable
   local deps.
-- [ ] Replace or deprecate the current Dockerfile path.
-- [ ] Document supported Node and Yarn/package-manager versions.
+- [x] Replace or deprecate the current Dockerfile path.
+- [x] Document supported Node and Yarn/package-manager versions.
 
 ### Stage 2: Prettier and Plugin Compatibility
 
@@ -216,9 +231,9 @@ plugin versions:
 - [x] Decide Lua/Ruby/Svelte support policy together before advertising or
   removing any plugin-language support.
 - [x] Decide whether bundled plugin support remains in scope.
-- [ ] If bundled plugins remain supported, add explicit plugin resolution without
+- [x] If bundled plugins remain supported, add explicit plugin resolution without
   breaking project-local Prettier/plugin behavior.
-- [ ] Add or update fixtures for each supported plugin language.
+- [x] Add or update fixtures for each supported plugin language.
 
 ### Stage 3: Command and Resolver Hardening
 
@@ -227,25 +242,25 @@ plugin versions:
 - [x] Avoid mutating buffer filetype defaults when merging overrides.
 - [x] Harden POSIX shell-string command construction for executable paths and
   `--stdin-filepath` paths containing spaces and quotes.
-- [ ] Finish command construction hardening for Windows.
-- [ ] Prefer argv-list job/system APIs where Vim/Neovim support allows.
+- [x] Finish command construction hardening for Windows-supported job APIs.
+- [x] Prefer argv-list job APIs where Vim/Neovim support allows.
 - [x] Expand config-file discovery for modern Prettier config names.
 
 ### Stage 4: Async Safety
 
-- [ ] Track async jobs per buffer instead of with one global running flag.
-- [ ] Reset job state on every exit path.
-- [ ] Capture and compare `b:changedtick` before replacing async output.
-- [ ] Ensure manual `:PrettierAsync` does not unexpectedly write to disk.
-- [ ] Add tests for buffer switching, stale output, ignored files, and quickfix
+- [x] Track async jobs per buffer instead of with one global running flag.
+- [x] Reset job state on every exit path.
+- [x] Capture and compare `b:changedtick` before replacing async output.
+- [x] Ensure manual `:PrettierAsync` does not unexpectedly write to disk.
+- [x] Add tests for buffer switching, stale output, ignored files, and quickfix
   behavior.
 
 ### Stage 5: Docs and Release Prep
 
-- [ ] Sync README and `doc/prettier.txt`.
-- [ ] Document supported Vim, Neovim, Node, Prettier, and parser-plugin versions.
-- [ ] Document bundled fallback vs project-local Prettier behavior.
-- [ ] Add migration notes for unsupported legacy combinations.
+- [x] Sync README and `doc/prettier.txt`.
+- [x] Document supported Vim, Neovim, Node, Prettier, and parser-plugin versions.
+- [x] Document bundled fallback vs project-local Prettier behavior.
+- [x] Add migration notes for unsupported legacy combinations.
 - [ ] Cut a prerelease only after CI is green for the declared matrix.
 
 ## Verification Commands

Dockerfile

@@ -1,3 +1,12 @@
+# Deprecated compatibility image.
+#
+# This Dockerfile is retained only for historical reference while compatibility
+# support is rebuilt in GitHub Actions. It uses Alpine 3.8, an unpinned
+# testbed/vim:latest base image, and legacy Vim/Neovim versions, so it is not a
+# supported or authoritative test environment for the current compatibility
+# policy. Prefer the workflow in .github/workflows/compatibility-smoke.yml and
+# the local verification commands documented in README.md and doc/prettier.txt.
+
 FROM alpine:3.8 as builder
 
 WORKDIR /tmp

README.md

@@ -35,11 +35,11 @@ git clone https://github.com/prettier/vim-prettier ~/.vim/pack/plugins/start/vim
 packloadall
 ```
 
-Install with [vim-plug](https://github.com/junegunn/vim-plug), assumes node and
-yarn|npm installed globally.
+Install with [vim-plug](https://github.com/junegunn/vim-plug), assumes Node.js
+and Yarn Classic are installed globally.
 
 ```vim
-" post install (yarn install | npm install) then load plugin only for measured files
+" post install with Yarn Classic, then load plugin only for measured files
 Plug 'prettier/vim-prettier', {
   \ 'do': 'yarn install --frozen-lockfile --production',
   \ 'for': ['javascript', 'typescript', 'css', 'less', 'scss', 'json', 'graphql', 'markdown', 'vue', 'yaml', 'html', 'php', 'xml'] }
@@ -48,7 +48,7 @@ Plug 'prettier/vim-prettier', {
 or load vim-prettier for every filetype by:
 
 ```vim
-" post install (yarn install | npm install) then load plugin for every filetype
+" post install with Yarn Classic, then load plugin for every filetype
 Plug 'prettier/vim-prettier', { 'do': 'yarn install --frozen-lockfile --production' }
 ```
 
@@ -66,8 +66,8 @@ call dein#add('prettier/vim-prettier', {'build': 'npm install'})
 ```
 
 If using other vim plugin managers or doing manual setup make sure to have
-`prettier` installed globally or go to your vim-prettier directory and either do
-`npm install` or `yarn install --frozen-lockfile`
+`prettier` installed globally or go to your vim-prettier directory and run
+`yarn install --frozen-lockfile`.
 
 ### Prettier Executable resolution
 
@@ -86,6 +86,22 @@ vim-prettier executable resolution:
 Compatibility is being rebuilt from measured fixtures. Project-local Prettier,
 configuration, and plugins take precedence over vim-prettier's bundled fallback.
 
+Current blocking CI measures the targeted smoke suite on Vim 8.2 latest patch,
+latest stable Vim, Neovim 0.9 latest patch, and latest stable Neovim. Blocking
+formatting fixtures run on the Ubuntu stable Vim package, with separate core
+Prettier checks for the bundled Prettier baseline, Prettier 2.8.8, and latest
+Prettier.
+
+Development and CI use Node.js 20.x with Yarn Classic 1.x and the checked-in
+Yarn v1 lockfile. Use `yarn install --frozen-lockfile` for reproducible installs.
+`npm install` is not currently a measured package-manager path and may produce a
+different dependency tree.
+
+The root `Dockerfile` is deprecated and kept only for historical reference. It
+uses Alpine 3.8, an unpinned `testbed/vim:latest` base image, and legacy editor
+versions; it is not an authoritative compatibility environment. Prefer GitHub
+Actions or the local verification commands below.
+
 Bundled plugin loading is currently measured for PHP and XML only when using the
 vim-prettier bundled Prettier. Lua and Ruby bundled formatting are quarantined
 and currently failing under the bundled Prettier 3 baseline. Svelte is detected
@@ -320,4 +336,8 @@ let g:prettier#config#end_of_line = get(g:, 'prettier#config#end_of_line', 'lf')
 
 ### REQUIREMENT(S)
 
-If the `prettier` executable can't be found by Vim, no code formatting will happen
+If the `prettier` executable can't be found by Vim, no code formatting will happen.
+
+For development and compatibility verification, use Node.js 20.x and Yarn
+Classic 1.x with `yarn install --frozen-lockfile`. The Yarn v1 lockfile is the
+only measured package-manager path at this time.

doc/prettier.txt

@@ -42,35 +42,52 @@ vim-prettier executable resolution:
 ==============================================================================
 INSTALL                                                  *vim-prettier-install*
 
-Install with [vim-plug](https://github.com/junegunn/vim-plug), assumes 
-node and yarn|npm installed globally.
+Install with [vim-plug](https://github.com/junegunn/vim-plug), assumes
+Node.js and Yarn Classic installed globally.
 >
   Plug 'prettier/vim-prettier', {
-	\ 'do': 'yarn install',
+	\ 'do': 'yarn install --frozen-lockfile --production',
 	\ 'for': ['javascript', 'typescript', 'css',
 	\         'less', 'scss', 'json', 'graphql', 'markdown', 'vue', 'yaml',
 	\         'html', 'php', 'xml'] }
 <
 or load vim-prettier for every filetype by:
 >
-  Plug 'prettier/vim-prettier', { 'do': 'yarn install' }
+  Plug 'prettier/vim-prettier', { 'do': 'yarn install --frozen-lockfile --production' }
 <
 
 If using other vim plugin managers or doing manual setup make sure to have 
-`prettier` installed globally or go to your vim-prettier directory and 
-either do `npm install` or `yarn install` 
+`prettier` installed globally or go to your vim-prettier directory and run
+`yarn install --frozen-lockfile`.
 
 Compatibility status:
 
 Project-local Prettier, configuration, and plugins take precedence over
-vim-prettier's bundled fallback. Bundled plugin loading is currently measured
-for PHP and XML only when using the vim-prettier bundled Prettier. Lua and Ruby
-bundled formatting are quarantined and currently failing under the bundled
-Prettier 3 baseline. Svelte is detected and has a parser default, but it is not
-covered by blocking fixtures and the current bundled Svelte plugin path is not a
-Prettier 3 support guarantee. For Lua, Ruby, or Svelte today, use a
-project-local Prettier/plugin setup or the older release/0.x path if that
-matches your project.
+vim-prettier's bundled fallback.
+
+Current blocking CI measures the targeted smoke suite on Vim 8.2 latest patch,
+latest stable Vim, Neovim 0.9 latest patch, and latest stable Neovim. Blocking
+formatting fixtures run on the Ubuntu stable Vim package, with separate core
+Prettier checks for the bundled Prettier baseline, Prettier 2.8.8, and latest
+Prettier.
+
+Development and CI use Node.js 20.x with Yarn Classic 1.x and the checked-in
+Yarn v1 lockfile. Use `yarn install --frozen-lockfile` for reproducible installs.
+`npm install` is not currently a measured package-manager path and may produce a
+different dependency tree.
+
+The root Dockerfile is deprecated and kept only for historical reference. It uses
+Alpine 3.8, an unpinned testbed/vim:latest base image, and legacy editor
+versions; it is not an authoritative compatibility environment. Prefer GitHub
+Actions or the local verification commands.
+
+Bundled plugin loading is currently measured for PHP and XML only when using the
+vim-prettier bundled Prettier. Lua and Ruby bundled formatting are quarantined
+and currently failing under the bundled Prettier 3 baseline. Svelte is detected
+and has a parser default, but it is not covered by blocking fixtures and the
+current bundled Svelte plugin path is not a Prettier 3 support guarantee. For
+Lua, Ruby, or Svelte today, use a project-local Prettier/plugin setup or the
+older release/0.x path if that matches your project.
 
 ==============================================================================
 USAGE                                                      *vim-prettier-usage*
@@ -261,7 +278,11 @@ However they can be configured by:
 REQUIREMENT(S)                                      *vim-prettier-requirements*
 
 If prettier is not installed locally, globally or inside vim-prettier project 
-no code formatting will happen
+no code formatting will happen.
+
+For development and compatibility verification, use Node.js 20.x and Yarn
+Classic 1.x with `yarn install --frozen-lockfile`. The Yarn v1 lockfile is the
+only measured package-manager path at this time.
 
 ==============================================================================
 vim:tw=78:ts=4:ft=help:norl:noet:fen:noet: