comprehensive-rust/.github/typos.toml

[default.extend-identifiers]
# False positives.
mis = "mis"
MIS = "MIS"
inout = "inout"
BARs = "BARs"

[type.po]
# Localized content should not be checked for typos. English
# in these files should be validated manually.
extend-glob = ["*.po"]
check-file = false

[files]
# Typos in third party packages should be fixed upstream.
extend-exclude = ["third_party/*", "theme/book.js"]
Add `typos` to CI (#1158) Hi all! This CL fixes #1093: * Avoids including current false-positives in the checking of typos * Excludes localization-related files, as `typos` works with English words * Fixes existing typos caught in the repo Tested this in CI with a typo and it showed up in the list of actions! --------- Co-authored-by: Martin Geisler <martin@geisler.net> 2023-09-05 22:21:59 +02:00			`[default.extend-identifiers]`
			`# False positives.`
			`mis = "mis"`
			`MIS = "MIS"`
			`inout = "inout"`
			`BARs = "BARs"`

			`[type.po]`
			`# Localized content should not be checked for typos. English`
			`# in these files should be validated manually.`
			`extend-glob = ["*.po"]`
			`check-file = false`

			`[files]`
			`# Typos in third party packages should be fixed upstream.`
Test translations using same source as for publish (#1492) Before we would run `mdbook test` using the current Markdown sources. This is subtly wrong: we publish the course using back-dated sources, so we should therefore also run the tests using the same sources (this ensures that the code snippets actually work). After this commit, all translatable content lives in exactly two directories: - `src/` - `third_party/` We need to restore both directories when testing and when publishing. This ensures consistency in the Markdown text and in the included source code. A new `.github/workflows/build.sh` script takes care of preparing the two directories according to the date in the PO file (if any). To ensure we can restore all of `third_party/` to an old commit, the non-changing `third_party/mdbook/book.js` file has been moved to `theme/book.js`. The file is generated by `mdbook init --theme`, making it suitable for modification by the user (us). Symlinks have been added to `third_party/mdbook/` to indicate that the files ultimately came from upstream. 2024-01-04 18:04:44 +02:00			`extend-exclude = ["third_party/*", "theme/book.js"]`