codelaw-rules-data 0.2.0__py3-none-any.whl

codelaw_rules_data/licenses/SchemaStore-Apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 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.

codelaw_rules_data/presets/data/conventions.toml

@@ -0,0 +1,5 @@
+description = "Opt-in house conventions for YAML and Markdown"
+
+[rules]
+"md/no-inline-html" = "warn"
+"yaml/document-start" = "warn"

codelaw_rules_data/presets/data/github-actions.toml

@@ -0,0 +1,6 @@
+description = "Starter rules for GitHub Actions workflows and composite actions"
+
+[rules]
+"yaml/gha-action-schema" = "error"
+"yaml/gha-pin-sha" = "warn"
+"yaml/gha-workflow-schema" = "error"

codelaw_rules_data/presets/data/package-json.toml

@@ -0,0 +1,7 @@
+description = "Starter rules for package.json"
+
+[rules]
+"json/package-deps-sorted" = "warn"
+"json/package-engines" = "warn"
+"json/package-json-schema" = "error"
+"json/package-scripts-sorted" = "warn"

codelaw_rules_data/presets/data/pyproject.toml

@@ -0,0 +1,6 @@
+description = "Starter rules for pyproject.toml"
+
+[rules]
+"toml/deps-sorted" = "warn"
+"toml/pyproject-requires-python" = "warn"
+"toml/pyproject-schema" = "error"

codelaw_rules_data/presets/data/recommended.toml

@@ -0,0 +1,9 @@
+description = "Correctness for JSON, YAML and TOML: keys defined twice, aliases without an anchor, and the scalars YAML 1.1 and 1.2 read differently"
+
+[rules]
+"json/no-duplicate-keys" = "error"
+"toml/no-duplicate-keys" = "error"
+"yaml/no-ambiguous-booleans" = "warn"
+"yaml/no-ambiguous-numbers" = "warn"
+"yaml/no-duplicate-keys" = "error"
+"yaml/no-undeclared-alias" = "error"

codelaw_rules_data/presets/data/tsconfig.toml

@@ -0,0 +1,5 @@
+description = "Starter rules for tsconfig.json"
+
+[rules]
+"json/tsconfig-schema" = "error"
+"json/tsconfig-strict" = "warn"

codelaw_rules_data/presets/md/recommended.toml

@@ -0,0 +1,20 @@
+description = "The non-layout rules of markdownlint 0.42.0's default set, reimplemented (layout belongs to the formatter), and the starter rule md/relative-links"
+
+[rules]
+"md/commands-show-output" = "warn"
+"md/descriptive-link-text" = "warn"
+"md/fence-language" = "warn"
+"md/first-line-heading" = "warn"
+"md/heading-increment" = "warn"
+"md/link-fragments" = "error"
+"md/link-image-reference-definitions" = "warn"
+"md/no-alt-text" = "warn"
+"md/no-bare-urls" = "warn"
+"md/no-duplicate-heading" = "warn"
+"md/no-emphasis-as-heading" = "warn"
+"md/no-empty-links" = "error"
+"md/no-reversed-links" = "error"
+"md/reference-links-images" = "error"
+"md/relative-links" = "error"
+"md/single-h1" = "warn"
+"md/table-column-count" = "error"

codelaw_rules_data/rules/json/no-duplicate-keys.cases.md

@@ -0,0 +1,27 @@
+# json/no-duplicate-keys — edge cases
+
+### case: same key in different objects
+
+```json
+{
+  "a": { "id": 1 },
+  "b": { "id": 2 }
+}
+```
+
+```expect
+(none)
+```
+
+### case: escaped spelling of the same key
+
+```json
+{
+  "id": 1,
+  "\u0069d": 2
+}
+```
+
+```expect
+3:3 json/no-duplicate-keys
+```

codelaw_rules_data/rules/json/no-duplicate-keys.md

