Skip to content

Format files with dprint #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ jobs:
rustup default nightly
rustup component add rustfmt

- name: Check Rust formatting
run: cargo fmt --all -- --check
- name: Check formatting
uses: dprint/check@v2.2

cargo:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ information on using pull requests.

## Community Guidelines

This project follows [Google's Open Source Community
Guidelines](https://opensource.google/conduct/).
This project follows
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ trigger when going through the code samples. We hope to improve on this via
## Building

The course is built using a few tools:

- [mdbook](https://github.com/rust-lang/mdBook)
- [mdbook-svgbob](https://github.com/boozook/mdbook-svgbob)
- [mdbook-i18n-helpers](https://github.com/google/mdbook-i18n-helpers)
Expand Down Expand Up @@ -64,9 +65,10 @@ and zip exercises and add them to `book/html`. To build any of the translated
versions of the course, run `MDBOOK_BOOK__LANGUAGE=xx mdbook build -d book/xx`
where `xx` is the ISO 639 language code (e.g. `da` for the Danish translation).
[TRANSLATIONS.md](TRANSLATIONS.md) contains further instructions.

## Contact

For questions or comments, please contact [Martin
Geisler](mailto:[email protected]) or start a [discussion on
GitHub](https://github.com/google/comprehensive-rust/discussions). We would love
to hear from you.
For questions or comments, please contact
[Martin Geisler](mailto:[email protected]) or start a
[discussion on GitHub](https://github.com/google/comprehensive-rust/discussions).
We would love to hear from you.
24 changes: 15 additions & 9 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,17 @@ When showing Rust code, please use the same spacing as `rustfmt`: `3 * x`
instead of `3*x`. However, feel free to remove newlines when it can make the
code more compact and easier to understand, e.g., you can use

<!-- dprint-ignore-start -->

```rust
struct Person { name: String }
```

if you like.
<!-- dprint-ignore-end -->

if the `Person` struct is not important for your example. Please use this
sparingly: enclose the code block in `<!-- dprint-ignore-start -->` and
`<!-- dprint-ignore-start -->` to suppress warnings about the formatting.

## Speaker Notes

Expand All @@ -61,27 +67,27 @@ collapsed or removed entirely from the slide.

## Translations

This section is about what you write in the translation. We describe [how to
create or update translations elsewhere](TRANSLATIONS.md).
This section is about what you write in the translation. We describe
[how to create or update translations elsewhere](TRANSLATIONS.md).

When translating the course, please take the following into account:

- Do not translate the course name ("Comprehensive Rust 🦀"). If the name is not
easily understood in your language, please add the translated version after
the original name.

- If the Rust Book has been [translated into your
language](https://doc.rust-lang.org/book/appendix-06-translation.html), please
use the same vocabulary.
- If the Rust Book has been
[translated into your language](https://doc.rust-lang.org/book/appendix-06-translation.html),
please use the same vocabulary.

- Be careful to preserve the Markdown syntax of the original text. Pay special
attention to reference links in all their variations: `[foo][bar]`, `[foo][]`
(which means `[foo][foo]`), and `[foo]` (which also means `[foo][foo]`).

As an example, if you translate `[foo]`, to `[FOO]`, you must also update the
corresponding link definition from `[foo]: https://example.net` to `[FOO]:
https://example.net`. If you forget to do this, you end up with a broken link
in the translation.
corresponding link definition from `[foo]: https://example.net` to
`[FOO]: https://example.net`. If you forget to do this, you end up with a
broken link in the translation.

- If you find mistakes or things that sound awkward in the original English
text, please submit PRs to fix them! Fixing typos in the translation is great,
Expand Down
10 changes: 5 additions & 5 deletions TRANSLATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ languages! We use the [Gettext] system for translations. This means that you
don't modify the Markdown files directly: instead you modify `.po` files in a
`po/` directory. The `.po` files are small text-based translation databases.

> **Tip:** You should not edit the `.po` files by hand. Instead use a PO
> editor, such as [Poedit](https://poedit.net/). There are also several online
> editors available. This will ensure that the file is encoded correctly.
> **Tip:** You should not edit the `.po` files by hand. Instead use a PO editor,
> such as [Poedit](https://poedit.net/). There are also several online editors
> available. This will ensure that the file is encoded correctly.

There is a `.po` file for each language. They are named after the [ISO 639]
language codes: Danish would go into `po/da.po`, Korean would go into
Expand All @@ -25,9 +25,9 @@ GNU Gettext utilities below.

We use two helpers for the translations:

* `mdbook-xgettext`: This program extracts the English text. It is an mdbook
- `mdbook-xgettext`: This program extracts the English text. It is an mdbook
renderer.
* `mdbook-gettext`: This program translates the book into a target language. It
- `mdbook-gettext`: This program translates the book into a target language. It
is an mdbook preprocessor.

Install both helpers with:
Expand Down
30 changes: 30 additions & 0 deletions dprint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"lineWidth": 80,
"json": {},
"markdown": {
"textWrap": "always"
},
"toml": {},
"exec": {
"associations": "**/*.rs",
"rustfmt": "rustfmt --edition 2021",
"rustfmt.associations": "**/*.rs"
},
"includes": [
"**/*.json",
"**/*.md",
"**/*.rs",
"**/*.toml"
],
"excludes": [
"/src/",
"/third_party/",
"target/"
],
"plugins": [
"https://plugins.dprint.dev/exec-0.3.5.json@d687dda57be0fe9a0088ccdaefa5147649ff24127d8b3ea227536c68ee7abeab",
"https://plugins.dprint.dev/json-0.17.2.wasm",
"https://plugins.dprint.dev/markdown-0.15.2.wasm",
"https://plugins.dprint.dev/toml-0.5.4.wasm"
]
}
4 changes: 2 additions & 2 deletions mdbook-exerciser/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "mdbook-exerciser"
version = "0.1.0"
authors = ["Andrew Walbran <[email protected]>"]
edition = "2021"
license = "Apache-2.0"
authors = ["Andrew Walbran <[email protected]>"]
description = "A tool for extracting starter code for exercises from Markdown files."
repository = "https://github.com/google/comprehensive-rust"
description = "A tool for extracting starter code for exercises from Markdown files."

[dependencies]
anyhow = "1.0.68"
Expand Down
7 changes: 4 additions & 3 deletions mdbook-exerciser/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# exerciser

This is an mdBook renderer to generate templates for exercises from the Markdown source. Given a
Markdown file `example.md` with one or more sections like:
This is an mdBook renderer to generate templates for exercises from the Markdown
source. Given a Markdown file `example.md` with one or more sections like:

````markdown
<!-- File src/main.rs -->
Expand All @@ -22,5 +22,6 @@ and mdbook configuration in `book.toml` like:
output-directory = "comprehensive-rust-exercises"
```

It will create a file `book/exerciser/comprehensive-rust-exercises/example/src/main.rs` with the
It will create a file
`book/exerciser/comprehensive-rust-exercises/example/src/main.rs` with the
appropriate contents.
2 changes: 1 addition & 1 deletion rustfmt.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
imports_granularity = "module" # Please use nightly for this setting.
imports_granularity = "module" # Please use nightly for this setting.
max_width = 90