Update project environment and fix issues for modern linting

Author: facelessuser

.github/workflows/build.yml

@@ -4,24 +4,29 @@ on:
   push:
     branches:
       - 'master'
+    tags:
+    - '**'
+  pull_request:
+    branches:
+    - '**'
 
 jobs:
   tests:
 
     env:
-      TOXENV: py37
+      TOXENV: py311
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: 3.11
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools tox
+        python -m pip install --upgrade pip setuptools tox build
     - name: Tests
       run: |
         python -m tox
@@ -34,14 +39,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: 3.11
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools tox
+        python -m pip install --upgrade pip setuptools tox build
     - name: Lint
       run: |
         python -m tox
@@ -54,14 +59,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: 3.11
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools tox
+        python -m pip install --upgrade pip setuptools tox build
     - name: Install Aspell
       run: |
         sudo apt-get install aspell aspell-en

.github/workflows/deploy.yml

@@ -12,15 +12,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: 3.11
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools
-        python -m pip install mkdocs-material pymdown-extensions pygments
+        python -m pip install --upgrade pip setuptools build
+        python -m pip install -r docs/src/requirements.txt
     - name: Deploy documents
       run: |
         git config user.name facelessuser

.github/workflows/pullrequest.yml

@@ -49,10 +49,9 @@ matrix:
       - title
       - alt
       ignores:
-      - 'code, pre'
-      - '.magiclink-compare, .magiclink-commit, .magiclink-repository, .md-footer-social__link'
-      - 'span.keys'
+      - 'code, pre, a.magiclink, span.keys'
       - '.MathJax_Preview, .md-nav__link, .md-footer-custom-text, .md-source__repository, .headerlink, .md-icon'
+      - '.md-social__link'
   - pyspelling.filters.url:
 
 - name: markdown

.pyspelling.yml

@@ -1,41 +1,46 @@
 # HexViewer
 
+## 2.7.1
+
+-   **FIX**: Ensure `typing` dependencies for Sublime versions using Python 3.3 host.
+
 ## 2.7.0
 
-- **NEW**: HexViewer no longer triggers on files with extension `hex`. Instead it uses a custom extension `hxv`.
-- **NEW**: Add new timestamp output in the hex inspector.
-- **NEW**: Only use `sublime-syntax` files to highlight HexViewer related syntaxes.
+-   **NEW**: HexViewer no longer triggers on files with extension `hex`. Instead it uses a custom extension `hxv`.
+-    **NEW**: Add new timestamp output in the hex inspector.
+-    **NEW**: Only use `sublime-syntax` files to highlight HexViewer related syntaxes.
 
 ## 2.6.5
 
-- **FIX**: Thread should be idle when Sublime Text is idle.
+-    **FIX**: Thread should be idle when Sublime Text is idle.
 
 ## 2.6.4
 
-- **FIX**: Fix issue with with selecting the correct hex byte when a character in the ASCII column is selected on the last row.
+-   **FIX**: Fix issue with with selecting the correct hex byte when a character in the ASCII column is selected on the
+    last row.
 
 ## 2.6.3
 
-- **FIX**: Fix change log auto-linking issue.
+-    **FIX**: Fix change log auto-linking issue.
 
 ## 2.6.2
 
-- **FIX**: Log rendering.
+-    **FIX**: Log rendering.
 
 ## 2.6.1
 
-- **FIX**: Update dependencies.
+-    **FIX**: Update dependencies.
 
 ## 2.6.0
 
-- **NEW**: Can now toggle image files to hex view, but still cannot auto detect them on open.
-- **FIX**: Misspelling of the setting `inspector_float_format`. Update your settings accordingly.
+-    **NEW**: Can now toggle image files to hex view, but still cannot auto detect them on open.
+-    **FIX**: Misspelling of the setting `inspector_float_format`. Update your settings accordingly.
 
 ## 2.5.0
 
-- **NEW**: Popup support limited to 3124+
+-    **NEW**: Popup support limited to 3124+
 
 ## 2.4.0
 
-- **NEW**: New support commands.
-- **FIX**: Fixed race condition.
+-    **NEW**: New support commands.
+-    **FIX**: Fixed race condition.

CHANGES.md

@@ -1,13 +1,8 @@
 {
     "*": {
         ">=3124": [
-            "pygments",
-            "python-markdown",
             "mdpopups",
-            "python-jinja2",
-            "markupsafe",
-            "pyyaml",
-            "pymdownx"
+            "typing"
         ]
     }
 }

dependencies.json