@@ -0,0 +1,45 @@
+---
+id: json/no-duplicate-keys
+title: "No key twice in one JSON object"
+languages: [json]
+fix: manual
+fix_reason: "which of the two values was meant can't be known from the file"
+stability: preview
+since: 0.1.0
+---
+
+Each key appears once in a JSON object. Keys are compared by value, so `"a"` and `"\u0061"` are the same key.
+
+**Why:** RFC 8259 leaves duplicate keys undefined: most parsers keep the last value and silently drop the first, others keep the first or refuse the file.
+
+```codelaw
+native: json/no-duplicate-keys
+```
+
+## How to fix
+
+1. Decide which value the key should have.
+2. Delete the other entry, or move it under a key of its own.
+
+## Examples
+
+### JSON
+
+#### Don't
+
+```json
+{
+  "name": "app",
+  "version": "1.0.0",
+  "name": "web-app"
+}
+```
+
+#### Do
+
+```json
+{
+  "name": "web-app",
+  "version": "1.0.0"
+}
+```

codelaw_rules_data/rules/json/package-deps-sorted.cases.md

@@ -0,0 +1,90 @@
+# json/package-deps-sorted — edge cases
+
+### case: every list is checked, and each is fixed on its own
+
+```json
+{
+  "dependencies": { "b": "1", "a": "1" },
+  "devDependencies": {
+    "vitest": "^3.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": { "react": "*" }
+}
+```
+
+```expect
+2:3 json/package-deps-sorted
+3:3 json/package-deps-sorted
+```
+
+```fixed
+{
+  "dependencies": { "a": "1", "b": "1" },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": { "react": "*" }
+}
+```
+
+### case: a list of bundled names
+
+```json
+{
+  "bundleDependencies": ["zod", "ajv"]
+}
+```
+
+```expect
+2:3 json/package-deps-sorted
+```
+
+```fixed
+{
+  "bundleDependencies": ["ajv", "zod"]
+}
+```
+
+### case: a comment between entries keeps the fix from running
+
+```json
+{
+  "dependencies": {
+    "b": "1",
+    // pinned until the next major
+    "a": "1"
+  }
+}
+```
+
+```expect
+2:3 json/package-deps-sorted
+```
+
+### case: the text around the list is untouched
+
+```json
+{
+  // build tooling
+  "name":    "x",
+  "dependencies": {"z": "1",
+                   "a": "2"},
+  "version": "1.0.0"
+}
+```
+
+```expect
+4:3 json/package-deps-sorted
+```
+
+```fixed
+{
+  // build tooling
+  "name":    "x",
+  "dependencies": {"a": "2",
+                   "z": "1"},
+  "version": "1.0.0"
+}
+```

codelaw_rules_data/rules/json/package-deps-sorted.md

@@ -0,0 +1,54 @@
+---
+id: json/package-deps-sorted
+title: "package.json dependency lists are sorted by name"
+languages: [json]
+files: ["**/package.json"]
+fix: auto
+stability: preview
+since: 0.1.0
+---
+
+The `dependencies`, `devDependencies`, `peerDependencies`, `optionalDependencies` and `bundleDependencies` of a `package.json` are in name order.
+
+**Why:** npm writes these lists sorted, so a hand-added entry out of order turns into an unrelated diff the next time npm touches the file; a sorted list is also quicker to scan.
+
+```codelaw
+target: [dependencies, devDependencies, peerDependencies, optionalDependencies, bundleDependencies, bundledDependencies]
+assert: { sorted: true }
+message: "Sort `$PATH` by package name"
+fix: [sort-keys]
+```
+
+## Examples
+
+### JSON
+
+#### Don't
+
+```json path=package.json
+{
+  "name": "app",
+  "dependencies": {
+    "react": "^19.0.0",
+    "@tanstack/query": "^5.0.0",
+    "lodash": "^4.17.21"
+  }
+}
+```
+
+#### Do
+
+```json path=package.json
+{
+  "name": "app",
+  "dependencies": {
+    "@tanstack/query": "^5.0.0",
+    "lodash": "^4.17.21",
+    "react": "^19.0.0"
+  }
+}
+```
+
+## Notes
+
+Names compare by Unicode code point, so scoped packages (`@scope/…`) come first. `bundleDependencies` may be a list of names; its items are sorted the same way. A list with comments between its entries is reported without a fix: the comments would be left behind while the entries move.

codelaw_rules_data/rules/json/package-engines.cases.md

