forspell 0.0.8 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +13 -13
- data/lib/forspell/file_list.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 16e96dc4e732badadf52412ae2cc8d2f6fd1b900e760151b8c8a8b0172eef612
|
|
4
|
+
data.tar.gz: ffbf262ff89973346045aa6e586ae0a7e31f1fbbfc284d7bd7c3448b8218ab2b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 50ac0b2e6b5b3e243d4ee11abeb84b22374e45623d142521111ebe3bb2e81f0118b944be72099212775f9f64a9b13c0260f04b2255b5d3a541a7b03214a9db3a
|
|
7
|
+
data.tar.gz: 675033785e77aa12a510589519ee2177f126fb9cf54dab53071d6006a5114fa7fc05d12e465a08ebe8acc01135c2bdd7aad71aee9626bba96fa3ddc7a240e1bd
|
data/README.md
CHANGED
|
@@ -3,21 +3,21 @@
|
|
|
3
3
|
[](http://badge.fury.io/rb/forspell)
|
|
4
4
|
[](https://travis-ci.org/kkuprikov/forspell)
|
|
5
5
|
|
|
6
|
-
**Forspell** is spellchecker for code and documentation. It uses well-known [hunspell](https://en.wikipedia.org/wiki/Hunspell) tool and dictionary, provides customizable output, and could be easily integrated into CI pipeline.
|
|
6
|
+
**Forspell** is a spellchecker for code and documentation. It uses the well-known [hunspell](https://en.wikipedia.org/wiki/Hunspell) tool and dictionary, provides customizable output, and could be easily integrated into CI pipeline.
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Here's an output example:
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
## Features
|
|
13
13
|
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* Ability to check Markdown files and comments in Ruby, C and C++ code;
|
|
15
|
+
* Skipping over code examples and identifiers inside comments and Markdown most of the time;
|
|
16
16
|
* Distributed with latest en-US hunspell dictionaries, but can be set to use any other dictionary;
|
|
17
|
-
* Includes
|
|
18
|
-
*
|
|
17
|
+
* Includes a custom Ruby ecosystem-related dictionary (so it will not report words like "Gemfile", "args", "middleware" and alike as misspelled);
|
|
18
|
+
* Easiness to create a custom dictionary for your project, so your internal terms would not be reported as misspellings;
|
|
19
19
|
* Option to auto-generate initial custom dictionary;
|
|
20
|
-
* Several output formats, including pretty
|
|
20
|
+
* Several output formats, including pretty print, YAML and JSON.
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
23
23
|
|
|
@@ -25,7 +25,7 @@ Example of output:
|
|
|
25
25
|
gem install forspell
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
`forspell` requires `libhunspell` >= 1.2.0 to be installed, see [hunspell site](https://github.com/hunspell/hunspell) for installation instructions (it is probably as easy as `<yourpackagemanager> install hunspell` on most of
|
|
28
|
+
`forspell` requires `libhunspell` >= 1.2.0 to be installed, see [hunspell site](https://github.com/hunspell/hunspell) for installation instructions (it is probably as easy as `<yourpackagemanager> install hunspell` on most of *nix and MacOS).
|
|
29
29
|
|
|
30
30
|
## Usage
|
|
31
31
|
|
|
@@ -46,27 +46,27 @@ Options:
|
|
|
46
46
|
|
|
47
47
|
`forspell` automatically loads command-line arguments from `.forspell` file in current folder, if it is present.
|
|
48
48
|
Arguments for `forspell` command are directories or separate files you want to check.
|
|
49
|
-
|
|
49
|
+
With no arguments provided, a current directory will be processed.
|
|
50
50
|
Supported file extensions are `.rb`, `.c`, `.cpp`, `.md`.
|
|
51
51
|
|
|
52
52
|
### Dictionaries
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
Forspell uses hunspell dictionaries to check spelling. By default, it is the `en_US` modern dictionary, distributed with forspell itself, but you can specify any other with `-d` option. If you have `/some/custom/path/fr_FR.aff` and `/some/custom/path/fr_FR.dic`, than you can use it instead of `en_US` with `-d /some/custom/path/fr_FR`.
|
|
55
55
|
|
|
56
56
|
In addition to the main dictionary, forspell also includes (and always uses) small auxiliary dictionary with words specific for Ruby ecosystem, you can review it in [forspell repo](https://github.com/kkuprikov/forspell/blob/master/lib/forspell/ruby.dict).
|
|
57
57
|
|
|
58
|
-
You can also add your project's **custom dictionary** with internal terms, for them not to obstruct spellchecker's output. Custom dictionary (or several)
|
|
58
|
+
You can also add your project's **custom dictionary** with internal terms, for them not to obstruct spellchecker's output. Custom dictionary (or several) may be passed with `-c` option. Also, `forspell.dict` will be automatically processed, if presented in current directory. Format of custom dictionary:
|
|
59
59
|
|
|
60
60
|
* Each word on its own line.
|
|
61
61
|
* Line contains either just `word` (means only this word in this form).
|
|
62
62
|
* ...or `word: example` -- in this case, "example" should be existing word from the main dictionary, and it means your custom term can have the same forms as example word. For example, "subclass: class" will mean that "subclass", "subclasses" and "subclass'" should be considered correct.
|
|
63
63
|
* `#` marks comments.
|
|
64
64
|
|
|
65
|
-
For larger projects, it is handy to generate custom dictionary with `forspell your,project,
|
|
65
|
+
For larger projects, it is handy to generate a custom dictionary with `forspell your,project,paths --gen-dictionary`. This will create `forspell.dict` with all misspellings found in your project, and you can proceed by deleting genuine errors and leave internal terms, which should be considered correct.
|
|
66
66
|
|
|
67
67
|
## Integration with CI
|
|
68
68
|
|
|
69
|
-
Forspell return codes:
|
|
69
|
+
Forspell's return codes:
|
|
70
70
|
|
|
71
71
|
* 0 - when no errors found
|
|
72
72
|
* 1 - when there are any errors
|
data/lib/forspell/file_list.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: forspell
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.9
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Kirill Kuprikov
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: exe
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2024-04-16 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: slop
|
|
@@ -73,14 +73,14 @@ dependencies:
|
|
|
73
73
|
requirements:
|
|
74
74
|
- - "~>"
|
|
75
75
|
- !ruby/object:Gem::Version
|
|
76
|
-
version: '
|
|
76
|
+
version: '6.0'
|
|
77
77
|
type: :runtime
|
|
78
78
|
prerelease: false
|
|
79
79
|
version_requirements: !ruby/object:Gem::Requirement
|
|
80
80
|
requirements:
|
|
81
81
|
- - "~>"
|
|
82
82
|
- !ruby/object:Gem::Version
|
|
83
|
-
version: '
|
|
83
|
+
version: '6.0'
|
|
84
84
|
- !ruby/object:Gem::Dependency
|
|
85
85
|
name: yard
|
|
86
86
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -257,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
257
257
|
- !ruby/object:Gem::Version
|
|
258
258
|
version: '0'
|
|
259
259
|
requirements: []
|
|
260
|
-
rubygems_version: 3.0.1
|
|
260
|
+
rubygems_version: 3.0.3.1
|
|
261
261
|
signing_key:
|
|
262
262
|
specification_version: 4
|
|
263
263
|
summary: For spelling check
|