vim-eof-comment 0.1.11__tar.gz → 0.3.18__tar.gz

vim_eof_comment-0.3.18/.flake8

@@ -0,0 +1,23 @@
+[flake8]
+exclude =
+    *.pyc,
+    *.pyi,
+    *migrations*,
+    *staticfiles*,
+    .git,
+    .tox
+    .venv,
+    __pycache__,
+    build,
+    docs,
+    locale,
+    test_*.py
+    tools,
+    venv,
+max-line-length = 100
+show-source = True
+statistics = True
+count = True
+import-order-style = pep8
+per-file-ignores =
+    __init__.py: F401

vim_eof_comment-0.3.18/.gitattributes

@@ -0,0 +1 @@
+.gitignore export-ignore

vim_eof_comment-0.3.18/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @DrKJeff16

vim_eof_comment-0.3.18/.github/workflows/flake8-lint.yml

@@ -0,0 +1,40 @@
+name: Lint with flake8
+on:
+  push:
+    paths:
+      - .github/workflows/flake8-lint.yml
+      - vim_eof_comment/*.py
+      - vim_eof_comment/args/*.py
+      - vim_eof_comment/comments/*.py
+      - vim_eof_comment/types/*.py
+    branches:
+      - main
+  pull_request:
+    paths:
+      - .github/workflows/flake8-lint.yml
+      - vim_eof_comment/*.py
+      - vim_eof_comment/args/*.py
+      - vim_eof_comment/comments/*.py
+      - vim_eof_comment/types/*.py
+    branches:
+      - main
+jobs:
+  flake8-lint:
+    runs-on: ubuntu-latest
+    name: Lint with flake8
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python environment
+        uses: actions/setup-python@v6.1.0
+        with:
+          python-version: "3.10"
+          architecture: x64
+      - name: flake8 Lint
+        uses: py-actions/flake8@v2.3.0
+        with:
+          ignore: "D401"
+          max-line-length: "100"
+          path: "vim_eof_comment"
+          plugins: "flake8-pyi"
+          exclude: ".tox,.git,*staticfiles*,build,locale,docs,tools,venv,.venv,*migrations*,*.pyc,*.pyi,__pycache__,test_*.py"

vim_eof_comment-0.3.18/.github/workflows/mypy-lint.yml

@@ -0,0 +1,37 @@
+name: Lint with mypy
+on:
+  push:
+    paths:
+      - "*.py"
+      - "*.pyi"
+      - .github/workflows/mypy-lint.yml
+    branches:
+      - main
+  pull_request:
+    paths:
+      - "*.py"
+      - "*.pyi"
+      - .github/workflows/mypy-lint.yml
+    branches:
+      - main
+jobs:
+  mypy-lint:
+    runs-on: ubuntu-latest
+    name: Lint with mypy
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python environment
+        uses: actions/setup-python@v6.1.0
+        with:
+          python-version: "3.10"
+          architecture: x64
+      - name: Install mypy
+        run: |
+          pip install -U mypy mypy-extensions typing typing-extensions
+      - name: Run mypy
+        uses: sasanquaneuf/mypy-github-action@main
+        with:
+          checkName: mypy-lint # NOTE: this needs to be the same as the job name
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

vim_eof_comment-0.3.18/.github/workflows/release.yml

@@ -0,0 +1,103 @@
+name: Action Release
+on:
+  push:
+    tags:
+      - "*.*.*"
+  merge_group:
+    branches:
+      - main
+  release:
+    types:
+      - created
+jobs:
+  release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Build Project Assets
+        run: |
+          mkdir -pv vim-eof-comment
+          cp -rv vim_eof_comment README.md LICENSE Makefile vim-eof-comment
+          zip -r -9 vim-eof-comment.zip vim-eof-comment
+          tar cvJf vim-eof-comment.tar.xz vim-eof-comment
+          tar cvzf vim-eof-comment.tar.gz vim-eof-comment
+          sha512sum vim-eof-comment.zip vim-eof-comment.tar.gz vim-eof-comment.tar.xz >| sha512sums.txt
+          md5sum vim-eof-comment.zip vim-eof-comment.tar.gz vim-eof-comment.tar.xz >| md5sums.txt
+          rm -rfv vim-eof-comment
+      - name: Get Release
+        uses: joutvhu/get-release@v1.0.3
+        with:
+          latest: true
+          prerelease: true
+          pattern: '^.*'
+          debug: true
+          throwing: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build Release File
+        run: |
+          echo ${{ github.sha }} | tee Release.txt
+      - name: Release
+        uses: softprops/action-gh-release@v2.5.0
+        with:
+          files: |
+            Release.txt
+            vim-eof-comment.tar.xz
+            vim-eof-comment.tar.gz
+            vim-eof-comment.zip
+            md5sums.txt
+            sha512sums.txt
+          token: ${{ secrets.GITHUB_TOKEN }}
+  release-build:
+    permissions:
+      contents: read
+    needs:
+      - release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Build Release Distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install -U setuptools argparse typing typing-extensions build
+          python -m build
+      - name: Upload Distributions
+        uses: actions/upload-artifact@v6
+        with:
+          name: release-dists
+          path: dist/
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/vim-eof-comment
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      url: https://pypi.org/p/vim-eof-comment/${{ github.event.release.name }}
+    steps:
+      - name: Retrieve Release Distributions
+        uses: actions/download-artifact@v7
+        with:
+          name: release-dists
+          path: dist/
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0
+        with:
+          packages-dir: dist/

vim_eof_comment-0.3.18/.github/workflows/vim-eof-comment.yml

@@ -0,0 +1,40 @@
+# GitHub Actions example
+name: Run vim-eof-comment
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+    branches:
+      - main
+jobs:
+  vim_eof_comment:
+    name: vim-eof-comment
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6.1.0
+        with:
+          python-version: '3.13'
+      - name: Install pipenv
+        run: |
+          python -m pip install -U pip
+          pip install pipenv
+      - name: Install vim-eof-comment
+        run: |
+          pipenv install --dev vim-eof-comment
+      - name: Run vim-eof-comment
+        run: |
+          pipenv run vim-eof-comment -e py,pyi,md,Makefile,yaml,toml -i py:4:Y,pyi:4:Y,md:2:Y -nv .
+      - name: Auto Commit Changes
+        uses: stefanzweifel/git-auto-commit-action@v7.1.0
+        with:
+          commit_message: "chore: format files with `vim-eof-comment`"
+          commit_options: "--signoff"
+          branch: ${{ github.head_ref }}

vim_eof_comment-0.3.18/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 7.0.0
+    hooks:
+      - id: isort
+        verbose: true
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+        verbose: true
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: remove-crlf
+        verbose: true
+      - id: forbid-crlf # Forbid files containing CRLF end-lines to be committed
+        verbose: true
+  - repo: local
+    hooks:
+      - id: lint
+        name: Lint Script
+        language: system
+        types: [python]
+        files: ^(vim_eof_comment/.*\.pyi?|Makefile)$
+        entry: make lint
+        verbose: true
+      - id: run_script
+        name: Install and Run Script Locally
+        language: system
+        types: [python]
+        files: ^(vim_eof_comment/.*\.py|Makefile)$
+        entry: make run-script
+        verbose: true
+
+# vim: set ts=2 sts=2 sw=2 et ai si sta:

vim_eof_comment-0.3.18/Makefile

@@ -0,0 +1,86 @@
+.PHONY: all help lint build local-install upload clean sign run-script docs
+
+all:
+	@$(MAKE) clean
+	@$(MAKE) local-install
+	@$(MAKE) run-script
+
+clean:
+	@echo "Cleaning..."
+	@rm -rf build dist *.egg-info
+	@echo -e "\nDone!"
+
+distclean: clean
+	@echo "Cleaning Everything..."
+	@rm -rf .mypy_cache .ropeproject .pytest_cache
+	@echo -e "\nDone!"
+
+docs:
+	@echo -e "Generating docs...\n"
+	@$(MAKE) -C docs html
+	@echo -e "\nDone!"
+
+help:
+	@echo -e "\nAvailable targets:"
+	@echo "  build"
+	@echo "  clean"
+	@echo "  distclean"
+	@echo "  docs"
+	@echo "  help"
+	@echo "  lint"
+	@echo "  local-install"
+	@echo "  run-script"
+	@echo "  sign"
+	@echo "  stubs"
+	@echo "  upload"
+	@echo
+
+lint:
+	@echo -e "Linting...\n"
+	@flake8 --statistics --show-source --color=always --max-line-length=100 --ignore=D401 \
+		--per-file-ignores=__init__.py:F401 \
+		--exclude .tox,.git,*staticfiles*,build,locale,docs,tools,venv,.venv,*migrations*,*.pyc,*.pyi,__pycache__,test_*.py \
+		vim_eof_comment
+	@pydocstyle --convention=numpy --match='.*\.py' vim_eof_comment
+	@autopep8 --aggressive --aggressive --aggressive --in-place --recursive vim_eof_comment
+	$(eval files := $(shell fd --full-path vim_eof_comment -e py))
+	@numpydoc lint $(files)
+	@echo -e "\nDone!"
+
+stubs: lint
+	@echo -e "Generating stubs...\n"
+	@stubgen --include-docstrings --include-private -v -p vim_eof_comment -o .
+	@echo -e "\nDone!"
+	@echo -e "\nRunning isort...\n"
+	@isort vim_eof_comment
+	@echo -e "\nDone!"
+	@echo -e "\nLinting with mypy...\n"
+	@mypy vim_eof_comment
+	@echo -e "\nDone!"
+
+build: stubs
+	@echo -e "Building...\n"
+	@python3 -m build
+	@echo -e "\nDone!"
+
+sign: build
+	@echo -e "Signing build...\n"
+	@pypi-attestations sign dist/*
+	@echo -e "\nDone!"
+
+local-install: build
+	@echo -e "Installing locally...\n"
+	@python3 -m pip install .
+	@echo -e "\nDone!"
+
+run-script:
+	@echo -e "Running vim-eof-comment...\n"
+	@vim-eof-comment -e py,pyi,Makefile -n -v .
+	@echo -e "\nDone!"
+
+upload: sign
+	@echo -e "Uploading to PyPI...\n"
+	@twine upload dist/*
+	@echo -e "\nDone!"
+
+# vim: set ts=4 sts=4 sw=0 noet ai si sta:

vim_eof_comment-0.3.18/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: vim-eof-comment
+Version: 0.3.18
+Summary: Adds Vim EOF modeline comments for given filetypes in given directories
+Author-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
+Maintainer-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
+License-Expression: GPL-2.0-only
+Project-URL: Download, https://github.com/DrKJeff16/vim-eof-comment/releases/latest
+Project-URL: Issues, https://github.com/DrKJeff16/vim-eof-comment/issues
+Project-URL: Repository, https://github.com/DrKJeff16/vim-eof-comment
+Keywords: eof comments,eof,files,preprocessing,text,vim modeline,vim,vim-eof
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python
+Classifier: Topic :: Text Processing :: Filters
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: argcomplete
+Requires-Dist: argparse
+Requires-Dist: colorama
+Requires-Dist: setuptools
+Requires-Dist: wheel
+Dynamic: license-file
+
+# vim-eof-comment
+
+![GitHub Repo stars](https://img.shields.io/github/stars/DrKJeff16/vim-eof-comment?style=flat-square)![GitHub Release](https://img.shields.io/github/v/release/DrKJeff16/vim-eof-comment?include_prereleases&sort=semver&display_name=release&style=flat-square)
+
+[PyPI Package][pypi] | [Source Code][source]
+
+Ensure Vim EOF comments in given files.
+
+---
+
+## About
+
+This tool adds a [Vim modeline comment](https://neovim.io/doc/user/options.html#_2.-automatically-setting-options) at the end of the target files.
+
+---
+
+## Install
+
+```bash
+pip install vim-eof-comment
+```
+
+---
+
+## Usage
+
+General usage is as follows:
+
+```bash
+vim-eof-comment [-h] [-v] [-V] -e EXT1[,EXT2[,EXT3[,...]]] [-i EXT1:INDENT[:Y/N][,...]] [-n] dir1 [dir2 [...]]
+```
+
+You can also call it as a module:
+
+```bash
+python -m vim_eof_comment [-h] [-v] [-V] -e EXT1[,EXT2[,EXT3[,...]]] [-i EXT1:INDENT[:Y/N][,...]] [-n] dir1 [dir2 [...]]
+```
+
+### Example
+
+```bash
+vim-eof-comment -e py,md,lua .
+```
+
+---
+
+## License
+
+[GNU GPL-v2.0][license]
+
+[license]: https://github.com/DrKJeff16/vim_eof_comment/blob/main/LICENSE
+[pypi]: https://pypi.org/project/vim-eof-comment/
+[source]: https://github.com/DrKJeff16/vim_eof_comment
+
+<!-- vim: set ts=2 sts=2 sw=2 et ai si sta: -->

vim_eof_comment-0.3.18/Pipfile

@@ -0,0 +1,44 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+setuptools = "*"
+wheel = "*"
+argparse = "*"
+pyproject = "*"
+colorama = "*"
+argcomplete = "*"
+pynvim = "*"
+
+[dev-packages]
+pynvim = "*"
+build = "*"
+pip = "*"
+pyproject = "*"
+twine = "*"
+pypi-attestations = "*"
+pre-commit = "*"
+flake8 = "*"
+flake8-pyi = "*"
+mypy = "*"
+mypy-extensions = "*"
+furo = "*"
+sphinx-rtd-theme = "*"
+renku-sphinx-theme = "*"
+sphinxawesome-theme = "*"
+numpydoc = "*"
+vim-eof-comment = "*"
+
+[scripts]
+lint = "flake8 --statistics --show-source --color always --max-line-length 100 --docstring-convention numpy --ignore=D401 ."
+build = "python3 -m build"
+upload = "twine upload dist/*"
+sign = "pypi-attestations sign dist/*"
+local-install = "python3 -m pip install ."
+install = "python3 -m pip install"
+stubs = "stubgen -p vim_eof_comment -o ."
+
+[requires]
+python_version = "3.13"

vim_eof_comment-0.3.18/README.md

@@ -0,0 +1,55 @@
+# vim-eof-comment
+
+![GitHub Repo stars](https://img.shields.io/github/stars/DrKJeff16/vim-eof-comment?style=flat-square)![GitHub Release](https://img.shields.io/github/v/release/DrKJeff16/vim-eof-comment?include_prereleases&sort=semver&display_name=release&style=flat-square)
+
+[PyPI Package][pypi] | [Source Code][source]
+
+Ensure Vim EOF comments in given files.
+
+---
+
+## About
+
+This tool adds a [Vim modeline comment](https://neovim.io/doc/user/options.html#_2.-automatically-setting-options) at the end of the target files.
+
+---
+
+## Install
+
+```bash
+pip install vim-eof-comment
+```
+
+---
+
+## Usage
+
+General usage is as follows:
+
+```bash
+vim-eof-comment [-h] [-v] [-V] -e EXT1[,EXT2[,EXT3[,...]]] [-i EXT1:INDENT[:Y/N][,...]] [-n] dir1 [dir2 [...]]
+```
+
+You can also call it as a module:
+
+```bash
+python -m vim_eof_comment [-h] [-v] [-V] -e EXT1[,EXT2[,EXT3[,...]]] [-i EXT1:INDENT[:Y/N][,...]] [-n] dir1 [dir2 [...]]
+```
+
+### Example
+
+```bash
+vim-eof-comment -e py,md,lua .
+```
+
+---
+
+## License
+
+[GNU GPL-v2.0][license]
+
+[license]: https://github.com/DrKJeff16/vim_eof_comment/blob/main/LICENSE
+[pypi]: https://pypi.org/project/vim-eof-comment/
+[source]: https://github.com/DrKJeff16/vim_eof_comment
+
+<!-- vim: set ts=2 sts=2 sw=2 et ai si sta: -->

vim_eof_comment-0.3.18/docs/Makefile

@@ -0,0 +1,22 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     := source
+BUILDDIR      := build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# vim: set ts=4 sts=4 sw=0 noet ai si sta:

vim_eof_comment-0.3.18/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

vim_eof_comment-0.3.18/docs/source/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""Runs configuration for building Sphinx documentation."""
+
+import sys
+from pathlib import Path
+from typing import List
+
+sys.path.insert(0, str(Path('..', 'src').resolve()))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project: str = 'vim-eof-comment'
+copyright: str = '2025, Guennadi Maximov C'
+author: str = 'Guennadi Maximov C'
+release: str = '0.1.33'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions: List[str] = [
+    'numpydoc',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.duration',
+]
+
+templates_path: List[str] = ['_templates']
+exclude_patterns: List[str] = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme: str = 'sphinx_rtd_theme'
+html_static_path: List[str] = ['_static']
+
+# -- Options for numpydoc ----------------------------------------------------
+numpydoc_xref_param_type = True
+numpydoc_validation_checks = {
+    "all",  # report on all checks, except the below
+    "ES01",
+    "EX01",
+    "SA01",
+}
+numpydoc_xref_aliases = {
+    'TextIO': 'typing.TextIO',
+    'List': 'list',
+    'Dict': 'dict',
+    'Tuple': 'tuple',
+}
+
+# vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment-0.3.18/docs/source/functions.rst

@@ -0,0 +1,2 @@
+Functions
+=========