https://github.com/ttytm/vzit

Zig formatter that utilizes `zig fmt` while allowing for tab indentation and diff viewing.
https://github.com/ttytm/vzit

cli-app code-formatter diff formatter tabs zig zig-fmt

Last synced: 3 months ago
JSON representation

Zig formatter that utilizes `zig fmt` while allowing for tab indentation and diff viewing.

• Host: GitHub
• URL: https://github.com/ttytm/vzit
• Owner: ttytm
• License: mit
• Created: 2024-05-17T15:50:37.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-18T12:09:32.000Z (7 months ago)
• Last Synced: 2024-10-25T09:18:41.908Z (3 months ago)
• Topics: cli-app, code-formatter, diff, formatter, tabs, zig, zig-fmt
• Language: V
• Homepage: https://github.com/ttytm/vzit
• Size: 31.3 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VZiT

[badge__build]: https://img.shields.io/github/actions/workflow/status/ttytm/vzit/ci.yml?branch=main&logo=github&logoColor=C0CAF5&labelColor=333

[badge__version]: https://img.shields.io/github/v/release/ttytm/vzit?logo=task&logoColor=C0CAF5&labelColor=333

[![][badge__build]](https://github.com/ttytm/vzit/actions?query=branch%3Amain)

[![][badge__version]](https://github.com/ttytm/vzit/releases/latest)

Uses `zig fmt` to format Zig code while allowing for tab indentation and diff viewing.

## Quick Start

- [Installation](https://github.com/ttytm/vzit/wiki/Installation)

- [Editor Setup](https://github.com/ttytm/vzit/wiki/Editor-Setup)

  - [Neovim](https://github.com/ttytm/vzit/wiki/Editor-Setup#neovim)

  - [VS Code / Codium](https://github.com/ttytm/vzit/wiki/Editor-Setup#vs-code--codium)

## Feature Overview

- Use tabs with `zig fmt` under the hood (no need to miss out on the amazing work that goes into it).

- View diffs with your preferred tool.

https://github-production-user-asset-6210df.s3.amazonaws.com/34311583/337395033-be5d0270-713f-495a-9f91-15665841eb64.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240606%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240606T184324Z&X-Amz-Expires=300&X-Amz-Signature=2df83e6313c9b80dfaab603825d552c4858a2876cbb7331afea85da1547f8097&X-Amz-SignedHeaders=host&actor_id=34311583&key_id=0&repo_id=802144933

## Usage

```

Usage: vzit [flags] [commands] 

Formatter and diff viewer utilizing zig fmt.

By default, formatted output is written to stdout.

Flags:

  -w  --write         Modifies non-conforming files in-place.

  -l  --list          Prints paths of non-conforming files. Exits with an error if any are found.

  -d  --diff          Prints differences of non-conforming files. Exits with an error if any are found.

                      - The 'VZIT_DIFF_CMD' environment variable allows setting a custom diff command.

  -i  --indentation   Sets the indentation used [possible values: 'tabs', 'smart', ''(spaces)].

                      - tabs: used by default.

                      - smart: based on the initial indentations in a file.

                      - : number of spaces.

  -h  --help          Prints help information.

  -v  --version       Prints version information.

Commands:

  update              Updates vizit to the latest version.

  help                Prints help information.

  version             Prints version information.

```

## Disclaimer

Maintaining quality throughout development will be paramount.

However, it is still an early release. Until a stable 1.0 release is available, minor versions (`0..*`) may contain breaking changes.

This is a spare time project. Please take it easy if there are delays in replying.