beman-tidy 0.2.0__tar.gz

beman_tidy-0.2.0/LICENSE

@@ -0,0 +1,219 @@
+
+                                 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.
+
+
+---- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.

beman_tidy-0.2.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: beman-tidy
+Version: 0.2.0
+Summary: The Codebase Bemanification Tool
+Keywords: beman,bemanproject,linting,repository hygiene,compliance,beman standard,pre-commit tool,cli tool,automation
+Author-email: Darius Neațu <neatudarius@gmail.com>
+Maintainer-email: Rishyak <hello@rishyak.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Developers
+License-File: LICENSE
+Requires-Dist: gitpython==3.1.44
+Requires-Dist: pyyaml==6.0.2
+
+# beman-tidy: The Codebase Bemanification Tool
+
+<!--
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+`beman-tidy` is a tool aimed at Beman Project contributors to check (`--dry-run`)
+and apply (`--fix-inplace`) the [Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md)
+to their repositories.
+
+**Note `2025-06-07`:** The first iteration of the tool will not support `--fix-inplace` in order to
+expedite adoption across the Beman Project.
+
+## Usage
+
+- Display help:
+
+```shell
+$ beman-tidy --help
+usage: beman-tidy [-h] [--fix-inplace | --no-fix-inplace] [--verbose | --no-verbose] [--require-all | --no-require-all] [--checks CHECKS] repo_path
+
+positional arguments:
+  repo_path             path to the repository to check
+
+options:
+  -h, --help            show this help message and exit
+  --fix-inplace, --no-fix-inplace
+                        Try to automatically fix found issues
+  --verbose, --no-verbose
+                        print verbose output for each check
+  --require-all, --no-require-all
+                        all checks are required regardless of the check type (e.g., Recommendation becomes Requirement)
+  --checks CHECKS       array of checks to run
+```
+
+- Run beman-tidy on the exemplar repository **(default: dry-run mode)**
+
+```shell
+# dry-run, require-all, non-verbose
+$ beman-tidy /path/to/exemplar --require-all
+Summary    Requirement:  18 checks passed, 1 checks failed, 5 checks skipped,  23 checks not implemented.
+Summary Recommendation:  0 checks passed, 0 checks failed, 0 checks skipped,  0 checks not implemented.
+
+Coverage    Requirement:  95.83% (23/24 checks passed).
+Coverage Recommendation:   0.00% (0/0 checks passed).
+Coverage          TOTAL:  95.83% (23/24 checks passed).
+
+# dry-run, non-require-all, non-verbose
+Summary    Requirement:  13 checks passed, 1 checks failed, 3 checks skipped,  9 checks not implemented.
+Summary Recommendation:  5 checks passed, 0 checks failed, 2 checks skipped,  14 checks not implemented.
+
+Coverage    Requirement:  66.67% (16/24 checks passed).
+Coverage Recommendation: 100.00% (7/7 checks passed).
+Coverage          TOTAL:  74.19% (23/31 checks passed).
+```
+
+or verbose mode without errors:
+
+```shell
+# dry-run, require-all, verbose mode - no errors
+beman-tidy pipeline started ...
+
+Running check [Requirement][license.approved] ...
+[info           ][license.approved         ]: Valid Apache License - Version 2.0 with LLVM Exceptions found in LICENSE file.
+	check [Requirement][license.approved] ... passed
+
+Running check [Requirement][license.apache_llvm] ...
+	check [Requirement][license.apache_llvm] ... passed
+
+Running check [Requirement][license.criteria] ...
+[skipped        ][license.criteria         ]: beman-tidy cannot actually check license.criteria. Please ignore this message if license.approved has passed. See https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md#licensecriteria for more information.
+Running check [Requirement][license.criteria] ... skipped
+
+...
+
+Running check [Requirement][readme.title] ...
+	check [Requirement][readme.title] ... passed
+
+Running check [Requirement][readme.badges] ...
+	check [Requirement][readme.badges] ... passed
+
+Running check [Requirement][readme.implements] ...
+	check [Requirement][readme.implements] ... passed
+
+...
+
+beman-tidy pipeline finished.
+
+Summary    Requirement:  19 checks passed, 0 checks failed, 3 checks skipped,  23 checks not implemented.
+Summary Recommendation:  0 checks passed, 0 checks failed, 2 checks skipped,  0 checks not implemented.
+
+Coverage    Requirement: 100.00% (24/24 checks passed).
+Coverage Recommendation:   0.00% (0/0 checks passed).
+Coverage          TOTAL: 100.00% (24/24 checks passed).
+```
+
+or verbose mode with errors:
+
+```shell
+# dry-run, require-all, verbose mode - with errors
+beman-tidy pipeline started ...
+
+Running check [Requirement][license.approved] ...
+[info           ][license.approved         ]: Valid Apache License - Version 2.0 with LLVM Exceptions found in LICENSE file.
+	check [Requirement][license.approved] ... passed
+
+Running check [Requirement][license.apache_llvm] ...
+	check [Requirement][license.apache_llvm] ... passed
+
+Running check [Requirement][license.criteria] ...
+[skipped        ][license.criteria         ]: beman-tidy cannot actually check license.criteria. Please ignore this message if license.approved has passed. See https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md#licensecriteria for more information.
+Running check [Requirement][license.criteria] ... skipped
+
+...
+
+Running check [Requirement][readme.implements] ...
+	check [Requirement][readme.implements] ... passed
+
+Running check [Requirement][readme.library_status] ...
+[error          ][readme.library_status    ]: The file '/Users/dariusn/dev/dn/git/Beman/exemplar/README.md' does not contain exactly one of the required statuses from ['**Status**: [Under development and not yet ready for production use.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#under-development-and-not-yet-ready-for-production-use)', '**Status**: [Production ready. API may undergo changes.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#production-ready-api-may-undergo-changes)', '**Status**: [Production ready. Stable API.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#production-ready-stable-api)', '**Status**: [Retired. No longer maintained or actively developed.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#retired-no-longer-maintained-or-actively-developed)']
+	check [Requirement][readme.library_status] ... failed
+
+...
+
+beman-tidy pipeline finished.
+
+Summary    Requirement:  18 checks passed, 1 checks failed, 3 checks skipped,  23 checks not implemented.
+Summary Recommendation:  0 checks passed, 0 checks failed, 2 checks skipped,  0 checks not implemented.
+
+Coverage    Requirement:  95.83% (23/24 checks passed).
+Coverage Recommendation:   0.00% (0/0 checks passed).
+Coverage          TOTAL:  95.83% (23/24 checks passed).
+```
+
+- Run beman-tidy on the exemplar repository (fix issues in-place):
+
+```shell
+beman-tidy path/to/exemplar --fix-inplace --verbose
+```
+
+## Working on beman-tidy
+
+Please refer to the [Beman Tidy Development Guide](https://github.com/bemanproject/beman-tidy/blob/main/docs/dev-guide.md) for more details.
+

beman_tidy-0.2.0/README.md

@@ -0,0 +1,142 @@
+# beman-tidy: The Codebase Bemanification Tool
+
+<!--
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+`beman-tidy` is a tool aimed at Beman Project contributors to check (`--dry-run`)
+and apply (`--fix-inplace`) the [Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md)
+to their repositories.
+
+**Note `2025-06-07`:** The first iteration of the tool will not support `--fix-inplace` in order to
+expedite adoption across the Beman Project.
+
+## Usage
+
+- Display help:
+
+```shell
+$ beman-tidy --help
+usage: beman-tidy [-h] [--fix-inplace | --no-fix-inplace] [--verbose | --no-verbose] [--require-all | --no-require-all] [--checks CHECKS] repo_path
+
+positional arguments:
+  repo_path             path to the repository to check
+
+options:
+  -h, --help            show this help message and exit
+  --fix-inplace, --no-fix-inplace
+                        Try to automatically fix found issues
+  --verbose, --no-verbose
+                        print verbose output for each check
+  --require-all, --no-require-all
+                        all checks are required regardless of the check type (e.g., Recommendation becomes Requirement)
+  --checks CHECKS       array of checks to run
+```
+
+- Run beman-tidy on the exemplar repository **(default: dry-run mode)**
+
+```shell
+# dry-run, require-all, non-verbose
+$ beman-tidy /path/to/exemplar --require-all
+Summary    Requirement:  18 checks passed, 1 checks failed, 5 checks skipped,  23 checks not implemented.
+Summary Recommendation:  0 checks passed, 0 checks failed, 0 checks skipped,  0 checks not implemented.
+
+Coverage    Requirement:  95.83% (23/24 checks passed).
+Coverage Recommendation:   0.00% (0/0 checks passed).
+Coverage          TOTAL:  95.83% (23/24 checks passed).
+
+# dry-run, non-require-all, non-verbose
+Summary    Requirement:  13 checks passed, 1 checks failed, 3 checks skipped,  9 checks not implemented.
+Summary Recommendation:  5 checks passed, 0 checks failed, 2 checks skipped,  14 checks not implemented.
+
+Coverage    Requirement:  66.67% (16/24 checks passed).
+Coverage Recommendation: 100.00% (7/7 checks passed).
+Coverage          TOTAL:  74.19% (23/31 checks passed).
+```
+
+or verbose mode without errors:
+
+```shell
+# dry-run, require-all, verbose mode - no errors
+beman-tidy pipeline started ...
+
+Running check [Requirement][license.approved] ...
+[info           ][license.approved         ]: Valid Apache License - Version 2.0 with LLVM Exceptions found in LICENSE file.
+	check [Requirement][license.approved] ... passed
+
+Running check [Requirement][license.apache_llvm] ...
+	check [Requirement][license.apache_llvm] ... passed
+
+Running check [Requirement][license.criteria] ...
+[skipped        ][license.criteria         ]: beman-tidy cannot actually check license.criteria. Please ignore this message if license.approved has passed. See https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md#licensecriteria for more information.
+Running check [Requirement][license.criteria] ... skipped
+
+...
+
+Running check [Requirement][readme.title] ...
+	check [Requirement][readme.title] ... passed
+
+Running check [Requirement][readme.badges] ...
+	check [Requirement][readme.badges] ... passed
+
+Running check [Requirement][readme.implements] ...
+	check [Requirement][readme.implements] ... passed
+
+...
+
+beman-tidy pipeline finished.
+
+Summary    Requirement:  19 checks passed, 0 checks failed, 3 checks skipped,  23 checks not implemented.
+Summary Recommendation:  0 checks passed, 0 checks failed, 2 checks skipped,  0 checks not implemented.
+
+Coverage    Requirement: 100.00% (24/24 checks passed).
+Coverage Recommendation:   0.00% (0/0 checks passed).
+Coverage          TOTAL: 100.00% (24/24 checks passed).
+```
+
+or verbose mode with errors:
+
+```shell
+# dry-run, require-all, verbose mode - with errors
+beman-tidy pipeline started ...
+
+Running check [Requirement][license.approved] ...
+[info           ][license.approved         ]: Valid Apache License - Version 2.0 with LLVM Exceptions found in LICENSE file.
+	check [Requirement][license.approved] ... passed
+
+Running check [Requirement][license.apache_llvm] ...
+	check [Requirement][license.apache_llvm] ... passed
+
+Running check [Requirement][license.criteria] ...
+[skipped        ][license.criteria         ]: beman-tidy cannot actually check license.criteria. Please ignore this message if license.approved has passed. See https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md#licensecriteria for more information.
+Running check [Requirement][license.criteria] ... skipped
+
+...
+
+Running check [Requirement][readme.implements] ...
+	check [Requirement][readme.implements] ... passed
+
+Running check [Requirement][readme.library_status] ...
+[error          ][readme.library_status    ]: The file '/Users/dariusn/dev/dn/git/Beman/exemplar/README.md' does not contain exactly one of the required statuses from ['**Status**: [Under development and not yet ready for production use.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#under-development-and-not-yet-ready-for-production-use)', '**Status**: [Production ready. API may undergo changes.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#production-ready-api-may-undergo-changes)', '**Status**: [Production ready. Stable API.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#production-ready-stable-api)', '**Status**: [Retired. No longer maintained or actively developed.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#retired-no-longer-maintained-or-actively-developed)']
+	check [Requirement][readme.library_status] ... failed
+
+...
+
+beman-tidy pipeline finished.
+
+Summary    Requirement:  18 checks passed, 1 checks failed, 3 checks skipped,  23 checks not implemented.
+Summary Recommendation:  0 checks passed, 0 checks failed, 2 checks skipped,  0 checks not implemented.
+
+Coverage    Requirement:  95.83% (23/24 checks passed).
+Coverage Recommendation:   0.00% (0/0 checks passed).
+Coverage          TOTAL:  95.83% (23/24 checks passed).
+```
+
+- Run beman-tidy on the exemplar repository (fix issues in-place):
+
+```shell
+beman-tidy path/to/exemplar --fix-inplace --verbose
+```
+
+## Working on beman-tidy
+
+Please refer to the [Beman Tidy Development Guide](https://github.com/bemanproject/beman-tidy/blob/main/docs/dev-guide.md) for more details.

beman_tidy-0.2.0/beman_tidy/.beman-standard.yml

@@ -0,0 +1,139 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# 2025-08-04: Latest Beman Standard (https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md)
+# snapshot made by neatudarius.
+# Please report any issue related to this file to https://github.com/bemanproject/infra/issues.
+
+# LICENSE
+license.approved:
+    - type: Requirement
+license.apache_llvm:
+    - type: Recommendation
+license.criteria:
+    - type: Requirement
+
+# GENERAL
+library.name:
+    - type: Recommendation
+
+# REPOSITORY
+repository.name:
+    - type: Requirement
+repository.default_branch:
+    - type: Requirement
+repository.codeowners:
+    - type: Requirement
+repository.code_review_rules:
+    - type: Requirement
+repository.disallow_git_submodules:
+    - type: Recommendation
+
+# RELEASE
+release.github:
+    - type: Requirement
+release.notes:
+    - type: Recommendation
+release.godbolt_trunk_version:
+    - type: Recommendation
+
+# TOP LEVEL
+toplevel.cmake:
+    - type: Requirement
+    - value: CMakeLists.txt
+toplevel.license:
+    - type: Requirement
+    - file_name: LICENSE
+toplevel.readme:
+    - type: Requirement
+    - file_name: README.md
+
+# README
+readme.title:
+    - type: Recommendation
+readme.badges:
+    - type: Requirement
+    - values:
+        - library_status: [
+            "![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg)",
+            "![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_production_ready_api_may_undergo_changes.svg)",
+            "![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_production_ready_stable_api.svg)",
+            "![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_retired.svg)"
+        ]
+        - standard_target: [
+            "![Standard Target](https://github.com/bemanproject/beman/blob/main/images/badges/cpp26.svg)",
+            "![Standard Target](https://github.com/bemanproject/beman/blob/main/images/badges/cpp29.svg)"
+        ]
+readme.purpose:
+    - type: Recommendation
+readme.implements:
+    - type: Recommendation
+readme.library_status:
+    - type: Requirement
+    - values: [
+            "**Status**: [Under development and not yet ready for production use.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#under-development-and-not-yet-ready-for-production-use)",
+            "**Status**: [Production ready. API may undergo changes.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#production-ready-api-may-undergo-changes)",
+            "**Status**: [Production ready. Stable API.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#production-ready-stable-api)",
+            "**Status**: [Retired. No longer maintained or actively developed.](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#retired-no-longer-maintained-or-actively-developed)",
+        ]
+readme.license:
+    - type: Requirement
+
+# CMAKE
+cmake.default:
+    - type: Recommendation
+cmake.use_fetch_content:
+    - type: Recommendation
+cmake.project_name:
+    - type: Recommendation
+cmake.passive_projects:
+    - type: Recommendation
+cmake.library_name:
+    - type: Recommendation
+cmake.library_alias:
+    - type: Requirement
+cmake.target_names:
+    - type: Recommendation
+cmake.passive_targets:
+    - type: Requirement
+cmake.config:
+    - type: Requirement
+cmake.skip_tests:
+    - type: Recommendation
+cmake.skip_examples:
+    - type: Recommendation
+cmake.avoid_passthroughs:
+    - type: Recommendation
+
+# DIRECTORY
+directory.interface_headers:
+    - type: Requirement
+directory.implementation_headers:
+    - type: Requirement
+directory.sources:
+    - type: Requirement
+directory.tests:
+    - type: Requirement
+directory.examples:
+    - type: Requirement
+directory.docs:
+    - type: Requirement
+directory.papers:
+    - type: Requirement
+
+# FILE
+file.cpp_names:
+    - type: Recommendation
+file.test_names:
+    - type: Requirement
+file.license_id:
+    - type: Requirement
+file.copyright:
+    - type: Recommendation
+
+# CPP
+cpp.namespace:
+    - type: Recommendation
+cpp.no_flag_forking:
+    - type: Requirement
+cpp.extension_identifiers:
+    - type: Recommendation