loxcan

KO | EN

gitlite — search

#hacktoberfest #typescript #go #deep-learning #docker #java #nodejs #windows #cli #kubernetes #pytorch #security #openai #open-source

(★ 66)

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

loxcan Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](https://raw.githubusercontent.com/siketyan/loxcan/main/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](https://raw.githubusercontent.com/siketyan/loxcan/main/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] Go Modules (Go)
- [x] Pipenv (Python)
- [x] npm (JavaScript, Node.js)
- [x] pnpm (JavaScript, Node.js)
- [x] Yarn (JavaScript, Node.js)
- [x] Pub (Dart)

## 📋 Supported Reporters
(✅ = Supported, ⬜️ = Scheduled)

- [x] GitHub
- [ ] GitLab

loxcan

loxcan Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

loxcan

loxcan Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README