indexwright 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project follows semantic
+versioning. Pre-1.0, rule additions and message changes may land in minor releases; the `json`
+output shape is the stable contract.
+
+## [0.1.0] — unreleased
+
+First release. Static analysis of `firestore.indexes.json`; no network access, no credentials.
+
+### Added
+
+- `indexwright lint <file...>` with `--format text|json|github`, `--max-warnings`, `--rule`,
+  `--disable`, `--quota`, and `--quota-threshold`.
+- Rules `scope-mismatch`, `field-order-variant`, `explicit-name-field`, and `quota-headroom`. Every
+  rule warns; the default exit code is 0 even with findings.
+- A canonical index key that resolves declarations differing only in an explicitly written
+  `__name__` to the same resource.
+- A provisional JavaScript API, so the rules can run without spawning a process.
+
+[0.1.0]: https://github.com/uny/indexwright/releases/tag/v0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Yuki Nagai
+
+   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.

package/README.md

@@ -0,0 +1,184 @@
+# indexwright
+
+Linter for Firestore composite index declarations — `firestore.indexes.json`.
+
+> **The rules are provisional.** Their false-positive rates are unmeasured, so every rule emits a
+> warning and the default exit code is 0 even with findings. See [Toward 1.0](#toward-10).
+
+## Why
+
+Firestore composite indexes are declared as data and applied as whole-state, and three properties of
+the platform make that declaration hard to get right:
+
+- **The emulator does not enforce composite indexes.** A query that will fail in production with
+  `FAILED_PRECONDITION` passes locally.
+- **There are no per-index usage metrics.** You cannot ask the platform which indexes are used.
+- **The index-matching rule is undocumented.** Index changes cannot be validated against
+  documentation, only empirically.
+
+Security rules have an official test harness and can be verified in the emulator. Composite indexes
+have no equivalent. So declarations drift into states that are detectable by inspection but that
+nothing inspects: inconsistent `queryScope` within a collection, near-duplicate indexes that differ
+only in field order, artifacts of round-tripping through live exports, and a silent approach to the
+per-database index quota.
+
+## What this is not
+
+**indexwright cannot determine whether an index is needed.** That question requires the queries,
+which live in application code, not in the index declaration. No rule asserts that an index is
+unnecessary, and no output should be read as authorising a deletion.
+
+Deleting a composite index is not symmetric with adding one: an addition does not disturb existing
+queries while it backfills, but a deletion breaks its queries the moment it takes effect, and
+restoring it requires a fresh backfill. A linter that only sees the declaration must never be the
+basis for a deletion.
+
+What indexwright asserts is narrower: *these declarations are structurally inconsistent with each
+other, and a human should look.*
+
+## Install
+
+```bash
+npm install --save-dev indexwright
+```
+
+Node.js 22 or newer. No runtime dependencies.
+
+Or run it without installing:
+
+```bash
+npx indexwright lint firestore.indexes.json
+```
+
+## Usage
+
+```
+indexwright lint <file...> [options]
+
+Options:
+  --format <fmt>        text (default) | json | github
+  --max-warnings <n>    exit 1 if warnings exceed n (default: unlimited)
+  --rule <id>           run only the given rule; repeatable
+  --disable <id>        skip the given rule; repeatable
+  --quota <n>           per-database composite index limit (default: 1000)
+  --quota-threshold <p> warn above this fraction of the limit (default: 0.8)
+  -h, --help            show the usage
+      --version         show the version
+```
+
+### Exit codes
+
+| Code | Meaning |
+|-----:|:--------|
+| 0 | Completed. Warnings may have been emitted. |
+| 1 | Warning count exceeded `--max-warnings`. |
+| 2 | Usage error, unreadable file, or malformed input. |
+
+**The default is exit 0 even with findings.** A linter whose rules have unmeasured false-positive
+rates must not gate a pipeline by default. Opt into enforcement with `--max-warnings` once you have
+measured your own noise level.
+
+## Rules
+
+| Id | Detects |
+|:---|:--------|
+| `scope-mismatch` | One `collectionGroup` declaring more than one `queryScope`. |
+| `field-order-variant` | Indexes over the same field set, declared in different field orders. |
+| `explicit-name-field` | A trailing `__name__` that restates the direction Firestore appends anyway. |
+| `quota-headroom` | The declared index count is close to the per-database limit. |
+
+Each rule's rationale, its known false positives, and the exact detection condition are in
+[SPEC.md](SPEC.md) §5.
+
+### A note on `__name__`
+
+Firestore appends the document key to every composite index, and live exports render it explicitly.
+indexwright treats the implicit direction as *the `order` of the last preceding field that carries
+one*, or `ASCENDING` when none does. A trailing `__name__` is stripped from the canonical key only
+when it matches that direction, so `[totalNbUses DESCENDING, __name__ ASCENDING]` — which is
+meaningful — is preserved and not flagged.
+
+## Output
+
+`text` is grouped by rule and meant for a terminal. `github` emits workflow commands plus a Markdown
+table for `$GITHUB_STEP_SUMMARY`. `json` is the stable machine-readable contract:
+
+```jsonc
+{
+  "version": "0.1.0",
+  "files": ["firestore.indexes.json"],
+  "summary": { "warnings": 1, "errors": 0, "byRule": { "scope-mismatch": 1, "…": 0 } },
+  "findings": [
+    {
+      "rule": "scope-mismatch",
+      "file": "firestore.indexes.json",
+      "key": "posts::COLLECTION_GROUP::pinned:ASCENDING|createdAt:DESCENDING",
+      "message": "…",
+      "related": []
+    }
+  ],
+  "errors": []
+}
+```
+
+Output is deterministic: findings are sorted by file, then rule, then key, so two runs diff cleanly.
+
+### In GitHub Actions
+
+```yaml
+- run: npx indexwright lint firestore.indexes.json --format github
+```
+
+## JavaScript API
+
+The package also exports the rules directly. **This API is provisional and may change in any minor
+release before 1.0**; only the `json` output shape carries the compatibility promise.
+
+```js
+import { lintFiles } from 'indexwright';
+
+const result = lintFiles(['firestore.indexes.json'], { quota: 200 });
+console.log(result.summary.byRule);
+```
+
+## Scope
+
+v0.1.0 is static analysis of declaration files only: no network access, no credentials, no Firestore
+connection.
+
+Planned, and deliberately split:
+
+- **v0.2 — query capture.** The emulator speaks the Firestore v1 gRPC API in plaintext on a local
+  port, so an intercepting proxy can record observed `StructuredQuery` shapes. This is language- and
+  framework-independent because it operates on the wire protocol.
+- **v0.3 — coverage check.** Replay a captured corpus against a throwaway database with the
+  candidate index set applied, and report queries that fail with `FAILED_PRECONDITION`. The oracle
+  is Firestore itself; indexwright does not reimplement the undocumented matching rule.
+
+Coverage will be bounded by what actually exercises the proxy. A query no test issues is not
+observed, and absence of observation is not evidence that an index is unused. That limit is
+inherent.
+
+## Toward 1.0
+
+1.0 requires, at minimum: measured false-positive rates for `scope-mismatch` and
+`field-order-variant` across more than one real project; at least one adopter outside the project of
+origin; and a decision, informed by that data, on whether any rule should default to failing.
+
+Until then the version stays below 1.0 and the rules stay provisional.
+
+## Development
+
+```bash
+npm install
+npm test                  # builds, then runs the suite against dist/
+npm run verify-package    # builds, packs, installs the tarball, exercises the bin and the API
+```
+
+Both scripts build first as an explicit step rather than through a `pre` hook, because npm skips
+`pre`/`post` scripts entirely under `ignore-scripts=true` — a setting many developers turn on. With
+a hook, that configuration silently tests whatever `dist/` happened to be lying around.
+
+## License
+
+Apache-2.0