https://github.com/siketyan/loxcan

🔍 Universal Lock File Scanner for Git. (Lock + Scan = LoXcan!)
https://github.com/siketyan/loxcan

github-action lock-file package-manager

Last synced: 4 days ago
JSON representation

🔍 Universal Lock File Scanner for Git. (Lock + Scan = LoXcan!)

• Host: GitHub
• URL: https://github.com/siketyan/loxcan
• Owner: siketyan
• License: mit
• Created: 2020-11-23T02:14:23.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T22:55:19.000Z (26 days ago)
• Last Synced: 2024-12-23T20:42:15.563Z (5 days ago)
• Topics: github-action, lock-file, package-manager
• Language: PHP
• Homepage:
• Size: 968 KB
• Stars: 60
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# loxcan

[![Latest Stable Version](https://poser.pugx.org/siketyan/loxcan/v)](https://packagist.org/packages/siketyan/loxcan)

[![Total Downloads](https://poser.pugx.org/siketyan/loxcan/downloads)](https://packagist.org/packages/siketyan/loxcan)

[![License](https://poser.pugx.org/siketyan/loxcan/license)](https://packagist.org/packages/siketyan/loxcan)

[![Codecov](https://codecov.io/gh/siketyan/loxcan/branch/master/graph/badge.svg?token=2DB0MRBL4E)](https://codecov.io/gh/siketyan/loxcan)

![PHP](https://github.com/siketyan/loxcan/workflows/PHP/badge.svg)

![Action](https://github.com/siketyan/loxcan/workflows/Action/badge.svg)

Universal Lock File Scanner for Git.

## 🚀 Motivation

Today, most languages have a package manager, and some language have two.

Dependency management is very important and difficult in software development.

In cases of code review, we check entire of the changed codes.

However, we often ignore lock files in the review, which controls dependencies of the project or the library.

On GitHub Pull Request, most lock files are hidden by default.

![Load diff screen](./resources/load-diff.png)

Actually, they are very long and not human-readable.

I tried to notify the diff of the lock files to the author of PR and/or the reviewer(s).

Using this action, the added, upgraded, downgraded, and removed packages are reported to the PR, in user-friendly format.

![Report of the changed packages](./resources/screenshot.png)

So we can check what packages will be changed by the PR, in the review.

## ✨ Usage

### Via Composer

```console

$ composer require --dev siketyan/loxcan

```

Then you can use this tool in CLI.

(In some IDEs, you can access to the executable as just `loxcan` !)

```console

$ ./vendor/bin/loxcan [base] [head]

```

### In GitHub Actions

Use `pull_request` events to trigger the action.

```yaml

steps:

  - uses: actions/checkout@v3

    with:

      fetch-depth: 0

  - uses: siketyan/loxcan@main

```

## 📦 Supported Package Managers

(✅ = Supported, ⬜️ = Scheduled)

- [x] Composer (PHP)

- [x] Cargo (Rust)

- [x] Pub (Dart)

- [x] npm (JavaScript, Node.js)

- [x] pnpm (JavaScript, Node.js)

- [x] Yarn (JavaScript, Node.js)

## 📋 Supported Reporters

(✅ = Supported, ⬜️ = Scheduled)

- [x] GitHub

- [ ] GitLab