Skip to content

Commit

Permalink
Update Vale version (#10)
Browse files Browse the repository at this point in the history
* Add Vale external styles to gitignore

* Add Vale instructions

* Add entries to vocabulary and test file

* Update .gitignore to exclude IDE dirs

* Move vocabularies to new format; remove unused Names.yml
  • Loading branch information
nvitucci authored Jan 16, 2024
1 parent 40c90dd commit 4b56e6f
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 22 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ dist
build/

# Exclude external styles
vale/styles
!vale/styles/Neo4j
!vale/styles/Vocab
!vale/styles/Experimental
vale/styles/Google

# IDE
.vscode
4 changes: 2 additions & 2 deletions vale/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ To add a new style (for example the Google style guide) in the Vale configuratio
1. Edit the `vale.ini` file to either add `Google` to the `BasedOnStyles` (to add all the style rules by default, and optionally disable some), or add single rules such as `Google.DateFormat = YES`.
2. Run `vale --config vale/.vale.ini sync` to download the new style (if it has not been downloaded before).
NOTE: Any styles added to the `vale/styles` directory except our custom ones are ignored by `git`.
NOTE: Any external styles added to the `vale/styles` directory (except our custom ones) must be added to `.gitignore`.

## Add terms to the vocabulary

You can add terms with their accepted spelling in the `accept.txt` file(s) within the `vale/Vocab` subdirectories.
You can add terms with their accepted spelling in the `accept.txt` file(s) within the `vale/config/vocabularies` subdirectories.

NOTE: Do not add entries where an entry fully contains another one, such as `Neo4j` and `Neo4j Aura`.
Use the `Neo4j/Names.yml` rule for single words instead.
Expand Down
11 changes: 0 additions & 11 deletions vale/styles/Neo4j/Names.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
API
APOC
AuraDB
AuraDB Enterprise
AuraDB Free
AuraDB Professional
AuraDS
AuraDS Enterprise
AuraDS Professional
CSV
Cypher
Graph Data Science
Neo4j
Neo4j Aura
Neo4j AuraDB
Neo4j AuraDS
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 3 additions & 5 deletions vale/test-results.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
test.adoc:5:9:Vale.Terms:Use 'Neo4j Browser' instead of 'Neo4j browser'.
test.adoc:7:5:Neo4j.Names:Use 'Neo4j' instead of 'neo4j'.
test.adoc:8:5:Neo4j.Names:Use 'AuraDB' instead of 'AuraDb'.
test.adoc:7:5:Vale.Terms:Use 'Neo4j' instead of 'neo4j'.
test.adoc:8:5:Vale.Terms:Use 'AuraDB' instead of 'AuraDb'.
test.adoc:9:6:Vale.Terms:Use 'Neo4j AuraDB' instead of 'Neo4j AuraDb'.
test.adoc:9:12:Neo4j.Names:Use 'AuraDB' instead of 'AuraDb'.
test.adoc:10:5:Vale.Terms:Use 'AuraDB Enterprise' instead of 'AuraDB enterprise'.
test.adoc:11:5:Vale.Terms:Use 'Neo4j AuraDB' instead of 'Neo4j AuraDb'.
test.adoc:11:11:Neo4j.Names:Use 'AuraDB' instead of 'AuraDb'.
test.adoc:12:10:Neo4j.Names:Use 'Cypher' instead of 'cypher'.
test.adoc:12:10:Vale.Terms:Use 'Cypher' instead of 'cypher'.
test.adoc:25:5:Neo4j.Headings:'Backup and Export' should use sentence-style capitalization.
test.adoc:26:5:Neo4j.Headings:'Use the Graph Catalog' should use sentence-style capitalization.
test.adoc:30:11:Neo4j.SimpleWords:Use 'try' instead of 'attempt'
Expand Down

0 comments on commit 4b56e6f

Please sign in to comment.