@@ -0,0 +1,131 @@
+# Contributing & Support
+
+## Overview
+
+Sublime\ Versions | Description
+----------------- |------------
+ST2               | Supported on a separate branch, but not actively.  Any further fixes or enhancements must come from the community.  Issues for versions less than ST3 will not be addressed moving forward by me.  Pull requests are welcome for back-porting features, enhancements, or fixes to the old branch, but the content of the pull **must** already exist on the main, actively developed branch.  I will not allow an older branch to exceed the main branch in regards to functionality.
+ST3               | Fully supported and actively maintained.
+
+Contribution from the community is encouraged and can be done in a variety of ways:
+
+-   Become a sponsor.
+-   Bug reports.
+-   Reviewing code.
+-   Code patches via pull requests.
+-   Documentation improvements via pull requests.
+
+## Become a Sponsor :octicons-heart-fill-16:{: .heart-throb}
+
+Open source projects take time and money. Help support the project by becoming a sponsor. You can add your support at
+any tier you feel comfortable with. No amount is too little. We also accept one time contributions via PayPal.
+
+[:octicons-mark-github-16: GitHub Sponsors](https://github.com/sponsors/facelessuser){: .md-button .md-button--primary }
+[:fontawesome-brands-paypal: PayPal](https://www.paypal.me/facelessuser){ .md-button}
+
+## Bug Reports
+
+1.  Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
+    **before** posting an issue.
+
+2.  When an issue is created, a minimal reproducible example is required. If the request for such is ignored, the
+    issue will be marked `Invalid` and closed.
+
+3.  When creating an issue on the repository, please provide as much info as possible:
+
+    -   Provide environment information by running `Preferences->Package Settings->ColorHelper->Support Info`.  The
+        information will be copied to the clipboard; paste the info in issue.
+    -   Errors in console.
+    -   Detailed description of the problem.
+    -   Examples for reproducing the error.  You can post pictures, but if specific text or code is required to
+        reproduce the issue, please provide the text in a plain text format for easy copy/paste.
+    -   Provide links to 3rd party syntax highlighting package you are using if applicable.
+
+    The more info provided, the greater the chance someone will take the time to answer, implement, or fix the issue.
+
+4.  Be prepared to answer questions and provide additional information if required.  Issues in which the creator refuses
+    to respond to follow up questions will be marked as stale and closed.
+
+## Reviewing Code
+
+Take part in reviewing pull requests and/or reviewing direct commits.  Make suggestions to improve the code and discuss
+solutions to overcome weakness in the algorithm.
+
+## Pull Requests
+
+Pull requests are welcome, and if you plan on contributing directly to the code, there are a couple of things to be
+mindful of.
+
+1.  Please describe the change in as much detail as possible so I can understand what is being added or modified.
+
+2.  If you are solving a bug that does not already have an issue, please describe the bug in detail and provide info on
+    how to reproduce if applicable (this is good for me and others to reference later when verifying the issue has been
+    resolved).
+
+3.  Please reference and link related open bugs or feature requests in this pull if applicable.
+
+4.  Make sure you've documented or updated the existing documentation if introducing a new feature or modifying the
+    behavior of an existing feature that a user needs to be aware of.  I will not accept new features or changes to
+    existing features if you have not provided documentation describing the feature.
+
+Continuous integration tests on are run on all pull requests and commits via Travis CI.  When making a pull request, the
+tests will automatically be run, and the request must pass to be accepted.  You can (and should) run these tests before
+pull requesting.  If it is not possible to run these tests locally, they will be run when the pull request is made, but
+it is strongly suggested that requesters make an effort to verify before requesting to allow for a quick, smooth merge.
+
+### Running Validation Tests
+
+/// tip | Tip
+If you are running Sublime on a Mac OS or Linux/Unix system, you run all tests by by running the shell script
+(assuming you have installed your environment fulfills all requirements below):
+
+```
+chmod +x run_tests.sh
+./run_tests.sh
+```
+///
+
+There are a couple of dependencies that must be present before running the tests.
+
+1.  As ST3 is the only current, actively supported version, Python 3.3 must be used to validate the tests.
+
+2.  Unit tests are run with `pytest`.  You can install `pytest` via:
+
+    ```
+    pip install pytest
+    ```
+
+    The tests should be run from the root folder of the plugin by using the following command:
+
+    ```
+    py.test .
+    ```
+
+3.  Linting is performed on the entire project with `flake8`, `flake8-docstrings`, and `pep8-naming`.  These can be
+    installed via:
+
+    ```
+    pip install flake8
+    pip install flake8-docstrings
+    pip install pep8-naming
+    ```
+
+    Linting is performed with the following command:
+
+    ```
+    flake8 .
+    ```
+
+## Documentation Improvements
+
+A ton of time has been spent not only creating and supporting this plugin, but also spent making this documentation.  If
+you feel it is still lacking, show your appreciation for the plugin by helping to improve the documentation.  Help with
+documentation is always appreciated and can be done via pull requests.  There shouldn't be any need to run validation
+tests if only updating documentation.
+
+You don't have to render the docs locally before pull requesting, but if you wish to, I currently use a combination of
+[MkDocs][mkdocs], the [Material theme][mkdocs-material], and [PyMdown Extensions][pymdown-extensions] to render the
+docs.  You can preview the docs if you install these two packages.  The command for previewing the docs is
+`mkdocs serve` from the root directory. You can then view the documents at `localhost:8000`.
+
+--8<-- "refs.md"