Merge branch 'master' into 3.0.0

Fixed numerous small conflicts
python-cmd2 · Jan 17, 2025 · 5c71df0 · 5c71df0
2 parents 506c3bf + e3c9b59
commit 5c71df0
Show file tree

Hide file tree

Showing 47 changed files with 1,660 additions and 1,399 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -14,21 +14,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -47,7 +47,7 @@ The tables below list all prerequisites along with the minimum required version
 #### Prerequisites to run cmd2 applications
 
 | Prerequisite                                             | Minimum Version | Purpose                                |
-|----------------------------------------------------------|-----------------|----------------------------------------|
+| -------------------------------------------------------- | --------------- | -------------------------------------- |
 | [python](https://www.python.org/downloads/)              | `3.9`           | Python programming language            |
 | [pyperclip](https://github.com/asweigart/pyperclip)      | `1.8.2`         | Cross-platform clipboard functions     |
 | [rich-argparse](https://pypi.org/project/rich-argparse/) | `1.6.0`         | Rich help formatters for argparse      |
@@ -56,7 +56,7 @@ The tables below list all prerequisites along with the minimum required version
 #### Additional prerequisites to build and publish cmd2
 
 | Prerequisite                                             | Minimum Version | Purpose                             |
-|----------------------------------------------------------|-----------------|-------------------------------------|
+| -------------------------------------------------------- | --------------- | ----------------------------------- |
 | [build](https://pypi.org/project/build/)                 | `1.2.2`         | Python build frontend               |
 | [setuptools](https://pypi.org/project/setuptools/)       | `72.1.0`        | Python package management           |
 | [setuptools-scm](https://github.com/pypa/setuptools-scm) | `8.0.4`         | Manage your versions by scm tag s   |
@@ -484,17 +484,17 @@ how to do it.
 4. The title (also called the subject) of your PR should be descriptive of your
    changes and succinctly indicate what is being fixed
 
-   - **Do not add the issue number in the PR title or commit message**
+    - **Do not add the issue number in the PR title or commit message**
 
-   - Examples: `Add test cases for Unicode support`; `Correct typo in overview documentation`
+    - Examples: `Add test cases for Unicode support`; `Correct typo in overview documentation`
 
 5. In the body of your PR include a more detailed summary of the changes you
    made and why
 
-   - If the PR is meant to fix an existing bug/issue, then, at the end of
-     your PR's description, append the keyword `closes` and #xxxx (where xxxx
-     is the issue number). Example: `closes #1337`. This tells GitHub to
-     close the existing issue if the PR is merged.
+    - If the PR is meant to fix an existing bug/issue, then, at the end of
+      your PR's description, append the keyword `closes` and #xxxx (where xxxx
+      is the issue number). Example: `closes #1337`. This tells GitHub to
+      close the existing issue if the PR is merged.
 
 6. Indicate what local testing you have done (e.g. what OS and version(s) of Python did you run the
    unit test suite with)
@@ -635,7 +635,7 @@ mostly automated. The manual steps are all git operations. Here's the checklist:
 1. Make sure latest year in `LICENSE` matches current year
 1. Make sure `CHANGELOG.md` describes the version and has the correct release date
 1. Add a git tag representing the version number using `invoke tag x.y.z`
-   - Where x, y, and z are all small non-negative integers
+    - Where x, y, and z are all small non-negative integers
 1. (Optional) Run `invoke pypi-test` to clean, build, and upload a new release to [Test PyPi](https://test.pypi.org)
 1. Run `invoke pypi` to clean, build, and upload a new release to [PyPi](https://pypi.org/)
 

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,11 +1,11 @@
 version: 2
 updates:
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
       interval: "weekly"
 
-- package-ecosystem: "pip"
-  directory: "/"
-  schedule:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
       interval: "weekly"
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,15 +2,15 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "build"
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
   build:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
-        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4 # https://github.com/actions/checkout

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -7,17 +7,17 @@ on:
     # The branches below must be a subset of the branches above
     branches: [master]
   schedule:
-    - cron: '0 6 * * 4'
+    - cron: "0 6 * * 4"
 
 permissions:
   contents: read
 
 jobs:
   analyze:
     permissions:
-      actions: read  # for github/codeql-action/init to get workflow details
-      contents: read  # for actions/checkout to fetch code
-      security-events: write  # for github/codeql-action/autobuild to send a status report
+      actions: read # for github/codeql-action/init to get workflow details
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/autobuild to send a status report
     name: Analyze
     runs-on: ubuntu-latest
 
@@ -26,48 +26,48 @@ jobs:
       matrix:
         # Override automatic language detection by changing the below list
         # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
-        language: ['python']
+        language: ["python"]
         # Learn more...
         # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        # We must fetch at least the immediate parents so that if this is
-        # a pull request then we can checkout the head.
-        fetch-depth: 2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          # We must fetch at least the immediate parents so that if this is
+          # a pull request then we can checkout the head.
+          fetch-depth: 2
 
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
+      # If this run was triggered by a pull request event, then checkout
+      # the head of the pull request instead of the merge commit.
+      - run: git checkout HEAD^2
+        if: ${{ github.event_name == 'pull_request' }}
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file. 
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -2,7 +2,7 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: Format
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 permissions:
   contents: read
@@ -11,7 +11,7 @@ jobs:
   format:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4  # https://github.com/actions/checkout
+      - uses: actions/checkout@v4 # https://github.com/actions/checkout
         with:
           # Only a single commit is fetched by default, for the ref/SHA that triggered the workflow.
           # Set fetch-depth: 0 to fetch all history for all branches and tags.

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -2,7 +2,7 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: Lint
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 permissions:
   contents: read
@@ -11,7 +11,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4  # https://github.com/actions/checkout
+      - uses: actions/checkout@v4 # https://github.com/actions/checkout
         with:
           # Only a single commit is fetched by default, for the ref/SHA that triggered the workflow.
           # Set fetch-depth: 0 to fetch all history for all branches and tags.

diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -2,7 +2,7 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: MyPy
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 permissions:
   contents: read

diff --git a/.gitignore b/.gitignore
@@ -50,3 +50,8 @@ Pipfile.lock
 
 # uv
 uv.lock
+
+# Node/npm used for installing Prettier locally to override the outdated version that is bundled with the VSCode extension
+node_modules/
+package-lock.json
+package.json
diff --git a/.prettierrc b/.prettierrc
@@ -1,10 +1,10 @@
 {
-    "overrides": [
-      {
-        "files": "*.md",
-        "options": {
-          "tabWidth": 4
-        }
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 4
       }
-    ]
-  }
+    }
+  ]
+}