https://github.com/dalisoft/ls-lint-go-npm
An extremely fast directory and filename linter - Bring some structure to your project filesystem
https://github.com/dalisoft/ls-lint-go-npm
filesystem-linter linter ls-lint
Last synced: about 1 month ago
JSON representation
An extremely fast directory and filename linter - Bring some structure to your project filesystem
- Host: GitHub
- URL: https://github.com/dalisoft/ls-lint-go-npm
- Owner: dalisoft
- License: apache-2.0
- Created: 2024-05-15T20:33:33.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-28T01:03:28.000Z (6 months ago)
- Last Synced: 2025-04-30T18:03:33.620Z (about 1 month ago)
- Topics: filesystem-linter, linter, ls-lint
- Language: Shell
- Homepage: https://ls-lint.org
- Size: 1.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ls-lint-go-npm
An extremely fast directory and filename linter - Bring some structure to your project filesystem
> **npm** integration for [ls-lint-go](https://github.com/loeffel-io/ls-lint) without any overhead so using full power of `ls-lint-go` CLI performance and feature
## Documentations
Look at [official documentation](https://ls-lint.org)
## Motivation
> This package is specifically designed for direct Command-Line Interface (CLI) interaction or as an extension for Visual Studio Code.
### The functionality for npx or bunx is not included and is not anticipated to be incorporated in the future
## How this is fast?
This project leverages the [binary2npm](https://github.com/dalisoft/binary2npm) utility to streamline the acquisition of platform-specific binaries. The binaries provided by the author are highly optimized, surpassing the performance of the traditional **Node.js** `bin.js` approach. By invoking the binaries directly, we circumvent unnecessary overhead, resulting in significantly reduced startup times and enhanced efficiency.
## Installation
```sh
npm install dalisoft/ls-lint-go-npm -D
# or
yarn install dalisoft/ls-lint-go-npm -D
# or
bun add dalisoft/ls-lint-go-npm -D
```
## Environment variables
| Name | Description | Required |
| -------------- | ----------------------------------------------------------------------------------------------- | -------- |
| `GITHUB_TOKEN` | For [GitHub API](https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting) | Yes |
## Usage
See [Documentations](#documentations), requires [Environment variables](#environment-variables)
## License
Apache-2.0