Add Vale for prose linting (#458)

Author: paddyroddy

.github/styles/.gitignore

@@ -0,0 +1,4 @@
+# only track the custom Vale rules
+/*
+!.gitignore
+!custom/

.github/styles/custom/dashes.yml

@@ -0,0 +1,12 @@
+---
+extends: existence
+message: Don't put a space before or after a dash.
+nonword: true
+level: warning
+action:
+  name: edit
+  params:
+    - remove
+    - " "
+tokens:
+  - \s[—–]\s

.github/styles/custom/endash.yml

@@ -0,0 +1,15 @@
+---
+extends: existence
+message: >-
+  Avoid en dashes ('–'). For hyphenated words, use a hyphen ('-').\nFor
+  parenthesis, use an em dash ('—').
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - replace
+    - "-"
+    - —
+tokens:
+  - –

.github/styles/custom/no-contractions.yml

@@ -0,0 +1,41 @@
+---
+extends: substitution
+message: Use '%s' instead of '%s.'
+level: error
+ignorecase: true
+swap:
+  aren't: are not,
+  can't: cannot,
+  couldn't: could not,
+  didn't: did not,
+  doesn't: does not,
+  don't: do not,
+  hasn't: has not,
+  haven't: have not,
+  how'll: how will,
+  how's: how is,
+  isn't: is not,
+  it'll: it will,
+  it's: it is,
+  shouldn't: should not
+  that'll: that will,
+  that's: that is,
+  they'll: they will,
+  they're: they are,
+  wasn't: was not,
+  we'll: we will,
+  we're: we are,
+  we've: we have,
+  weren't: were not,
+  what'll: what will,
+  what's: what is,
+  when'll: when will,
+  when's: when is,
+  where'll: where will,
+  where's: where is,
+  who'll: who will,
+  who's: who is,
+  why'll: why will,
+  why's: why is,
+  won't: will not,
+  you're: you are

.github/styles/custom/oxford-comma.yml

@@ -0,0 +1,7 @@
+---
+extends: existence
+message: Use the Oxford comma in '%s'.
+scope: sentence
+level: suggestion
+tokens:
+  - (?:[^,]+,){1,}\s\w+\s(?:and|or)

.github/styles/custom/quotes.yml

@@ -0,0 +1,11 @@
+---
+extends: existence
+message: Use straight quotes instead of smart quotes.
+level: error
+nonword: true
+action:
+tokens:
+  - “
+  - ”
+  - ‘
+  - ’

.github/styles/custom/spaces.yml

@@ -0,0 +1,7 @@
+---
+extends: existence
+message: Use only one space between words and sentences (not two).
+level: error
+nonword: true
+tokens:
+  - "[\\w.?!,()\\-\":] {2,}[\\w.?!,()\\-\":]"

.github/workflows/linting.yaml

@@ -16,3 +16,8 @@ jobs:
       - uses: paddyroddy/.github/actions/linting@7193f2d6fda65de74a0d750fd19f53314f899200 # v0
         with:
           pre-commit-config: ./.pre-commit-config.yaml
+
+      # yamllint disable-line rule:line-length
+      - uses: paddyroddy/.github/actions/vale@d5aea086eaabccae4bcf39786ad5138b629755a6 # v0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.typos.toml

@@ -0,0 +1,2 @@
+[type.yaml]
+extend-words.yse = "yse"

.vale.ini

@@ -0,0 +1,20 @@
+StylesPath = .github/styles
+
+# https://github.com/errata-ai/packages
+Packages = proselint
+
+[*.md]
+BasedOnStyles = custom,\
+                proselint,\
+                Vale
+
+# Disable
+Vale.Spelling = NO
+
+# the paper is already submitted so cannot be changed
+[paper/paper.md]
+BasedOnStyles =
+
+# `vale sync` in CI means the packages are then linted, so turn them off
+[.github/styles/**]
+BasedOnStyles =

CODE_OF_CONDUCT.md

@@ -4,7 +4,7 @@
 
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
+size, visible/invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.

CONTRIBUTING.md

@@ -9,9 +9,9 @@ section before making your contribution. It will make it a lot easier for us
 maintainers and smooth out the experience for all involved. The community looks
 forward to your contributions. 🎉
 
-> And if you like the project, but just don't have time to contribute, that's
+> And if you like the project, but just do not have time to contribute, that is
 > fine. There are other easy ways to support the project and show your
-> appreciation, which we would also be very happy about:
+> appreciation, which we would also be happy about:
 >
 > - Star the project
 > - Tweet about it
@@ -40,7 +40,7 @@ If you then still feel the need to ask a question and need clarification, we
 recommend the following:
 
 - Open an [Issue](https://github.com/astro-informatics/sleplet/issues/new).
-- Provide as much context as you can about what you're running into.
+- Provide as much context as you can about what you are running into.
 - Provide project and platform versions (python etc.), depending on what seems
   relevant.
 
@@ -58,7 +58,7 @@ We will then take care of the issue as soon as possible.
 
 #### Before Submitting a Bug Report
 
-A good bug report shouldn't leave others needing to chase you up for more
+A good bug report should not leave others needing to chase you up for more
 information. Therefore, we ask you to investigate carefully, collect information
 and describe the issue in detail in your report. Please complete the following
 steps in advance to help us fix any potential bug as fast as possible.
@@ -95,7 +95,7 @@ We use GitHub issues to track bugs and errors. If you run into an issue with the
 project:
 
 - Open an [Issue](https://github.com/astro-informatics/sleplet/issues/new).
-  (Since we can't be sure at this point whether it is a bug or not, we ask you
+  (Since we cannot be sure at this point whether it is a bug or not, we ask you
   not to talk about a bug yet and not to label the issue.)
 - Explain the behaviour you would expect and the actual behaviour.
 - Please provide as much context as possible and describe the _reproduction_
@@ -104,7 +104,7 @@ project:
   problem and create a reduced test case.
 - Provide the information you collected in the previous section.
 
-Once it's filed:
+Once it is filed:
 
 - The project team will label the issue accordingly.
 - A team member will try to reproduce the issue with your provided steps. If
@@ -131,10 +131,10 @@ and the community to understand your suggestion and find related suggestions.
 - Perform a [search](https://github.com/astro-informatics/sleplet/issues) to see
   if the enhancement has already been suggested. If it has, add a comment to the
   existing issue instead of opening a new one.
-- Find out whether your idea fits with the scope and aims of the project. It's
+- Find out whether your idea fits with the scope and aims of the project. It is
   up to you to make a strong case to convince the project's developers of the
   merits of this feature. Keep in mind that we want features that will be useful
-  to the majority of our users and not just a small subset. If you're just
+  to the majority of our users and not just a small subset. If you are just
   targeting a minority of users, consider writing an add-on/plugin library.
 
 #### How Do I Submit a Good Enhancement Suggestion?

README.md

@@ -59,8 +59,7 @@ the figures in
 Windows is not currently supported as `SLEPLET` relies on
 [pyssht](https://pypi.org/project/pyssht) and
 [pys2let](https://pypi.org/project/pys2let) which do not work on Windows. These
-can hopefully be replaced with
-[s2fft](https://github.com/astro-informatics/s2fft) and
+may be replaced with [s2fft](https://github.com/astro-informatics/s2fft) and
 [s2wav](https://github.com/astro-informatics/s2wav) in the future when they are
 available on [PyPI](https://pypi.org).
 

documentation/DOCUMENTATION.md

@@ -56,8 +56,8 @@ arbitrary region. The default region is the `south_america` arbitrary region.
 ## Paper Figures
 
 To recreate the figures from the below papers, one may use the CLI or the API.
-For those which don't use the `mesh` or `sphere` CLIs, the relevant API code
-isn't provided as it is contained within the
+For those which do not use the `mesh` or `sphere` CLIs, the relevant API code is
+not provided as it is contained within the
 [examples folder](https://github.com/astro-informatics/sleplet/tree/main/examples).
 
 ### Sifting Convolution on the Sphere