feat: use mapstructure to split defintion types

This allows each check to define its own fields without having to add them all
to one struct. It should also make the process of adding checks a little
more straightforward.

closes #15

rule/Abbreviations.yml

@@ -1,8 +1,8 @@
-type: substitution
+extends: substitution
 message: Use '%s'
 ignorecase: false
 level: error
-map:
+swap:
   '(?:eg)': e.g.,
   '(?:ie)': i.e.,
   '(?:e\.g\.)\s*': e.g.,

rule/Annotations.yml

@@ -1,5 +1,5 @@
 message: "'%s' left in text"
-type: existence
+extends: existence
 ignorecase: false
 level: warning
 tokens:

rule/ComplexWords.yml

@@ -1,8 +1,8 @@
-type: substitution
+extends: substitution
 message: Consider using '%s' instead of '%s'
 ignorecase: true
 level: warning
-map:
+swap:
   abundance: plenty
   accelerate: speed up
   accentuate: stress

rule/Editorializing.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "Consider removing '%s'"
 ignorecase: true
 scope: text

rule/GenderBias.yml

@@ -1,8 +1,8 @@
-type: substitution
+extends: substitution
 message: Consider using '%s' instead of '%s'
 ignorecase: true
 level: error
-map:
+swap:
   (?:alumna|alumnus):          graduate
   (?:alumnae|alumni):          graduates
   (?:mother|father)land:       native land

rule/Hedging.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "Consider removing '%s'"
 ignorecase: true
 level: warning

rule/Litotes.yml

@@ -1,8 +1,8 @@
-type: substitution
+extends: substitution
 message: Consider using '%s' instead of '%s'
 ignorecase: true
 level: warning
-map:
+swap:
   no minor: major
   no ordinary: extraordinary
   no(?:t)? small: large

rule/PassiveVoice.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' is passive voice"
 ignorecase: true
 level: warning

rule/Redundancy.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' is redundant"
 ignorecase: true
 level: error

rule/Repetition.yml

@@ -1,4 +1,4 @@
-type: repetition
+extends: repetition
 message: "'%s' is repeated!"
 level: error
 scope: paragraph

rule/Uncomparables.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' is not comparable"
 ignorecase: true
 level: error

rule/Wordiness.yml

@@ -1,8 +1,8 @@
-type: substitution
+extends: substitution
 message: Consider using '%s' instead of '%s'
 ignorecase: true
 level: warning
-map:
+swap:
   (?:give|gave) rise to: lead to
   (?:previous|prior) to: before
   a (?:large)? majority of: most

styles/TheEconomist/Didactic.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' - Do not be too didactic"
 description: "If too many sentences begin with '%s,' readers will think they are reading a textbook."
 link: http://www.economist.com/styleguide/introduction

styles/TheEconomist/Hectoring.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' - Do not be hectoring or arrogant"
 description: "Those who disagree with you are not necessarily '%s.'"
 link: http://www.economist.com/styleguide/introduction

styles/TheEconomist/HorribleWords.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' - See section 'Horrible words'"
 description: "Be aware that the use of '%s' may have an emetic effect on some of your readers."
 link: http://www.economist.com/style-guide/horrible-words

styles/TheEconomist/OughtShould.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: Go easy on the oughts and shoulds
 description: "The aim is not just to tell readers what you think, but to persuade them."
 link: http://www.economist.com/styleguide/introduction

styles/TheEconomist/OverusedWords.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' is overused"
 description: "Nothing betrays the lazy writer faster than fly-blown phrases used in the belief that they are snappy, trendy or cool."
 link: http://www.economist.com/style-guide/overused-words

styles/TheEconomist/Punctuation.yml

@@ -1,10 +1,10 @@
-type: substitution
+extends: substitution
 message: Use '%s' instead of '%s'
 level: error
 scope: text
 ignorecase: false
 nonword: true
-map:
+swap:
   e\.g\.: eg
   i\.e\.: ie
   \b(?:eg|ie)[^,]: eg, or ie,

styles/TheEconomist/Slang.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' - See section 'Journalese and slang'"
 scope: text
 level: warning

styles/TheEconomist/UnexpandedAcronyms.yml

@@ -1,11 +1,11 @@
-type: conditional
+extends: conditional
 message: "'%s' has no definition"
 level: warning
 scope: text
 description: "Write the words in full on first appearance, unless the abbreviation or acronym is well known."
 link: http://www.economist.com/style-guide/abbreviations
-if: \b([A-Z]{3,5})\b
-then: (?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)
+first: \b([A-Z]{3,5})\b
+second: (?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)
 exceptions:
   - ABC
   - ADD

styles/TheEconomist/UnnecessaryWords.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' - See section 'Unnecessary words'"
 level: warning
 scope: text

styles/demo/CheckLinks.yml

@@ -1,4 +1,4 @@
-type: script
+extends: script
 scope: text
 runtime: python3
 exe: check_links.py

styles/demo/CheckSpelling.yml

@@ -1,4 +1,4 @@
-type: script
+extends: script
 scope: text
 runtime: node
 exe: check_spelling.js

styles/demo/CommasPerSentence.yml

@@ -1,7 +1,5 @@
 message: "More than 3 commas!"
-type: occurrence
+extends: occurrence
 scope: sentence
 max: 3
-tokens:
-  - ','
-
+token: ','

styles/demo/EndingPreposition.yml

@@ -1,5 +1,5 @@
 message: "Don't end a sentence with '%s'"
-type: existence
+extends: existence
 level: suggestion
 scope: sentence
 raw:

styles/demo/HeadingStartsWithCapital.yml

@@ -1,5 +1,5 @@
 message: "'%s' should be capitalized"
-type: existence
+extends: existence
 level: suggestion
 scope: heading
 raw:

styles/demo/Hyphen.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' doesn't need a hyphen"
 level: error
 scope: text.html

styles/demo/NounStrings.yml

@@ -1,5 +1,5 @@
 message: "'%s ...'"
-type: repetition
+extends: repetition
 scope: sentence.md
 max: 3
 tokens:

styles/demo/ParagraphLength.yml

@@ -1,7 +1,6 @@
 message: "Paragraphs should be less than 150 words"
-type: occurrence
+extends: occurrence
 scope: paragraph.txt
 level: suggestion
 max: 150
-tokens:
-  - \b(\w+)\b
+token: \b(\w+)\b

styles/demo/SentenceLength.yml

@@ -1,7 +1,6 @@
 message: "Sentences should be less than 25 words"
-type: occurrence
+extends: occurrence
 scope: sentence
 level: suggestion
 max: 25
-tokens:
-  - \b(\w+)\b
+token: \b(\w+)\b

styles/demo/Spacing.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' should have one space"
 level: warning
 scope: paragraph

styles/write-good/Adverbs.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' - Adverbs can weaken meaning"
 ignorecase: true
 level: warning

styles/write-good/LexicalIllusions.yml

@@ -1,4 +1,4 @@
-type: repetition
+extends: repetition
 message: "'%s' is repeated!"
 level: warning
 ignorecase: true

styles/write-good/NoCliches.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' is a cliché"
 ignorecase: true
 level: warning

styles/write-good/PassiveVoice.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s'"
 ignorecase: true
 level: warning

styles/write-good/StartsWithSo.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "Don't start a sentence with '%s'"
 ignorecase: true
 level: error

styles/write-good/ThereIs.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "Don't start a sentence with '%s'"
 ignorecase: true
 level: error

styles/write-good/TooWordy.yml

@@ -1,4 +1,4 @@
-type: existence
+extends: existence
 message: "'%s' is too wordy"
 ignorecase: true
 level: warning