https://github.com/capjamesg/viclint
Official linter for VisionScript.
https://github.com/capjamesg/viclint
linting visionscript
Last synced: 2 months ago
JSON representation
Official linter for VisionScript.
- Host: GitHub
- URL: https://github.com/capjamesg/viclint
- Owner: capjamesg
- License: mit
- Created: 2023-08-18T21:02:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-18T21:02:39.000Z (over 2 years ago)
- Last Synced: 2025-03-10T18:00:44.518Z (12 months ago)
- Topics: linting, visionscript
- Language: Python
- Homepage: https://visionscript.dev/lint/
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# viclint
viclint is the official code linter for [VisionScript](https://visionscript.dev).
You can use `viclint` to ensure your code conforms to the VisionScript style.
## Installation
To install viclint, run the following command:
```bash
pip install viclint
```
## Usage
To use viclint, run:
```bash
viclint
```
`` can be a single file or a directory whose `.vic` files you want to lint.
A file must end in `.vic` to be linted.
Here is an example output from the linter:
```
🪄 Linting ./camera.vic...
✨ Your code is now prettier! ✨
```
If the lint failed, you will see an error message:
```
🪄 Linting ./camera.vic...
🚨 ./camera.vic failed to lint.
```
## License
This project is licensed under an [MIT license](LICENSE).
## Related Resources
- [VisionScript Website and Documentation](https://visionscript.dev)
- [VisionScript GitHub repository](https://github.com/capjamesg/visionscript)
- [VisionScript Visual Studio Code extension](https://github.com/capjamesg/)