conventional-pre-commit 2.1.1__tar.gz → 2.3.0__tar.gz

conventional_pre_commit-2.3.0/PKG-INFO

@@ -0,0 +1,378 @@
+Metadata-Version: 2.1
+Name: conventional_pre_commit
+Version: 2.3.0
+Summary: A pre-commit hook that checks commit messages for Conventional Commits formatting.
+Author-email: Compiler LLC <dev@compiler.la>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: code, https://github.com/compilerla/conventional-pre-commit
+Project-URL: tracker, https://github.com/compilerla/conventional-pre-commit/issues
+Keywords: git,pre-commit,conventional-commits
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+# conventional-pre-commit
+
+A [`pre-commit`](https://pre-commit.com) hook to check commit messages for
+[Conventional Commits](https://conventionalcommits.org) formatting.
+
+## Usage
+
+Make sure `pre-commit` is [installed](https://pre-commit.com#install).
+
+Create a blank configuration file at the root of your repo, if needed:
+
+```console
+touch .pre-commit-config.yaml
+```
+
+Add a new repo entry to your configuration file:
+
+```yaml
+repos:
+  # - repo: ...
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: <git sha or tag>
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
+```
+
+Install the `pre-commit` script:
+
+```console
+pre-commit install --hook-type commit-msg
+```
+
+Make a (normal) commit :x::
+
+```console
+$ git commit -m "add a new feature"
+
+[INFO] Initializing environment for ....
+Conventional Commit......................................................Failed
+- hook id: conventional-pre-commit
+- duration: 0.07s
+- exit code: 1
+
+[Bad Commit message] >> add a new feature
+
+Your commit message does not follow Conventional Commits formatting
+https://www.conventionalcommits.org/
+
+Conventional Commits start with one of the below types, followed by a colon,
+followed by the commit message:
+
+    build chore ci docs feat fix perf refactor revert style test
+
+Example commit message adding a feature:
+
+    feat: implement new API
+
+Example commit message fixing an issue:
+
+    fix: remove infinite loop
+
+Optionally, include a scope in parentheses after the type for more context:
+
+    fix(account): remove infinite loop
+```
+
+Make a (conventional) commit :heavy_check_mark::
+
+```console
+$ git commit -m "feat: add a new feature"
+
+[INFO] Initializing environment for ....
+Conventional Commit......................................................Passed
+- hook id: conventional-pre-commit
+- duration: 0.05s
+```
+
+## Install with pip
+
+`conventional-pre-commit` can also be installed and used from the command line:
+
+```shell
+pip install conventional-pre-commit
+```
+
+Then run the command line script:
+
+```shell
+conventional-pre-commit [types] input
+```
+
+- `[types]` is an optional list of Conventional Commit types to allow (e.g. `feat fix chore`)
+
+- `input` is a file containing the commit message to check:
+
+```shell
+conventional-pre-commit feat fix chore ci test .git/COMMIT_MSG
+```
+
+Or from a Python program:
+
+```python
+from conventional_pre_commit.format import is_conventional
+
+# prints True
+print(is_conventional("feat: this is a conventional commit"))
+
+# prints False
+print(is_conventional("nope: this is not a conventional commit"))
+
+# prints True
+print(is_conventional("custom: this is a conventional commit", types=["custom"]))
+```
+
+## Development
+
+`conventional-pre-commit` comes with a [VS Code devcontainer](https://code.visualstudio.com/learn/develop-cloud/containers)
+configuration to provide a consistent development environment.
+
+With the `Remote - Containers` extension enabled, open the folder containing this repository inside Visual Studio Code.
+
+You should receive a prompt in the Visual Studio Code window; click `Reopen in Container` to run the development environment
+inside the devcontainer.
+
+If you do not receive a prompt, or when you feel like starting from a fresh environment:
+
+1. `Ctrl/Cmd+Shift+P` to bring up the command palette in Visual Studio Code
+1. Type `Remote-Containers` to filter the commands
+1. Select `Rebuild and Reopen in Container` to completely rebuild the devcontainer
+1. Select `Reopen in Container` to reopen the most recent devcontainer build
+
+## Versioning
+
+Versioning generally follows [Semantic Versioning](https://semver.org/).
+
+## Making a release
+
+Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
+
+1. Create a branch `chore/release`
+1. Bump the version in `pyproject.toml`
+1. PR, merge `chore/release` into `main`
+1. Tag `main` with the new version (prefixed by `v`):
+
+   ```bash
+   git fetch
+   git reset --hard origin/main
+   git tag vX.Y.Z
+   git push origin vX.Y.Z
+   ```
+
+1. Publish a pre-release to push the new package to TestPyPI
+1. Publish a regular Release to push the new package to PyPI
+
+## License
+
+[Apache 2.0](LICENSE)
+
+Inspired by matthorgan's [`pre-commit-conventional-commits`](https://github.com/matthorgan/pre-commit-conventional-commits).

conventional_pre_commit-2.1.1/PKG-INFO → conventional_pre_commit-2.3.0/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: conventional_pre_commit
-Version: 2.1.1
-Summary: A pre-commit hook that checks commit messages for Conventional Commits formatting.
-Home-page: https://github.com/compilerla/conventional-pre-commit
-Author: Compiler LLC
-Author-email: dev@compiler.la
-License: Apache 2.0
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
 # conventional-pre-commit
 
 A [`pre-commit`](https://pre-commit.com) hook to check commit messages for
@@ -31,8 +17,7 @@ Add a new repo entry to your configuration file:
 
 ```yaml
 repos:
-
-# - repo: ...
+  # - repo: ...
 
   - repo: https://github.com/compilerla/conventional-pre-commit
     rev: <git sha or tag>
@@ -107,9 +92,9 @@ Then run the command line script:
 conventional-pre-commit [types] input
 ```
 
-Where `[types]` is an optional list of Conventional Commit types to allow (e.g. `feat fix chore`)
+- `[types]` is an optional list of Conventional Commit types to allow (e.g. `feat fix chore`)
 
-And `input` is a file containing the commit message to check:
+- `input` is a file containing the commit message to check:
 
 ```shell
 conventional-pre-commit feat fix chore ci test .git/COMMIT_MSG
@@ -130,10 +115,6 @@ print(is_conventional("nope: this is not a conventional commit"))
 print(is_conventional("custom: this is a conventional commit", types=["custom"]))
 ```
 
-## Versioning
-
-Versioning generally follows [Semantic Versioning](https://semver.org/).
-
 ## Development
 
 `conventional-pre-commit` comes with a [VS Code devcontainer](https://code.visualstudio.com/learn/develop-cloud/containers)
@@ -151,6 +132,29 @@ If you do not receive a prompt, or when you feel like starting from a fresh envi
 1. Select `Rebuild and Reopen in Container` to completely rebuild the devcontainer
 1. Select `Reopen in Container` to reopen the most recent devcontainer build
 
+## Versioning
+
+Versioning generally follows [Semantic Versioning](https://semver.org/).
+
+## Making a release
+
+Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
+
+1. Create a branch `chore/release`
+1. Bump the version in `pyproject.toml`
+1. PR, merge `chore/release` into `main`
+1. Tag `main` with the new version (prefixed by `v`):
+
+   ```bash
+   git fetch
+   git reset --hard origin/main
+   git tag vX.Y.Z
+   git push origin vX.Y.Z
+   ```
+
+1. Publish a pre-release to push the new package to TestPyPI
+1. Publish a regular Release to push the new package to PyPI
+
 ## License
 
 [Apache 2.0](LICENSE)

{conventional_pre_commit-2.1.1 → conventional_pre_commit-2.3.0}/conventional_pre_commit/format.py

@@ -21,9 +21,12 @@ def r_types(types):
     return "|".join(types)
 
 
-def r_scope():
+def r_scope(optional=True):
     """Regex str for an optional (scope)."""
-    return r"(\([\w \/:-]+\))?"
+    if optional:
+        return r"(\([\w \/:-]+\))?"
+    else:
+        return r"(\([\w \/:-]+\))"
 
 
 def r_delim():
@@ -43,7 +46,7 @@ def conventional_types(types=[]):
     return types
 
 
-def is_conventional(input, types=DEFAULT_TYPES):
+def is_conventional(input, types=DEFAULT_TYPES, optional_scope=True):
     """
     Returns True if input matches Conventional Commits formatting
     https://www.conventionalcommits.org
@@ -51,7 +54,7 @@ def is_conventional(input, types=DEFAULT_TYPES):
     Optionally provide a list of additional custom types.
     """
     types = conventional_types(types)
-    pattern = f"^({r_types(types)}){r_scope()}{r_delim()}{r_subject()}$"
+    pattern = f"^({r_types(types)}){r_scope(optional_scope)}{r_delim()}{r_subject()}$"
     regex = re.compile(pattern, re.DOTALL)
 
     return bool(regex.match(input))

{conventional_pre_commit-2.1.1 → conventional_pre_commit-2.3.0}/conventional_pre_commit/hook.py

@@ -20,6 +20,9 @@ def main(argv=[]):
     )
     parser.add_argument("types", type=str, nargs="*", default=format.DEFAULT_TYPES, help="Optional list of types to support")
     parser.add_argument("input", type=str, help="A file containing a git commit message")
+    parser.add_argument(
+        "--force-scope", action="store_false", default=True, dest="optional_scope", help="Force commit to have scope defined."
+    )
 
     if len(argv) < 1:
         argv = sys.argv[1:]
@@ -29,10 +32,22 @@ def main(argv=[]):
     except SystemExit:
         return RESULT_FAIL
 
-    with open(args.input) as f:
-        message = f.read()
+    try:
+        with open(args.input, encoding="utf-8") as f:
+            message = f.read()
+    except UnicodeDecodeError:
+        print(
+            f"""
+{Colors.LRED}[Bad Commit message encoding] {Colors.RESTORE}
+
+{Colors.YELLOW}conventional-pre-commit couldn't decode your commit message.{Colors.RESTORE}
+{Colors.YELLOW}UTF-8{Colors.RESTORE} encoding is assumed, please configure git to write commit messages in UTF-8.
+See {Colors.LBLUE}https://git-scm.com/docs/git-commit/#_discussion{Colors.RESTORE} for more.
+        """
+        )
+        return RESULT_FAIL
 
-    if format.is_conventional(message, args.types):
+    if format.is_conventional(message, args.types, args.optional_scope):
         return RESULT_SUCCESS
     else:
         print(
@@ -54,7 +69,7 @@ def main(argv=[]):
 
             fix: remove infinite loop
 
-        {Colors.YELLOW}Optionally, include a scope in parentheses after the type for more context:{Colors.RESTORE}
+        {Colors.YELLOW}Example commit with scope in parentheses after the type for more context:{Colors.RESTORE}
 
             fix(account): remove infinite loop"""
         )