@@ -0,0 +1,24 @@
+# json/package-engines — edge cases
+
+### case: engines without node
+
+```json
+{
+  "engines": {
+    "npm": ">=10"
+  }
+}
+```
+
+```expect
+2:14 json/package-engines
+```
+
+```fixed
+{
+  "engines": {
+    "node": ">=22",
+    "npm": ">=10"
+  }
+}
+```

codelaw_rules_data/rules/json/package-engines.md

@@ -0,0 +1,45 @@
+---
+id: json/package-engines
+title: "package.json declares engines.node"
+languages: [json]
+files: ["**/package.json"]
+fix: suggest
+fix_reason: "the supported Node.js range is a project decision; the fix inserts the `node` option, which may not be the right range"
+stability: preview
+options:
+  node: { type: "string", default: ">=22", description: "the range the fix writes into `engines.node`" }
+since: 0.1.0
+---
+
+A `package.json` says which Node.js versions the package runs on, in `engines.node`.
+
+**Why:** Without it, npm and package managers can't warn someone installing on an unsupported Node.js, and the package fails later with an error that doesn't say why.
+
+```codelaw
+native: json/package-engines
+```
+
+## Examples
+
+### JSON
+
+#### Don't
+
+```json path=package.json
+{
+  "name": "app",
+  "version": "1.0.0"
+}
+```
+
+#### Do
+
+```json path=package.json
+{
+  "name": "app",
+  "version": "1.0.0",
+  "engines": {
+    "node": ">=22"
+  }
+}
+```

codelaw_rules_data/rules/json/package-json-schema.md

@@ -0,0 +1,57 @@
+---
+id: json/package-json-schema
+title: "package.json matches its schema"
+languages: [json]
+files: ["**/package.json"]
+fix: manual
+fix_reason: "a value the schema rejects is wrong in a way only its author knows how to correct"
+stability: preview
+ported_from: [schemastore/package.json]
+since: 0.1.0
+---
+
+A `package.json` matches SchemaStore's schema for it: every field has the type and the form npm reads, and `name` and `version` are written the way the registry accepts.
+
+**Why:** npm and the tools that read `package.json` ignore or misread a field of the wrong shape — a `bin` that is a list, a `files` that is a string, an `engines` range that is a number — so the mistake surfaces later, far from the line that caused it.
+
+```codelaw
+target: $
+assert: { schema: schemas/package }
+message: "$ERROR"
+```
+
+## How to fix
+
+1. Read the message: it names the field and the form the schema expects.
+2. Rewrite the value in that form, or remove the field if it was a mistake.
+3. Run `codelaw check` on the file again until it is clean.
+
+## Examples
+
+### JSON
+
+#### Don't
+
+```json path=package.json
+{
+  "name": "app",
+  "version": "1.0.0",
+  "files": "dist",
+  "private": "yes"
+}
+```
+
+#### Do
+
+```json path=package.json
+{
+  "name": "app",
+  "version": "1.0.0",
+  "files": ["dist"],
+  "private": true
+}
+```
+
+## Notes
+
+The schema is SchemaStore's `package.json` schema, shipped with the pack in `data/schemas/package.json` with its descriptions removed; nothing is fetched. Fields whose schema lives in another SchemaStore file (`eslintConfig`, `prettier`, `stylelint`, `ava`, `release`, `nodemonConfig`, …) accept any value. `oneOf` is read as `anyOf`, and a pattern the engine's regular expressions can't read (look-around) accepts every value.

codelaw_rules_data/rules/json/package-scripts-sorted.cases.md

@@ -0,0 +1,45 @@
+# json/package-scripts-sorted — edge cases
+
+### case: order-sensitive runner
+
+```json
+{
+  "scripts": {
+    "build": "run-s build:*",
+    "build:js": "tsc",
+    "build:css": "sass"
+  }
+}
+```
+
+```expect
+(none)
+```
+
+### case: hooks sort next to their script
+
+```json
+{
+  "scripts": {
+    "prepare": "husky",
+    "postbuild": "x",
+    "build": "tsc",
+    "prebuild": "rm -rf dist"
+  }
+}
+```
+
+```expect
+2:3 json/package-scripts-sorted
+```
+
+```fixed
+{
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc",
+    "postbuild": "x",
+    "prepare": "husky"
+  }
+}
+```