mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-03-22 06:51:58 +02:00
c9f66fd425
This is the result of running `dprint fmt` after removing `src/` from
the list of excluded directories.
This also reformats the Rust code: we might want to tweak this a bit in
the future since some of the changes removes the hand-formatting. Of
course, this formatting can be seen as a mis-feature, so maybe this is
good overall.
Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged
after this, meaning that all existing translations remain valid! A few
messages were changed because of stray whitespace characters:
msgid ""
"Slices always borrow from another object. In this example, `a` has to remain "
-"'alive' (in scope) for at least as long as our slice. "
+"'alive' (in scope) for at least as long as our slice."
msgstr ""
The formatting is enforced in CI and we will have to see how annoying
this is in practice for the many contributors. If it becomes annoying,
we should look into fixing dprint/check#11 so that `dprint` can annotate
the lines that need fixing directly, then I think we can consider more
strict formatting checks.
I added more customization to `rustfmt.toml`. This is to better emulate
the dense style used in the course:
- `max_width = 85` allows lines to take up the full width available in
our code blocks (when taking margins and the line numbers into account).
- `wrap_comments = true` ensures that we don't show very long comments
in the code examples. I edited some comments to shorten them and avoid
unnecessary line breaks — please trim other unnecessarily long comments
when you see them! Remember we're writing code for slides 😄
- `use_small_heuristics = "Max"` allows for things like struct literals
and if-statements to take up the full line width configured above.
The formatting settings apply to all our Rust code right now — I think
we could improve this with https://github.com/dprint/dprint/issues/711
which lets us add per-directory `dprint` configuration files. However,
the `inherit: true` setting is not yet implemented (as far as I can
tell), so a nested configuration file will have to copy most or all of
the top-level file.
73 lines
2.4 KiB
Rust
73 lines
2.4 KiB
Rust
// Copyright 2023 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
use anyhow::Context;
|
|
use log::trace;
|
|
use mdbook::book::Book;
|
|
use mdbook::renderer::RenderContext;
|
|
use mdbook::BookItem;
|
|
use mdbook_exerciser::process;
|
|
use std::fs::{create_dir, remove_dir_all};
|
|
use std::io::stdin;
|
|
use std::path::Path;
|
|
|
|
fn main() -> anyhow::Result<()> {
|
|
pretty_env_logger::init();
|
|
|
|
let context = RenderContext::from_json(&mut stdin()).context("Parsing stdin")?;
|
|
|
|
let config = context
|
|
.config
|
|
.get_renderer("exerciser")
|
|
.context("Missing output.exerciser configuration")?;
|
|
|
|
let output_directory = Path::new(
|
|
config
|
|
.get("output-directory")
|
|
.context(
|
|
"Missing output.exerciser.output-directory configuration value",
|
|
)?
|
|
.as_str()
|
|
.context("Expected a string for output.exerciser.output-directory")?,
|
|
);
|
|
|
|
let _ = remove_dir_all(output_directory);
|
|
create_dir(output_directory).with_context(|| {
|
|
format!("Failed to create output directory {:?}", output_directory)
|
|
})?;
|
|
|
|
process_all(&context.book, output_directory)?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
fn process_all(book: &Book, output_directory: &Path) -> anyhow::Result<()> {
|
|
for item in book.iter() {
|
|
if let BookItem::Chapter(chapter) = item {
|
|
trace!("Chapter {:?} / {:?}", chapter.path, chapter.source_path);
|
|
if let Some(chapter_path) = &chapter.path {
|
|
// Put the exercises in a subdirectory named after the chapter file,
|
|
// without its parent directories.
|
|
let chapter_output_directory =
|
|
output_directory.join(chapter_path.file_stem().with_context(
|
|
|| format!("Chapter {:?} has no file stem", chapter_path),
|
|
)?);
|
|
process(&chapter_output_directory, &chapter.content)?;
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|