lockdelta 0.1.0

package/LICENSE

@@ -0,0 +1,183 @@
+                                 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 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 transformations
+      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, as submitted to the 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 designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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 any
+      Contribution embodied 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as Your separate and expressed permission.
+
+   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 reproducing 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 exemplary 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 all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or 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 offer such obligations 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 warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Louis-Amaury Chaib
+
+   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,342 @@
+# lockdelta
+
+Diff dependency lockfiles between git refs or PRs and emit a structured report. Works as a **GitHub Action**, **CLI**, or **Node.js library**.
+
+Supports Python, JavaScript, and Deno ecosystems — including automatic detection of tool migrations (e.g. poetry → uv). Monorepo-aware: all lockfiles in the repository are auto-discovered.
+
+---
+
+## GitHub Action
+
+### Basic usage
+
+```yaml
+name: Dependency review
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  lockdelta:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+
+    steps:
+      - name: Diff dependencies
+        id: lockdelta
+        uses: lachaib/lockdelta@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Use the diff
+        run: echo '${{ steps.lockdelta.outputs.diff }}'
+```
+
+No inputs are required on `pull_request` or `push` events. The action reads the relevant SHAs from the GitHub event payload automatically and fetches everything through the GitHub API — no `actions/checkout` needed.
+
+| Event | What is compared |
+|-------|-----------------|
+| `pull_request` | PR base commit → head commit |
+| `push` | SHA before the push → SHA after the push |
+
+`GITHUB_TOKEN` is provided automatically by GitHub Actions — no extra secrets needed.
+
+> **First push to a branch**: when `before` is the null SHA (no previous commit on the branch), the action skips rather than erroring.
+
+### Inputs
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `pr-number` | GitHub PR number. Auto-detected from the event payload on `pull_request` events — usually not needed. | Auto |
+| `base-ref` | Base git ref (branch, tag, SHA). Reads `GITHUB_BASE_REF` in CI. | `HEAD~1` |
+| `head-ref` | Head git ref. Reads `GITHUB_HEAD_REF` in CI. | `HEAD` |
+| `repo` | GitHub repo in `OWNER/NAME` format. Auto-detected from `GITHUB_REPOSITORY`. | Auto |
+| `lockfile` | Specific lockfile path. Auto-discovers all if omitted. | — |
+| `type` | Force lockfile type: `uv`, `poetry`, `pdm`, etc. Used with `lockfile`. | — |
+| `filters` | YAML map of named package groups → boolean outputs (see [Filters](#filters)). | — |
+| `markdown` | Set to `'true'` to generate a markdown summary output. | `false` |
+| `json-to-file` | File path to write the JSON report to. | — |
+| `markdown-to-file` | File path to write the markdown summary to. Requires `markdown: 'true'`. | — |
+| `post-comment` | `'true'` always posts/updates a comment. `'if-changed'` posts only when at least one dependency changed. `'false'` never posts. Requires `pull-requests: write`. | `false` |
+
+### Outputs
+
+| Output | Description |
+|--------|-------------|
+| `diff` | Full JSON diff report (see [Output schema](#output-schema)) |
+| `markdown` | Markdown summary (Added / Changed / Removed). Set when `markdown: 'true'`. |
+| `<group>` | One boolean output per group defined in `filters`. |
+
+### Markdown summary
+
+When `markdown: 'true'` or `post-comment` is not `'false'`, lockdelta generates a three-section markdown summary. Direct production dependencies are **bold**, dev dependencies are *italic*, and transitive deps are plain. Package names link to their registry (PyPI, npmjs, jsr.io).
+
+```yaml
+- name: Diff dependencies
+  id: lockdelta
+  uses: lachaib/lockdelta@v1
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  with:
+    markdown: 'true'
+    post-comment: 'if-changed'
+```
+
+(`pull-requests: write` permission required on the job for `post-comment`.)
+
+Example output:
+
+```markdown
+### Changed
+
+- **[requests](https://pypi.org/project/requests/)**: `2.31.0` → `2.32.3`
+- *[pytest](https://pypi.org/project/pytest/)*: `8.0.0` → `8.1.0`
+- [certifi](https://pypi.org/project/certifi/): `2024.2.2` → `2024.7.4`
+
+### Added
+
+- **[httpx](https://pypi.org/project/httpx/)**: `0.27.0`
+```
+
+### Filters
+
+Inspired by [dorny/paths-filter](https://github.com/dorny/paths-filter), the `filters` input lets you name groups of packages. Each group produces a boolean output you can use to gate subsequent steps.
+
+```yaml
+- name: Diff dependencies
+  id: lockdelta
+  uses: lachaib/lockdelta@v1
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  with:
+    filters: |
+      auth:
+        - pyjwt
+        - cryptography
+        - authlib
+      http-client:
+        - httpx
+        - requests
+        - urllib3
+
+- name: Run auth tests
+  if: steps.lockdelta.outputs.auth == 'true'
+  run: pytest tests/auth/
+
+- name: Run integration tests
+  if: steps.lockdelta.outputs.http-client == 'true'
+  run: pytest tests/integration/
+```
+
+### Full example: review gate with PR comment
+
+```yaml
+name: Dependency review
+on:
+  pull_request:
+
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - name: Diff dependencies
+        id: lockdelta
+        uses: lachaib/lockdelta@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          markdown: 'true'
+          post-comment: 'if-changed'
+          filters: |
+            security:
+              - pyjwt
+              - cryptography
+              - certifi
+
+      - name: Block on security package changes
+        if: steps.lockdelta.outputs.security == 'true'
+        run: |
+          echo "Security-sensitive packages changed — manual review required."
+          exit 1
+```
+
+---
+
+## CLI
+
+```bash
+npx lockdelta [options]
+```
+
+> **Note:** `GITHUB_TOKEN` must be set in the environment when using `--pr`.
+
+### Options
+
+```
+--base <ref>         Base git ref (default: HEAD~1, or GITHUB_BASE_REF)
+--head <ref>         Head git ref (default: HEAD, or GITHUB_HEAD_REF)
+--pr <number>        GitHub PR number (uses GitHub API for exact SHAs)
+--repo <owner/name>  GitHub repository (auto-detected from GITHUB_REPOSITORY or git remote)
+--lockfile <path>    Compare a specific lockfile only
+--type <type>        Force lockfile type: uv, poetry, pdm, npm, yarn, pnpm, bun, deno
+--old <path>         Old lockfile path (local file comparison mode)
+--new <path>         New lockfile path (local file comparison mode)
+--output <path>      Write JSON to file instead of stdout
+```
+
+### Examples
+
+```bash
+# Compare against previous commit (git repo)
+lockdelta
+
+# Compare two specific refs
+lockdelta --base main --head my-feature-branch
+
+# Compare a GitHub PR by number
+GITHUB_TOKEN=ghp_... lockdelta --pr 123 --repo owner/myrepo
+
+# Compare two local lockfiles directly
+lockdelta --old old/uv.lock --new new/uv.lock
+
+# Filter to direct dependencies only
+lockdelta --pr 123 | jq '.lockfiles[].changes[] | select(.is_direct)'
+```
+
+---
+
+## Library
+
+```ts
+import { run } from 'lockdelta';
+
+// Compare a PR (requires GITHUB_TOKEN in environment)
+const report = await run({ prNumber: '123', repo: 'owner/myrepo' });
+
+// Compare git refs
+const report = await run({ base: 'main', head: 'my-branch' });
+
+// Compare local files
+const report = await run({ oldFile: './old.lock', newFile: './new.lock' });
+
+console.log(report.summary);
+// { added: 1, removed: 0, updated: 3, total_changes: 4, ecosystems: ['python'] }
+```
+
+### Extending with custom ecosystems
+
+```ts
+import { registerEcosystem } from 'lockdelta';
+import type { Ecosystem, DirectDeps } from 'lockdelta';
+
+const rubyEcosystem: Ecosystem = {
+  name: 'ruby',
+  supportedLockfiles: [{ filename: 'Gemfile.lock', type: 'bundler' }],
+  manifestName: 'Gemfile',
+  getLockfileType: (filename) => filename === 'Gemfile.lock' ? 'bundler' : undefined,
+  parseLockfile: (content, _type) => { /* parse and return { name: version } */ return {}; },
+  parseDirectDeps: (content): DirectDeps => ({ prod: new Set(), dev: new Set() }),
+  normalizeName: (name) => name.toLowerCase(),
+};
+
+registerEcosystem(rubyEcosystem);
+```
+
+---
+
+## Output schema
+
+```ts
+interface PackageChange {
+  name: string;
+  change_type: 'added' | 'removed' | 'updated';
+  old_version: string | null;
+  new_version: string | null;
+  is_direct: boolean;  // declared in the project manifest
+  is_dev: boolean;     // declared in a dev/optional dependency section
+}
+
+interface DiffReport {
+  schema_version: '1';
+  generated_at: string;         // ISO 8601
+  base_ref: string;
+  head_ref: string;
+  summary: {
+    added: number;
+    removed: number;
+    updated: number;
+    total_changes: number;
+    ecosystems: string[];        // e.g. ['python', 'javascript']
+  };
+  lockfiles: Array<{
+    path: string | null;
+    workspace: string;           // '.' for root, 'packages/backend' for monorepos
+    type: string | null;         // e.g. 'uv' | 'poetry' | 'npm' | 'yarn'
+    ecosystem: string;           // e.g. 'python' | 'javascript' | 'deno'
+    summary: { added: number; removed: number; updated: number; total_changes: number };
+    changes: PackageChange[];
+    migration: {                 // non-null when the lockfile tool changed between refs
+      note: string;
+      base_lockfile: string | null;
+      base_lockfile_type: string | null;
+      head_lockfile: string | null;
+      head_lockfile_type: string | null;
+    } | null;
+  }>;
+}
+```
+
+---
+
+## Supported ecosystems
+
+### Python
+
+| Lockfile | Tool | Notes |
+|----------|------|-------|
+| `uv.lock` | [uv](https://github.com/astral-sh/uv) | |
+| `poetry.lock` | [Poetry](https://python-poetry.org) | |
+| `pdm.lock` | [PDM](https://pdm-project.org) | |
+| `pylock.toml` | pip / any ([PEP 751](https://peps.python.org/pep-0751/)) | standard format |
+
+Manifest: `pyproject.toml`. Direct deps are read from `[project].dependencies` (prod) and `[project.optional-dependencies]`, `[tool.poetry.group.*]`, `[tool.uv.dev-dependencies]`, `[dependency-groups]` (dev).
+
+### JavaScript
+
+| Lockfile | Tool | Notes |
+|----------|------|-------|
+| `package-lock.json` | [npm](https://www.npmjs.com) | v1, v2, v3 |
+| `yarn.lock` | [Yarn](https://yarnpkg.com) | Classic (v1) and Berry (v2+) |
+| `pnpm-lock.yaml` | [pnpm](https://pnpm.io) | v5, v6, v9 |
+| `bun.lock` | [Bun](https://bun.sh) | v1.2+ |
+
+Manifest: `package.json`. `dependencies`, `optionalDependencies`, `peerDependencies` → prod. `devDependencies` → dev.
+
+### Deno
+
+| Lockfile | Tool |
+|----------|------|
+| `deno.lock` | [Deno](https://deno.land) |
+
+Manifest: `deno.json`. Both npm and JSR packages are tracked (JSR packages are prefixed with `jsr:` to avoid name collisions).
+
+Migrations between lockfile formats within the same ecosystem are detected automatically (e.g. poetry → uv).
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, how to add a new ecosystem, and contribution guidelines.
+
+---
+
+## License
+
+Apache 2.0 — Copyright 2026 Louis-Amaury Chaib. See [LICENSE](LICENSE).

package/action.yml

@@ -0,0 +1,90 @@
+name: 'lockdelta'
+description: 'Diff dependency lockfiles between git refs or PRs and emit a structured JSON report'
+author: 'lachaib'
+
+branding:
+  icon: 'git-pull-request'
+  color: 'blue'
+
+inputs:
+  base-ref:
+    description: >
+      Base git ref (branch, tag, or SHA). Auto-detected from GITHUB_BASE_REF in CI.
+      In git mode (no pr-number), defaults to HEAD~1.
+    required: false
+  head-ref:
+    description: >
+      Head git ref. Auto-detected from GITHUB_HEAD_REF in CI.
+      In git mode, defaults to HEAD.
+    required: false
+  pr-number:
+    description: >
+      GitHub PR number. Uses the PR's exact base and head commit SHAs via the gh CLI,
+      which avoids branch timing issues. Set to ${{ github.event.pull_request.number }}.
+    required: false
+  repo:
+    description: >
+      GitHub repository in OWNER/NAME format.
+      Auto-detected from GITHUB_REPOSITORY if omitted.
+    required: false
+  lockfile:
+    description: >
+      Specific lockfile path to compare. When omitted, all lockfiles in the
+      repository are auto-discovered (monorepo-aware).
+    required: false
+  type:
+    description: >
+      Force lockfile type: uv, poetry, pdm. Only used together with the lockfile input.
+    required: false
+  filters:
+    description: >
+      YAML map of named package groups. Each group produces a boolean output named after
+      the group, set to 'true' if any package in the group changed. Inspired by
+      dorny/paths-filter. Example:
+        auth:
+          - pyjwt
+          - cryptography
+        http-client:
+          - httpx
+          - requests
+    required: false
+  markdown:
+    description: >
+      Set to 'true' to generate a markdown summary of changes. The summary has three
+      sections (Added, Changed, Removed). Direct prod dependencies are **bold**,
+      dev dependencies are *italic*, transitive deps are plain.
+    required: false
+    default: 'false'
+  json-to-file:
+    description: >
+      File path to write the JSON diff report to. When set, the full report is also
+      written to this path in addition to being emitted as the `diff` output.
+    required: false
+  markdown-to-file:
+    description: >
+      File path to write the markdown summary to. Requires markdown: 'true'.
+    required: false
+  post-comment:
+    description: >
+      Controls PR comment posting. 'true' always posts or updates a comment.
+      'if-changed' posts only when at least one dependency changed (silent skip
+      when nothing changed). 'false' never posts. Uses the GitHub REST API;
+      updates an existing lockdelta comment on re-runs. PR number is auto-detected
+      from the event payload on pull_request events. The markdown summary is
+      generated even if markdown: 'false'.
+    required: false
+    default: 'false'
+
+outputs:
+  diff:
+    description: >
+      JSON diff report. Schema matches DiffReport in the TypeScript types.
+      Contains schema_version, generated_at, base_ref, head_ref, summary, and lockfiles[].
+  markdown:
+    description: >
+      Markdown summary of dependency changes (Added/Changed/Removed sections).
+      Only set when the markdown input is 'true'.
+
+runs:
+  using: 'node24'
+  main: 'dist/action.js'