https://github.com/modprog/rsn-fmt

https://github.com/modprog/rsn-fmt

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/modprog/rsn-fmt
• Owner: ModProg
• License: apache-2.0
• Created: 2023-03-31T23:46:20.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-16T09:11:16.000Z (about 1 year ago)
• Last Synced: 2024-11-28T11:20:18.891Z (about 1 month ago)
• Language: Rust
• Size: 87.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# rsn-fmt

[![CI Status](https://github.com/ModProg/rsn-fmt/actions/workflows/test.yaml/badge.svg)](https://github.com/ModProg/rsn-fmt/actions/workflows/test.yaml)

[![Crates.io](https://img.shields.io/crates/v/rsn-fmt)](https://crates.io/crates/rsn-fmt)

[![Docs.rs](https://img.shields.io/crates/v/template?color=informational&label=docs.rs)](https://docs.rs/rsn-fmt)

[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://modprog.github.io/rsn-fmt/rsn_fmt/)

## Configuration

Configuration can be done through a `rsnfmt.rsn` or `.rsnfmt.rsn` config file in any parent directory

or in the user's configuration:

| Linux (and similar)                   | Windows                                    | macOS                            |

|---------------------------------------|--------------------------------------------|----------------------------------|

| `$XDG_CONFIG_HOME` or `$HOME/.config` | `$HOME/Library/Application Support`        | `{FOLDERID_RoamingAppData}`      |

| `/home/alice/.config`                 | `/Users/Alice/Library/Application Support` | `C:\Users\Alice\AppData\Roaming` |

The default values are:

```rust

{

    max_width: 60,

    // Normalize all comments to a specific format

    // Possible values: Block, Line, No

    normalize_comments: No,

    // Wrap comments: boolean

    wrap_comments: false,

    // Should formatting preserve empty lines

    // Possible values: One, All, None

    preserve_empty_lines: One,

    // Inherit parent/global configuration: boolean

    inherit: true

}

```