Sign in

flagon-io/hello

public

Greets people from the command line. The sample repository for g1t.

Add .editorconfig matching existing Rust and Markdown formatting #31

Closedsyntaqx opened this chore
Resolved by Add .editorconfig matching existing Rust and Markdown formatting #35, merged by g1t

Create .editorconfig at the repo root. Existing files (src/lib.rs, src/main.rs, tests/cli.rs, README.md) use LF line endings, no tabs, and 4-space indentation in Rust (rustfmt default). Inspect the files first to confirm, including whether they end with a final newline and the Markdown indentation/trailing whitespace conventions.

Include root = true, a [*] section (charset = utf-8, end_of_line = lf, insert_final_newline = true, trim_trailing_whitespace = true), a [*.rs] section (indent_style = space, indent_size = 4), and a [*.md] section matching what the Markdown files do (set trim_trailing_whitespace = false only if Markdown relies on trailing double-space breaks, otherwise keep true). Optionally [*.toml] with 2 or 4 spaces to match Cargo.toml. Do not reformat any existing file.

Definition of done

  • test -f .editorconfig passes.
  • grep -q 'root = true' .editorconfig passes.
  • cargo test passes.

Pull requests

1 for this issue

  1. Add .editorconfig matching existing Rust and Markdown formatting #351 file+19−08203332

    Merged by g1t·g1t· requested by syntaqx

    I added a root .editorconfig that matches how the existing files are already formatted. No existing file was reformatted. Before writing it, I checked src/lib.rs, src/main.rs, tests/cli.rs, README.md and Cargo.toml. All of them use LF endings, contain no tabs, have no trailing whitespace, and end with a final newline. Global ([]): utf-8, LF, a final newline, and trailing whitespace trimmed. Rust ([.rs]): 4-space indentation, which is the rustfmt default. Markdown ([.md]): spaces for indentation, with trailing-whitespace trimming left on. README.md has no trailing double-space line breaks, so there was no reason to turn trimming off. TOML ([.toml]): 4 spaces. This is a guess, because Cargo.toml has no indented lines to confirm it. cargo test runs but reports 0 tests passed, so it only confirms the crate builds. I didn't run the two test/grep checks on .editorconfig separately. I also didn't check the file against an actual editor or EditorConfig tool.

Discussion

syntaqxqueued this for g1t·
syntaqxassigned this to g1t, which opened #35·
g1tbotclosed this by merging #35·

Sign in to comment.