Skip to content
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

Add cargo-spellcheck config, fix typos #20

Merged
merged 2 commits into from
Oct 6, 2022
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
9 changes: 9 additions & 0 deletions .config/artichoke.dic
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
250
<
>
@generated
Lopopolo
POSIX
autogenerated
callouts
tokio
65 changes: 65 additions & 0 deletions .config/spellcheck.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Also take into account developer comments
dev_comments = true
# Skip the README.md file as defined in the cargo manifest
skip_readme = false

[Hunspell]
# lang and name of `.dic` file
lang = "en_US"
# OS specific additives
# Linux: [ /usr/share/myspell ]
# Windows: []
# macOS [ /home/alice/Libraries/hunspell, /Libraries/hunspell ]

# Additional search paths, which take presedence over the default
# os specific search dirs, searched in order, defaults last
search_dirs = ["."]

# Adds additional dictionaries, can be specified as
# absolute paths or relative in the search dirs (in this order).
# Relative paths are resolved relative to the configuration file
# which is used.
# Refer to `man 5 hunspell`
# or https://www.systutorials.com/docs/linux/man/4-hunspell/#lbAE
# on how to define a custom dictionary file.
extra_dictionaries = ["artichoke.dic"]

# If set to `true`, the OS specific default search paths
# are skipped and only explicitly specified ones are used.
skip_os_lookups = false

# Use the builtin dictionaries if none were found in
# in the configured lookup paths.
# Usually combined with `skip_os_lookups=true`
# to enforce the `builtin` usage for consistent
# results across distributions and CI runs.
# Setting this will still use the dictionaries
# specified in `extra_dictionaries = [..]`
# for topic specific lingo.
use_builtin = true


[Hunspell.quirks]
# Transforms words that are provided by the tokenizer
# into word fragments based on the capture groups which are to
# be checked.
# If no capture groups are present, the matched word is whitelisted.
transform_regex = ["^'([^\\s])'$", "^[0-9]+x$"]
# Accepts `alphabeta` variants if the checker provides a replacement suggestion
# of `alpha-beta`.
allow_concatenation = true
# And the counterpart, which accepts words with dashes, when the suggestion has
# recommendations without the dashes. This is less common.
allow_dashed = false

[NlpRules]
# Allows the user to override the default included
# exports of LanguageTool, with other custom
# languages

# override_rules = "/path/to/rules_binencoded.bin"
# override_tokenizer = "/path/to/tokenizer_binencoded.bin"

[Reflow]
# Reflows doc comments to adhere to adhere to a given maximum line width limit.
max_line_length = 80
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,11 @@ tags
[._]*.un~

# End of https://www.toptal.com/developers/gitignore/api/vim,rust,ruby

# Overrides

# Cargo and other Rust tool configuration lives in a top-level `.config/` directory.
!/.config/
# https://github.com/sourcefrog/cargo-mutants/blob/main/.gitignore
mutants.out
mutants.out.old
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "posix-space"
version = "1.0.2" # remember to set `html_root_url` in `src/lib.rs`.
version = "1.0.3" # remember to set `html_root_url` in `src/lib.rs`.
authors = ["Ryan Lopopolo <rjl@hyperbo.la>"]
license = "MIT"
edition = "2018"
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ locale per [POSIX.1-2017], chapter 7, [Locale].
> \<carriage-return\>, \<tab\>, and \<vertical-tab\> shall be included.

The function defined in this crate should have equivalent behavior to the C
fucntion [`isspace`] as defined in `ctype.h`.
function [`isspace`] as defined in `ctype.h`.

[`isspace`]: https://linux.die.net/man/3/isspace

Expand All @@ -33,7 +33,7 @@ Add this to your `Cargo.toml`:

```toml
[dependencies]
posix-space = "1.0.2"
posix-space = "1.0.3"
```

Then classify bytes like:
Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@
//! > \<tab\>, and \<vertical-tab\> shall be included.
//!
//! The function defined in this crate should have equivalent behavior to the C
//! fucntion [`isspace`] as defined in `ctype.h`.
//! function [`isspace`] as defined in `ctype.h`.
//!
//! [`isspace`]: https://linux.die.net/man/3/isspace

#![doc(html_root_url = "https://docs.rs/posix-space/1.0.2")]
#![doc(html_root_url = "https://docs.rs/posix-space/1.0.3")]
#![no_std]

/// Determine whether the given byte is in **space** POSIX character class.
Expand Down Expand Up @@ -364,7 +364,7 @@ mod tests {
}
}

// Ensure code blocks in README.md compile
// Ensure code blocks in `README.md` compile.
//
// This module and macro declaration should be kept at the end of the file, in
// order to not interfere with code coverage.
Expand Down