feat(core): add allows keyword to Weir (#2602)

* feat(core): add `ignores` test syntax to Weir

* feat(core): explicitely fail if the lint count is greater than zero on equivalent strings

* docs(core): document `ignores` keyword

* refactor(core): replace exising tests with use of `ignores`

* refactor(core): change from `ignores` -> `allows`

* refactor(core): align other idents

Author: elijah-potter

harper-core/src/linting/weir_rules/AOkHyphen.weir

@@ -23,7 +23,7 @@ test "You were totally a ok host." "You were totally a-ok host."
 test "Being a ok line of communication matters." "Being a-ok line of communication matters."
 test "It has been a ok solution in the past." "It has been a-ok solution in the past."
 
-test "The dashboard shows A-OK feedback." "The dashboard shows A-OK feedback."
-test "Our status is OK." "Our status is OK."
-test "This is a good plan." "This is a good plan."
-test "AOK signals readiness." "AOK signals readiness."
+allows "The dashboard shows A-OK feedback."
+allows "Our status is OK."
+allows "This is a good plan."
+allows "AOK signals readiness."

harper-core/src/linting/weir_rules/AllOfASudden.weir

@@ -14,5 +14,5 @@ test "He whispered, \"all the sudden we were alone.\"" "He whispered, \"all of a
 test "ALL THE SUDDEN THE ROOM WENT DARK." "ALL OF A SUDDEN THE ROOM WENT DARK."
 test "They were laughing all the sudden." "They were laughing all of a sudden."
 test "It stormed all of sudden after a warm morning." "It stormed all of a sudden after a warm morning."
-test "Their excitement and suddenness were all the suddenness she remembered." "Their excitement and suddenness were all the suddenness she remembered."
+allows "Their excitement and suddenness were all the suddenness she remembered."
 test "This all the sudden change surprised everyone." "This all of a sudden change surprised everyone."

harper-core/src/linting/weir_rules/Alongside.weir

@@ -12,6 +12,6 @@ test "The skiff pulled along side." "The skiff pulled alongside."
 test "\"We drifted along side,\" she said." "\"We drifted alongside,\" she said."
 test "They stood along side, waiting patiently." "They stood alongside, waiting patiently."
 test "Cars lined up along side the curb." "Cars lined up alongside the curb."
-test "They walked alongside the river." "They walked alongside the river."
-test "They walked along the side of the river." "They walked along the side of the river."
-test "We camped along the lakeside all weekend." "We camped along the lakeside all weekend."
+allows "They walked alongside the river."
+allows "They walked along the side of the river."
+allows "We camped along the lakeside all weekend."

harper-core/src/linting/weir_rules/AsFollows.weir

@@ -17,9 +17,9 @@ test "Is this description as follow the sample?" "Is this description as follows
 test "You can verify as follow once the build completes." "You can verify as follows once the build completes."
 
 # Ensure unrelated uses of "follow" are not affected
-test "Follow the instructions as written." "Follow the instructions as written."
-test "We follow-up on these requests weekly." "We follow-up on these requests weekly."
-test "This is the way to follow as best you can." "This is the way to follow as best you can."
-test "As follows the plan will unfold." "As follows the plan will unfold."
-test "I will follow your lead." "I will follow your lead."
-test "The as follows section is helpful." "The as follows section is helpful."
+allows "Follow the instructions as written."
+allows "We follow-up on these requests weekly."
+allows "This is the way to follow as best you can."
+allows "As follows the plan will unfold."
+allows "I will follow your lead."
+allows "The as follows section is helpful."

harper-core/src/linting/weir_rules/Beforehand.weir

@@ -6,4 +6,4 @@ let becomes "beforehand"
 
 test "Let me know before hand if you will attend." "Let me know beforehand if you will attend."
 test "I prepared the documents before-hand." "I prepared the documents beforehand."
-test "We finished the preparations beforehand." "We finished the preparations beforehand."
+allows "We finished the preparations beforehand."

harper-core/src/linting/weir_rules/BewareOf.weir

@@ -20,8 +20,8 @@ test "Beware among the wild animals outside the park." "Beware of the wild anima
 test "Beware between the gaps in the scaffolding." "Beware of the gaps in the scaffolding."
 test "BEWARE WITH THE LOUD CRASHING." "BEWARE OF THE LOUD CRASHING."
 
-test "Beware of the dog that guards the porch." "Beware of the dog that guards the porch."
-test "Beware the gap between the platforms." "Beware the gap between the platforms."
-test "Beware every time you go near the cliff." "Beware every time you go near the cliff."
-test "Some people say beware: the path narrows." "Some people say beware: the path narrows."
-test "Beware of tall waves on this beach." "Beware of tall waves on this beach."
+allows "Beware of the dog that guards the porch."
+allows "Beware the gap between the platforms."
+allows "Beware every time you go near the cliff."
+allows "Some people say beware: the path narrows."
+allows "Beware of tall waves on this beach."

harper-core/src/linting/weir_rules/CoursingThroughVeins.weir

@@ -7,4 +7,4 @@ let becomes "coursing through veins"
 
 test "cursing through veins" "coursing through veins"
 test "It felt like the drugs were cursing through veins." "It felt like the drugs were coursing through veins."
-test "He was cursing through the entire meeting." "He was cursing through the entire meeting."
+allows "He was cursing through the entire meeting."

harper-core/src/linting/weir_rules/DoIAdjective.weir

@@ -18,8 +18,8 @@ test "Do I not interested in attending?" "Am I not interested in attending?"
 test "Do I not ready yet?" "Am I not ready yet?"
 test "do I concerned about the changes?" "am I concerned about the changes?"
 
-test "Do I want to help you?" "Do I want to help you?"
-test "Do I need to finish this tonight?" "Do I need to finish this tonight?"
-test "Do I have to explain everything?" "Do I have to explain everything?"
-test "Do I run the tests again?" "Do I run the tests again?"
-test "Do I look like I'm not listening?" "Do I look like I'm not listening?"
+allows "Do I want to help you?"
+allows "Do I need to finish this tonight?"
+allows "Do I have to explain everything?"
+allows "Do I run the tests again?"
+allows "Do I look like I'm not listening?"

harper-core/src/linting/weir_rules/DoNotWant.weir

@@ -7,4 +7,4 @@ let becomes ["don't want", "do not want"]
 
 test "I don't wan to pay for this." "I don't want to pay for this."
 test "Don't Wan that option." "Don't Want that option."
-test "I don't want to leave." "I don't want to leave."
+allows "I don't want to leave."

harper-core/src/linting/weir_rules/DoToDueTo.weir

@@ -17,8 +17,8 @@ test "The app crashed do to memory leaks." "The app crashed due to memory leaks.
 test "Tickets sold quickly do to a viral post." "Tickets sold quickly due to a viral post."
 test "It failed do to data loss." "It failed due to data loss."
 
-test "What did you do to the file?" "What did you do to the file?"
-test "Please do to the file what you did to the other one." "Please do to the file what you did to the other one."
-test "Don't do to others what you wouldn't want done to you." "Don't do to others what you wouldn't want done to you."
-test "We need to do to this spreadsheet what we did last week." "We need to do to this spreadsheet what we did last week."
-test "She asked what the update would do to her settings." "She asked what the update would do to her settings."
+allows "What did you do to the file?"
+allows "Please do to the file what you did to the other one."
+allows "Don't do to others what you wouldn't want done to you."
+allows "We need to do to this spreadsheet what we did last week."
+allows "She asked what the update would do to her settings."