Skip to content

feat(dist): package and distribute the plugin (F10)#15

Merged
liupeirong merged 1 commit into
mainfrom
feature/f10-distribution
Jun 5, 2026
Merged

feat(dist): package and distribute the plugin (F10)#15
liupeirong merged 1 commit into
mainfrom
feature/f10-distribution

Conversation

@liupeirong

Copy link
Copy Markdown
Owner
  • Add s:ResolvePythonCommand() to auto-discover checkout .venv Python
  • Support g:vimai_python, VIMAI_PYTHON, and VIMAI_SCRIPT overrides
  • Add doc/vimai.txt Vim help documentation
  • Add MANIFEST.in for source distribution inclusion
  • Add vimai console script entry point in pyproject.toml
  • Document vim-plug, Vundle, lazy.nvim, and release archive installs
  • Rewrite Step 5 for auto-venv resolution (no manual activation needed)
  • Add tests/test_distribution.py and vader launcher resolution tests
  • Update docs/ARCHITECTURE.md with Distribution section

- Add s:ResolvePythonCommand() to auto-discover checkout .venv Python
- Support g:vimai_python, VIMAI_PYTHON, and VIMAI_SCRIPT overrides
- Add doc/vimai.txt Vim help documentation
- Add MANIFEST.in for source distribution inclusion
- Add vimai console script entry point in pyproject.toml
- Document vim-plug, Vundle, lazy.nvim, and release archive installs
- Rewrite Step 5 for auto-venv resolution (no manual activation needed)
- Add tests/test_distribution.py and vader launcher resolution tests
- Update docs/ARCHITECTURE.md with Distribution section

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

✅ Looks Good

Overall assessment: This PR cleanly implements the F10 distribution feature with proper security practices, good documentation, and adequate test coverage.

Findings Summary

Dimension Count
Security 0
Correctness 0
Reliability 0
Testing gaps 0 (minor note below)

Cross-cutting observations

  1. shellescape() usage — Correctly applied to both s:python_cmd and s:main_script in all command construction paths. Good security hygiene.

  2. Resolution priority chaing:vimai_python$VIMAI_PYTHON → checkout .venvpython fallback is well-designed and clearly documented in README, help docs, and ARCHITECTURE.md.

  3. Pre-existing gap: no [build-system] in pyproject.toml — Now that [project.scripts] declares a vimai console entry point, a [build-system] section (e.g., requires = ["setuptools"]) would make the package buildable with standard tools (pip install ., python -m build) without deprecation warnings. Not blocking since the project uses uv exclusively, but worth a follow-up if the CLI entry point is intended for external consumption.

  4. Teststest_distribution.py provides structural smoke tests; vimai.vader covers runtime resolution via VimaiTestPythonCommand() and VimaiTestMainScript(). Together they provide reasonable coverage for the feature.

No blocking issues. Ship it. 🚢

Generated by Agentic PR Review for issue #15 · opus46 2.7M ·

@liupeirong
liupeirong merged commit cef5a0b into main Jun 5, 2026
7 checks passed
@liupeirong
liupeirong deleted the feature/f10-distribution branch June 5, 2026 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant