[services] Tunnelbroker - Adding a `.rustfmt.toml`to the project root
ClosedPublic
Actions

Authored by • max on Jul 18 2022, 6:15 AM.

Details

Reviewers

• karol
varun
• jon
ashoat

Commits

rCOMMb6de5bc4045b: [services] Tunnelbroker - Adding a `.rustfmt.toml`to the project root

Summary

To make Rust formatting consistent with the codebase this file adds tab spacing and maximum width rules for the Rust formatting cargo fmt.
We are placing the .rustfmt.toml file at the root of the project. According to the documentation, we can use the project-wide file at the root of the project (parent directory).

The rustfmt.toml files form the sub-directories (services/commtest, services/identity, native/cpp/CommonCpp/CryptoTools/opaque-ke-cxx) were removed.

Linear task: ENG-1330

Test Plan

Running cargo fmt from the Rust workspace directory formats the code according to the standard.

Diff Detail

Repository

rCOMM Comm

Branch

add-rustfmt

Lint

No Lint Coverage

Unit

No Test Coverage

Event Timeline

• max created this revision.Jul 18 2022, 6:15 AM

• max held this revision as a draft.

Herald added subscribers: • abosh, • karol, atul and 3 others. · View Herald TranscriptJul 18 2022, 6:15 AM

• max published this revision for review.Jul 18 2022, 6:16 AM

• max retitled this revision from [services] Tunnelbroker - Adding a `rustfmt.toml` for the formatting rules to [services] Tunnelbroker - Adding a `rustfmt.toml` for the Rust formatting rules.

• max edited the summary of this revision. (Show Details)

• max edited the test plan for this revision. (Show Details)

• max added reviewers: • karol, varun, • jon.

• max added a child revision: D4540: [services] Tunnelbroker - Rust APNS push notifications A2 library wrapper.

• max mentioned this in D4540: [services] Tunnelbroker - Rust APNS push notifications A2 library wrapper.Jul 18 2022, 6:20 AM

Harbormaster completed remote builds in B10580: Diff 14568.Jul 18 2022, 6:28 AM

varun accepted this revision.Jul 18 2022, 8:17 AM

This revision is now accepted and ready to land.Jul 18 2022, 8:17 AM

Is there a way to introduce a universal rustfmt.toml for the whole project?

In D4553#130009, @ashoat wrote:

Is there a way to introduce a universal rustfmt.toml for the whole project?

Yeah, I just looked and this is possible. We can have a single rustfmt.toml in the project root directory

Let's definitely do that. @geekbrother what do you think of changing this diff so it introduces a rustfmt.toml in the root, and deletes the other rustfmt.toml files?

This revision now requires changes to proceed.Jul 18 2022, 12:10 PM

In D4553#130013, @ashoat wrote:

Let's definitely do that. @geekbrother what do you think of changing this diff so it introduces a rustfmt.toml in the root, and deletes the other rustfmt.toml files?

Sure, I'll check it and will make changes.

• max planned changes to this revision.Jul 18 2022, 12:14 PM

Moving to use the .rustfmt.toml at the project's root directory.

• max planned changes to this revision.Jul 19 2022, 6:54 AM

Rebased on master.

• max planned changes to this revision.Jul 19 2022, 7:06 AM

Harbormaster completed remote builds in B10645: Diff 14645.Jul 19 2022, 7:06 AM

• max retitled this revision from [services] Tunnelbroker - Adding a `rustfmt.toml` for the Rust formatting rules to [services] Tunnelbroker - Adding a `.rustfmt.toml`to the project root.Jul 19 2022, 7:11 AM

• max edited the summary of this revision. (Show Details)

• max edited the test plan for this revision. (Show Details)

In D4553#130013, @ashoat wrote:

Let's definitely do that. @geekbrother what do you think of changing this diff so it introduces a rustfmt.toml in the root, and deletes the other rustfmt.toml files?

I've placed the .rustfmt.toml file at the root of the project.
According to the documentation, we can use the project-wide file at the root of the project (parent directory).

Running cargo fmt inside the Rust workspace like services/identity formatting the code according to the project's root .rustfmt.toml file.
The workspaces rustfmt.toml files are removed in this diff.
The description of the diff was also updated.