From c1dfc132e4caf501372ca3ff2d6317e202151723 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Tue, 19 Dec 2023 15:59:24 +0100 Subject: [PATCH 01/57] docs: add vale to project added vale.ini with vale configuration set up vale gh action added new style rules to vale --- .editorconfig | 2 +- .github/styles/Vocab/Docs/accept.txt | 1 + .github/styles/Vocab/Docs/reject.txt | 0 .github/styles/proselint/Airlinese.yml | 8 + .github/styles/proselint/AnimalLabels.yml | 48 ++ .github/styles/proselint/Annotations.yml | 9 + .github/styles/proselint/Apologizing.yml | 8 + .github/styles/proselint/Archaisms.yml | 52 ++ .github/styles/proselint/But.yml | 8 + .github/styles/proselint/Cliches.yml | 782 ++++++++++++++++++++ .github/styles/proselint/CorporateSpeak.yml | 30 + .github/styles/proselint/Currency.yml | 5 + .github/styles/proselint/Cursing.yml | 15 + .github/styles/proselint/DateCase.yml | 7 + .github/styles/proselint/DateMidnight.yml | 7 + .github/styles/proselint/DateRedundancy.yml | 10 + .github/styles/proselint/DateSpacing.yml | 7 + .github/styles/proselint/DenizenLabels.yml | 52 ++ .github/styles/proselint/Diacritical.yml | 95 +++ .github/styles/proselint/GenderBias.yml | 45 ++ .github/styles/proselint/GroupTerms.yml | 39 + .github/styles/proselint/Hedging.yml | 8 + .github/styles/proselint/Hyperbole.yml | 6 + .github/styles/proselint/Jargon.yml | 11 + .github/styles/proselint/LGBTOffensive.yml | 13 + .github/styles/proselint/LGBTTerms.yml | 15 + .github/styles/proselint/Malapropisms.yml | 8 + .github/styles/proselint/Needless.yml | 358 +++++++++ .github/styles/proselint/Nonwords.yml | 38 + .github/styles/proselint/Oxymorons.yml | 22 + .github/styles/proselint/P-Value.yml | 6 + .github/styles/proselint/RASSyndrome.yml | 30 + .github/styles/proselint/README.md | 12 + .github/styles/proselint/Skunked.yml | 13 + .github/styles/proselint/Spelling.yml | 17 + .github/styles/proselint/Typography.yml | 11 + .github/styles/proselint/Uncomparables.yml | 50 ++ .github/styles/proselint/Very.yml | 6 + .github/styles/proselint/meta.json | 17 + .github/styles/write-good/Cliches.yml | 702 ++++++++++++++++++ .github/styles/write-good/E-Prime.yml | 32 + .github/styles/write-good/Illusions.yml | 11 + .github/styles/write-good/Passive.yml | 183 +++++ .github/styles/write-good/README.md | 27 + .github/styles/write-good/So.yml | 5 + .github/styles/write-good/ThereIs.yml | 6 + .github/styles/write-good/TooWordy.yml | 221 ++++++ .github/styles/write-good/Weasel.yml | 207 ++++++ .github/styles/write-good/meta.json | 4 + .github/workflows/vale.yaml | 13 + vale.ini | 14 + 51 files changed, 3295 insertions(+), 1 deletion(-) create mode 100644 .github/styles/Vocab/Docs/accept.txt create mode 100644 .github/styles/Vocab/Docs/reject.txt create mode 100644 .github/styles/proselint/Airlinese.yml create mode 100644 .github/styles/proselint/AnimalLabels.yml create mode 100644 .github/styles/proselint/Annotations.yml create mode 100644 .github/styles/proselint/Apologizing.yml create mode 100644 .github/styles/proselint/Archaisms.yml create mode 100644 .github/styles/proselint/But.yml create mode 100644 .github/styles/proselint/Cliches.yml create mode 100644 .github/styles/proselint/CorporateSpeak.yml create mode 100644 .github/styles/proselint/Currency.yml create mode 100644 .github/styles/proselint/Cursing.yml create mode 100644 .github/styles/proselint/DateCase.yml create mode 100644 .github/styles/proselint/DateMidnight.yml create mode 100644 .github/styles/proselint/DateRedundancy.yml create mode 100644 .github/styles/proselint/DateSpacing.yml create mode 100644 .github/styles/proselint/DenizenLabels.yml create mode 100644 .github/styles/proselint/Diacritical.yml create mode 100644 .github/styles/proselint/GenderBias.yml create mode 100644 .github/styles/proselint/GroupTerms.yml create mode 100644 .github/styles/proselint/Hedging.yml create mode 100644 .github/styles/proselint/Hyperbole.yml create mode 100644 .github/styles/proselint/Jargon.yml create mode 100644 .github/styles/proselint/LGBTOffensive.yml create mode 100644 .github/styles/proselint/LGBTTerms.yml create mode 100644 .github/styles/proselint/Malapropisms.yml create mode 100644 .github/styles/proselint/Needless.yml create mode 100644 .github/styles/proselint/Nonwords.yml create mode 100644 .github/styles/proselint/Oxymorons.yml create mode 100644 .github/styles/proselint/P-Value.yml create mode 100644 .github/styles/proselint/RASSyndrome.yml create mode 100644 .github/styles/proselint/README.md create mode 100644 .github/styles/proselint/Skunked.yml create mode 100644 .github/styles/proselint/Spelling.yml create mode 100644 .github/styles/proselint/Typography.yml create mode 100644 .github/styles/proselint/Uncomparables.yml create mode 100644 .github/styles/proselint/Very.yml create mode 100644 .github/styles/proselint/meta.json create mode 100644 .github/styles/write-good/Cliches.yml create mode 100644 .github/styles/write-good/E-Prime.yml create mode 100644 .github/styles/write-good/Illusions.yml create mode 100644 .github/styles/write-good/Passive.yml create mode 100644 .github/styles/write-good/README.md create mode 100644 .github/styles/write-good/So.yml create mode 100644 .github/styles/write-good/ThereIs.yml create mode 100644 .github/styles/write-good/TooWordy.yml create mode 100644 .github/styles/write-good/Weasel.yml create mode 100644 .github/styles/write-good/meta.json create mode 100644 .github/workflows/vale.yaml create mode 100644 vale.ini diff --git a/.editorconfig b/.editorconfig index 984605938..52977d4a0 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,5 +8,5 @@ trim_trailing_whitespace = true insert_final_newline = true end_of_line = lf # editorconfig-tools is unable to ignore longs strings or urls -max_line_length = null +max_line_length = 0 quote_type = single diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt new file mode 100644 index 000000000..2cfab5fe2 --- /dev/null +++ b/.github/styles/Vocab/Docs/accept.txt @@ -0,0 +1 @@ +[Aa]pify diff --git a/.github/styles/Vocab/Docs/reject.txt b/.github/styles/Vocab/Docs/reject.txt new file mode 100644 index 000000000..e69de29bb diff --git a/.github/styles/proselint/Airlinese.yml b/.github/styles/proselint/Airlinese.yml new file mode 100644 index 000000000..a6ae9c193 --- /dev/null +++ b/.github/styles/proselint/Airlinese.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' is airlinese." +ignorecase: true +level: error +tokens: + - enplan(?:e|ed|ing|ement) + - deplan(?:e|ed|ing|ement) + - taking off momentarily diff --git a/.github/styles/proselint/AnimalLabels.yml b/.github/styles/proselint/AnimalLabels.yml new file mode 100644 index 000000000..b92e06fcb --- /dev/null +++ b/.github/styles/proselint/AnimalLabels.yml @@ -0,0 +1,48 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +level: error +action: + name: replace +swap: + (?:bull|ox)-like: taurine + (?:calf|veal)-like: vituline + (?:crow|raven)-like: corvine + (?:leopard|panther)-like: pardine + bird-like: avine + centipede-like: scolopendrine + crab-like: cancrine + crocodile-like: crocodiline + deer-like: damine + eagle-like: aquiline + earthworm-like: lumbricine + falcon-like: falconine + ferine: wild animal-like + fish-like: piscine + fox-like: vulpine + frog-like: ranine + goat-like: hircine + goose-like: anserine + gull-like: laridine + hare-like: leporine + hawk-like: accipitrine + hippopotamus-like: hippopotamine + lizard-like: lacertine + mongoose-like: viverrine + mouse-like: murine + ostrich-like: struthionine + peacock-like: pavonine + porcupine-like: hystricine + rattlesnake-like: crotaline + sable-like: zibeline + sheep-like: ovine + shrew-like: soricine + sparrow-like: passerine + swallow-like: hirundine + swine-like: suilline + tiger-like: tigrine + viper-like: viperine + vulture-like: vulturine + wasp-like: vespine + wolf-like: lupine + woodpecker-like: picine + zebra-like: zebrine diff --git a/.github/styles/proselint/Annotations.yml b/.github/styles/proselint/Annotations.yml new file mode 100644 index 000000000..dcb24f41b --- /dev/null +++ b/.github/styles/proselint/Annotations.yml @@ -0,0 +1,9 @@ +extends: existence +message: "'%s' left in text." +ignorecase: false +level: error +tokens: + - XXX + - FIXME + - TODO + - NOTE diff --git a/.github/styles/proselint/Apologizing.yml b/.github/styles/proselint/Apologizing.yml new file mode 100644 index 000000000..11088aaa8 --- /dev/null +++ b/.github/styles/proselint/Apologizing.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Excessive apologizing: '%s'" +ignorecase: true +level: error +action: + name: remove +tokens: + - More research is needed diff --git a/.github/styles/proselint/Archaisms.yml b/.github/styles/proselint/Archaisms.yml new file mode 100644 index 000000000..c8df9abc9 --- /dev/null +++ b/.github/styles/proselint/Archaisms.yml @@ -0,0 +1,52 @@ +extends: existence +message: "'%s' is archaic." +ignorecase: true +level: error +tokens: + - alack + - anent + - begat + - belike + - betimes + - boughten + - brocage + - brokage + - camarade + - chiefer + - chiefest + - Christiana + - completely obsolescent + - cozen + - divers + - deflexion + - fain + - forsooth + - foreclose from + - haply + - howbeit + - illumine + - in sooth + - maugre + - meseems + - methinks + - nigh + - peradventure + - perchance + - saith + - shew + - sistren + - spake + - to wit + - verily + - whilom + - withal + - wot + - enclosed please find + - please find enclosed + - enclosed herewith + - enclosed herein + - inforce + - ex postfacto + - foreclose from + - forewent + - for ever diff --git a/.github/styles/proselint/But.yml b/.github/styles/proselint/But.yml new file mode 100644 index 000000000..0e2c32b93 --- /dev/null +++ b/.github/styles/proselint/But.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Do not start a paragraph with a 'but'." +level: error +scope: paragraph +action: + name: remove +tokens: + - ^But diff --git a/.github/styles/proselint/Cliches.yml b/.github/styles/proselint/Cliches.yml new file mode 100644 index 000000000..c56183c51 --- /dev/null +++ b/.github/styles/proselint/Cliches.yml @@ -0,0 +1,782 @@ +extends: existence +message: "'%s' is a cliche." +level: error +ignorecase: true +tokens: + - a chip off the old block + - a clean slate + - a dark and stormy night + - a far cry + - a fate worse than death + - a fine kettle of fish + - a loose cannon + - a penny saved is a penny earned + - a tough row to hoe + - a word to the wise + - ace in the hole + - acid test + - add insult to injury + - against all odds + - air your dirty laundry + - alas and alack + - all fun and games + - all hell broke loose + - all in a day's work + - all talk, no action + - all thumbs + - all your eggs in one basket + - all's fair in love and war + - all's well that ends well + - almighty dollar + - American as apple pie + - an axe to grind + - another day, another dollar + - armed to the teeth + - as luck would have it + - as old as time + - as the crow flies + - at loose ends + - at my wits end + - at the end of the day + - avoid like the plague + - babe in the woods + - back against the wall + - back in the saddle + - back to square one + - back to the drawing board + - bad to the bone + - badge of honor + - bald faced liar + - bald-faced lie + - ballpark figure + - banging your head against a brick wall + - baptism by fire + - barking up the wrong tree + - bat out of hell + - be all and end all + - beat a dead horse + - beat around the bush + - been there, done that + - beggars can't be choosers + - behind the eight ball + - bend over backwards + - benefit of the doubt + - bent out of shape + - best thing since sliced bread + - bet your bottom dollar + - better half + - better late than never + - better mousetrap + - better safe than sorry + - between a rock and a hard place + - between a rock and a hard place + - between Scylla and Charybdis + - between the devil and the deep blue see + - betwixt and between + - beyond the pale + - bide your time + - big as life + - big cheese + - big fish in a small pond + - big man on campus + - bigger they are the harder they fall + - bird in the hand + - bird's eye view + - birds and the bees + - birds of a feather flock together + - bit the hand that feeds you + - bite the bullet + - bite the dust + - bitten off more than he can chew + - black as coal + - black as pitch + - black as the ace of spades + - blast from the past + - bleeding heart + - blessing in disguise + - blind ambition + - blind as a bat + - blind leading the blind + - blissful ignorance + - blood is thicker than water + - blood sweat and tears + - blow a fuse + - blow off steam + - blow your own horn + - blushing bride + - boils down to + - bolt from the blue + - bone to pick + - bored stiff + - bored to tears + - bottomless pit + - boys will be boys + - bright and early + - brings home the bacon + - broad across the beam + - broken record + - brought back to reality + - bulk large + - bull by the horns + - bull in a china shop + - burn the midnight oil + - burning question + - burning the candle at both ends + - burst your bubble + - bury the hatchet + - busy as a bee + - but that's another story + - by hook or by crook + - call a spade a spade + - called onto the carpet + - calm before the storm + - can of worms + - can't cut the mustard + - can't hold a candle to + - case of mistaken identity + - cast aspersions + - cat got your tongue + - cat's meow + - caught in the crossfire + - caught red-handed + - chase a red herring + - checkered past + - chomping at the bit + - cleanliness is next to godliness + - clear as a bell + - clear as mud + - close to the vest + - cock and bull story + - cold shoulder + - come hell or high water + - comparing apples and oranges + - compleat + - conspicuous by its absence + - cool as a cucumber + - cool, calm, and collected + - cost a king's ransom + - count your blessings + - crack of dawn + - crash course + - creature comforts + - cross that bridge when you come to it + - crushing blow + - cry like a baby + - cry me a river + - cry over spilt milk + - crystal clear + - crystal clear + - curiosity killed the cat + - cut and dried + - cut through the red tape + - cut to the chase + - cute as a bugs ear + - cute as a button + - cute as a puppy + - cuts to the quick + - cutting edge + - dark before the dawn + - day in, day out + - dead as a doornail + - decision-making process + - devil is in the details + - dime a dozen + - divide and conquer + - dog and pony show + - dog days + - dog eat dog + - dog tired + - don't burn your bridges + - don't count your chickens + - don't look a gift horse in the mouth + - don't rock the boat + - don't step on anyone's toes + - don't take any wooden nickels + - down and out + - down at the heels + - down in the dumps + - down the hatch + - down to earth + - draw the line + - dressed to kill + - dressed to the nines + - drives me up the wall + - dubious distinction + - dull as dishwater + - duly authorized + - dyed in the wool + - eagle eye + - ear to the ground + - early bird catches the worm + - easier said than done + - easy as pie + - eat your heart out + - eat your words + - eleventh hour + - even the playing field + - every dog has its day + - every fiber of my being + - everything but the kitchen sink + - eye for an eye + - eyes peeled + - face the music + - facts of life + - fair weather friend + - fall by the wayside + - fan the flames + - far be it from me + - fast and loose + - feast or famine + - feather your nest + - feathered friends + - few and far between + - fifteen minutes of fame + - fills the bill + - filthy vermin + - fine kettle of fish + - first and foremost + - fish out of water + - fishing for a compliment + - fit as a fiddle + - fit the bill + - fit to be tied + - flash in the pan + - flat as a pancake + - flip your lid + - flog a dead horse + - fly by night + - fly the coop + - follow your heart + - for all intents and purposes + - for free + - for the birds + - for what it's worth + - force of nature + - force to be reckoned with + - forgive and forget + - fox in the henhouse + - free and easy + - free as a bird + - fresh as a daisy + - full steam ahead + - fun in the sun + - garbage in, garbage out + - gentle as a lamb + - get a kick out of + - get a leg up + - get down and dirty + - get the lead out + - get to the bottom of + - get with the program + - get your feet wet + - gets my goat + - gilding the lily + - gilding the lily + - give and take + - go against the grain + - go at it tooth and nail + - go for broke + - go him one better + - go the extra mile + - go with the flow + - goes without saying + - good as gold + - good deed for the day + - good things come to those who wait + - good time was had by all + - good times were had by all + - greased lightning + - greek to me + - green thumb + - green-eyed monster + - grist for the mill + - growing like a weed + - hair of the dog + - hand to mouth + - happy as a clam + - happy as a lark + - hasn't a clue + - have a nice day + - have a short fuse + - have high hopes + - have the last laugh + - haven't got a row to hoe + - he's got his hands full + - head honcho + - head over heels + - hear a pin drop + - heard it through the grapevine + - heart's content + - heavy as lead + - hem and haw + - high and dry + - high and mighty + - high as a kite + - his own worst enemy + - his work cut out for him + - hit paydirt + - hither and yon + - Hobson's choice + - hold your head up high + - hold your horses + - hold your own + - hold your tongue + - honest as the day is long + - horns of a dilemma + - horns of a dilemma + - horse of a different color + - hot under the collar + - hour of need + - I beg to differ + - icing on the cake + - if the shoe fits + - if the shoe were on the other foot + - if you catch my drift + - in a jam + - in a jiffy + - in a nutshell + - in a pig's eye + - in a pinch + - in a word + - in hot water + - in light of + - in the final analysis + - in the gutter + - in the last analysis + - in the nick of time + - in the thick of it + - in your dreams + - innocent bystander + - it ain't over till the fat lady sings + - it goes without saying + - it takes all kinds + - it takes one to know one + - it's a small world + - it's not what you know, it's who you know + - it's only a matter of time + - ivory tower + - Jack of all trades + - jockey for position + - jog your memory + - joined at the hip + - judge a book by its cover + - jump down your throat + - jump in with both feet + - jump on the bandwagon + - jump the gun + - jump to conclusions + - just a hop, skip, and a jump + - just the ticket + - justice is blind + - keep a stiff upper lip + - keep an eye on + - keep it simple, stupid + - keep the home fires burning + - keep up with the Joneses + - keep your chin up + - keep your fingers crossed + - kick the bucket + - kick up your heels + - kick your feet up + - kid in a candy store + - kill two birds with one stone + - kiss of death + - knock it out of the park + - knock on wood + - knock your socks off + - know him from Adam + - know the ropes + - know the score + - knuckle down + - knuckle sandwich + - knuckle under + - labor of love + - ladder of success + - land on your feet + - lap of luxury + - last but not least + - last but not least + - last hurrah + - last-ditch effort + - law of the jungle + - law of the land + - lay down the law + - leaps and bounds + - let sleeping dogs lie + - let the cat out of the bag + - let the good times roll + - let your hair down + - let's talk turkey + - letter perfect + - lick your wounds + - lies like a rug + - life's a bitch + - life's a grind + - light at the end of the tunnel + - lighter than a feather + - lighter than air + - like clockwork + - like father like son + - like taking candy from a baby + - like there's no tomorrow + - lion's share + - live and learn + - live and let live + - long and short of it + - long lost love + - look before you leap + - look down your nose + - look what the cat dragged in + - looking a gift horse in the mouth + - looks like death warmed over + - loose cannon + - lose your head + - lose your temper + - loud as a horn + - lounge lizard + - loved and lost + - low man on the totem pole + - luck of the draw + - luck of the Irish + - make a mockery of + - make hay while the sun shines + - make money hand over fist + - make my day + - make the best of a bad situation + - make the best of it + - make your blood boil + - male chauvinism + - man of few words + - man's best friend + - mark my words + - meaningful dialogue + - missed the boat on that one + - moment in the sun + - moment of glory + - moment of truth + - moment of truth + - money to burn + - more in sorrow than in anger + - more power to you + - more sinned against than sinning + - more than one way to skin a cat + - movers and shakers + - moving experience + - my better half + - naked as a jaybird + - naked truth + - neat as a pin + - needle in a haystack + - needless to say + - neither here nor there + - never look back + - never say never + - nip and tuck + - nip in the bud + - nip it in the bud + - no guts, no glory + - no love lost + - no pain, no gain + - no skin off my back + - no stone unturned + - no time like the present + - no use crying over spilled milk + - nose to the grindstone + - not a hope in hell + - not a minute's peace + - not in my backyard + - not playing with a full deck + - not the end of the world + - not written in stone + - nothing to sneeze at + - nothing ventured nothing gained + - now we're cooking + - off the top of my head + - off the wagon + - off the wall + - old hat + - olden days + - older and wiser + - older than dirt + - older than Methuselah + - on a roll + - on cloud nine + - on pins and needles + - on the bandwagon + - on the money + - on the nose + - on the rocks + - on the same page + - on the spot + - on the tip of my tongue + - on the wagon + - on thin ice + - once bitten, twice shy + - one bad apple doesn't spoil the bushel + - one born every minute + - one brick short + - one foot in the grave + - one in a million + - one red cent + - only game in town + - open a can of worms + - open and shut case + - open the flood gates + - opportunity doesn't knock twice + - out of pocket + - out of sight, out of mind + - out of the frying pan into the fire + - out of the woods + - out on a limb + - over a barrel + - over the hump + - pain and suffering + - pain in the + - panic button + - par for the course + - part and parcel + - party pooper + - pass the buck + - patience is a virtue + - pay through the nose + - penny pincher + - perfect storm + - pig in a poke + - pile it on + - pillar of the community + - pin your hopes on + - pitter patter of little feet + - plain as day + - plain as the nose on your face + - play by the rules + - play your cards right + - playing the field + - playing with fire + - pleased as punch + - plenty of fish in the sea + - point with pride + - poor as a church mouse + - pot calling the kettle black + - presidential timber + - pretty as a picture + - pull a fast one + - pull your punches + - pulled no punches + - pulling your leg + - pure as the driven snow + - put it in a nutshell + - put one over on you + - put the cart before the horse + - put the pedal to the metal + - put your best foot forward + - put your foot down + - quantum jump + - quantum leap + - quick as a bunny + - quick as a lick + - quick as a wink + - quick as lightning + - quiet as a dormouse + - rags to riches + - raining buckets + - raining cats and dogs + - rank and file + - rat race + - reap what you sow + - red as a beet + - red herring + - redound to one's credit + - redound to the benefit of + - reinvent the wheel + - rich and famous + - rings a bell + - ripe old age + - ripped me off + - rise and shine + - road to hell is paved with good intentions + - rob Peter to pay Paul + - roll over in the grave + - rub the wrong way + - ruled the roost + - running in circles + - sad but true + - sadder but wiser + - salt of the earth + - scared stiff + - scared to death + - sea change + - sealed with a kiss + - second to none + - see eye to eye + - seen the light + - seize the day + - set the record straight + - set the world on fire + - set your teeth on edge + - sharp as a tack + - shirked his duties + - shoot for the moon + - shoot the breeze + - shot in the dark + - shoulder to the wheel + - sick as a dog + - sigh of relief + - signed, sealed, and delivered + - sink or swim + - six of one, half a dozen of another + - six of one, half a dozen of the other + - skating on thin ice + - slept like a log + - slinging mud + - slippery as an eel + - slow as molasses + - smart as a whip + - smooth as a baby's bottom + - sneaking suspicion + - snug as a bug in a rug + - sow wild oats + - spare the rod, spoil the child + - speak of the devil + - spilled the beans + - spinning your wheels + - spitting image of + - spoke with relish + - spread like wildfire + - spring to life + - squeaky wheel gets the grease + - stands out like a sore thumb + - start from scratch + - stick in the mud + - still waters run deep + - stitch in time + - stop and smell the roses + - straight as an arrow + - straw that broke the camel's back + - stretched to the breaking point + - strong as an ox + - stubborn as a mule + - stuff that dreams are made of + - stuffed shirt + - sweating blood + - sweating bullets + - take a load off + - take one for the team + - take the bait + - take the bull by the horns + - take the plunge + - takes one to know one + - takes two to tango + - than you can shake a stick at + - the cream of the crop + - the cream rises to the top + - the more the merrier + - the real deal + - the real McCoy + - the red carpet treatment + - the same old story + - the straw that broke the camel's back + - there is no accounting for taste + - thick as a brick + - thick as thieves + - thick as thieves + - thin as a rail + - think outside of the box + - thinking outside the box + - third time's the charm + - this day and age + - this hurts me worse than it hurts you + - this point in time + - thought leaders? + - three sheets to the wind + - through thick and thin + - throw in the towel + - throw the baby out with the bathwater + - tie one on + - tighter than a drum + - time and time again + - time is of the essence + - tip of the iceberg + - tired but happy + - to coin a phrase + - to each his own + - to make a long story short + - to the best of my knowledge + - toe the line + - tongue in cheek + - too good to be true + - too hot to handle + - too numerous to mention + - touch with a ten foot pole + - tough as nails + - trial and error + - trials and tribulations + - tried and true + - trip down memory lane + - twist of fate + - two cents worth + - two peas in a pod + - ugly as sin + - under the counter + - under the gun + - under the same roof + - under the weather + - until the cows come home + - unvarnished truth + - up the creek + - uphill battle + - upper crust + - upset the applecart + - vain attempt + - vain effort + - vanquish the enemy + - various and sundry + - vested interest + - viable alternative + - waiting for the other shoe to drop + - wakeup call + - warm welcome + - watch your p's and q's + - watch your tongue + - watching the clock + - water under the bridge + - wax eloquent + - wax poetic + - we've got a situation here + - weather the storm + - weed them out + - week of Sundays + - went belly up + - wet behind the ears + - what goes around comes around + - what you see is what you get + - when it rains, it pours + - when push comes to shove + - when the cat's away + - when the going gets tough, the tough get going + - whet (?:the|your) appetite + - white as a sheet + - whole ball of wax + - whole hog + - whole nine yards + - wild goose chase + - will wonders never cease? + - wisdom of the ages + - wise as an owl + - wolf at the door + - wool pulled over our eyes + - words fail me + - work like a dog + - world weary + - worst nightmare + - worth its weight in gold + - writ large + - wrong side of the bed + - yanking your chain + - yappy as a dog + - years young + - you are what you eat + - you can run but you can't hide + - you only live once + - you're the boss + - young and foolish + - young and vibrant diff --git a/.github/styles/proselint/CorporateSpeak.yml b/.github/styles/proselint/CorporateSpeak.yml new file mode 100644 index 000000000..4de8ee3f8 --- /dev/null +++ b/.github/styles/proselint/CorporateSpeak.yml @@ -0,0 +1,30 @@ +extends: existence +message: "'%s' is corporate speak." +ignorecase: true +level: error +tokens: + - at the end of the day + - back to the drawing board + - hit the ground running + - get the ball rolling + - low-hanging fruit + - thrown under the bus + - think outside the box + - let's touch base + - get my manager's blessing + - it's on my radar + - ping me + - i don't have the bandwidth + - no brainer + - par for the course + - bang for your buck + - synergy + - move the goal post + - apples to apples + - win-win + - circle back around + - all hands on deck + - take this offline + - drill-down + - elephant in the room + - on my plate diff --git a/.github/styles/proselint/Currency.yml b/.github/styles/proselint/Currency.yml new file mode 100644 index 000000000..ebd4b7d3e --- /dev/null +++ b/.github/styles/proselint/Currency.yml @@ -0,0 +1,5 @@ +extends: existence +message: "Incorrect use of symbols in '%s'." +ignorecase: true +raw: + - \$[\d]* ?(?:dollars|usd|us dollars) diff --git a/.github/styles/proselint/Cursing.yml b/.github/styles/proselint/Cursing.yml new file mode 100644 index 000000000..e65070a91 --- /dev/null +++ b/.github/styles/proselint/Cursing.yml @@ -0,0 +1,15 @@ +extends: existence +message: "Consider replacing '%s'." +level: error +ignorecase: true +tokens: + - shit + - piss + - fuck + - cunt + - cocksucker + - motherfucker + - tits + - fart + - turd + - twat diff --git a/.github/styles/proselint/DateCase.yml b/.github/styles/proselint/DateCase.yml new file mode 100644 index 000000000..9aa1bd991 --- /dev/null +++ b/.github/styles/proselint/DateCase.yml @@ -0,0 +1,7 @@ +extends: existence +message: With lowercase letters, the periods are standard. +ignorecase: false +level: error +nonword: true +tokens: + - '\d{1,2} ?[ap]m\b' diff --git a/.github/styles/proselint/DateMidnight.yml b/.github/styles/proselint/DateMidnight.yml new file mode 100644 index 000000000..0130e1aef --- /dev/null +++ b/.github/styles/proselint/DateMidnight.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use 'midnight' or 'noon'." +ignorecase: true +level: error +nonword: true +tokens: + - '12 ?[ap]\.?m\.?' diff --git a/.github/styles/proselint/DateRedundancy.yml b/.github/styles/proselint/DateRedundancy.yml new file mode 100644 index 000000000..b1f653ea5 --- /dev/null +++ b/.github/styles/proselint/DateRedundancy.yml @@ -0,0 +1,10 @@ +extends: existence +message: "'a.m.' is always morning; 'p.m.' is always night." +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2} ?a\.?m\.? in the morning' + - '\d{1,2} ?p\.?m\.? in the evening' + - '\d{1,2} ?p\.?m\.? at night' + - '\d{1,2} ?p\.?m\.? in the afternoon' diff --git a/.github/styles/proselint/DateSpacing.yml b/.github/styles/proselint/DateSpacing.yml new file mode 100644 index 000000000..b7a2fd33b --- /dev/null +++ b/.github/styles/proselint/DateSpacing.yml @@ -0,0 +1,7 @@ +extends: existence +message: "It's standard to put a space before '%s'" +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2}[ap]\.?m\.?' diff --git a/.github/styles/proselint/DenizenLabels.yml b/.github/styles/proselint/DenizenLabels.yml new file mode 100644 index 000000000..bc3dd8abb --- /dev/null +++ b/.github/styles/proselint/DenizenLabels.yml @@ -0,0 +1,52 @@ +extends: substitution +message: Did you mean '%s'? +ignorecase: false +action: + name: replace +swap: + (?:Afrikaaner|Afrikander): Afrikaner + (?:Hong Kongite|Hong Kongian): Hong Konger + (?:Indianan|Indianian): Hoosier + (?:Michiganite|Michiganian): Michigander + (?:New Hampshireite|New Hampshireman): New Hampshirite + (?:Newcastlite|Newcastleite): Novocastrian + (?:Providencian|Providencer): Providentian + (?:Trentian|Trentonian): Tridentine + (?:Warsawer|Warsawian): Varsovian + (?:Wolverhamptonite|Wolverhamptonian): Wulfrunian + Alabaman: Alabamian + Albuquerquian: Albuquerquean + Anchoragite: Anchorageite + Arizonian: Arizonan + Arkansawyer: Arkansan + Belarusan: Belarusian + Cayman Islander: Caymanian + Coloradoan: Coloradan + Connecticuter: Nutmegger + Fairbanksian: Fairbanksan + Fort Worther: Fort Worthian + Grenadian: Grenadan + Halifaxer: Haligonian + Hartlepoolian: Hartlepudlian + Illinoisian: Illinoisan + Iowegian: Iowan + Leedsian: Leodenisian + Liverpoolian: Liverpudlian + Los Angelean: Angeleno + Manchesterian: Mancunian + Minneapolisian: Minneapolitan + Missouran: Missourian + Monacan: Monegasque + Neopolitan: Neapolitan + New Jerseyite: New Jerseyan + New Orleansian: New Orleanian + Oklahoma Citian: Oklahoma Cityan + Oklahomian: Oklahoman + Saudi Arabian: Saudi + Seattlite: Seattleite + Surinamer: Surinamese + Tallahassean: Tallahasseean + Tennesseean: Tennessean + Trois-Rivièrester: Trifluvian + Utahan: Utahn + Valladolidian: Vallisoletano diff --git a/.github/styles/proselint/Diacritical.yml b/.github/styles/proselint/Diacritical.yml new file mode 100644 index 000000000..2416cf28b --- /dev/null +++ b/.github/styles/proselint/Diacritical.yml @@ -0,0 +1,95 @@ +extends: substitution +message: Consider using '%s' instead of '%s'. +ignorecase: true +level: error +action: + name: replace +swap: + beau ideal: beau idéal + boutonniere: boutonnière + bric-a-brac: bric-à-brac + cafe: café + cause celebre: cause célèbre + chevre: chèvre + cliche: cliché + consomme: consommé + coup de grace: coup de grâce + crudites: crudités + creme brulee: crème brûlée + creme de menthe: crème de menthe + creme fraice: crème fraîche + creme fresh: crème fraîche + crepe: crêpe + debutante: débutante + decor: décor + deja vu: déjà vu + denouement: dénouement + facade: façade + fiance: fiancé + fiancee: fiancée + flambe: flambé + garcon: garçon + lycee: lycée + maitre d: maître d + menage a trois: ménage à trois + negligee: négligée + protege: protégé + protegee: protégée + puree: purée + my resume: my résumé + your resume: your résumé + his resume: his résumé + her resume: her résumé + a resume: a résumé + the resume: the résumé + risque: risqué + roue: roué + soiree: soirée + souffle: soufflé + soupcon: soupçon + touche: touché + tete-a-tete: tête-à-tête + voila: voilà + a la carte: à la carte + a la mode: à la mode + emigre: émigré + + # Spanish loanwords + El Nino: El Niño + jalapeno: jalapeño + La Nina: La Niña + pina colada: piña colada + senor: señor + senora: señora + senorita: señorita + + # Portuguese loanwords + acai: açaí + + # German loanwords + doppelganger: doppelgänger + Fuhrer: Führer + Gewurztraminer: Gewürztraminer + vis-a-vis: vis-à-vis + Ubermensch: Übermensch + + # Swedish loanwords + filmjolk: filmjölk + smorgasbord: smörgåsbord + + # Names, places, and companies + Beyonce: Beyoncé + Bronte: Brontë + Champs-Elysees: Champs-Élysées + Citroen: Citroën + Curacao: Curaçao + Lowenbrau: Löwenbräu + Monegasque: Monégasque + Motley Crue: Mötley Crüe + Nescafe: Nescafé + Queensryche: Queensrÿche + Quebec: Québec + Quebecois: Québécois + Angstrom: Ångström + angstrom: ångström + Skoda: Škoda diff --git a/.github/styles/proselint/GenderBias.yml b/.github/styles/proselint/GenderBias.yml new file mode 100644 index 000000000..d98d3cf45 --- /dev/null +++ b/.github/styles/proselint/GenderBias.yml @@ -0,0 +1,45 @@ +extends: substitution +message: Consider using '%s' instead of '%s'. +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumnae|alumni): graduates + (?:alumna|alumnus): graduate + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.github/styles/proselint/GroupTerms.yml b/.github/styles/proselint/GroupTerms.yml new file mode 100644 index 000000000..7a59fa48a --- /dev/null +++ b/.github/styles/proselint/GroupTerms.yml @@ -0,0 +1,39 @@ +extends: substitution +message: Consider using '%s' instead of '%s'. +ignorecase: true +action: + name: replace +swap: + (?:bunch|group|pack|flock) of chickens: brood of chickens + (?:bunch|group|pack|flock) of crows: murder of crows + (?:bunch|group|pack|flock) of hawks: cast of hawks + (?:bunch|group|pack|flock) of parrots: pandemonium of parrots + (?:bunch|group|pack|flock) of peacocks: muster of peacocks + (?:bunch|group|pack|flock) of penguins: muster of penguins + (?:bunch|group|pack|flock) of sparrows: host of sparrows + (?:bunch|group|pack|flock) of turkeys: rafter of turkeys + (?:bunch|group|pack|flock) of woodpeckers: descent of woodpeckers + (?:bunch|group|pack|herd) of apes: shrewdness of apes + (?:bunch|group|pack|herd) of baboons: troop of baboons + (?:bunch|group|pack|herd) of badgers: cete of badgers + (?:bunch|group|pack|herd) of bears: sloth of bears + (?:bunch|group|pack|herd) of bullfinches: bellowing of bullfinches + (?:bunch|group|pack|herd) of bullocks: drove of bullocks + (?:bunch|group|pack|herd) of caterpillars: army of caterpillars + (?:bunch|group|pack|herd) of cats: clowder of cats + (?:bunch|group|pack|herd) of colts: rag of colts + (?:bunch|group|pack|herd) of crocodiles: bask of crocodiles + (?:bunch|group|pack|herd) of dolphins: school of dolphins + (?:bunch|group|pack|herd) of foxes: skulk of foxes + (?:bunch|group|pack|herd) of gorillas: band of gorillas + (?:bunch|group|pack|herd) of hippopotami: bloat of hippopotami + (?:bunch|group|pack|herd) of horses: drove of horses + (?:bunch|group|pack|herd) of jellyfish: fluther of jellyfish + (?:bunch|group|pack|herd) of kangeroos: mob of kangeroos + (?:bunch|group|pack|herd) of monkeys: troop of monkeys + (?:bunch|group|pack|herd) of oxen: yoke of oxen + (?:bunch|group|pack|herd) of rhinoceros: crash of rhinoceros + (?:bunch|group|pack|herd) of wild boar: sounder of wild boar + (?:bunch|group|pack|herd) of wild pigs: drift of wild pigs + (?:bunch|group|pack|herd) of zebras: zeal of wild pigs + (?:bunch|group|pack|school) of trout: hover of trout diff --git a/.github/styles/proselint/Hedging.yml b/.github/styles/proselint/Hedging.yml new file mode 100644 index 000000000..a8615f8bb --- /dev/null +++ b/.github/styles/proselint/Hedging.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' is hedging." +ignorecase: true +level: error +tokens: + - I would argue that + - ', so to speak' + - to a certain degree diff --git a/.github/styles/proselint/Hyperbole.yml b/.github/styles/proselint/Hyperbole.yml new file mode 100644 index 000000000..0361772ce --- /dev/null +++ b/.github/styles/proselint/Hyperbole.yml @@ -0,0 +1,6 @@ +extends: existence +message: "'%s' is hyperbolic." +level: error +nonword: true +tokens: + - '[a-z]+[!?]{2,}' diff --git a/.github/styles/proselint/Jargon.yml b/.github/styles/proselint/Jargon.yml new file mode 100644 index 000000000..2454a9c34 --- /dev/null +++ b/.github/styles/proselint/Jargon.yml @@ -0,0 +1,11 @@ +extends: existence +message: "'%s' is jargon." +ignorecase: true +level: error +tokens: + - in the affirmative + - in the negative + - agendize + - per your order + - per your request + - disincentivize diff --git a/.github/styles/proselint/LGBTOffensive.yml b/.github/styles/proselint/LGBTOffensive.yml new file mode 100644 index 000000000..eaf5a84a1 --- /dev/null +++ b/.github/styles/proselint/LGBTOffensive.yml @@ -0,0 +1,13 @@ +extends: existence +message: "'%s' is offensive. Remove it or consider the context." +ignorecase: true +tokens: + - fag + - faggot + - dyke + - sodomite + - homosexual agenda + - gay agenda + - transvestite + - homosexual lifestyle + - gay lifestyle diff --git a/.github/styles/proselint/LGBTTerms.yml b/.github/styles/proselint/LGBTTerms.yml new file mode 100644 index 000000000..efdf26886 --- /dev/null +++ b/.github/styles/proselint/LGBTTerms.yml @@ -0,0 +1,15 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +action: + name: replace +swap: + homosexual man: gay man + homosexual men: gay men + homosexual woman: lesbian + homosexual women: lesbians + homosexual people: gay people + homosexual couple: gay couple + sexual preference: sexual orientation + (?:admitted homosexual|avowed homosexual): openly gay + special rights: equal rights diff --git a/.github/styles/proselint/Malapropisms.yml b/.github/styles/proselint/Malapropisms.yml new file mode 100644 index 000000000..96997787a --- /dev/null +++ b/.github/styles/proselint/Malapropisms.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' is a malapropism." +ignorecase: true +level: error +tokens: + - the infinitesimal universe + - a serial experience + - attack my voracity diff --git a/.github/styles/proselint/Needless.yml b/.github/styles/proselint/Needless.yml new file mode 100644 index 000000000..1f2732e17 --- /dev/null +++ b/.github/styles/proselint/Needless.yml @@ -0,0 +1,358 @@ +extends: substitution +message: Prefer '%s' over '%s' +ignorecase: true +action: + name: replace +swap: + '(?:cell phone|cell-phone)': cellphone + '(?:cliquey|cliquy)': cliquish + '(?:pygmean|pygmaen)': pygmy + '(?:retributional|retributionary)': retributive + '(?:revokable|revokeable)': revocable + abolishment: abolition + accessary: accessory + accreditate: accredit + accruement: accrual + accusee: accused + acquaintanceship: acquaintance + acquitment: acquittal + administrate: administer + administrated: administered + administrating: administering + adulterate: adulterous + advisatory: advisory + advocator: advocate + aggrievance: grievance + allegator: alleger + allusory: allusive + amative: amorous + amortizement: amortization + amphiboly: amphibology + anecdotalist: anecdotist + anilinctus: anilingus + anticipative: anticipatory + antithetic: antithetical + applicative: applicable + applicatory: applicable + applier: applicator + approbative: approbatory + arbitrager: arbitrageur + arsenous: arsenious + ascendance: ascendancy + ascendence: ascendancy + ascendency: ascendancy + auctorial: authorial + averral: averment + barbwire: barbed wire + benefic: beneficent + benignant: benign + bestowment: bestowal + betrothment: betrothal + blamableness: blameworthiness + butt naked: buck naked + camarade: comrade + carta blanca: carte blanche + casualities: casualties + casuality: casualty + catch on fire: catch fire + catholicly: catholically + cease fire: ceasefire + channelize: channel + chaplainship: chaplaincy + chrysalid: chrysalis + chrysalids: chrysalises + cigaret: cigarette + coemployee: coworker + cognitional: cognitive + cohabitate: cohabit + cohabitor: cohabitant + collodium: collodion + collusory: collusive + commemoratory: commemorative + commonty: commonage + communicatory: communicative + compensative: compensatory + complacence: complacency + complicitous: complicit + computate: compute + conciliative: conciliatory + concomitancy: concomitance + condonance: condonation + confirmative: confirmatory + congruency: congruence + connotate: connote + consanguineal: consanguine + conspicuity: conspicuousness + conspiratorialist: conspirator + constitutionist: constitutionalist + contingence: contigency + contributary: contributory + contumacity: contumacy + conversible: convertible + conveyal: conveyance + copartner: partner + copartnership: partnership + corroboratory: corroborative + cotemporaneous: contemporaneous + cotemporary: contemporary + criminate: incriminate + culpatory: inculpatory + cumbrance: encumbrance + cumulate: accumulate + curatory: curative + daredeviltry: daredevilry + deceptious: deceptive + defamative: defamatory + defraudulent: fraudulent + degeneratory: degenerative + delimitate: delimit + delusory: delusive + denouncement: denunciation + depositee: depositary + depreciative: depreciatory + deprival: deprivation + derogative: derogatory + destroyable: destructible + detoxicate: detoxify + detractory: detractive + deviancy: deviance + deviationist: deviant + digamy: deuterogamy + digitalize: digitize + diminishment: diminution + diplomatist: diplomat + disassociate: dissociate + disciplinatory: disciplinary + discriminant: discriminating + disenthrone: dethrone + disintegratory: disintegrative + dismission: dismissal + disorientate: disorient + disorientated: disoriented + disquieten: disquiet + distraite: distrait + divergency: divergence + dividable: divisible + doctrinary: doctrinaire + documental: documentary + domesticize: domesticate + duplicatory: duplicative + duteous: dutiful + educationalist: educationist + educatory: educative + enigmatas: enigmas + enlargen: enlarge + enswathe: swathe + epical: epic + erotism: eroticism + ethician: ethicist + ex officiis: ex officio + exculpative: exculpatory + exigeant: exigent + exigence: exigency + exotism: exoticism + expedience: expediency + expediential: expedient + extensible: extendable + eying: eyeing + fiefdom: fief + flagrance: flagrancy + flatulency: flatulence + fraudful: fraudulent + funebrial: funereal + geographical: geographic + geometrical: geometric + gerry-rigged: jury-rigged + goatherder: goatherd + gustatorial: gustatory + habitude: habit + henceforward: henceforth + hesitance: hesitancy + heterogenous: heterogeneous + hierarchic: hierarchical + hindermost: hindmost + honorand: honoree + hypostasize: hypostatize + hysteric: hysterical + idolatrize: idolize + impanel: empanel + imperviable: impervious + importunacy: importunity + impotency: impotence + imprimatura: imprimatur + improprietous: improper + inalterable: unalterable + incitation: incitement + incommunicative: uncommunicative + inconsistence: inconsistency + incontrollable: uncontrollable + incurment: incurrence + indow: endow + indue: endue + inhibitive: inhibitory + innavigable: unnavigable + innovational: innovative + inquisitional: inquisitorial + insistment: insistence + insolvable: unsolvable + instillment: instillation + instinctual: instinctive + insuror: insurer + insurrectional: insurrectionary + interpretate: interpret + intervenience: intervention + ironical: ironic + jerry-rigged: jury-rigged + judgmatic: judgmental + labyrinthian: labyrinthine + laudative: laudatory + legitimatization: legitimation + legitimatize: legitimize + legitimization: legitimation + lengthways: lengthwise + life-sized: life-size + liquorice: licorice + lithesome: lithe + lollipop: lollypop + loth: loath + lubricous: lubricious + maihem: mayhem + medicinal marijuana: medical marijuana + meliorate: ameliorate + minimalize: minimize + mirk: murk + mirky: murky + misdoubt: doubt + monetarize: monetize + moveable: movable + narcism: narcissism + neglective: neglectful + negligency: negligence + neologizer: neologist + neurologic: neurological + nicknack: knickknack + nictate: nictitate + nonenforceable: unenforceable + normalcy: normality + numbedness: numbness + omittable: omissible + onomatopoetic: onomatopoeic + opinioned: opined + optimum advantage: optimal advantage + orientate: orient + outsized: outsize + oversized: oversize + overthrowal: overthrow + pacificist: pacifist + paederast: pederast + parachronism: anachronism + parti-color: parti-colored + participative: participatory + party-colored: parti-colored + pediatrist: pediatrician + penumbrous: penumbral + perjorative: pejorative + permissory: permissive + permutate: permute + personation: impersonation + pharmaceutic: pharmaceutical + pleuritis: pleurisy + policy holder: policyholder + policyowner: policyholder + politicalize: politicize + precedency: precedence + preceptoral: preceptorial + precipitance: precipitancy + precipitant: precipitate + preclusory: preclusive + precolumbian: pre-Columbian + prefectoral: prefectorial + preponderately: preponderantly + preserval: preservation + preventative: preventive + proconsulship: proconsulate + procreational: procreative + procurance: procurement + propelment: propulsion + propulsory: propulsive + prosecutive: prosecutory + protectory: protective + provocatory: provocative + pruriency: prurience + psychal: psychical + punitory: punitive + quantitate: quantify + questionary: questionnaire + quiescency: quiescence + rabbin: rabbi + reasonability: reasonableness + recidivistic: recidivous + recriminative: recriminatory + recruital: recruitment + recurrency: recurrence + recusance: recusancy + recusation: recusal + recusement: recusal + redemptory: redemptive + referrable: referable + referrible: referable + refutatory: refutative + remitment: remittance + remittal: remission + renouncement: renunciation + renunciable: renounceable + reparatory: reparative + repudiative: repudiatory + requitement: requital + rescindment: rescission + restoral: restoration + reticency: reticence + reviewal: review + revisal: revision + revisional: revisionary + revolute: revolt + saliency: salience + salutiferous: salutary + sensatory: sensory + sessionary: sessional + shareowner: shareholder + sicklily: sickly + signator: signatory + slanderize: slander + societary: societal + sodomist: sodomite + solicitate: solicit + speculatory: speculative + spiritous: spirituous + statutorial: statutory + submergeable: submersible + submittal: submission + subtile: subtle + succuba: succubus + sufficience: sufficiency + suppliant: supplicant + surmisal: surmise + suspendible: suspendable + synthetize: synthesize + systemize: systematize + tactual: tactile + tangental: tangential + tautologous: tautological + tee-shirt: T-shirt + thenceforward: thenceforth + transiency: transience + transposal: transposition + unfrequent: infrequent + unreasonability: unreasonableness + unrevokable: irrevocable + unsubstantial: insubstantial + usurpature: usurpation + variative: variational + vegetive: vegetative + vindicative: vindictive + vituperous: vituperative + vociferant: vociferous + volitive: volitional + wolverene: wolverine + wolvish: wolfish + Zoroastrism: Zoroastrianism diff --git a/.github/styles/proselint/Nonwords.yml b/.github/styles/proselint/Nonwords.yml new file mode 100644 index 000000000..57e7b9e42 --- /dev/null +++ b/.github/styles/proselint/Nonwords.yml @@ -0,0 +1,38 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + affrontery: effrontery + analyzation: analysis + annoyment: annoyance + confirmant: confirmand + confirmants: confirmands + conversate: converse + crained: cranded + discomforture: discomfort|discomfiture + dispersement: disbursement|dispersal + doubtlessly: doubtless|undoubtedly + forebearance: forbearance + improprietous: improper + inclimate: inclement + inimicable: inimical + irregardless: regardless + minimalize: minimize + minimalized: minimized + minimalizes: minimizes + minimalizing: minimizing + optimalize: optimize + paralyzation: paralysis + pettifogger: pettifog + proprietous: proper + relative inexpense: relatively low price|affordability + seldomly: seldom + thusly: thus + uncategorically: categorically + undoubtably: undoubtedly|indubitably + unequivocable: unequivocal + unmercilessly: mercilessly + unrelentlessly: unrelentingly|relentlessly diff --git a/.github/styles/proselint/Oxymorons.yml b/.github/styles/proselint/Oxymorons.yml new file mode 100644 index 000000000..25fd2aa5d --- /dev/null +++ b/.github/styles/proselint/Oxymorons.yml @@ -0,0 +1,22 @@ +extends: existence +message: "'%s' is an oxymoron." +ignorecase: true +level: error +tokens: + - amateur expert + - increasingly less + - advancing backwards + - alludes explicitly to + - explicitly alludes to + - totally obsolescent + - completely obsolescent + - generally always + - usually always + - increasingly less + - build down + - conspicuous absence + - exact estimate + - found missing + - intense apathy + - mandatory choice + - organized mess diff --git a/.github/styles/proselint/P-Value.yml b/.github/styles/proselint/P-Value.yml new file mode 100644 index 000000000..82309386f --- /dev/null +++ b/.github/styles/proselint/P-Value.yml @@ -0,0 +1,6 @@ +extends: existence +message: "You should use more decimal places, unless '%s' is really true." +ignorecase: true +level: suggestion +tokens: + - 'p = 0\.0{2,4}' diff --git a/.github/styles/proselint/RASSyndrome.yml b/.github/styles/proselint/RASSyndrome.yml new file mode 100644 index 000000000..deae9c7d3 --- /dev/null +++ b/.github/styles/proselint/RASSyndrome.yml @@ -0,0 +1,30 @@ +extends: existence +message: "'%s' is redundant." +level: error +action: + name: edit + params: + - split + - ' ' + - '0' +tokens: + - ABM missile + - ACT test + - ABM missiles + - ABS braking system + - ATM machine + - CD disc + - CPI Index + - GPS system + - GUI interface + - HIV virus + - ISBN number + - LCD display + - PDF format + - PIN number + - RAS syndrome + - RIP in peace + - please RSVP + - SALT talks + - SAT test + - UPC codes diff --git a/.github/styles/proselint/README.md b/.github/styles/proselint/README.md new file mode 100644 index 000000000..402076869 --- /dev/null +++ b/.github/styles/proselint/README.md @@ -0,0 +1,12 @@ +Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/.github/styles/proselint/Skunked.yml b/.github/styles/proselint/Skunked.yml new file mode 100644 index 000000000..96a1f690e --- /dev/null +++ b/.github/styles/proselint/Skunked.yml @@ -0,0 +1,13 @@ +extends: existence +message: "'%s' is a bit of a skunked term — impossible to use without issue." +ignorecase: true +level: error +tokens: + - bona fides + - deceptively + - decimate + - effete + - fulsome + - hopefully + - impassionate + - Thankfully diff --git a/.github/styles/proselint/Spelling.yml b/.github/styles/proselint/Spelling.yml new file mode 100644 index 000000000..d3c9be7b7 --- /dev/null +++ b/.github/styles/proselint/Spelling.yml @@ -0,0 +1,17 @@ +extends: consistency +message: "Inconsistent spelling of '%s'." +level: error +ignorecase: true +either: + advisor: adviser + centre: center + colour: color + emphasise: emphasize + finalise: finalize + focussed: focused + labour: labor + learnt: learned + organise: organize + organised: organized + organising: organizing + recognise: recognize diff --git a/.github/styles/proselint/Typography.yml b/.github/styles/proselint/Typography.yml new file mode 100644 index 000000000..60283ebf0 --- /dev/null +++ b/.github/styles/proselint/Typography.yml @@ -0,0 +1,11 @@ +extends: substitution +message: Consider using the '%s' symbol instead of '%s'. +level: error +nonword: true +swap: + '\.\.\.': … + '\([cC]\)': © + '\(TM\)': ™ + '\(tm\)': ™ + '\([rR]\)': ® + '[0-9]+ ?x ?[0-9]+': × diff --git a/.github/styles/proselint/Uncomparables.yml b/.github/styles/proselint/Uncomparables.yml new file mode 100644 index 000000000..9b96f42b0 --- /dev/null +++ b/.github/styles/proselint/Uncomparables.yml @@ -0,0 +1,50 @@ +extends: existence +message: "'%s' is not comparable" +ignorecase: true +level: error +action: + name: edit + params: + - split + - ' ' + - '1' +raw: + - \b(?:absolutely|most|more|less|least|very|quite|largely|extremely|increasingly|kind of|mildy|hardly|greatly|sort of)\b\s* +tokens: + - absolute + - adequate + - complete + - correct + - certain + - devoid + - entire + - 'false' + - fatal + - favorite + - final + - ideal + - impossible + - inevitable + - infinite + - irrevocable + - main + - manifest + - only + - paramount + - perfect + - perpetual + - possible + - preferable + - principal + - singular + - stationary + - sufficient + - 'true' + - unanimous + - unavoidable + - unbroken + - uniform + - unique + - universal + - void + - whole diff --git a/.github/styles/proselint/Very.yml b/.github/styles/proselint/Very.yml new file mode 100644 index 000000000..e4077f792 --- /dev/null +++ b/.github/styles/proselint/Very.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Remove '%s'." +ignorecase: true +level: error +tokens: + - very diff --git a/.github/styles/proselint/meta.json b/.github/styles/proselint/meta.json new file mode 100644 index 000000000..e3c65800b --- /dev/null +++ b/.github/styles/proselint/meta.json @@ -0,0 +1,17 @@ +{ + "author": "jdkato", + "description": "A Vale-compatible implementation of the proselint linter.", + "email": "support@errata.ai", + "lang": "en", + "url": "https://github.com/errata-ai/proselint/releases/latest/download/proselint.zip", + "feed": "https://github.com/errata-ai/proselint/releases.atom", + "issues": "https://github.com/errata-ai/proselint/issues/new", + "license": "BSD-3-Clause", + "name": "proselint", + "sources": [ + "https://github.com/amperser/proselint" + ], + "vale_version": ">=1.0.0", + "coverage": 0.0, + "version": "0.1.0" +} diff --git a/.github/styles/write-good/Cliches.yml b/.github/styles/write-good/Cliches.yml new file mode 100644 index 000000000..c95314387 --- /dev/null +++ b/.github/styles/write-good/Cliches.yml @@ -0,0 +1,702 @@ +extends: existence +message: "Try to avoid using clichés like '%s'." +ignorecase: true +level: warning +tokens: + - a chip off the old block + - a clean slate + - a dark and stormy night + - a far cry + - a fine kettle of fish + - a loose cannon + - a penny saved is a penny earned + - a tough row to hoe + - a word to the wise + - ace in the hole + - acid test + - add insult to injury + - against all odds + - air your dirty laundry + - all fun and games + - all in a day's work + - all talk, no action + - all thumbs + - all your eggs in one basket + - all's fair in love and war + - all's well that ends well + - almighty dollar + - American as apple pie + - an axe to grind + - another day, another dollar + - armed to the teeth + - as luck would have it + - as old as time + - as the crow flies + - at loose ends + - at my wits end + - avoid like the plague + - babe in the woods + - back against the wall + - back in the saddle + - back to square one + - back to the drawing board + - bad to the bone + - badge of honor + - bald faced liar + - ballpark figure + - banging your head against a brick wall + - baptism by fire + - barking up the wrong tree + - bat out of hell + - be all and end all + - beat a dead horse + - beat around the bush + - been there, done that + - beggars can't be choosers + - behind the eight ball + - bend over backwards + - benefit of the doubt + - bent out of shape + - best thing since sliced bread + - bet your bottom dollar + - better half + - better late than never + - better mousetrap + - better safe than sorry + - between a rock and a hard place + - beyond the pale + - bide your time + - big as life + - big cheese + - big fish in a small pond + - big man on campus + - bigger they are the harder they fall + - bird in the hand + - bird's eye view + - birds and the bees + - birds of a feather flock together + - bit the hand that feeds you + - bite the bullet + - bite the dust + - bitten off more than he can chew + - black as coal + - black as pitch + - black as the ace of spades + - blast from the past + - bleeding heart + - blessing in disguise + - blind ambition + - blind as a bat + - blind leading the blind + - blood is thicker than water + - blood sweat and tears + - blow off steam + - blow your own horn + - blushing bride + - boils down to + - bolt from the blue + - bone to pick + - bored stiff + - bored to tears + - bottomless pit + - boys will be boys + - bright and early + - brings home the bacon + - broad across the beam + - broken record + - brought back to reality + - bull by the horns + - bull in a china shop + - burn the midnight oil + - burning question + - burning the candle at both ends + - burst your bubble + - bury the hatchet + - busy as a bee + - by hook or by crook + - call a spade a spade + - called onto the carpet + - calm before the storm + - can of worms + - can't cut the mustard + - can't hold a candle to + - case of mistaken identity + - cat got your tongue + - cat's meow + - caught in the crossfire + - caught red-handed + - checkered past + - chomping at the bit + - cleanliness is next to godliness + - clear as a bell + - clear as mud + - close to the vest + - cock and bull story + - cold shoulder + - come hell or high water + - cool as a cucumber + - cool, calm, and collected + - cost a king's ransom + - count your blessings + - crack of dawn + - crash course + - creature comforts + - cross that bridge when you come to it + - crushing blow + - cry like a baby + - cry me a river + - cry over spilt milk + - crystal clear + - curiosity killed the cat + - cut and dried + - cut through the red tape + - cut to the chase + - cute as a bugs ear + - cute as a button + - cute as a puppy + - cuts to the quick + - dark before the dawn + - day in, day out + - dead as a doornail + - devil is in the details + - dime a dozen + - divide and conquer + - dog and pony show + - dog days + - dog eat dog + - dog tired + - don't burn your bridges + - don't count your chickens + - don't look a gift horse in the mouth + - don't rock the boat + - don't step on anyone's toes + - don't take any wooden nickels + - down and out + - down at the heels + - down in the dumps + - down the hatch + - down to earth + - draw the line + - dressed to kill + - dressed to the nines + - drives me up the wall + - dull as dishwater + - dyed in the wool + - eagle eye + - ear to the ground + - early bird catches the worm + - easier said than done + - easy as pie + - eat your heart out + - eat your words + - eleventh hour + - even the playing field + - every dog has its day + - every fiber of my being + - everything but the kitchen sink + - eye for an eye + - face the music + - facts of life + - fair weather friend + - fall by the wayside + - fan the flames + - feast or famine + - feather your nest + - feathered friends + - few and far between + - fifteen minutes of fame + - filthy vermin + - fine kettle of fish + - fish out of water + - fishing for a compliment + - fit as a fiddle + - fit the bill + - fit to be tied + - flash in the pan + - flat as a pancake + - flip your lid + - flog a dead horse + - fly by night + - fly the coop + - follow your heart + - for all intents and purposes + - for the birds + - for what it's worth + - force of nature + - force to be reckoned with + - forgive and forget + - fox in the henhouse + - free and easy + - free as a bird + - fresh as a daisy + - full steam ahead + - fun in the sun + - garbage in, garbage out + - gentle as a lamb + - get a kick out of + - get a leg up + - get down and dirty + - get the lead out + - get to the bottom of + - get your feet wet + - gets my goat + - gilding the lily + - give and take + - go against the grain + - go at it tooth and nail + - go for broke + - go him one better + - go the extra mile + - go with the flow + - goes without saying + - good as gold + - good deed for the day + - good things come to those who wait + - good time was had by all + - good times were had by all + - greased lightning + - greek to me + - green thumb + - green-eyed monster + - grist for the mill + - growing like a weed + - hair of the dog + - hand to mouth + - happy as a clam + - happy as a lark + - hasn't a clue + - have a nice day + - have high hopes + - have the last laugh + - haven't got a row to hoe + - head honcho + - head over heels + - hear a pin drop + - heard it through the grapevine + - heart's content + - heavy as lead + - hem and haw + - high and dry + - high and mighty + - high as a kite + - hit paydirt + - hold your head up high + - hold your horses + - hold your own + - hold your tongue + - honest as the day is long + - horns of a dilemma + - horse of a different color + - hot under the collar + - hour of need + - I beg to differ + - icing on the cake + - if the shoe fits + - if the shoe were on the other foot + - in a jam + - in a jiffy + - in a nutshell + - in a pig's eye + - in a pinch + - in a word + - in hot water + - in the gutter + - in the nick of time + - in the thick of it + - in your dreams + - it ain't over till the fat lady sings + - it goes without saying + - it takes all kinds + - it takes one to know one + - it's a small world + - it's only a matter of time + - ivory tower + - Jack of all trades + - jockey for position + - jog your memory + - joined at the hip + - judge a book by its cover + - jump down your throat + - jump in with both feet + - jump on the bandwagon + - jump the gun + - jump to conclusions + - just a hop, skip, and a jump + - just the ticket + - justice is blind + - keep a stiff upper lip + - keep an eye on + - keep it simple, stupid + - keep the home fires burning + - keep up with the Joneses + - keep your chin up + - keep your fingers crossed + - kick the bucket + - kick up your heels + - kick your feet up + - kid in a candy store + - kill two birds with one stone + - kiss of death + - knock it out of the park + - knock on wood + - knock your socks off + - know him from Adam + - know the ropes + - know the score + - knuckle down + - knuckle sandwich + - knuckle under + - labor of love + - ladder of success + - land on your feet + - lap of luxury + - last but not least + - last hurrah + - last-ditch effort + - law of the jungle + - law of the land + - lay down the law + - leaps and bounds + - let sleeping dogs lie + - let the cat out of the bag + - let the good times roll + - let your hair down + - let's talk turkey + - letter perfect + - lick your wounds + - lies like a rug + - life's a bitch + - life's a grind + - light at the end of the tunnel + - lighter than a feather + - lighter than air + - like clockwork + - like father like son + - like taking candy from a baby + - like there's no tomorrow + - lion's share + - live and learn + - live and let live + - long and short of it + - long lost love + - look before you leap + - look down your nose + - look what the cat dragged in + - looking a gift horse in the mouth + - looks like death warmed over + - loose cannon + - lose your head + - lose your temper + - loud as a horn + - lounge lizard + - loved and lost + - low man on the totem pole + - luck of the draw + - luck of the Irish + - make hay while the sun shines + - make money hand over fist + - make my day + - make the best of a bad situation + - make the best of it + - make your blood boil + - man of few words + - man's best friend + - mark my words + - meaningful dialogue + - missed the boat on that one + - moment in the sun + - moment of glory + - moment of truth + - money to burn + - more power to you + - more than one way to skin a cat + - movers and shakers + - moving experience + - naked as a jaybird + - naked truth + - neat as a pin + - needle in a haystack + - needless to say + - neither here nor there + - never look back + - never say never + - nip and tuck + - nip it in the bud + - no guts, no glory + - no love lost + - no pain, no gain + - no skin off my back + - no stone unturned + - no time like the present + - no use crying over spilled milk + - nose to the grindstone + - not a hope in hell + - not a minute's peace + - not in my backyard + - not playing with a full deck + - not the end of the world + - not written in stone + - nothing to sneeze at + - nothing ventured nothing gained + - now we're cooking + - off the top of my head + - off the wagon + - off the wall + - old hat + - older and wiser + - older than dirt + - older than Methuselah + - on a roll + - on cloud nine + - on pins and needles + - on the bandwagon + - on the money + - on the nose + - on the rocks + - on the spot + - on the tip of my tongue + - on the wagon + - on thin ice + - once bitten, twice shy + - one bad apple doesn't spoil the bushel + - one born every minute + - one brick short + - one foot in the grave + - one in a million + - one red cent + - only game in town + - open a can of worms + - open and shut case + - open the flood gates + - opportunity doesn't knock twice + - out of pocket + - out of sight, out of mind + - out of the frying pan into the fire + - out of the woods + - out on a limb + - over a barrel + - over the hump + - pain and suffering + - pain in the + - panic button + - par for the course + - part and parcel + - party pooper + - pass the buck + - patience is a virtue + - pay through the nose + - penny pincher + - perfect storm + - pig in a poke + - pile it on + - pillar of the community + - pin your hopes on + - pitter patter of little feet + - plain as day + - plain as the nose on your face + - play by the rules + - play your cards right + - playing the field + - playing with fire + - pleased as punch + - plenty of fish in the sea + - point with pride + - poor as a church mouse + - pot calling the kettle black + - pretty as a picture + - pull a fast one + - pull your punches + - pulling your leg + - pure as the driven snow + - put it in a nutshell + - put one over on you + - put the cart before the horse + - put the pedal to the metal + - put your best foot forward + - put your foot down + - quick as a bunny + - quick as a lick + - quick as a wink + - quick as lightning + - quiet as a dormouse + - rags to riches + - raining buckets + - raining cats and dogs + - rank and file + - rat race + - reap what you sow + - red as a beet + - red herring + - reinvent the wheel + - rich and famous + - rings a bell + - ripe old age + - ripped me off + - rise and shine + - road to hell is paved with good intentions + - rob Peter to pay Paul + - roll over in the grave + - rub the wrong way + - ruled the roost + - running in circles + - sad but true + - sadder but wiser + - salt of the earth + - scared stiff + - scared to death + - sealed with a kiss + - second to none + - see eye to eye + - seen the light + - seize the day + - set the record straight + - set the world on fire + - set your teeth on edge + - sharp as a tack + - shoot for the moon + - shoot the breeze + - shot in the dark + - shoulder to the wheel + - sick as a dog + - sigh of relief + - signed, sealed, and delivered + - sink or swim + - six of one, half a dozen of another + - skating on thin ice + - slept like a log + - slinging mud + - slippery as an eel + - slow as molasses + - smart as a whip + - smooth as a baby's bottom + - sneaking suspicion + - snug as a bug in a rug + - sow wild oats + - spare the rod, spoil the child + - speak of the devil + - spilled the beans + - spinning your wheels + - spitting image of + - spoke with relish + - spread like wildfire + - spring to life + - squeaky wheel gets the grease + - stands out like a sore thumb + - start from scratch + - stick in the mud + - still waters run deep + - stitch in time + - stop and smell the roses + - straight as an arrow + - straw that broke the camel's back + - strong as an ox + - stubborn as a mule + - stuff that dreams are made of + - stuffed shirt + - sweating blood + - sweating bullets + - take a load off + - take one for the team + - take the bait + - take the bull by the horns + - take the plunge + - takes one to know one + - takes two to tango + - the more the merrier + - the real deal + - the real McCoy + - the red carpet treatment + - the same old story + - there is no accounting for taste + - thick as a brick + - thick as thieves + - thin as a rail + - think outside of the box + - third time's the charm + - this day and age + - this hurts me worse than it hurts you + - this point in time + - three sheets to the wind + - through thick and thin + - throw in the towel + - tie one on + - tighter than a drum + - time and time again + - time is of the essence + - tip of the iceberg + - tired but happy + - to coin a phrase + - to each his own + - to make a long story short + - to the best of my knowledge + - toe the line + - tongue in cheek + - too good to be true + - too hot to handle + - too numerous to mention + - touch with a ten foot pole + - tough as nails + - trial and error + - trials and tribulations + - tried and true + - trip down memory lane + - twist of fate + - two cents worth + - two peas in a pod + - ugly as sin + - under the counter + - under the gun + - under the same roof + - under the weather + - until the cows come home + - unvarnished truth + - up the creek + - uphill battle + - upper crust + - upset the applecart + - vain attempt + - vain effort + - vanquish the enemy + - vested interest + - waiting for the other shoe to drop + - wakeup call + - warm welcome + - watch your p's and q's + - watch your tongue + - watching the clock + - water under the bridge + - weather the storm + - weed them out + - week of Sundays + - went belly up + - wet behind the ears + - what goes around comes around + - what you see is what you get + - when it rains, it pours + - when push comes to shove + - when the cat's away + - when the going gets tough, the tough get going + - white as a sheet + - whole ball of wax + - whole hog + - whole nine yards + - wild goose chase + - will wonders never cease? + - wisdom of the ages + - wise as an owl + - wolf at the door + - words fail me + - work like a dog + - world weary + - worst nightmare + - worth its weight in gold + - wrong side of the bed + - yanking your chain + - yappy as a dog + - years young + - you are what you eat + - you can run but you can't hide + - you only live once + - you're the boss + - young and foolish + - young and vibrant diff --git a/.github/styles/write-good/E-Prime.yml b/.github/styles/write-good/E-Prime.yml new file mode 100644 index 000000000..074a102b2 --- /dev/null +++ b/.github/styles/write-good/E-Prime.yml @@ -0,0 +1,32 @@ +extends: existence +message: "Try to avoid using '%s'." +ignorecase: true +level: suggestion +tokens: + - am + - are + - aren't + - be + - been + - being + - he's + - here's + - here's + - how's + - i'm + - is + - isn't + - it's + - she's + - that's + - there's + - they're + - was + - wasn't + - we're + - were + - weren't + - what's + - where's + - who's + - you're diff --git a/.github/styles/write-good/Illusions.yml b/.github/styles/write-good/Illusions.yml new file mode 100644 index 000000000..b4f132185 --- /dev/null +++ b/.github/styles/write-good/Illusions.yml @@ -0,0 +1,11 @@ +extends: repetition +message: "'%s' is repeated!" +level: warning +alpha: true +action: + name: edit + params: + - truncate + - " " +tokens: + - '[^\s]+' diff --git a/.github/styles/write-good/Passive.yml b/.github/styles/write-good/Passive.yml new file mode 100644 index 000000000..f472cb904 --- /dev/null +++ b/.github/styles/write-good/Passive.yml @@ -0,0 +1,183 @@ +extends: existence +message: "'%s' may be passive voice. Use active voice if you can." +ignorecase: true +level: warning +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/.github/styles/write-good/README.md b/.github/styles/write-good/README.md new file mode 100644 index 000000000..3edcc9b37 --- /dev/null +++ b/.github/styles/write-good/README.md @@ -0,0 +1,27 @@ +Based on [write-good](https://github.com/btford/write-good). + +> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. + +``` +The MIT License (MIT) + +Copyright (c) 2014 Brian Ford + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/.github/styles/write-good/So.yml b/.github/styles/write-good/So.yml new file mode 100644 index 000000000..e57f099dc --- /dev/null +++ b/.github/styles/write-good/So.yml @@ -0,0 +1,5 @@ +extends: existence +message: "Don't start a sentence with '%s'." +level: error +raw: + - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/.github/styles/write-good/ThereIs.yml b/.github/styles/write-good/ThereIs.yml new file mode 100644 index 000000000..8b82e8f6c --- /dev/null +++ b/.github/styles/write-good/ThereIs.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Don't start a sentence with '%s'." +ignorecase: false +level: error +raw: + - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' diff --git a/.github/styles/write-good/TooWordy.yml b/.github/styles/write-good/TooWordy.yml new file mode 100644 index 000000000..275701b19 --- /dev/null +++ b/.github/styles/write-good/TooWordy.yml @@ -0,0 +1,221 @@ +extends: existence +message: "'%s' is too wordy." +ignorecase: true +level: warning +tokens: + - a number of + - abundance + - accede to + - accelerate + - accentuate + - accompany + - accomplish + - accorded + - accrue + - acquiesce + - acquire + - additional + - adjacent to + - adjustment + - admissible + - advantageous + - adversely impact + - advise + - aforementioned + - aggregate + - aircraft + - all of + - all things considered + - alleviate + - allocate + - along the lines of + - already existing + - alternatively + - amazing + - ameliorate + - anticipate + - apparent + - appreciable + - as a matter of fact + - as a means of + - as far as I'm concerned + - as of yet + - as to + - as yet + - ascertain + - assistance + - at the present time + - at this time + - attain + - attributable to + - authorize + - because of the fact that + - belated + - benefit from + - bestow + - by means of + - by virtue of + - by virtue of the fact that + - cease + - close proximity + - commence + - comply with + - concerning + - consequently + - consolidate + - constitutes + - demonstrate + - depart + - designate + - discontinue + - due to the fact that + - each and every + - economical + - eliminate + - elucidate + - employ + - endeavor + - enumerate + - equitable + - equivalent + - evaluate + - evidenced + - exclusively + - expedite + - expend + - expiration + - facilitate + - factual evidence + - feasible + - finalize + - first and foremost + - for all intents and purposes + - for the most part + - for the purpose of + - forfeit + - formulate + - have a tendency to + - honest truth + - however + - if and when + - impacted + - implement + - in a manner of speaking + - in a timely manner + - in a very real sense + - in accordance with + - in addition + - in all likelihood + - in an effort to + - in between + - in excess of + - in lieu of + - in light of the fact that + - in many cases + - in my opinion + - in order to + - in regard to + - in some instances + - in terms of + - in the case of + - in the event that + - in the final analysis + - in the nature of + - in the near future + - in the process of + - inception + - incumbent upon + - indicate + - indication + - initiate + - irregardless + - is applicable to + - is authorized to + - is responsible for + - it is + - it is essential + - it seems that + - it was + - magnitude + - maximum + - methodology + - minimize + - minimum + - modify + - monitor + - multiple + - necessitate + - nevertheless + - not certain + - not many + - not often + - not unless + - not unlike + - notwithstanding + - null and void + - numerous + - objective + - obligate + - obtain + - on the contrary + - on the other hand + - one particular + - optimum + - overall + - owing to the fact that + - participate + - particulars + - pass away + - pertaining to + - point in time + - portion + - possess + - preclude + - previously + - prior to + - prioritize + - procure + - proficiency + - provided that + - purchase + - put simply + - readily apparent + - refer back + - regarding + - relocate + - remainder + - remuneration + - requirement + - reside + - residence + - retain + - satisfy + - shall + - should you wish + - similar to + - solicit + - span across + - strategize + - subsequent + - substantial + - successfully complete + - sufficient + - terminate + - the month of + - the point I am trying to make + - therefore + - time period + - took advantage of + - transmit + - transpire + - type of + - until such time as + - utilization + - utilize + - validate + - various different + - what I mean to say is + - whether or not + - with respect to + - with the exception of + - witnessed diff --git a/.github/styles/write-good/Weasel.yml b/.github/styles/write-good/Weasel.yml new file mode 100644 index 000000000..e29391444 --- /dev/null +++ b/.github/styles/write-good/Weasel.yml @@ -0,0 +1,207 @@ +extends: existence +message: "'%s' is a weasel word!" +ignorecase: true +level: warning +tokens: + - absolutely + - accidentally + - additionally + - allegedly + - alternatively + - angrily + - anxiously + - approximately + - awkwardly + - badly + - barely + - beautifully + - blindly + - boldly + - bravely + - brightly + - briskly + - bristly + - bubbly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - clearly + - closely + - coldly + - completely + - consequently + - correctly + - courageously + - crinkly + - cruelly + - crumbly + - cuddly + - currently + - daily + - daringly + - deadly + - definitely + - deliberately + - doubtfully + - dumbly + - eagerly + - early + - easily + - elegantly + - enormously + - enthusiastically + - equally + - especially + - eventually + - exactly + - exceedingly + - exclusively + - extremely + - fairly + - faithfully + - fatally + - fiercely + - finally + - fondly + - few + - foolishly + - fortunately + - frankly + - frantically + - generously + - gently + - giggly + - gladly + - gracefully + - greedily + - happily + - hardly + - hastily + - healthily + - heartily + - helpfully + - honestly + - hourly + - hungrily + - hurriedly + - immediately + - impatiently + - inadequately + - ingeniously + - innocently + - inquisitively + - interestingly + - irritably + - jiggly + - joyously + - justly + - kindly + - largely + - lately + - lazily + - likely + - literally + - lonely + - loosely + - loudly + - loudly + - luckily + - madly + - many + - mentally + - mildly + - monthly + - mortally + - mostly + - mysteriously + - neatly + - nervously + - nightly + - noisily + - normally + - obediently + - occasionally + - only + - openly + - painfully + - particularly + - patiently + - perfectly + - politely + - poorly + - powerfully + - presumably + - previously + - promptly + - punctually + - quarterly + - quickly + - quietly + - rapidly + - rarely + - really + - recently + - recklessly + - regularly + - remarkably + - relatively + - reluctantly + - repeatedly + - rightfully + - roughly + - rudely + - sadly + - safely + - selfishly + - sensibly + - seriously + - sharply + - shortly + - shyly + - significantly + - silently + - simply + - sleepily + - slowly + - smartly + - smelly + - smoothly + - softly + - solemnly + - sparkly + - speedily + - stealthily + - sternly + - stupidly + - substantially + - successfully + - suddenly + - surprisingly + - suspiciously + - swiftly + - tenderly + - tensely + - thoughtfully + - tightly + - timely + - truthfully + - unexpectedly + - unfortunately + - usually + - very + - victoriously + - violently + - vivaciously + - warmly + - waverly + - weakly + - wearily + - weekly + - wildly + - wisely + - worldly + - wrinkly + - yearly diff --git a/.github/styles/write-good/meta.json b/.github/styles/write-good/meta.json new file mode 100644 index 000000000..a115d2886 --- /dev/null +++ b/.github/styles/write-good/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/write-good/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml new file mode 100644 index 000000000..699360622 --- /dev/null +++ b/.github/workflows/vale.yaml @@ -0,0 +1,13 @@ +name: Lint with Vale on pull request +on: [pull_request] + +jobs: + vale: + name: vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@reviewdog + with: + files: sources/* + fail_on_error: true diff --git a/vale.ini b/vale.ini new file mode 100644 index 000000000..5df31c397 --- /dev/null +++ b/vale.ini @@ -0,0 +1,14 @@ +StylesPath = .github/styles +MinAlertLevel = warning +IgnoredScopes = code, tt, table, tr, td + +Vocab = Docs + +Packages = proselint, write-good + +[formats] +mdx = md + +[*.md] +BasedOnStyles = proselint, write-good + From d3a9d601c883f4d0c022c045685a52b5f5dcc38b Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Tue, 19 Dec 2023 16:03:35 +0100 Subject: [PATCH 02/57] fix dir path --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 699360622..aca163949 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -9,5 +9,5 @@ jobs: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@reviewdog with: - files: sources/* + files: ./sources/* fail_on_error: true From c4ec376bcd0c69b957733aa802f6d1683321d957 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Tue, 19 Dec 2023 16:07:16 +0100 Subject: [PATCH 03/57] fix to dir path --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index aca163949..4aba7e517 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -9,5 +9,5 @@ jobs: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@reviewdog with: - files: ./sources/* + files: ./sources/ fail_on_error: true From f6551dc29b0dea49c4a4194420a80edee252da54 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 10:36:48 +0100 Subject: [PATCH 04/57] change files to lint add readme, contributing guide and a '__onlymodified' flag for files to lint by vale --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 4aba7e517..bfb81fcab 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -9,5 +9,5 @@ jobs: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@reviewdog with: - files: ./sources/ + files: '["./sources/", "./README.md", "CONTRIBUTING.md", "__onlyModified" ]' fail_on_error: true From 1d48e3a29575aa98bfe74ded2c8bf99c5f1ac23a Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 10:56:25 +0100 Subject: [PATCH 05/57] remove __onlymodified flag --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index bfb81fcab..ad7f994b9 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -9,5 +9,5 @@ jobs: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@reviewdog with: - files: '["./sources/", "./README.md", "CONTRIBUTING.md", "__onlyModified" ]' + files: '["./sources/", "./README.md", "CONTRIBUTING.md"]' fail_on_error: true From d5a682fce709c2a05162eb412fc51b96eb858526 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 11:08:45 +0100 Subject: [PATCH 06/57] fix path & fix typo fix path to contributing guide fixtypo in fail-on-error --- .github/workflows/vale.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index ad7f994b9..c47ac0830 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -9,5 +9,5 @@ jobs: - uses: actions/checkout@v4 - uses: errata-ai/vale-action@reviewdog with: - files: '["./sources/", "./README.md", "CONTRIBUTING.md"]' - fail_on_error: true + files: '["./sources/", "./README.md", "./CONTRIBUTING.md"]' + fail-on-error: true From a1af8f5bdb3f725886117ee896bbdd84ab04a641 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 11:14:05 +0100 Subject: [PATCH 07/57] revert changes to fail_on_error & add new filter revert changes add new filter to show only --- .github/workflows/vale.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index c47ac0830..ae289e7f7 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -10,4 +10,5 @@ jobs: - uses: errata-ai/vale-action@reviewdog with: files: '["./sources/", "./README.md", "./CONTRIBUTING.md"]' - fail-on-error: true + fail_on_error: true + filter_mode: file From 36f86dbb1eab5c66f0df75f0b005842b0113f644 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 11:19:12 +0100 Subject: [PATCH 08/57] test rewrite with vale error --- sources/platform/proxy/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index b8f56ffe9..7e3ecf2e0 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -26,7 +26,7 @@ You can view your proxy settings and password on the [Proxy](https://console.api ## Quickstart {#quickstart} -Usage of Apify Proxy means just a couple of lines of code thanks to our SDKs for ([JavaScript](/sdk/js) and [Python](/sdk/python)): +Usage of Apify Proxy means just a couple of lines of code, thanks to our SDKs for ([JavaScript](/sdk/js) and [Python](/sdk/python)): @@ -85,7 +85,7 @@ There are several types of proxy servers, each of them with different advantages Date: Wed, 20 Dec 2023 11:53:08 +0100 Subject: [PATCH 09/57] test - fix vale error --- sources/platform/proxy/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index 7e3ecf2e0..9f5859f21 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -80,7 +80,7 @@ if __name__ == '__main__': ## Proxy types {#proxy-types} -There are several types of proxy servers, each of them with different advantages, disadvantages, and pricing. You can use them to access websites from various geographies and with different levels of anonymity. +Several types of proxy servers exist, each offering distinct advantages, disadvantages, and varying pricing structures. You can use them to access websites from various geographies and with different levels of anonymity. Date: Wed, 20 Dec 2023 13:48:58 +0100 Subject: [PATCH 10/57] add get changed files action add get changed files action add Actor proper capitalization to accepted rules --- .github/styles/Vocab/Docs/accept.txt | 1 + .github/workflows/vale.yaml | 17 +++++++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt index 2cfab5fe2..fc6970b49 100644 --- a/.github/styles/Vocab/Docs/accept.txt +++ b/.github/styles/Vocab/Docs/accept.txt @@ -1 +1,2 @@ [Aa]pify +Actor diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index ae289e7f7..26888bc1c 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -6,9 +6,14 @@ jobs: name: vale runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - uses: errata-ai/vale-action@reviewdog - with: - files: '["./sources/", "./README.md", "./CONTRIBUTING.md"]' - fail_on_error: true - filter_mode: file + - name: Checkout + uses: actions/checkout@v4 + - name: Get Changed Files + id: get_changed_files + uses: lots0logs/gh-action-get-changed-files@2.1.4 + - name: Vale + uses: errata-ai/vale-action@reviewdog + with: + files: '${{ steps.get_changed_files.output.all }}' + fail_on_error: true + filter_mode: file From b7778c3dcb4fb7c6e8354a8465f0cc201db01450 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 13:52:08 +0100 Subject: [PATCH 11/57] add required token var --- .github/workflows/vale.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 26888bc1c..fe6f13d79 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -11,6 +11,8 @@ jobs: - name: Get Changed Files id: get_changed_files uses: lots0logs/gh-action-get-changed-files@2.1.4 + with: + token: ${{ secrets.GITHUB_TOKEN }} - name: Vale uses: errata-ai/vale-action@reviewdog with: From 25a4430619247d2e4b25ca932bf219c9a8730a35 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 13:56:42 +0100 Subject: [PATCH 12/57] fix gh action version --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index fe6f13d79..f1c9a7e31 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -10,7 +10,7 @@ jobs: uses: actions/checkout@v4 - name: Get Changed Files id: get_changed_files - uses: lots0logs/gh-action-get-changed-files@2.1.4 + uses: lots0logs/gh-action-get-changed-files@2.2.2 with: token: ${{ secrets.GITHUB_TOKEN }} - name: Vale From f9760a5aa3be38b885083c93a3c7c6c11903bdf6 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 14:05:11 +0100 Subject: [PATCH 13/57] fix typo --- .github/workflows/vale.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index f1c9a7e31..0e145278b 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -16,6 +16,8 @@ jobs: - name: Vale uses: errata-ai/vale-action@reviewdog with: - files: '${{ steps.get_changed_files.output.all }}' + files: '${{ steps.get_changed_files.outputs.all }}' fail_on_error: true filter_mode: file + env: + GITHUB_TOKEN: ${{secret.GITHUB_TOKEN}} From aa44d1a328e97e2e5d0d00b2d34b892561846716 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 14:08:45 +0100 Subject: [PATCH 14/57] test - vale error --- sources/platform/proxy/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index 9f5859f21..028811a3c 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -80,7 +80,7 @@ if __name__ == '__main__': ## Proxy types {#proxy-types} -Several types of proxy servers exist, each offering distinct advantages, disadvantages, and varying pricing structures. You can use them to access websites from various geographies and with different levels of anonymity. +There are several types of proxy servers exist, each offering distinct advantages, disadvantages, and varying pricing structures. You can use them to access websites from various geographies and with different levels of anonymity. Date: Wed, 20 Dec 2023 14:18:22 +0100 Subject: [PATCH 15/57] change run rules --- .github/workflows/vale.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 0e145278b..fab8be004 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -1,9 +1,10 @@ name: Lint with Vale on pull request -on: [pull_request] +on: + pull_request: + types: [ opened, edited, synchronize ] jobs: vale: - name: vale runs-on: ubuntu-latest steps: - name: Checkout From c9ed0a5b8521baefdf4ac0a1b130232f879e7614 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 14:20:03 +0100 Subject: [PATCH 16/57] fix typos --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index fab8be004..c9b663589 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -21,4 +21,4 @@ jobs: fail_on_error: true filter_mode: file env: - GITHUB_TOKEN: ${{secret.GITHUB_TOKEN}} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 498cebdeb03a909277e684ca6dfabfb53d54560b Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Wed, 20 Dec 2023 14:22:22 +0100 Subject: [PATCH 17/57] test - vale error fix --- sources/platform/proxy/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index 028811a3c..9f5859f21 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -80,7 +80,7 @@ if __name__ == '__main__': ## Proxy types {#proxy-types} -There are several types of proxy servers exist, each offering distinct advantages, disadvantages, and varying pricing structures. You can use them to access websites from various geographies and with different levels of anonymity. +Several types of proxy servers exist, each offering distinct advantages, disadvantages, and varying pricing structures. You can use them to access websites from various geographies and with different levels of anonymity. Date: Thu, 21 Dec 2023 11:13:50 +0100 Subject: [PATCH 18/57] add Microsoft Style Guide add Microsoft Style Guide to Vale remove proselint create Apify Style Guide for Vale --- .github/styles/Apify/Apify.yml | 10 + .github/styles/Apify/Capitalization.yml | 9 + .github/styles/Apify/Languages.yml | 10 + .github/styles/Microsoft/AMPM.yml | 9 + .github/styles/Microsoft/Accessibility.yml | 25 + .github/styles/Microsoft/Acronyms.yml | 64 ++ .github/styles/Microsoft/Adverbs.yml | 270 ++++++ .github/styles/Microsoft/Auto.yml | 11 + .github/styles/Microsoft/Avoid.yml | 14 + .github/styles/Microsoft/ComplexWords.yml | 120 +++ .github/styles/Microsoft/Contractions.yml | 50 ++ .github/styles/Microsoft/Dashes.yml | 13 + .github/styles/Microsoft/DateFormat.yml | 8 + .github/styles/Microsoft/DateNumbers.yml | 40 + .github/styles/Microsoft/DateOrder.yml | 8 + .github/styles/Microsoft/Ellipses.yml | 9 + .github/styles/Microsoft/FirstPerson.yml | 16 + .github/styles/Microsoft/Foreign.yml | 13 + .github/styles/Microsoft/Gender.yml | 8 + .../{proselint => Microsoft}/GenderBias.yml | 7 +- .github/styles/Microsoft/GeneralURL.yml | 11 + .github/styles/Microsoft/HeadingAcronyms.yml | 7 + .github/styles/Microsoft/HeadingColons.yml | 8 + .../styles/Microsoft/HeadingPunctuation.yml | 13 + .github/styles/Microsoft/Headings.yml | 28 + .github/styles/Microsoft/Hyphens.yml | 14 + .github/styles/Microsoft/Negative.yml | 13 + .github/styles/Microsoft/Ordinal.yml | 13 + .github/styles/Microsoft/OxfordComma.yml | 8 + .github/styles/Microsoft/Passive.yml | 183 ++++ .github/styles/Microsoft/Percentages.yml | 7 + .github/styles/Microsoft/Quotes.yml | 7 + .github/styles/Microsoft/RangeFormat.yml | 13 + .github/styles/Microsoft/RangeTime.yml | 13 + .github/styles/Microsoft/Ranges.yml | 7 + .github/styles/Microsoft/Semicolon.yml | 8 + .github/styles/Microsoft/SentenceLength.yml | 7 + .github/styles/Microsoft/Spacing.yml | 8 + .github/styles/Microsoft/Suspended.yml | 7 + .github/styles/Microsoft/Terms.yml | 41 + .github/styles/Microsoft/URLFormat.yml | 10 + .github/styles/Microsoft/Units.yml | 16 + .github/styles/Microsoft/Vocab.yml | 25 + .github/styles/Microsoft/We.yml | 11 + .github/styles/Microsoft/Wordiness.yml | 122 +++ .github/styles/Microsoft/meta.json | 4 + .github/styles/Vocab/Docs/accept.txt | 11 +- .github/styles/proselint/Airlinese.yml | 8 - .github/styles/proselint/AnimalLabels.yml | 48 -- .github/styles/proselint/Annotations.yml | 9 - .github/styles/proselint/Apologizing.yml | 8 - .github/styles/proselint/Archaisms.yml | 52 -- .github/styles/proselint/But.yml | 8 - .github/styles/proselint/Cliches.yml | 782 ------------------ .github/styles/proselint/CorporateSpeak.yml | 30 - .github/styles/proselint/Currency.yml | 5 - .github/styles/proselint/Cursing.yml | 15 - .github/styles/proselint/DateCase.yml | 7 - .github/styles/proselint/DateMidnight.yml | 7 - .github/styles/proselint/DateRedundancy.yml | 10 - .github/styles/proselint/DateSpacing.yml | 7 - .github/styles/proselint/DenizenLabels.yml | 52 -- .github/styles/proselint/Diacritical.yml | 95 --- .github/styles/proselint/GroupTerms.yml | 39 - .github/styles/proselint/Hedging.yml | 8 - .github/styles/proselint/Hyperbole.yml | 6 - .github/styles/proselint/Jargon.yml | 11 - .github/styles/proselint/LGBTOffensive.yml | 13 - .github/styles/proselint/LGBTTerms.yml | 15 - .github/styles/proselint/Malapropisms.yml | 8 - .github/styles/proselint/Needless.yml | 358 -------- .github/styles/proselint/Nonwords.yml | 38 - .github/styles/proselint/Oxymorons.yml | 22 - .github/styles/proselint/P-Value.yml | 6 - .github/styles/proselint/RASSyndrome.yml | 30 - .github/styles/proselint/README.md | 12 - .github/styles/proselint/Skunked.yml | 13 - .github/styles/proselint/Spelling.yml | 17 - .github/styles/proselint/Typography.yml | 11 - .github/styles/proselint/Uncomparables.yml | 50 -- .github/styles/proselint/Very.yml | 6 - .github/styles/proselint/meta.json | 17 - vale.ini | 7 +- 83 files changed, 1328 insertions(+), 1831 deletions(-) create mode 100644 .github/styles/Apify/Apify.yml create mode 100644 .github/styles/Apify/Capitalization.yml create mode 100644 .github/styles/Apify/Languages.yml create mode 100644 .github/styles/Microsoft/AMPM.yml create mode 100644 .github/styles/Microsoft/Accessibility.yml create mode 100644 .github/styles/Microsoft/Acronyms.yml create mode 100644 .github/styles/Microsoft/Adverbs.yml create mode 100644 .github/styles/Microsoft/Auto.yml create mode 100644 .github/styles/Microsoft/Avoid.yml create mode 100644 .github/styles/Microsoft/ComplexWords.yml create mode 100644 .github/styles/Microsoft/Contractions.yml create mode 100644 .github/styles/Microsoft/Dashes.yml create mode 100644 .github/styles/Microsoft/DateFormat.yml create mode 100644 .github/styles/Microsoft/DateNumbers.yml create mode 100644 .github/styles/Microsoft/DateOrder.yml create mode 100644 .github/styles/Microsoft/Ellipses.yml create mode 100644 .github/styles/Microsoft/FirstPerson.yml create mode 100644 .github/styles/Microsoft/Foreign.yml create mode 100644 .github/styles/Microsoft/Gender.yml rename .github/styles/{proselint => Microsoft}/GenderBias.yml (95%) create mode 100644 .github/styles/Microsoft/GeneralURL.yml create mode 100644 .github/styles/Microsoft/HeadingAcronyms.yml create mode 100644 .github/styles/Microsoft/HeadingColons.yml create mode 100644 .github/styles/Microsoft/HeadingPunctuation.yml create mode 100644 .github/styles/Microsoft/Headings.yml create mode 100644 .github/styles/Microsoft/Hyphens.yml create mode 100644 .github/styles/Microsoft/Negative.yml create mode 100644 .github/styles/Microsoft/Ordinal.yml create mode 100644 .github/styles/Microsoft/OxfordComma.yml create mode 100644 .github/styles/Microsoft/Passive.yml create mode 100644 .github/styles/Microsoft/Percentages.yml create mode 100644 .github/styles/Microsoft/Quotes.yml create mode 100644 .github/styles/Microsoft/RangeFormat.yml create mode 100644 .github/styles/Microsoft/RangeTime.yml create mode 100644 .github/styles/Microsoft/Ranges.yml create mode 100644 .github/styles/Microsoft/Semicolon.yml create mode 100644 .github/styles/Microsoft/SentenceLength.yml create mode 100644 .github/styles/Microsoft/Spacing.yml create mode 100644 .github/styles/Microsoft/Suspended.yml create mode 100644 .github/styles/Microsoft/Terms.yml create mode 100644 .github/styles/Microsoft/URLFormat.yml create mode 100644 .github/styles/Microsoft/Units.yml create mode 100644 .github/styles/Microsoft/Vocab.yml create mode 100644 .github/styles/Microsoft/We.yml create mode 100644 .github/styles/Microsoft/Wordiness.yml create mode 100644 .github/styles/Microsoft/meta.json delete mode 100644 .github/styles/proselint/Airlinese.yml delete mode 100644 .github/styles/proselint/AnimalLabels.yml delete mode 100644 .github/styles/proselint/Annotations.yml delete mode 100644 .github/styles/proselint/Apologizing.yml delete mode 100644 .github/styles/proselint/Archaisms.yml delete mode 100644 .github/styles/proselint/But.yml delete mode 100644 .github/styles/proselint/Cliches.yml delete mode 100644 .github/styles/proselint/CorporateSpeak.yml delete mode 100644 .github/styles/proselint/Currency.yml delete mode 100644 .github/styles/proselint/Cursing.yml delete mode 100644 .github/styles/proselint/DateCase.yml delete mode 100644 .github/styles/proselint/DateMidnight.yml delete mode 100644 .github/styles/proselint/DateRedundancy.yml delete mode 100644 .github/styles/proselint/DateSpacing.yml delete mode 100644 .github/styles/proselint/DenizenLabels.yml delete mode 100644 .github/styles/proselint/Diacritical.yml delete mode 100644 .github/styles/proselint/GroupTerms.yml delete mode 100644 .github/styles/proselint/Hedging.yml delete mode 100644 .github/styles/proselint/Hyperbole.yml delete mode 100644 .github/styles/proselint/Jargon.yml delete mode 100644 .github/styles/proselint/LGBTOffensive.yml delete mode 100644 .github/styles/proselint/LGBTTerms.yml delete mode 100644 .github/styles/proselint/Malapropisms.yml delete mode 100644 .github/styles/proselint/Needless.yml delete mode 100644 .github/styles/proselint/Nonwords.yml delete mode 100644 .github/styles/proselint/Oxymorons.yml delete mode 100644 .github/styles/proselint/P-Value.yml delete mode 100644 .github/styles/proselint/RASSyndrome.yml delete mode 100644 .github/styles/proselint/README.md delete mode 100644 .github/styles/proselint/Skunked.yml delete mode 100644 .github/styles/proselint/Spelling.yml delete mode 100644 .github/styles/proselint/Typography.yml delete mode 100644 .github/styles/proselint/Uncomparables.yml delete mode 100644 .github/styles/proselint/Very.yml delete mode 100644 .github/styles/proselint/meta.json diff --git a/.github/styles/Apify/Apify.yml b/.github/styles/Apify/Apify.yml new file mode 100644 index 000000000..ad6fdcbad --- /dev/null +++ b/.github/styles/Apify/Apify.yml @@ -0,0 +1,10 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: false +level: warning +swap: + Apify Dashboard: Apify Console + apify freelancers: Apify Freelancers + Apify Platfrom: Apify platform + '(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy + circa: approx. diff --git a/.github/styles/Apify/Capitalization.yml b/.github/styles/Apify/Capitalization.yml new file mode 100644 index 000000000..d58bb1d36 --- /dev/null +++ b/.github/styles/Apify/Capitalization.yml @@ -0,0 +1,9 @@ +extends: existence +message: "The word '%s' should always be capitalized." +ignorecase: false +level: error +tokens: + - '\bactor\b' + - '\bactors\b' + - '\bapify\b(?!-\w+)' +nonword: false diff --git a/.github/styles/Apify/Languages.yml b/.github/styles/Apify/Languages.yml new file mode 100644 index 000000000..518584b2f --- /dev/null +++ b/.github/styles/Apify/Languages.yml @@ -0,0 +1,10 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: false +level: warning +swap: + 'javascript|Javascript|javaScript': JavaScript + '(?|C: drive)': drive C + '(?:internet bot|web robot)s?': bot(s) + '(?:microsoft cloud|the cloud)': cloud + '(?:mobile|smart) ?phone': phone + '24/7': every day + 'audio(?:-| )book': audiobook + 'back(?:-| )light': backlight + 'chat ?bots?': chatbot(s) + adaptor: adapter + administrate: administer + afterwards: afterward + alphabetic: alphabetical + alphanumerical: alphanumeric + anti-aliasing: antialiasing + anti-malware: antimalware + anti-spyware: antispyware + anti-virus: antivirus + appendixes: appendices + artificial intelligence: AI + '(?:assembler|machine language)': assembly language + caap: CaaP + conversation-as-a-platform: conversation as a platform + eb: EB + gb: GB + gbps: Gbps + kb: KB + keypress: keystroke + mb: MB + pb: PB + tb: TB + zb: ZB diff --git a/.github/styles/Microsoft/URLFormat.yml b/.github/styles/Microsoft/URLFormat.yml new file mode 100644 index 000000000..82e702f98 --- /dev/null +++ b/.github/styles/Microsoft/URLFormat.yml @@ -0,0 +1,10 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + URL for: URL of + an URL: a URL + diff --git a/.github/styles/Microsoft/Units.yml b/.github/styles/Microsoft/Units.yml new file mode 100644 index 000000000..f062418ee --- /dev/null +++ b/.github/styles/Microsoft/Units.yml @@ -0,0 +1,16 @@ +extends: existence +message: "Don't spell out the number in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms +level: error +raw: + - '[a-zA-Z]+\s' +tokens: + - '(?:centi|milli)?meters' + - '(?:kilo)?grams' + - '(?:kilo)?meters' + - '(?:mega)?pixels' + - cm + - inches + - lb + - miles + - pounds diff --git a/.github/styles/Microsoft/Vocab.yml b/.github/styles/Microsoft/Vocab.yml new file mode 100644 index 000000000..eebe97b15 --- /dev/null +++ b/.github/styles/Microsoft/Vocab.yml @@ -0,0 +1,25 @@ +extends: existence +message: "Verify your use of '%s' with the A-Z word list." +link: 'https://docs.microsoft.com/en-us/style-guide' +level: suggestion +ignorecase: true +tokens: + - above + - accessible + - actionable + - against + - alarm + - alert + - alias + - allows? + - and/or + - as well as + - assure + - author + - avg + - beta + - ensure + - he + - insure + - sample + - she diff --git a/.github/styles/Microsoft/We.yml b/.github/styles/Microsoft/We.yml new file mode 100644 index 000000000..97c901c1b --- /dev/null +++ b/.github/styles/Microsoft/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/.github/styles/Microsoft/Wordiness.yml b/.github/styles/Microsoft/Wordiness.yml new file mode 100644 index 000000000..22a4c932c --- /dev/null +++ b/.github/styles/Microsoft/Wordiness.yml @@ -0,0 +1,122 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: warning +action: + name: replace +swap: + (?:give|gave) rise to: lead to + (?:previous|prior) to: before + a (?:large)? majority of: most + a (?:large)? number of: many + a myriad of: myriad + adversely impact: hurt + all across: across + all of a sudden: suddenly + all of these: these + all of: all + all-time record: record + almost all: most + almost never: seldom + along the lines of: similar to + an adequate number of: enough + an appreciable number of: many + an estimated: about + any and all: all + are in agreement: agree + as a matter of fact: in fact + as a means of: to + as a result of: because of + as of yet: yet + as per: per + at a later date: later + at all times: always + at the present time: now + at this point in time: at this point + based in large part on: based on + based on the fact that: because + basic necessity: necessity + because of the fact that: because + came to a realization: realized + came to an abrupt end: ended abruptly + carry out an evaluation of: evaluate + close down: close + closed down: closed + complete stranger: stranger + completely separate: separate + concerning the matter of: regarding + conduct a review of: review + conduct an investigation: investigate + conduct experiments: experiment + continue on: continue + despite the fact that: although + disappear from sight: disappear + drag and drop: drag + drag-and-drop: drag + doomed to fail: doomed + due to the fact that: because + during the period of: during + during the time that: while + emergency situation: emergency + except when: unless + excessive number: too many + extend an invitation: invite + fall down: fall + fell down: fell + for the duration of: during + gather together: gather + has the ability to: can + has the capacity to: can + has the opportunity to: could + hold a meeting: meet + if this is not the case: if not + in a careful manner: carefully + in a thoughtful manner: thoughtfully + in a timely manner: timely + in an effort to: to + in between: between + in lieu of: instead of + in many cases: often + in most cases: usually + in order to: to + in some cases: sometimes + in spite of the fact that: although + in spite of: despite + in the (?:very)? near future: soon + in the event that: if + in the neighborhood of: roughly + in the vicinity of: close to + it would appear that: apparently + lift up: lift + made reference to: referred to + make reference to: refer to + mix together: mix + none at all: none + not in a position to: unable + not possible: impossible + of major importance: important + perform an assessment of: assess + pertaining to: about + place an order: order + plays a key role in: is essential to + present time: now + readily apparent: apparent + some of the: some + span across: span + subsequent to: after + successfully complete: complete + sufficient number (?:of)?: enough + take action: act + take into account: consider + the question as to whether: whether + there is no doubt but that: doubtless + this day and age: this age + this is a subject that: this subject + time (?:frame|period): time + under the provisions of: under + until such time as: until + used for fuel purposes: used for fuel + whether or not: whether + with regard to: regarding + with the exception of: except for diff --git a/.github/styles/Microsoft/meta.json b/.github/styles/Microsoft/meta.json new file mode 100644 index 000000000..297719bbb --- /dev/null +++ b/.github/styles/Microsoft/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Microsoft/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt index fc6970b49..229368396 100644 --- a/.github/styles/Vocab/Docs/accept.txt +++ b/.github/styles/Vocab/Docs/accept.txt @@ -1,2 +1,9 @@ -[Aa]pify -Actor +apify(?=-\w+) +Actor(s)? +booleans +Docusaurus +env +navbar +nginx +npm + diff --git a/.github/styles/proselint/Airlinese.yml b/.github/styles/proselint/Airlinese.yml deleted file mode 100644 index a6ae9c193..000000000 --- a/.github/styles/proselint/Airlinese.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' is airlinese." -ignorecase: true -level: error -tokens: - - enplan(?:e|ed|ing|ement) - - deplan(?:e|ed|ing|ement) - - taking off momentarily diff --git a/.github/styles/proselint/AnimalLabels.yml b/.github/styles/proselint/AnimalLabels.yml deleted file mode 100644 index b92e06fcb..000000000 --- a/.github/styles/proselint/AnimalLabels.yml +++ /dev/null @@ -1,48 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -level: error -action: - name: replace -swap: - (?:bull|ox)-like: taurine - (?:calf|veal)-like: vituline - (?:crow|raven)-like: corvine - (?:leopard|panther)-like: pardine - bird-like: avine - centipede-like: scolopendrine - crab-like: cancrine - crocodile-like: crocodiline - deer-like: damine - eagle-like: aquiline - earthworm-like: lumbricine - falcon-like: falconine - ferine: wild animal-like - fish-like: piscine - fox-like: vulpine - frog-like: ranine - goat-like: hircine - goose-like: anserine - gull-like: laridine - hare-like: leporine - hawk-like: accipitrine - hippopotamus-like: hippopotamine - lizard-like: lacertine - mongoose-like: viverrine - mouse-like: murine - ostrich-like: struthionine - peacock-like: pavonine - porcupine-like: hystricine - rattlesnake-like: crotaline - sable-like: zibeline - sheep-like: ovine - shrew-like: soricine - sparrow-like: passerine - swallow-like: hirundine - swine-like: suilline - tiger-like: tigrine - viper-like: viperine - vulture-like: vulturine - wasp-like: vespine - wolf-like: lupine - woodpecker-like: picine - zebra-like: zebrine diff --git a/.github/styles/proselint/Annotations.yml b/.github/styles/proselint/Annotations.yml deleted file mode 100644 index dcb24f41b..000000000 --- a/.github/styles/proselint/Annotations.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "'%s' left in text." -ignorecase: false -level: error -tokens: - - XXX - - FIXME - - TODO - - NOTE diff --git a/.github/styles/proselint/Apologizing.yml b/.github/styles/proselint/Apologizing.yml deleted file mode 100644 index 11088aaa8..000000000 --- a/.github/styles/proselint/Apologizing.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Excessive apologizing: '%s'" -ignorecase: true -level: error -action: - name: remove -tokens: - - More research is needed diff --git a/.github/styles/proselint/Archaisms.yml b/.github/styles/proselint/Archaisms.yml deleted file mode 100644 index c8df9abc9..000000000 --- a/.github/styles/proselint/Archaisms.yml +++ /dev/null @@ -1,52 +0,0 @@ -extends: existence -message: "'%s' is archaic." -ignorecase: true -level: error -tokens: - - alack - - anent - - begat - - belike - - betimes - - boughten - - brocage - - brokage - - camarade - - chiefer - - chiefest - - Christiana - - completely obsolescent - - cozen - - divers - - deflexion - - fain - - forsooth - - foreclose from - - haply - - howbeit - - illumine - - in sooth - - maugre - - meseems - - methinks - - nigh - - peradventure - - perchance - - saith - - shew - - sistren - - spake - - to wit - - verily - - whilom - - withal - - wot - - enclosed please find - - please find enclosed - - enclosed herewith - - enclosed herein - - inforce - - ex postfacto - - foreclose from - - forewent - - for ever diff --git a/.github/styles/proselint/But.yml b/.github/styles/proselint/But.yml deleted file mode 100644 index 0e2c32b93..000000000 --- a/.github/styles/proselint/But.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Do not start a paragraph with a 'but'." -level: error -scope: paragraph -action: - name: remove -tokens: - - ^But diff --git a/.github/styles/proselint/Cliches.yml b/.github/styles/proselint/Cliches.yml deleted file mode 100644 index c56183c51..000000000 --- a/.github/styles/proselint/Cliches.yml +++ /dev/null @@ -1,782 +0,0 @@ -extends: existence -message: "'%s' is a cliche." -level: error -ignorecase: true -tokens: - - a chip off the old block - - a clean slate - - a dark and stormy night - - a far cry - - a fate worse than death - - a fine kettle of fish - - a loose cannon - - a penny saved is a penny earned - - a tough row to hoe - - a word to the wise - - ace in the hole - - acid test - - add insult to injury - - against all odds - - air your dirty laundry - - alas and alack - - all fun and games - - all hell broke loose - - all in a day's work - - all talk, no action - - all thumbs - - all your eggs in one basket - - all's fair in love and war - - all's well that ends well - - almighty dollar - - American as apple pie - - an axe to grind - - another day, another dollar - - armed to the teeth - - as luck would have it - - as old as time - - as the crow flies - - at loose ends - - at my wits end - - at the end of the day - - avoid like the plague - - babe in the woods - - back against the wall - - back in the saddle - - back to square one - - back to the drawing board - - bad to the bone - - badge of honor - - bald faced liar - - bald-faced lie - - ballpark figure - - banging your head against a brick wall - - baptism by fire - - barking up the wrong tree - - bat out of hell - - be all and end all - - beat a dead horse - - beat around the bush - - been there, done that - - beggars can't be choosers - - behind the eight ball - - bend over backwards - - benefit of the doubt - - bent out of shape - - best thing since sliced bread - - bet your bottom dollar - - better half - - better late than never - - better mousetrap - - better safe than sorry - - between a rock and a hard place - - between a rock and a hard place - - between Scylla and Charybdis - - between the devil and the deep blue see - - betwixt and between - - beyond the pale - - bide your time - - big as life - - big cheese - - big fish in a small pond - - big man on campus - - bigger they are the harder they fall - - bird in the hand - - bird's eye view - - birds and the bees - - birds of a feather flock together - - bit the hand that feeds you - - bite the bullet - - bite the dust - - bitten off more than he can chew - - black as coal - - black as pitch - - black as the ace of spades - - blast from the past - - bleeding heart - - blessing in disguise - - blind ambition - - blind as a bat - - blind leading the blind - - blissful ignorance - - blood is thicker than water - - blood sweat and tears - - blow a fuse - - blow off steam - - blow your own horn - - blushing bride - - boils down to - - bolt from the blue - - bone to pick - - bored stiff - - bored to tears - - bottomless pit - - boys will be boys - - bright and early - - brings home the bacon - - broad across the beam - - broken record - - brought back to reality - - bulk large - - bull by the horns - - bull in a china shop - - burn the midnight oil - - burning question - - burning the candle at both ends - - burst your bubble - - bury the hatchet - - busy as a bee - - but that's another story - - by hook or by crook - - call a spade a spade - - called onto the carpet - - calm before the storm - - can of worms - - can't cut the mustard - - can't hold a candle to - - case of mistaken identity - - cast aspersions - - cat got your tongue - - cat's meow - - caught in the crossfire - - caught red-handed - - chase a red herring - - checkered past - - chomping at the bit - - cleanliness is next to godliness - - clear as a bell - - clear as mud - - close to the vest - - cock and bull story - - cold shoulder - - come hell or high water - - comparing apples and oranges - - compleat - - conspicuous by its absence - - cool as a cucumber - - cool, calm, and collected - - cost a king's ransom - - count your blessings - - crack of dawn - - crash course - - creature comforts - - cross that bridge when you come to it - - crushing blow - - cry like a baby - - cry me a river - - cry over spilt milk - - crystal clear - - crystal clear - - curiosity killed the cat - - cut and dried - - cut through the red tape - - cut to the chase - - cute as a bugs ear - - cute as a button - - cute as a puppy - - cuts to the quick - - cutting edge - - dark before the dawn - - day in, day out - - dead as a doornail - - decision-making process - - devil is in the details - - dime a dozen - - divide and conquer - - dog and pony show - - dog days - - dog eat dog - - dog tired - - don't burn your bridges - - don't count your chickens - - don't look a gift horse in the mouth - - don't rock the boat - - don't step on anyone's toes - - don't take any wooden nickels - - down and out - - down at the heels - - down in the dumps - - down the hatch - - down to earth - - draw the line - - dressed to kill - - dressed to the nines - - drives me up the wall - - dubious distinction - - dull as dishwater - - duly authorized - - dyed in the wool - - eagle eye - - ear to the ground - - early bird catches the worm - - easier said than done - - easy as pie - - eat your heart out - - eat your words - - eleventh hour - - even the playing field - - every dog has its day - - every fiber of my being - - everything but the kitchen sink - - eye for an eye - - eyes peeled - - face the music - - facts of life - - fair weather friend - - fall by the wayside - - fan the flames - - far be it from me - - fast and loose - - feast or famine - - feather your nest - - feathered friends - - few and far between - - fifteen minutes of fame - - fills the bill - - filthy vermin - - fine kettle of fish - - first and foremost - - fish out of water - - fishing for a compliment - - fit as a fiddle - - fit the bill - - fit to be tied - - flash in the pan - - flat as a pancake - - flip your lid - - flog a dead horse - - fly by night - - fly the coop - - follow your heart - - for all intents and purposes - - for free - - for the birds - - for what it's worth - - force of nature - - force to be reckoned with - - forgive and forget - - fox in the henhouse - - free and easy - - free as a bird - - fresh as a daisy - - full steam ahead - - fun in the sun - - garbage in, garbage out - - gentle as a lamb - - get a kick out of - - get a leg up - - get down and dirty - - get the lead out - - get to the bottom of - - get with the program - - get your feet wet - - gets my goat - - gilding the lily - - gilding the lily - - give and take - - go against the grain - - go at it tooth and nail - - go for broke - - go him one better - - go the extra mile - - go with the flow - - goes without saying - - good as gold - - good deed for the day - - good things come to those who wait - - good time was had by all - - good times were had by all - - greased lightning - - greek to me - - green thumb - - green-eyed monster - - grist for the mill - - growing like a weed - - hair of the dog - - hand to mouth - - happy as a clam - - happy as a lark - - hasn't a clue - - have a nice day - - have a short fuse - - have high hopes - - have the last laugh - - haven't got a row to hoe - - he's got his hands full - - head honcho - - head over heels - - hear a pin drop - - heard it through the grapevine - - heart's content - - heavy as lead - - hem and haw - - high and dry - - high and mighty - - high as a kite - - his own worst enemy - - his work cut out for him - - hit paydirt - - hither and yon - - Hobson's choice - - hold your head up high - - hold your horses - - hold your own - - hold your tongue - - honest as the day is long - - horns of a dilemma - - horns of a dilemma - - horse of a different color - - hot under the collar - - hour of need - - I beg to differ - - icing on the cake - - if the shoe fits - - if the shoe were on the other foot - - if you catch my drift - - in a jam - - in a jiffy - - in a nutshell - - in a pig's eye - - in a pinch - - in a word - - in hot water - - in light of - - in the final analysis - - in the gutter - - in the last analysis - - in the nick of time - - in the thick of it - - in your dreams - - innocent bystander - - it ain't over till the fat lady sings - - it goes without saying - - it takes all kinds - - it takes one to know one - - it's a small world - - it's not what you know, it's who you know - - it's only a matter of time - - ivory tower - - Jack of all trades - - jockey for position - - jog your memory - - joined at the hip - - judge a book by its cover - - jump down your throat - - jump in with both feet - - jump on the bandwagon - - jump the gun - - jump to conclusions - - just a hop, skip, and a jump - - just the ticket - - justice is blind - - keep a stiff upper lip - - keep an eye on - - keep it simple, stupid - - keep the home fires burning - - keep up with the Joneses - - keep your chin up - - keep your fingers crossed - - kick the bucket - - kick up your heels - - kick your feet up - - kid in a candy store - - kill two birds with one stone - - kiss of death - - knock it out of the park - - knock on wood - - knock your socks off - - know him from Adam - - know the ropes - - know the score - - knuckle down - - knuckle sandwich - - knuckle under - - labor of love - - ladder of success - - land on your feet - - lap of luxury - - last but not least - - last but not least - - last hurrah - - last-ditch effort - - law of the jungle - - law of the land - - lay down the law - - leaps and bounds - - let sleeping dogs lie - - let the cat out of the bag - - let the good times roll - - let your hair down - - let's talk turkey - - letter perfect - - lick your wounds - - lies like a rug - - life's a bitch - - life's a grind - - light at the end of the tunnel - - lighter than a feather - - lighter than air - - like clockwork - - like father like son - - like taking candy from a baby - - like there's no tomorrow - - lion's share - - live and learn - - live and let live - - long and short of it - - long lost love - - look before you leap - - look down your nose - - look what the cat dragged in - - looking a gift horse in the mouth - - looks like death warmed over - - loose cannon - - lose your head - - lose your temper - - loud as a horn - - lounge lizard - - loved and lost - - low man on the totem pole - - luck of the draw - - luck of the Irish - - make a mockery of - - make hay while the sun shines - - make money hand over fist - - make my day - - make the best of a bad situation - - make the best of it - - make your blood boil - - male chauvinism - - man of few words - - man's best friend - - mark my words - - meaningful dialogue - - missed the boat on that one - - moment in the sun - - moment of glory - - moment of truth - - moment of truth - - money to burn - - more in sorrow than in anger - - more power to you - - more sinned against than sinning - - more than one way to skin a cat - - movers and shakers - - moving experience - - my better half - - naked as a jaybird - - naked truth - - neat as a pin - - needle in a haystack - - needless to say - - neither here nor there - - never look back - - never say never - - nip and tuck - - nip in the bud - - nip it in the bud - - no guts, no glory - - no love lost - - no pain, no gain - - no skin off my back - - no stone unturned - - no time like the present - - no use crying over spilled milk - - nose to the grindstone - - not a hope in hell - - not a minute's peace - - not in my backyard - - not playing with a full deck - - not the end of the world - - not written in stone - - nothing to sneeze at - - nothing ventured nothing gained - - now we're cooking - - off the top of my head - - off the wagon - - off the wall - - old hat - - olden days - - older and wiser - - older than dirt - - older than Methuselah - - on a roll - - on cloud nine - - on pins and needles - - on the bandwagon - - on the money - - on the nose - - on the rocks - - on the same page - - on the spot - - on the tip of my tongue - - on the wagon - - on thin ice - - once bitten, twice shy - - one bad apple doesn't spoil the bushel - - one born every minute - - one brick short - - one foot in the grave - - one in a million - - one red cent - - only game in town - - open a can of worms - - open and shut case - - open the flood gates - - opportunity doesn't knock twice - - out of pocket - - out of sight, out of mind - - out of the frying pan into the fire - - out of the woods - - out on a limb - - over a barrel - - over the hump - - pain and suffering - - pain in the - - panic button - - par for the course - - part and parcel - - party pooper - - pass the buck - - patience is a virtue - - pay through the nose - - penny pincher - - perfect storm - - pig in a poke - - pile it on - - pillar of the community - - pin your hopes on - - pitter patter of little feet - - plain as day - - plain as the nose on your face - - play by the rules - - play your cards right - - playing the field - - playing with fire - - pleased as punch - - plenty of fish in the sea - - point with pride - - poor as a church mouse - - pot calling the kettle black - - presidential timber - - pretty as a picture - - pull a fast one - - pull your punches - - pulled no punches - - pulling your leg - - pure as the driven snow - - put it in a nutshell - - put one over on you - - put the cart before the horse - - put the pedal to the metal - - put your best foot forward - - put your foot down - - quantum jump - - quantum leap - - quick as a bunny - - quick as a lick - - quick as a wink - - quick as lightning - - quiet as a dormouse - - rags to riches - - raining buckets - - raining cats and dogs - - rank and file - - rat race - - reap what you sow - - red as a beet - - red herring - - redound to one's credit - - redound to the benefit of - - reinvent the wheel - - rich and famous - - rings a bell - - ripe old age - - ripped me off - - rise and shine - - road to hell is paved with good intentions - - rob Peter to pay Paul - - roll over in the grave - - rub the wrong way - - ruled the roost - - running in circles - - sad but true - - sadder but wiser - - salt of the earth - - scared stiff - - scared to death - - sea change - - sealed with a kiss - - second to none - - see eye to eye - - seen the light - - seize the day - - set the record straight - - set the world on fire - - set your teeth on edge - - sharp as a tack - - shirked his duties - - shoot for the moon - - shoot the breeze - - shot in the dark - - shoulder to the wheel - - sick as a dog - - sigh of relief - - signed, sealed, and delivered - - sink or swim - - six of one, half a dozen of another - - six of one, half a dozen of the other - - skating on thin ice - - slept like a log - - slinging mud - - slippery as an eel - - slow as molasses - - smart as a whip - - smooth as a baby's bottom - - sneaking suspicion - - snug as a bug in a rug - - sow wild oats - - spare the rod, spoil the child - - speak of the devil - - spilled the beans - - spinning your wheels - - spitting image of - - spoke with relish - - spread like wildfire - - spring to life - - squeaky wheel gets the grease - - stands out like a sore thumb - - start from scratch - - stick in the mud - - still waters run deep - - stitch in time - - stop and smell the roses - - straight as an arrow - - straw that broke the camel's back - - stretched to the breaking point - - strong as an ox - - stubborn as a mule - - stuff that dreams are made of - - stuffed shirt - - sweating blood - - sweating bullets - - take a load off - - take one for the team - - take the bait - - take the bull by the horns - - take the plunge - - takes one to know one - - takes two to tango - - than you can shake a stick at - - the cream of the crop - - the cream rises to the top - - the more the merrier - - the real deal - - the real McCoy - - the red carpet treatment - - the same old story - - the straw that broke the camel's back - - there is no accounting for taste - - thick as a brick - - thick as thieves - - thick as thieves - - thin as a rail - - think outside of the box - - thinking outside the box - - third time's the charm - - this day and age - - this hurts me worse than it hurts you - - this point in time - - thought leaders? - - three sheets to the wind - - through thick and thin - - throw in the towel - - throw the baby out with the bathwater - - tie one on - - tighter than a drum - - time and time again - - time is of the essence - - tip of the iceberg - - tired but happy - - to coin a phrase - - to each his own - - to make a long story short - - to the best of my knowledge - - toe the line - - tongue in cheek - - too good to be true - - too hot to handle - - too numerous to mention - - touch with a ten foot pole - - tough as nails - - trial and error - - trials and tribulations - - tried and true - - trip down memory lane - - twist of fate - - two cents worth - - two peas in a pod - - ugly as sin - - under the counter - - under the gun - - under the same roof - - under the weather - - until the cows come home - - unvarnished truth - - up the creek - - uphill battle - - upper crust - - upset the applecart - - vain attempt - - vain effort - - vanquish the enemy - - various and sundry - - vested interest - - viable alternative - - waiting for the other shoe to drop - - wakeup call - - warm welcome - - watch your p's and q's - - watch your tongue - - watching the clock - - water under the bridge - - wax eloquent - - wax poetic - - we've got a situation here - - weather the storm - - weed them out - - week of Sundays - - went belly up - - wet behind the ears - - what goes around comes around - - what you see is what you get - - when it rains, it pours - - when push comes to shove - - when the cat's away - - when the going gets tough, the tough get going - - whet (?:the|your) appetite - - white as a sheet - - whole ball of wax - - whole hog - - whole nine yards - - wild goose chase - - will wonders never cease? - - wisdom of the ages - - wise as an owl - - wolf at the door - - wool pulled over our eyes - - words fail me - - work like a dog - - world weary - - worst nightmare - - worth its weight in gold - - writ large - - wrong side of the bed - - yanking your chain - - yappy as a dog - - years young - - you are what you eat - - you can run but you can't hide - - you only live once - - you're the boss - - young and foolish - - young and vibrant diff --git a/.github/styles/proselint/CorporateSpeak.yml b/.github/styles/proselint/CorporateSpeak.yml deleted file mode 100644 index 4de8ee3f8..000000000 --- a/.github/styles/proselint/CorporateSpeak.yml +++ /dev/null @@ -1,30 +0,0 @@ -extends: existence -message: "'%s' is corporate speak." -ignorecase: true -level: error -tokens: - - at the end of the day - - back to the drawing board - - hit the ground running - - get the ball rolling - - low-hanging fruit - - thrown under the bus - - think outside the box - - let's touch base - - get my manager's blessing - - it's on my radar - - ping me - - i don't have the bandwidth - - no brainer - - par for the course - - bang for your buck - - synergy - - move the goal post - - apples to apples - - win-win - - circle back around - - all hands on deck - - take this offline - - drill-down - - elephant in the room - - on my plate diff --git a/.github/styles/proselint/Currency.yml b/.github/styles/proselint/Currency.yml deleted file mode 100644 index ebd4b7d3e..000000000 --- a/.github/styles/proselint/Currency.yml +++ /dev/null @@ -1,5 +0,0 @@ -extends: existence -message: "Incorrect use of symbols in '%s'." -ignorecase: true -raw: - - \$[\d]* ?(?:dollars|usd|us dollars) diff --git a/.github/styles/proselint/Cursing.yml b/.github/styles/proselint/Cursing.yml deleted file mode 100644 index e65070a91..000000000 --- a/.github/styles/proselint/Cursing.yml +++ /dev/null @@ -1,15 +0,0 @@ -extends: existence -message: "Consider replacing '%s'." -level: error -ignorecase: true -tokens: - - shit - - piss - - fuck - - cunt - - cocksucker - - motherfucker - - tits - - fart - - turd - - twat diff --git a/.github/styles/proselint/DateCase.yml b/.github/styles/proselint/DateCase.yml deleted file mode 100644 index 9aa1bd991..000000000 --- a/.github/styles/proselint/DateCase.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: With lowercase letters, the periods are standard. -ignorecase: false -level: error -nonword: true -tokens: - - '\d{1,2} ?[ap]m\b' diff --git a/.github/styles/proselint/DateMidnight.yml b/.github/styles/proselint/DateMidnight.yml deleted file mode 100644 index 0130e1aef..000000000 --- a/.github/styles/proselint/DateMidnight.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use 'midnight' or 'noon'." -ignorecase: true -level: error -nonword: true -tokens: - - '12 ?[ap]\.?m\.?' diff --git a/.github/styles/proselint/DateRedundancy.yml b/.github/styles/proselint/DateRedundancy.yml deleted file mode 100644 index b1f653ea5..000000000 --- a/.github/styles/proselint/DateRedundancy.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "'a.m.' is always morning; 'p.m.' is always night." -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} ?a\.?m\.? in the morning' - - '\d{1,2} ?p\.?m\.? in the evening' - - '\d{1,2} ?p\.?m\.? at night' - - '\d{1,2} ?p\.?m\.? in the afternoon' diff --git a/.github/styles/proselint/DateSpacing.yml b/.github/styles/proselint/DateSpacing.yml deleted file mode 100644 index b7a2fd33b..000000000 --- a/.github/styles/proselint/DateSpacing.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "It's standard to put a space before '%s'" -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2}[ap]\.?m\.?' diff --git a/.github/styles/proselint/DenizenLabels.yml b/.github/styles/proselint/DenizenLabels.yml deleted file mode 100644 index bc3dd8abb..000000000 --- a/.github/styles/proselint/DenizenLabels.yml +++ /dev/null @@ -1,52 +0,0 @@ -extends: substitution -message: Did you mean '%s'? -ignorecase: false -action: - name: replace -swap: - (?:Afrikaaner|Afrikander): Afrikaner - (?:Hong Kongite|Hong Kongian): Hong Konger - (?:Indianan|Indianian): Hoosier - (?:Michiganite|Michiganian): Michigander - (?:New Hampshireite|New Hampshireman): New Hampshirite - (?:Newcastlite|Newcastleite): Novocastrian - (?:Providencian|Providencer): Providentian - (?:Trentian|Trentonian): Tridentine - (?:Warsawer|Warsawian): Varsovian - (?:Wolverhamptonite|Wolverhamptonian): Wulfrunian - Alabaman: Alabamian - Albuquerquian: Albuquerquean - Anchoragite: Anchorageite - Arizonian: Arizonan - Arkansawyer: Arkansan - Belarusan: Belarusian - Cayman Islander: Caymanian - Coloradoan: Coloradan - Connecticuter: Nutmegger - Fairbanksian: Fairbanksan - Fort Worther: Fort Worthian - Grenadian: Grenadan - Halifaxer: Haligonian - Hartlepoolian: Hartlepudlian - Illinoisian: Illinoisan - Iowegian: Iowan - Leedsian: Leodenisian - Liverpoolian: Liverpudlian - Los Angelean: Angeleno - Manchesterian: Mancunian - Minneapolisian: Minneapolitan - Missouran: Missourian - Monacan: Monegasque - Neopolitan: Neapolitan - New Jerseyite: New Jerseyan - New Orleansian: New Orleanian - Oklahoma Citian: Oklahoma Cityan - Oklahomian: Oklahoman - Saudi Arabian: Saudi - Seattlite: Seattleite - Surinamer: Surinamese - Tallahassean: Tallahasseean - Tennesseean: Tennessean - Trois-Rivièrester: Trifluvian - Utahan: Utahn - Valladolidian: Vallisoletano diff --git a/.github/styles/proselint/Diacritical.yml b/.github/styles/proselint/Diacritical.yml deleted file mode 100644 index 2416cf28b..000000000 --- a/.github/styles/proselint/Diacritical.yml +++ /dev/null @@ -1,95 +0,0 @@ -extends: substitution -message: Consider using '%s' instead of '%s'. -ignorecase: true -level: error -action: - name: replace -swap: - beau ideal: beau idéal - boutonniere: boutonnière - bric-a-brac: bric-à-brac - cafe: café - cause celebre: cause célèbre - chevre: chèvre - cliche: cliché - consomme: consommé - coup de grace: coup de grâce - crudites: crudités - creme brulee: crème brûlée - creme de menthe: crème de menthe - creme fraice: crème fraîche - creme fresh: crème fraîche - crepe: crêpe - debutante: débutante - decor: décor - deja vu: déjà vu - denouement: dénouement - facade: façade - fiance: fiancé - fiancee: fiancée - flambe: flambé - garcon: garçon - lycee: lycée - maitre d: maître d - menage a trois: ménage à trois - negligee: négligée - protege: protégé - protegee: protégée - puree: purée - my resume: my résumé - your resume: your résumé - his resume: his résumé - her resume: her résumé - a resume: a résumé - the resume: the résumé - risque: risqué - roue: roué - soiree: soirée - souffle: soufflé - soupcon: soupçon - touche: touché - tete-a-tete: tête-à-tête - voila: voilà - a la carte: à la carte - a la mode: à la mode - emigre: émigré - - # Spanish loanwords - El Nino: El Niño - jalapeno: jalapeño - La Nina: La Niña - pina colada: piña colada - senor: señor - senora: señora - senorita: señorita - - # Portuguese loanwords - acai: açaí - - # German loanwords - doppelganger: doppelgänger - Fuhrer: Führer - Gewurztraminer: Gewürztraminer - vis-a-vis: vis-à-vis - Ubermensch: Übermensch - - # Swedish loanwords - filmjolk: filmjölk - smorgasbord: smörgåsbord - - # Names, places, and companies - Beyonce: Beyoncé - Bronte: Brontë - Champs-Elysees: Champs-Élysées - Citroen: Citroën - Curacao: Curaçao - Lowenbrau: Löwenbräu - Monegasque: Monégasque - Motley Crue: Mötley Crüe - Nescafe: Nescafé - Queensryche: Queensrÿche - Quebec: Québec - Quebecois: Québécois - Angstrom: Ångström - angstrom: ångström - Skoda: Škoda diff --git a/.github/styles/proselint/GroupTerms.yml b/.github/styles/proselint/GroupTerms.yml deleted file mode 100644 index 7a59fa48a..000000000 --- a/.github/styles/proselint/GroupTerms.yml +++ /dev/null @@ -1,39 +0,0 @@ -extends: substitution -message: Consider using '%s' instead of '%s'. -ignorecase: true -action: - name: replace -swap: - (?:bunch|group|pack|flock) of chickens: brood of chickens - (?:bunch|group|pack|flock) of crows: murder of crows - (?:bunch|group|pack|flock) of hawks: cast of hawks - (?:bunch|group|pack|flock) of parrots: pandemonium of parrots - (?:bunch|group|pack|flock) of peacocks: muster of peacocks - (?:bunch|group|pack|flock) of penguins: muster of penguins - (?:bunch|group|pack|flock) of sparrows: host of sparrows - (?:bunch|group|pack|flock) of turkeys: rafter of turkeys - (?:bunch|group|pack|flock) of woodpeckers: descent of woodpeckers - (?:bunch|group|pack|herd) of apes: shrewdness of apes - (?:bunch|group|pack|herd) of baboons: troop of baboons - (?:bunch|group|pack|herd) of badgers: cete of badgers - (?:bunch|group|pack|herd) of bears: sloth of bears - (?:bunch|group|pack|herd) of bullfinches: bellowing of bullfinches - (?:bunch|group|pack|herd) of bullocks: drove of bullocks - (?:bunch|group|pack|herd) of caterpillars: army of caterpillars - (?:bunch|group|pack|herd) of cats: clowder of cats - (?:bunch|group|pack|herd) of colts: rag of colts - (?:bunch|group|pack|herd) of crocodiles: bask of crocodiles - (?:bunch|group|pack|herd) of dolphins: school of dolphins - (?:bunch|group|pack|herd) of foxes: skulk of foxes - (?:bunch|group|pack|herd) of gorillas: band of gorillas - (?:bunch|group|pack|herd) of hippopotami: bloat of hippopotami - (?:bunch|group|pack|herd) of horses: drove of horses - (?:bunch|group|pack|herd) of jellyfish: fluther of jellyfish - (?:bunch|group|pack|herd) of kangeroos: mob of kangeroos - (?:bunch|group|pack|herd) of monkeys: troop of monkeys - (?:bunch|group|pack|herd) of oxen: yoke of oxen - (?:bunch|group|pack|herd) of rhinoceros: crash of rhinoceros - (?:bunch|group|pack|herd) of wild boar: sounder of wild boar - (?:bunch|group|pack|herd) of wild pigs: drift of wild pigs - (?:bunch|group|pack|herd) of zebras: zeal of wild pigs - (?:bunch|group|pack|school) of trout: hover of trout diff --git a/.github/styles/proselint/Hedging.yml b/.github/styles/proselint/Hedging.yml deleted file mode 100644 index a8615f8bb..000000000 --- a/.github/styles/proselint/Hedging.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' is hedging." -ignorecase: true -level: error -tokens: - - I would argue that - - ', so to speak' - - to a certain degree diff --git a/.github/styles/proselint/Hyperbole.yml b/.github/styles/proselint/Hyperbole.yml deleted file mode 100644 index 0361772ce..000000000 --- a/.github/styles/proselint/Hyperbole.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "'%s' is hyperbolic." -level: error -nonword: true -tokens: - - '[a-z]+[!?]{2,}' diff --git a/.github/styles/proselint/Jargon.yml b/.github/styles/proselint/Jargon.yml deleted file mode 100644 index 2454a9c34..000000000 --- a/.github/styles/proselint/Jargon.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "'%s' is jargon." -ignorecase: true -level: error -tokens: - - in the affirmative - - in the negative - - agendize - - per your order - - per your request - - disincentivize diff --git a/.github/styles/proselint/LGBTOffensive.yml b/.github/styles/proselint/LGBTOffensive.yml deleted file mode 100644 index eaf5a84a1..000000000 --- a/.github/styles/proselint/LGBTOffensive.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "'%s' is offensive. Remove it or consider the context." -ignorecase: true -tokens: - - fag - - faggot - - dyke - - sodomite - - homosexual agenda - - gay agenda - - transvestite - - homosexual lifestyle - - gay lifestyle diff --git a/.github/styles/proselint/LGBTTerms.yml b/.github/styles/proselint/LGBTTerms.yml deleted file mode 100644 index efdf26886..000000000 --- a/.github/styles/proselint/LGBTTerms.yml +++ /dev/null @@ -1,15 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -action: - name: replace -swap: - homosexual man: gay man - homosexual men: gay men - homosexual woman: lesbian - homosexual women: lesbians - homosexual people: gay people - homosexual couple: gay couple - sexual preference: sexual orientation - (?:admitted homosexual|avowed homosexual): openly gay - special rights: equal rights diff --git a/.github/styles/proselint/Malapropisms.yml b/.github/styles/proselint/Malapropisms.yml deleted file mode 100644 index 96997787a..000000000 --- a/.github/styles/proselint/Malapropisms.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' is a malapropism." -ignorecase: true -level: error -tokens: - - the infinitesimal universe - - a serial experience - - attack my voracity diff --git a/.github/styles/proselint/Needless.yml b/.github/styles/proselint/Needless.yml deleted file mode 100644 index 1f2732e17..000000000 --- a/.github/styles/proselint/Needless.yml +++ /dev/null @@ -1,358 +0,0 @@ -extends: substitution -message: Prefer '%s' over '%s' -ignorecase: true -action: - name: replace -swap: - '(?:cell phone|cell-phone)': cellphone - '(?:cliquey|cliquy)': cliquish - '(?:pygmean|pygmaen)': pygmy - '(?:retributional|retributionary)': retributive - '(?:revokable|revokeable)': revocable - abolishment: abolition - accessary: accessory - accreditate: accredit - accruement: accrual - accusee: accused - acquaintanceship: acquaintance - acquitment: acquittal - administrate: administer - administrated: administered - administrating: administering - adulterate: adulterous - advisatory: advisory - advocator: advocate - aggrievance: grievance - allegator: alleger - allusory: allusive - amative: amorous - amortizement: amortization - amphiboly: amphibology - anecdotalist: anecdotist - anilinctus: anilingus - anticipative: anticipatory - antithetic: antithetical - applicative: applicable - applicatory: applicable - applier: applicator - approbative: approbatory - arbitrager: arbitrageur - arsenous: arsenious - ascendance: ascendancy - ascendence: ascendancy - ascendency: ascendancy - auctorial: authorial - averral: averment - barbwire: barbed wire - benefic: beneficent - benignant: benign - bestowment: bestowal - betrothment: betrothal - blamableness: blameworthiness - butt naked: buck naked - camarade: comrade - carta blanca: carte blanche - casualities: casualties - casuality: casualty - catch on fire: catch fire - catholicly: catholically - cease fire: ceasefire - channelize: channel - chaplainship: chaplaincy - chrysalid: chrysalis - chrysalids: chrysalises - cigaret: cigarette - coemployee: coworker - cognitional: cognitive - cohabitate: cohabit - cohabitor: cohabitant - collodium: collodion - collusory: collusive - commemoratory: commemorative - commonty: commonage - communicatory: communicative - compensative: compensatory - complacence: complacency - complicitous: complicit - computate: compute - conciliative: conciliatory - concomitancy: concomitance - condonance: condonation - confirmative: confirmatory - congruency: congruence - connotate: connote - consanguineal: consanguine - conspicuity: conspicuousness - conspiratorialist: conspirator - constitutionist: constitutionalist - contingence: contigency - contributary: contributory - contumacity: contumacy - conversible: convertible - conveyal: conveyance - copartner: partner - copartnership: partnership - corroboratory: corroborative - cotemporaneous: contemporaneous - cotemporary: contemporary - criminate: incriminate - culpatory: inculpatory - cumbrance: encumbrance - cumulate: accumulate - curatory: curative - daredeviltry: daredevilry - deceptious: deceptive - defamative: defamatory - defraudulent: fraudulent - degeneratory: degenerative - delimitate: delimit - delusory: delusive - denouncement: denunciation - depositee: depositary - depreciative: depreciatory - deprival: deprivation - derogative: derogatory - destroyable: destructible - detoxicate: detoxify - detractory: detractive - deviancy: deviance - deviationist: deviant - digamy: deuterogamy - digitalize: digitize - diminishment: diminution - diplomatist: diplomat - disassociate: dissociate - disciplinatory: disciplinary - discriminant: discriminating - disenthrone: dethrone - disintegratory: disintegrative - dismission: dismissal - disorientate: disorient - disorientated: disoriented - disquieten: disquiet - distraite: distrait - divergency: divergence - dividable: divisible - doctrinary: doctrinaire - documental: documentary - domesticize: domesticate - duplicatory: duplicative - duteous: dutiful - educationalist: educationist - educatory: educative - enigmatas: enigmas - enlargen: enlarge - enswathe: swathe - epical: epic - erotism: eroticism - ethician: ethicist - ex officiis: ex officio - exculpative: exculpatory - exigeant: exigent - exigence: exigency - exotism: exoticism - expedience: expediency - expediential: expedient - extensible: extendable - eying: eyeing - fiefdom: fief - flagrance: flagrancy - flatulency: flatulence - fraudful: fraudulent - funebrial: funereal - geographical: geographic - geometrical: geometric - gerry-rigged: jury-rigged - goatherder: goatherd - gustatorial: gustatory - habitude: habit - henceforward: henceforth - hesitance: hesitancy - heterogenous: heterogeneous - hierarchic: hierarchical - hindermost: hindmost - honorand: honoree - hypostasize: hypostatize - hysteric: hysterical - idolatrize: idolize - impanel: empanel - imperviable: impervious - importunacy: importunity - impotency: impotence - imprimatura: imprimatur - improprietous: improper - inalterable: unalterable - incitation: incitement - incommunicative: uncommunicative - inconsistence: inconsistency - incontrollable: uncontrollable - incurment: incurrence - indow: endow - indue: endue - inhibitive: inhibitory - innavigable: unnavigable - innovational: innovative - inquisitional: inquisitorial - insistment: insistence - insolvable: unsolvable - instillment: instillation - instinctual: instinctive - insuror: insurer - insurrectional: insurrectionary - interpretate: interpret - intervenience: intervention - ironical: ironic - jerry-rigged: jury-rigged - judgmatic: judgmental - labyrinthian: labyrinthine - laudative: laudatory - legitimatization: legitimation - legitimatize: legitimize - legitimization: legitimation - lengthways: lengthwise - life-sized: life-size - liquorice: licorice - lithesome: lithe - lollipop: lollypop - loth: loath - lubricous: lubricious - maihem: mayhem - medicinal marijuana: medical marijuana - meliorate: ameliorate - minimalize: minimize - mirk: murk - mirky: murky - misdoubt: doubt - monetarize: monetize - moveable: movable - narcism: narcissism - neglective: neglectful - negligency: negligence - neologizer: neologist - neurologic: neurological - nicknack: knickknack - nictate: nictitate - nonenforceable: unenforceable - normalcy: normality - numbedness: numbness - omittable: omissible - onomatopoetic: onomatopoeic - opinioned: opined - optimum advantage: optimal advantage - orientate: orient - outsized: outsize - oversized: oversize - overthrowal: overthrow - pacificist: pacifist - paederast: pederast - parachronism: anachronism - parti-color: parti-colored - participative: participatory - party-colored: parti-colored - pediatrist: pediatrician - penumbrous: penumbral - perjorative: pejorative - permissory: permissive - permutate: permute - personation: impersonation - pharmaceutic: pharmaceutical - pleuritis: pleurisy - policy holder: policyholder - policyowner: policyholder - politicalize: politicize - precedency: precedence - preceptoral: preceptorial - precipitance: precipitancy - precipitant: precipitate - preclusory: preclusive - precolumbian: pre-Columbian - prefectoral: prefectorial - preponderately: preponderantly - preserval: preservation - preventative: preventive - proconsulship: proconsulate - procreational: procreative - procurance: procurement - propelment: propulsion - propulsory: propulsive - prosecutive: prosecutory - protectory: protective - provocatory: provocative - pruriency: prurience - psychal: psychical - punitory: punitive - quantitate: quantify - questionary: questionnaire - quiescency: quiescence - rabbin: rabbi - reasonability: reasonableness - recidivistic: recidivous - recriminative: recriminatory - recruital: recruitment - recurrency: recurrence - recusance: recusancy - recusation: recusal - recusement: recusal - redemptory: redemptive - referrable: referable - referrible: referable - refutatory: refutative - remitment: remittance - remittal: remission - renouncement: renunciation - renunciable: renounceable - reparatory: reparative - repudiative: repudiatory - requitement: requital - rescindment: rescission - restoral: restoration - reticency: reticence - reviewal: review - revisal: revision - revisional: revisionary - revolute: revolt - saliency: salience - salutiferous: salutary - sensatory: sensory - sessionary: sessional - shareowner: shareholder - sicklily: sickly - signator: signatory - slanderize: slander - societary: societal - sodomist: sodomite - solicitate: solicit - speculatory: speculative - spiritous: spirituous - statutorial: statutory - submergeable: submersible - submittal: submission - subtile: subtle - succuba: succubus - sufficience: sufficiency - suppliant: supplicant - surmisal: surmise - suspendible: suspendable - synthetize: synthesize - systemize: systematize - tactual: tactile - tangental: tangential - tautologous: tautological - tee-shirt: T-shirt - thenceforward: thenceforth - transiency: transience - transposal: transposition - unfrequent: infrequent - unreasonability: unreasonableness - unrevokable: irrevocable - unsubstantial: insubstantial - usurpature: usurpation - variative: variational - vegetive: vegetative - vindicative: vindictive - vituperous: vituperative - vociferant: vociferous - volitive: volitional - wolverene: wolverine - wolvish: wolfish - Zoroastrism: Zoroastrianism diff --git a/.github/styles/proselint/Nonwords.yml b/.github/styles/proselint/Nonwords.yml deleted file mode 100644 index 57e7b9e42..000000000 --- a/.github/styles/proselint/Nonwords.yml +++ /dev/null @@ -1,38 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - affrontery: effrontery - analyzation: analysis - annoyment: annoyance - confirmant: confirmand - confirmants: confirmands - conversate: converse - crained: cranded - discomforture: discomfort|discomfiture - dispersement: disbursement|dispersal - doubtlessly: doubtless|undoubtedly - forebearance: forbearance - improprietous: improper - inclimate: inclement - inimicable: inimical - irregardless: regardless - minimalize: minimize - minimalized: minimized - minimalizes: minimizes - minimalizing: minimizing - optimalize: optimize - paralyzation: paralysis - pettifogger: pettifog - proprietous: proper - relative inexpense: relatively low price|affordability - seldomly: seldom - thusly: thus - uncategorically: categorically - undoubtably: undoubtedly|indubitably - unequivocable: unequivocal - unmercilessly: mercilessly - unrelentlessly: unrelentingly|relentlessly diff --git a/.github/styles/proselint/Oxymorons.yml b/.github/styles/proselint/Oxymorons.yml deleted file mode 100644 index 25fd2aa5d..000000000 --- a/.github/styles/proselint/Oxymorons.yml +++ /dev/null @@ -1,22 +0,0 @@ -extends: existence -message: "'%s' is an oxymoron." -ignorecase: true -level: error -tokens: - - amateur expert - - increasingly less - - advancing backwards - - alludes explicitly to - - explicitly alludes to - - totally obsolescent - - completely obsolescent - - generally always - - usually always - - increasingly less - - build down - - conspicuous absence - - exact estimate - - found missing - - intense apathy - - mandatory choice - - organized mess diff --git a/.github/styles/proselint/P-Value.yml b/.github/styles/proselint/P-Value.yml deleted file mode 100644 index 82309386f..000000000 --- a/.github/styles/proselint/P-Value.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "You should use more decimal places, unless '%s' is really true." -ignorecase: true -level: suggestion -tokens: - - 'p = 0\.0{2,4}' diff --git a/.github/styles/proselint/RASSyndrome.yml b/.github/styles/proselint/RASSyndrome.yml deleted file mode 100644 index deae9c7d3..000000000 --- a/.github/styles/proselint/RASSyndrome.yml +++ /dev/null @@ -1,30 +0,0 @@ -extends: existence -message: "'%s' is redundant." -level: error -action: - name: edit - params: - - split - - ' ' - - '0' -tokens: - - ABM missile - - ACT test - - ABM missiles - - ABS braking system - - ATM machine - - CD disc - - CPI Index - - GPS system - - GUI interface - - HIV virus - - ISBN number - - LCD display - - PDF format - - PIN number - - RAS syndrome - - RIP in peace - - please RSVP - - SALT talks - - SAT test - - UPC codes diff --git a/.github/styles/proselint/README.md b/.github/styles/proselint/README.md deleted file mode 100644 index 402076869..000000000 --- a/.github/styles/proselint/README.md +++ /dev/null @@ -1,12 +0,0 @@ -Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/.github/styles/proselint/Skunked.yml b/.github/styles/proselint/Skunked.yml deleted file mode 100644 index 96a1f690e..000000000 --- a/.github/styles/proselint/Skunked.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "'%s' is a bit of a skunked term — impossible to use without issue." -ignorecase: true -level: error -tokens: - - bona fides - - deceptively - - decimate - - effete - - fulsome - - hopefully - - impassionate - - Thankfully diff --git a/.github/styles/proselint/Spelling.yml b/.github/styles/proselint/Spelling.yml deleted file mode 100644 index d3c9be7b7..000000000 --- a/.github/styles/proselint/Spelling.yml +++ /dev/null @@ -1,17 +0,0 @@ -extends: consistency -message: "Inconsistent spelling of '%s'." -level: error -ignorecase: true -either: - advisor: adviser - centre: center - colour: color - emphasise: emphasize - finalise: finalize - focussed: focused - labour: labor - learnt: learned - organise: organize - organised: organized - organising: organizing - recognise: recognize diff --git a/.github/styles/proselint/Typography.yml b/.github/styles/proselint/Typography.yml deleted file mode 100644 index 60283ebf0..000000000 --- a/.github/styles/proselint/Typography.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: substitution -message: Consider using the '%s' symbol instead of '%s'. -level: error -nonword: true -swap: - '\.\.\.': … - '\([cC]\)': © - '\(TM\)': ™ - '\(tm\)': ™ - '\([rR]\)': ® - '[0-9]+ ?x ?[0-9]+': × diff --git a/.github/styles/proselint/Uncomparables.yml b/.github/styles/proselint/Uncomparables.yml deleted file mode 100644 index 9b96f42b0..000000000 --- a/.github/styles/proselint/Uncomparables.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: existence -message: "'%s' is not comparable" -ignorecase: true -level: error -action: - name: edit - params: - - split - - ' ' - - '1' -raw: - - \b(?:absolutely|most|more|less|least|very|quite|largely|extremely|increasingly|kind of|mildy|hardly|greatly|sort of)\b\s* -tokens: - - absolute - - adequate - - complete - - correct - - certain - - devoid - - entire - - 'false' - - fatal - - favorite - - final - - ideal - - impossible - - inevitable - - infinite - - irrevocable - - main - - manifest - - only - - paramount - - perfect - - perpetual - - possible - - preferable - - principal - - singular - - stationary - - sufficient - - 'true' - - unanimous - - unavoidable - - unbroken - - uniform - - unique - - universal - - void - - whole diff --git a/.github/styles/proselint/Very.yml b/.github/styles/proselint/Very.yml deleted file mode 100644 index e4077f792..000000000 --- a/.github/styles/proselint/Very.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "Remove '%s'." -ignorecase: true -level: error -tokens: - - very diff --git a/.github/styles/proselint/meta.json b/.github/styles/proselint/meta.json deleted file mode 100644 index e3c65800b..000000000 --- a/.github/styles/proselint/meta.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "author": "jdkato", - "description": "A Vale-compatible implementation of the proselint linter.", - "email": "support@errata.ai", - "lang": "en", - "url": "https://github.com/errata-ai/proselint/releases/latest/download/proselint.zip", - "feed": "https://github.com/errata-ai/proselint/releases.atom", - "issues": "https://github.com/errata-ai/proselint/issues/new", - "license": "BSD-3-Clause", - "name": "proselint", - "sources": [ - "https://github.com/amperser/proselint" - ], - "vale_version": ">=1.0.0", - "coverage": 0.0, - "version": "0.1.0" -} diff --git a/vale.ini b/vale.ini index 5df31c397..d3dd2d694 100644 --- a/vale.ini +++ b/vale.ini @@ -4,11 +4,14 @@ IgnoredScopes = code, tt, table, tr, td Vocab = Docs -Packages = proselint, write-good +Packages = Microsoft, write-good [formats] mdx = md [*.md] -BasedOnStyles = proselint, write-good +BasedOnStyles = Apify, write-good, Microsoft + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*) (http[^\n]+\[) From 04f724d3a4e07c770278099cbe8a9dacc1c2ef49 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 11:22:21 +0100 Subject: [PATCH 19/57] turn off quotes rules --- vale.ini | 2 ++ 1 file changed, 2 insertions(+) diff --git a/vale.ini b/vale.ini index d3dd2d694..4c550159f 100644 --- a/vale.ini +++ b/vale.ini @@ -15,3 +15,5 @@ BasedOnStyles = Apify, write-good, Microsoft # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*) (http[^\n]+\[) +# Disabling rules +Microsoft.Quotes = NO From 002dcd400b04cd01fed7ce18db98dc868fac3183 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 11:22:48 +0100 Subject: [PATCH 20/57] vale test msoft rules --- sources/platform/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/index.mdx b/sources/platform/index.mdx index 2f4f124cc..0707100ae 100644 --- a/sources/platform/index.mdx +++ b/sources/platform/index.mdx @@ -11,7 +11,7 @@ import homepageContent from "./homepage_content.json"; # Apify platform -> **Apify** is a cloud platform that helps you build reliable web scrapers, fast, and automate anything you can do manually in a web browser. +> **apify** is a cloud platform that helps you build reliable web scrapers, fast, and automate anything you can do manually in a web browser. > > **Actors** are serverless cloud programs running on the Apify platform that can easily crawl websites with millions of pages, but also perform arbitrary computing jobs such as sending emails or data transformations. They can be started manually, using our API or scheduler, and they can be easily integrated with other apps. From bc1383a65f46ee142f76d3cbbcad40e9b0972a70 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 11:31:27 +0100 Subject: [PATCH 21/57] vale - test --- .github/workflows/vale.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index c9b663589..ee0224dfa 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -1,7 +1,6 @@ name: Lint with Vale on pull request on: - pull_request: - types: [ opened, edited, synchronize ] + [pull_request] jobs: vale: From 9a2736c9ed632b10b7c905bfd952ac4120cf0c68 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:34:43 +0100 Subject: [PATCH 22/57] add proselint for testing purposes add proseling add styles dir to gitignore --- .gitignore | 3 +++ vale.ini | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 533fd6403..2333ee5bc 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,6 @@ sources/typedefs tsconfig.tsbuildinfo .turbo apify-docs-theme/package-lock.json +.github/styles/* +!.github/styles/Vocab +!.github/styles/Apify diff --git a/vale.ini b/vale.ini index 4c550159f..ef86140f2 100644 --- a/vale.ini +++ b/vale.ini @@ -4,7 +4,7 @@ IgnoredScopes = code, tt, table, tr, td Vocab = Docs -Packages = Microsoft, write-good +Packages = Microsoft, write-good, proselint [formats] mdx = md From 3e2f57585e9a4f2c2e47284dbf85238761b20401 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:38:09 +0100 Subject: [PATCH 23/57] remove proselint from vale.ini --- vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vale.ini b/vale.ini index ef86140f2..4c550159f 100644 --- a/vale.ini +++ b/vale.ini @@ -4,7 +4,7 @@ IgnoredScopes = code, tt, table, tr, td Vocab = Docs -Packages = Microsoft, write-good, proselint +Packages = Microsoft, write-good [formats] mdx = md From d7346524393407f394bd51b25997992f675f5335 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:41:29 +0100 Subject: [PATCH 24/57] remove vale setup for testing --- .github/styles/Microsoft/AMPM.yml | 9 - .github/styles/Microsoft/Accessibility.yml | 25 - .github/styles/Microsoft/Acronyms.yml | 64 -- .github/styles/Microsoft/Adverbs.yml | 270 ------- .github/styles/Microsoft/Auto.yml | 11 - .github/styles/Microsoft/Avoid.yml | 14 - .github/styles/Microsoft/ComplexWords.yml | 120 --- .github/styles/Microsoft/Contractions.yml | 50 -- .github/styles/Microsoft/Dashes.yml | 13 - .github/styles/Microsoft/DateFormat.yml | 8 - .github/styles/Microsoft/DateNumbers.yml | 40 - .github/styles/Microsoft/DateOrder.yml | 8 - .github/styles/Microsoft/Ellipses.yml | 9 - .github/styles/Microsoft/FirstPerson.yml | 16 - .github/styles/Microsoft/Foreign.yml | 13 - .github/styles/Microsoft/Gender.yml | 8 - .github/styles/Microsoft/GenderBias.yml | 44 -- .github/styles/Microsoft/GeneralURL.yml | 11 - .github/styles/Microsoft/HeadingAcronyms.yml | 7 - .github/styles/Microsoft/HeadingColons.yml | 8 - .../styles/Microsoft/HeadingPunctuation.yml | 13 - .github/styles/Microsoft/Headings.yml | 28 - .github/styles/Microsoft/Hyphens.yml | 14 - .github/styles/Microsoft/Negative.yml | 13 - .github/styles/Microsoft/Ordinal.yml | 13 - .github/styles/Microsoft/OxfordComma.yml | 8 - .github/styles/Microsoft/Passive.yml | 183 ----- .github/styles/Microsoft/Percentages.yml | 7 - .github/styles/Microsoft/Quotes.yml | 7 - .github/styles/Microsoft/RangeFormat.yml | 13 - .github/styles/Microsoft/RangeTime.yml | 13 - .github/styles/Microsoft/Ranges.yml | 7 - .github/styles/Microsoft/Semicolon.yml | 8 - .github/styles/Microsoft/SentenceLength.yml | 7 - .github/styles/Microsoft/Spacing.yml | 8 - .github/styles/Microsoft/Suspended.yml | 7 - .github/styles/Microsoft/Terms.yml | 41 - .github/styles/Microsoft/URLFormat.yml | 10 - .github/styles/Microsoft/Units.yml | 16 - .github/styles/Microsoft/Vocab.yml | 25 - .github/styles/Microsoft/We.yml | 11 - .github/styles/Microsoft/Wordiness.yml | 122 --- .github/styles/Microsoft/meta.json | 4 - .github/styles/write-good/Cliches.yml | 702 ------------------ .github/styles/write-good/E-Prime.yml | 32 - .github/styles/write-good/Illusions.yml | 11 - .github/styles/write-good/Passive.yml | 183 ----- .github/styles/write-good/README.md | 27 - .github/styles/write-good/So.yml | 5 - .github/styles/write-good/ThereIs.yml | 6 - .github/styles/write-good/TooWordy.yml | 221 ------ .github/styles/write-good/Weasel.yml | 207 ------ .github/styles/write-good/meta.json | 4 - .github/workflows/vale.yaml | 23 - vale.ini | 19 - 55 files changed, 2766 deletions(-) delete mode 100644 .github/styles/Microsoft/AMPM.yml delete mode 100644 .github/styles/Microsoft/Accessibility.yml delete mode 100644 .github/styles/Microsoft/Acronyms.yml delete mode 100644 .github/styles/Microsoft/Adverbs.yml delete mode 100644 .github/styles/Microsoft/Auto.yml delete mode 100644 .github/styles/Microsoft/Avoid.yml delete mode 100644 .github/styles/Microsoft/ComplexWords.yml delete mode 100644 .github/styles/Microsoft/Contractions.yml delete mode 100644 .github/styles/Microsoft/Dashes.yml delete mode 100644 .github/styles/Microsoft/DateFormat.yml delete mode 100644 .github/styles/Microsoft/DateNumbers.yml delete mode 100644 .github/styles/Microsoft/DateOrder.yml delete mode 100644 .github/styles/Microsoft/Ellipses.yml delete mode 100644 .github/styles/Microsoft/FirstPerson.yml delete mode 100644 .github/styles/Microsoft/Foreign.yml delete mode 100644 .github/styles/Microsoft/Gender.yml delete mode 100644 .github/styles/Microsoft/GenderBias.yml delete mode 100644 .github/styles/Microsoft/GeneralURL.yml delete mode 100644 .github/styles/Microsoft/HeadingAcronyms.yml delete mode 100644 .github/styles/Microsoft/HeadingColons.yml delete mode 100644 .github/styles/Microsoft/HeadingPunctuation.yml delete mode 100644 .github/styles/Microsoft/Headings.yml delete mode 100644 .github/styles/Microsoft/Hyphens.yml delete mode 100644 .github/styles/Microsoft/Negative.yml delete mode 100644 .github/styles/Microsoft/Ordinal.yml delete mode 100644 .github/styles/Microsoft/OxfordComma.yml delete mode 100644 .github/styles/Microsoft/Passive.yml delete mode 100644 .github/styles/Microsoft/Percentages.yml delete mode 100644 .github/styles/Microsoft/Quotes.yml delete mode 100644 .github/styles/Microsoft/RangeFormat.yml delete mode 100644 .github/styles/Microsoft/RangeTime.yml delete mode 100644 .github/styles/Microsoft/Ranges.yml delete mode 100644 .github/styles/Microsoft/Semicolon.yml delete mode 100644 .github/styles/Microsoft/SentenceLength.yml delete mode 100644 .github/styles/Microsoft/Spacing.yml delete mode 100644 .github/styles/Microsoft/Suspended.yml delete mode 100644 .github/styles/Microsoft/Terms.yml delete mode 100644 .github/styles/Microsoft/URLFormat.yml delete mode 100644 .github/styles/Microsoft/Units.yml delete mode 100644 .github/styles/Microsoft/Vocab.yml delete mode 100644 .github/styles/Microsoft/We.yml delete mode 100644 .github/styles/Microsoft/Wordiness.yml delete mode 100644 .github/styles/Microsoft/meta.json delete mode 100644 .github/styles/write-good/Cliches.yml delete mode 100644 .github/styles/write-good/E-Prime.yml delete mode 100644 .github/styles/write-good/Illusions.yml delete mode 100644 .github/styles/write-good/Passive.yml delete mode 100644 .github/styles/write-good/README.md delete mode 100644 .github/styles/write-good/So.yml delete mode 100644 .github/styles/write-good/ThereIs.yml delete mode 100644 .github/styles/write-good/TooWordy.yml delete mode 100644 .github/styles/write-good/Weasel.yml delete mode 100644 .github/styles/write-good/meta.json delete mode 100644 .github/workflows/vale.yaml delete mode 100644 vale.ini diff --git a/.github/styles/Microsoft/AMPM.yml b/.github/styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed162..000000000 --- a/.github/styles/Microsoft/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: Use 'AM' or 'PM' (preceded by a space). -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.github/styles/Microsoft/Accessibility.yml b/.github/styles/Microsoft/Accessibility.yml deleted file mode 100644 index 05bf92739..000000000 --- a/.github/styles/Microsoft/Accessibility.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Don't use language (such as '%s') that defines people by their disability." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms -level: suggestion -ignorecase: true -tokens: - - a victim of - - able-bodied - - affected by - - an epileptic - - crippled - - disabled - - dumb - - handicapped - - handicaps - - healthy - - lame - - maimed - - missing a limb - - mute - - normal - - sight-impaired - - stricken with - - suffers from - - vision-impaired diff --git a/.github/styles/Microsoft/Acronyms.yml b/.github/styles/Microsoft/Acronyms.yml deleted file mode 100644 index 308ff7c0e..000000000 --- a/.github/styles/Microsoft/Acronyms.yml +++ /dev/null @@ -1,64 +0,0 @@ -extends: conditional -message: "'%s' has no definition." -link: https://docs.microsoft.com/en-us/style-guide/acronyms -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP diff --git a/.github/styles/Microsoft/Adverbs.yml b/.github/styles/Microsoft/Adverbs.yml deleted file mode 100644 index 07d98d83e..000000000 --- a/.github/styles/Microsoft/Adverbs.yml +++ /dev/null @@ -1,270 +0,0 @@ -extends: existence -message: "Consider removing '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: remove -tokens: - - abnormally - - absentmindedly - - accidentally - - adventurously - - anxiously - - arrogantly - - awkwardly - - bashfully - - beautifully - - bitterly - - bleakly - - blindly - - blissfully - - boastfully - - boldly - - bravely - - briefly - - brightly - - briskly - - broadly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - cleverly - - closely - - coaxingly - - colorfully - - continually - - coolly - - courageously - - crossly - - cruelly - - curiously - - daintily - - dearly - - deceivingly - - deeply - - defiantly - - deliberately - - delightfully - - diligently - - dimly - - doubtfully - - dreamily - - easily - - elegantly - - energetically - - enormously - - enthusiastically - - excitedly - - extremely - - fairly - - faithfully - - famously - - ferociously - - fervently - - fiercely - - fondly - - foolishly - - fortunately - - frankly - - frantically - - freely - - frenetically - - frightfully - - furiously - - generally - - generously - - gently - - gladly - - gleefully - - gracefully - - gratefully - - greatly - - greedily - - happily - - hastily - - healthily - - heavily - - helplessly - - honestly - - hopelessly - - hungrily - - innocently - - inquisitively - - intensely - - intently - - interestingly - - inwardly - - irritably - - jaggedly - - jealously - - jovially - - joyfully - - joyously - - jubilantly - - judgmentally - - justly - - keenly - - kiddingly - - kindheartedly - - knavishly - - knowingly - - knowledgeably - - lazily - - lightly - - limply - - lively - - loftily - - longingly - - loosely - - loudly - - lovingly - - loyally - - madly - - majestically - - meaningfully - - mechanically - - merrily - - miserably - - mockingly - - mortally - - mysteriously - - naturally - - nearly - - neatly - - nervously - - nicely - - noisily - - obediently - - obnoxiously - - oddly - - offensively - - optimistically - - overconfidently - - painfully - - partially - - patiently - - perfectly - - playfully - - politely - - poorly - - positively - - potentially - - powerfully - - promptly - - properly - - punctually - - quaintly - - queasily - - queerly - - questionably - - quickly - - quietly - - quirkily - - quizzically - - randomly - - rapidly - - rarely - - readily - - really - - reassuringly - - recklessly - - regularly - - reluctantly - - repeatedly - - reproachfully - - restfully - - righteously - - rightfully - - rigidly - - roughly - - rudely - - safely - - scarcely - - scarily - - searchingly - - sedately - - seemingly - - selfishly - - separately - - seriously - - shakily - - sharply - - sheepishly - - shrilly - - shyly - - silently - - sleepily - - slowly - - smoothly - - softly - - solemnly - - solidly - - speedily - - stealthily - - sternly - - strictly - - suddenly - - supposedly - - surprisingly - - suspiciously - - sweetly - - swiftly - - sympathetically - - tenderly - - tensely - - terribly - - thankfully - - thoroughly - - thoughtfully - - tightly - - tremendously - - triumphantly - - truthfully - - ultimately - - unabashedly - - unaccountably - - unbearably - - unethically - - unexpectedly - - unfortunately - - unimpressively - - unnaturally - - unnecessarily - - urgently - - usefully - - uselessly - - utterly - - vacantly - - vaguely - - vainly - - valiantly - - vastly - - verbally - - very - - viciously - - victoriously - - violently - - vivaciously - - voluntarily - - warmly - - weakly - - wearily - - wetly - - wholly - - wildly - - willfully - - wisely - - woefully - - wonderfully - - worriedly - - yawningly - - yearningly - - yieldingly - - youthfully - - zealously - - zestfully - - zestily diff --git a/.github/styles/Microsoft/Auto.yml b/.github/styles/Microsoft/Auto.yml deleted file mode 100644 index 4da439353..000000000 --- a/.github/styles/Microsoft/Auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "In general, don't hyphenate '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto -ignorecase: true -level: error -action: - name: convert - params: - - simple -tokens: - - 'auto-\w+' diff --git a/.github/styles/Microsoft/Avoid.yml b/.github/styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c7..000000000 --- a/.github/styles/Microsoft/Avoid.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Don't use '%s'. See the A-Z word list for details." -# See the A-Z word list -link: https://docs.microsoft.com/en-us/style-guide -ignorecase: true -level: error -tokens: - - abortion - - and so on - - app(?:lication)?s? (?:developer|program) - - app(?:lication)? file - - backbone - - backend - - contiguous selection diff --git a/.github/styles/Microsoft/ComplexWords.yml b/.github/styles/Microsoft/ComplexWords.yml deleted file mode 100644 index 65b7a3472..000000000 --- a/.github/styles/Microsoft/ComplexWords.yml +++ /dev/null @@ -1,120 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - "approximate(?:ly)?": about - abundance: plenty - accelerate: speed up - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - additional: more|extra - address: discuss - addressees: you - adjacent to: next to - adjustment: change - admissible: allowed - advantageous: helpful - advise: tell - aggregate: total - aircraft: plane - alleviate: ease - allocate: assign|divide - alternatively: or - alternatives: choices|options - ameliorate: improve - amend: change - anticipate: expect - apparent: clear|plain - ascertain: discover|find out - assistance: help - attain: meet - attempt: try - authorize: allow - belated: late - bestow: give - cease: stop|end - collaborate: work together - commence: begin - compensate: pay - component: part - comprise: form|include - concept: idea - concerning: about - confer: give|award - consequently: so - consolidate: merge - constitutes: forms - contains: has - convene: meet - demonstrate: show|prove - depart: leave - designate: choose - desire: want|wish - determine: decide|find - detrimental: bad|harmful - disclose: share|tell - discontinue: stop - disseminate: send|give - eliminate: end - elucidate: explain - employ: use - enclosed: inside|included - encounter: meet - endeavor: try - enumerate: count - equitable: fair - equivalent: equal - exclusively: only - expedite: hurry - facilitate: ease - females: women - finalize: complete|finish - frequently: often - identical: same - incorrect: wrong - indication: sign - initiate: start|begin - itemized: listed - jeopardize: risk - liaise: work with|partner with - maintain: keep|support - methodology: method - modify: change - monitor: check|watch - multiple: many - necessitate: cause - notify: tell - numerous: many - objective: aim|goal - obligate: bind|compel - optimum: best|most - permit: let - portion: part - possess: own - previous: earlier - previously: before - prioritize: rank - procure: buy - provide: give|offer - purchase: buy - relocate: move - solicit: request - state-of-the-art: latest - subsequent: later|next - substantial: large - sufficient: enough - terminate: end - transmit: send - utilization: use - utilize: use diff --git a/.github/styles/Microsoft/Contractions.yml b/.github/styles/Microsoft/Contractions.yml deleted file mode 100644 index 8c81dcbce..000000000 --- a/.github/styles/Microsoft/Contractions.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error -ignorecase: true -action: - name: replace -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - - 'it is(?!\.)': it's - 'it''s(?=\.)': it is - - should not: shouldn't - - "that is(?![.,])": that's - 'that''s(?=\.)': that is - - 'they are(?!\.)': they're - 'they''re(?=\.)': they are - - was not: wasn't - - 'we are(?!\.)': we're - 'we''re(?=\.)': we are - - 'we have(?!\.)': we've - 'we''ve(?=\.)': we have - - were not: weren't - - 'what is(?!\.)': what's - 'what''s(?=\.)': what is - - 'when is(?!\.)': when's - 'when''s(?=\.)': when is - - 'where is(?!\.)': where's - 'where''s(?=\.)': where is - - will not: won't diff --git a/.github/styles/Microsoft/Dashes.yml b/.github/styles/Microsoft/Dashes.yml deleted file mode 100644 index 2894cf722..000000000 --- a/.github/styles/Microsoft/Dashes.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Remove the spaces around '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes -ignorecase: true -nonword: true -level: error -action: - name: edit - params: - - remove - - ' ' -tokens: - - '[—–]\s|\s[—–]' diff --git a/.github/styles/Microsoft/DateFormat.yml b/.github/styles/Microsoft/DateFormat.yml deleted file mode 100644 index 196531394..000000000 --- a/.github/styles/Microsoft/DateFormat.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: Use 'July 31, 2016' format, not '%s'. -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.github/styles/Microsoft/DateNumbers.yml b/.github/styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747c..000000000 --- a/.github/styles/Microsoft/DateNumbers.yml +++ /dev/null @@ -1,40 +0,0 @@ -extends: existence -message: "Don't use ordinal numbers for dates." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -level: error -nonword: true -ignorecase: true -raw: - - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* -tokens: - - first - - second - - third - - fourth - - fifth - - sixth - - seventh - - eighth - - ninth - - tenth - - eleventh - - twelfth - - thirteenth - - fourteenth - - fifteenth - - sixteenth - - seventeenth - - eighteenth - - nineteenth - - twentieth - - twenty-first - - twenty-second - - twenty-third - - twenty-fourth - - twenty-fifth - - twenty-sixth - - twenty-seventh - - twenty-eighth - - twenty-ninth - - thirtieth - - thirty-first diff --git a/.github/styles/Microsoft/DateOrder.yml b/.github/styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba51..000000000 --- a/.github/styles/Microsoft/DateOrder.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Always spell out the name of the month." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -ignorecase: true -level: error -nonword: true -tokens: - - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/.github/styles/Microsoft/Ellipses.yml b/.github/styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8b..000000000 --- a/.github/styles/Microsoft/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/.github/styles/Microsoft/FirstPerson.yml b/.github/styles/Microsoft/FirstPerson.yml deleted file mode 100644 index 77761af88..000000000 --- a/.github/styles/Microsoft/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Use first person (such as '%s') sparingly." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'd\b - - \bI'll\b - - \bI'm\b - - \bI've\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/.github/styles/Microsoft/Foreign.yml b/.github/styles/Microsoft/Foreign.yml deleted file mode 100644 index 0d3d6002a..000000000 --- a/.github/styles/Microsoft/Foreign.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - '\b(?:viz\.)[\s,]': namely - '\b(?:ergo)[\s,]': therefore diff --git a/.github/styles/Microsoft/Gender.yml b/.github/styles/Microsoft/Gender.yml deleted file mode 100644 index 47c080247..000000000 --- a/.github/styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he diff --git a/.github/styles/Microsoft/GenderBias.yml b/.github/styles/Microsoft/GenderBias.yml deleted file mode 100644 index 3d873aa31..000000000 --- a/.github/styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,44 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.github/styles/Microsoft/GeneralURL.yml b/.github/styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d9..000000000 --- a/.github/styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/.github/styles/Microsoft/HeadingAcronyms.yml b/.github/styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 9dc3b6c2d..000000000 --- a/.github/styles/Microsoft/HeadingAcronyms.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Avoid using acronyms in a title or heading." -link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings -level: warning -scope: heading -tokens: - - '[A-Z]{2,4}' diff --git a/.github/styles/Microsoft/HeadingColons.yml b/.github/styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c3914..000000000 --- a/.github/styles/Microsoft/HeadingColons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Capitalize '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons -nonword: true -level: error -scope: heading -tokens: - - ':\s[a-z]' diff --git a/.github/styles/Microsoft/HeadingPunctuation.yml b/.github/styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index af04b02eb..000000000 --- a/.github/styles/Microsoft/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't use end punctuation in headings." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - remove - - '.?!' -tokens: - - '[a-z][.?!](?:\s|$)' diff --git a/.github/styles/Microsoft/Headings.yml b/.github/styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc1..000000000 --- a/.github/styles/Microsoft/Headings.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: https://docs.microsoft.com/en-us/style-guide/capitalization -level: suggestion -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/.github/styles/Microsoft/Hyphens.yml b/.github/styles/Microsoft/Hyphens.yml deleted file mode 100644 index 90bbb5def..000000000 --- a/.github/styles/Microsoft/Hyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -level: warning -ignorecase: false -nonword: true -action: - name: edit - params: - - replace - - '-' - - ' ' -tokens: - - '\s[^\s-]+ly-' diff --git a/.github/styles/Microsoft/Negative.yml b/.github/styles/Microsoft/Negative.yml deleted file mode 100644 index d6ff2f224..000000000 --- a/.github/styles/Microsoft/Negative.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Form a negative number with an en dash, not a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\s-\d+\s' diff --git a/.github/styles/Microsoft/Ordinal.yml b/.github/styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e380..000000000 --- a/.github/styles/Microsoft/Ordinal.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't add -ly to an ordinal number." -link: https://docs.microsoft.com/en-us/style-guide/numbers -level: error -action: - name: edit - params: - - trim - - ly -tokens: - - firstly - - secondly - - thirdly diff --git a/.github/styles/Microsoft/OxfordComma.yml b/.github/styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3c..000000000 --- a/.github/styles/Microsoft/OxfordComma.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas -scope: sentence -level: suggestion -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/.github/styles/Microsoft/Passive.yml b/.github/styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377ca..000000000 --- a/.github/styles/Microsoft/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' looks like passive voice." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/.github/styles/Microsoft/Percentages.yml b/.github/styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363f..000000000 --- a/.github/styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' diff --git a/.github/styles/Microsoft/Quotes.yml b/.github/styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f497606..000000000 --- a/.github/styles/Microsoft/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: 'Punctuation should be inside the quotes.' -link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: error -nonword: true -tokens: - - '["“][^"”“]+["”][.,]' diff --git a/.github/styles/Microsoft/RangeFormat.yml b/.github/styles/Microsoft/RangeFormat.yml deleted file mode 100644 index f1d736e9d..000000000 --- a/.github/styles/Microsoft/RangeFormat.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use an en dash in a range of numbers." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\b\d+\s?[-]\s?\d+\b' diff --git a/.github/styles/Microsoft/RangeTime.yml b/.github/styles/Microsoft/RangeTime.yml deleted file mode 100644 index cdd4b3346..000000000 --- a/.github/styles/Microsoft/RangeTime.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use 'to' instead of a dash in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '[-–]' - - 'to' -tokens: - - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/.github/styles/Microsoft/Ranges.yml b/.github/styles/Microsoft/Ranges.yml deleted file mode 100644 index 67d9702b0..000000000 --- a/.github/styles/Microsoft/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "In most cases, use 'from' or 'through' to describe a range of numbers." -link: 'https://docs.microsoft.com/en-us/style-guide/numbers' -nonword: true -level: warning -tokens: - - '\b\d+\s?[-–]\s?\d+\b' diff --git a/.github/styles/Microsoft/Semicolon.yml b/.github/styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467d..000000000 --- a/.github/styles/Microsoft/Semicolon.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Try to simplify this sentence." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/.github/styles/Microsoft/SentenceLength.yml b/.github/styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf051..000000000 --- a/.github/styles/Microsoft/SentenceLength.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: occurrence -message: "Try to keep sentences short (< 30 words)." -scope: sentence -level: suggestion -max: 30 -token: \b(\w+)\b - diff --git a/.github/styles/Microsoft/Spacing.yml b/.github/styles/Microsoft/Spacing.yml deleted file mode 100644 index bbd10e51d..000000000 --- a/.github/styles/Microsoft/Spacing.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' diff --git a/.github/styles/Microsoft/Suspended.yml b/.github/styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9c..000000000 --- a/.github/styles/Microsoft/Suspended.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use '%s' unless space is limited." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -ignorecase: true -level: warning -tokens: - - '\w+- and \w+-' diff --git a/.github/styles/Microsoft/Terms.yml b/.github/styles/Microsoft/Terms.yml deleted file mode 100644 index 7708900eb..000000000 --- a/.github/styles/Microsoft/Terms.yml +++ /dev/null @@ -1,41 +0,0 @@ -extends: substitution -message: "Prefer '%s' over '%s'." -# term preference should be based on microsoft style guide, such as -link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/adapter -level: warning -ignorecase: true -action: - name: replace -swap: - '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant - '(?:drive C:|drive C>|C: drive)': drive C - '(?:internet bot|web robot)s?': bot(s) - '(?:microsoft cloud|the cloud)': cloud - '(?:mobile|smart) ?phone': phone - '24/7': every day - 'audio(?:-| )book': audiobook - 'back(?:-| )light': backlight - 'chat ?bots?': chatbot(s) - adaptor: adapter - administrate: administer - afterwards: afterward - alphabetic: alphabetical - alphanumerical: alphanumeric - anti-aliasing: antialiasing - anti-malware: antimalware - anti-spyware: antispyware - anti-virus: antivirus - appendixes: appendices - artificial intelligence: AI - '(?:assembler|machine language)': assembly language - caap: CaaP - conversation-as-a-platform: conversation as a platform - eb: EB - gb: GB - gbps: Gbps - kb: KB - keypress: keystroke - mb: MB - pb: PB - tb: TB - zb: ZB diff --git a/.github/styles/Microsoft/URLFormat.yml b/.github/styles/Microsoft/URLFormat.yml deleted file mode 100644 index 82e702f98..000000000 --- a/.github/styles/Microsoft/URLFormat.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - URL for: URL of - an URL: a URL - diff --git a/.github/styles/Microsoft/Units.yml b/.github/styles/Microsoft/Units.yml deleted file mode 100644 index f062418ee..000000000 --- a/.github/styles/Microsoft/Units.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Don't spell out the number in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms -level: error -raw: - - '[a-zA-Z]+\s' -tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' - - cm - - inches - - lb - - miles - - pounds diff --git a/.github/styles/Microsoft/Vocab.yml b/.github/styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b15..000000000 --- a/.github/styles/Microsoft/Vocab.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' -level: suggestion -ignorecase: true -tokens: - - above - - accessible - - actionable - - against - - alarm - - alert - - alias - - allows? - - and/or - - as well as - - assure - - author - - avg - - beta - - ensure - - he - - insure - - sample - - she diff --git a/.github/styles/Microsoft/We.yml b/.github/styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1b..000000000 --- a/.github/styles/Microsoft/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/.github/styles/Microsoft/Wordiness.yml b/.github/styles/Microsoft/Wordiness.yml deleted file mode 100644 index 22a4c932c..000000000 --- a/.github/styles/Microsoft/Wordiness.yml +++ /dev/null @@ -1,122 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: replace -swap: - (?:give|gave) rise to: lead to - (?:previous|prior) to: before - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of a sudden: suddenly - all of these: these - all of: all - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - drag and drop: drag - drag-and-drop: drag - doomed to fail: doomed - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for diff --git a/.github/styles/Microsoft/meta.json b/.github/styles/Microsoft/meta.json deleted file mode 100644 index 297719bbb..000000000 --- a/.github/styles/Microsoft/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Microsoft/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/.github/styles/write-good/Cliches.yml b/.github/styles/write-good/Cliches.yml deleted file mode 100644 index c95314387..000000000 --- a/.github/styles/write-good/Cliches.yml +++ /dev/null @@ -1,702 +0,0 @@ -extends: existence -message: "Try to avoid using clichés like '%s'." -ignorecase: true -level: warning -tokens: - - a chip off the old block - - a clean slate - - a dark and stormy night - - a far cry - - a fine kettle of fish - - a loose cannon - - a penny saved is a penny earned - - a tough row to hoe - - a word to the wise - - ace in the hole - - acid test - - add insult to injury - - against all odds - - air your dirty laundry - - all fun and games - - all in a day's work - - all talk, no action - - all thumbs - - all your eggs in one basket - - all's fair in love and war - - all's well that ends well - - almighty dollar - - American as apple pie - - an axe to grind - - another day, another dollar - - armed to the teeth - - as luck would have it - - as old as time - - as the crow flies - - at loose ends - - at my wits end - - avoid like the plague - - babe in the woods - - back against the wall - - back in the saddle - - back to square one - - back to the drawing board - - bad to the bone - - badge of honor - - bald faced liar - - ballpark figure - - banging your head against a brick wall - - baptism by fire - - barking up the wrong tree - - bat out of hell - - be all and end all - - beat a dead horse - - beat around the bush - - been there, done that - - beggars can't be choosers - - behind the eight ball - - bend over backwards - - benefit of the doubt - - bent out of shape - - best thing since sliced bread - - bet your bottom dollar - - better half - - better late than never - - better mousetrap - - better safe than sorry - - between a rock and a hard place - - beyond the pale - - bide your time - - big as life - - big cheese - - big fish in a small pond - - big man on campus - - bigger they are the harder they fall - - bird in the hand - - bird's eye view - - birds and the bees - - birds of a feather flock together - - bit the hand that feeds you - - bite the bullet - - bite the dust - - bitten off more than he can chew - - black as coal - - black as pitch - - black as the ace of spades - - blast from the past - - bleeding heart - - blessing in disguise - - blind ambition - - blind as a bat - - blind leading the blind - - blood is thicker than water - - blood sweat and tears - - blow off steam - - blow your own horn - - blushing bride - - boils down to - - bolt from the blue - - bone to pick - - bored stiff - - bored to tears - - bottomless pit - - boys will be boys - - bright and early - - brings home the bacon - - broad across the beam - - broken record - - brought back to reality - - bull by the horns - - bull in a china shop - - burn the midnight oil - - burning question - - burning the candle at both ends - - burst your bubble - - bury the hatchet - - busy as a bee - - by hook or by crook - - call a spade a spade - - called onto the carpet - - calm before the storm - - can of worms - - can't cut the mustard - - can't hold a candle to - - case of mistaken identity - - cat got your tongue - - cat's meow - - caught in the crossfire - - caught red-handed - - checkered past - - chomping at the bit - - cleanliness is next to godliness - - clear as a bell - - clear as mud - - close to the vest - - cock and bull story - - cold shoulder - - come hell or high water - - cool as a cucumber - - cool, calm, and collected - - cost a king's ransom - - count your blessings - - crack of dawn - - crash course - - creature comforts - - cross that bridge when you come to it - - crushing blow - - cry like a baby - - cry me a river - - cry over spilt milk - - crystal clear - - curiosity killed the cat - - cut and dried - - cut through the red tape - - cut to the chase - - cute as a bugs ear - - cute as a button - - cute as a puppy - - cuts to the quick - - dark before the dawn - - day in, day out - - dead as a doornail - - devil is in the details - - dime a dozen - - divide and conquer - - dog and pony show - - dog days - - dog eat dog - - dog tired - - don't burn your bridges - - don't count your chickens - - don't look a gift horse in the mouth - - don't rock the boat - - don't step on anyone's toes - - don't take any wooden nickels - - down and out - - down at the heels - - down in the dumps - - down the hatch - - down to earth - - draw the line - - dressed to kill - - dressed to the nines - - drives me up the wall - - dull as dishwater - - dyed in the wool - - eagle eye - - ear to the ground - - early bird catches the worm - - easier said than done - - easy as pie - - eat your heart out - - eat your words - - eleventh hour - - even the playing field - - every dog has its day - - every fiber of my being - - everything but the kitchen sink - - eye for an eye - - face the music - - facts of life - - fair weather friend - - fall by the wayside - - fan the flames - - feast or famine - - feather your nest - - feathered friends - - few and far between - - fifteen minutes of fame - - filthy vermin - - fine kettle of fish - - fish out of water - - fishing for a compliment - - fit as a fiddle - - fit the bill - - fit to be tied - - flash in the pan - - flat as a pancake - - flip your lid - - flog a dead horse - - fly by night - - fly the coop - - follow your heart - - for all intents and purposes - - for the birds - - for what it's worth - - force of nature - - force to be reckoned with - - forgive and forget - - fox in the henhouse - - free and easy - - free as a bird - - fresh as a daisy - - full steam ahead - - fun in the sun - - garbage in, garbage out - - gentle as a lamb - - get a kick out of - - get a leg up - - get down and dirty - - get the lead out - - get to the bottom of - - get your feet wet - - gets my goat - - gilding the lily - - give and take - - go against the grain - - go at it tooth and nail - - go for broke - - go him one better - - go the extra mile - - go with the flow - - goes without saying - - good as gold - - good deed for the day - - good things come to those who wait - - good time was had by all - - good times were had by all - - greased lightning - - greek to me - - green thumb - - green-eyed monster - - grist for the mill - - growing like a weed - - hair of the dog - - hand to mouth - - happy as a clam - - happy as a lark - - hasn't a clue - - have a nice day - - have high hopes - - have the last laugh - - haven't got a row to hoe - - head honcho - - head over heels - - hear a pin drop - - heard it through the grapevine - - heart's content - - heavy as lead - - hem and haw - - high and dry - - high and mighty - - high as a kite - - hit paydirt - - hold your head up high - - hold your horses - - hold your own - - hold your tongue - - honest as the day is long - - horns of a dilemma - - horse of a different color - - hot under the collar - - hour of need - - I beg to differ - - icing on the cake - - if the shoe fits - - if the shoe were on the other foot - - in a jam - - in a jiffy - - in a nutshell - - in a pig's eye - - in a pinch - - in a word - - in hot water - - in the gutter - - in the nick of time - - in the thick of it - - in your dreams - - it ain't over till the fat lady sings - - it goes without saying - - it takes all kinds - - it takes one to know one - - it's a small world - - it's only a matter of time - - ivory tower - - Jack of all trades - - jockey for position - - jog your memory - - joined at the hip - - judge a book by its cover - - jump down your throat - - jump in with both feet - - jump on the bandwagon - - jump the gun - - jump to conclusions - - just a hop, skip, and a jump - - just the ticket - - justice is blind - - keep a stiff upper lip - - keep an eye on - - keep it simple, stupid - - keep the home fires burning - - keep up with the Joneses - - keep your chin up - - keep your fingers crossed - - kick the bucket - - kick up your heels - - kick your feet up - - kid in a candy store - - kill two birds with one stone - - kiss of death - - knock it out of the park - - knock on wood - - knock your socks off - - know him from Adam - - know the ropes - - know the score - - knuckle down - - knuckle sandwich - - knuckle under - - labor of love - - ladder of success - - land on your feet - - lap of luxury - - last but not least - - last hurrah - - last-ditch effort - - law of the jungle - - law of the land - - lay down the law - - leaps and bounds - - let sleeping dogs lie - - let the cat out of the bag - - let the good times roll - - let your hair down - - let's talk turkey - - letter perfect - - lick your wounds - - lies like a rug - - life's a bitch - - life's a grind - - light at the end of the tunnel - - lighter than a feather - - lighter than air - - like clockwork - - like father like son - - like taking candy from a baby - - like there's no tomorrow - - lion's share - - live and learn - - live and let live - - long and short of it - - long lost love - - look before you leap - - look down your nose - - look what the cat dragged in - - looking a gift horse in the mouth - - looks like death warmed over - - loose cannon - - lose your head - - lose your temper - - loud as a horn - - lounge lizard - - loved and lost - - low man on the totem pole - - luck of the draw - - luck of the Irish - - make hay while the sun shines - - make money hand over fist - - make my day - - make the best of a bad situation - - make the best of it - - make your blood boil - - man of few words - - man's best friend - - mark my words - - meaningful dialogue - - missed the boat on that one - - moment in the sun - - moment of glory - - moment of truth - - money to burn - - more power to you - - more than one way to skin a cat - - movers and shakers - - moving experience - - naked as a jaybird - - naked truth - - neat as a pin - - needle in a haystack - - needless to say - - neither here nor there - - never look back - - never say never - - nip and tuck - - nip it in the bud - - no guts, no glory - - no love lost - - no pain, no gain - - no skin off my back - - no stone unturned - - no time like the present - - no use crying over spilled milk - - nose to the grindstone - - not a hope in hell - - not a minute's peace - - not in my backyard - - not playing with a full deck - - not the end of the world - - not written in stone - - nothing to sneeze at - - nothing ventured nothing gained - - now we're cooking - - off the top of my head - - off the wagon - - off the wall - - old hat - - older and wiser - - older than dirt - - older than Methuselah - - on a roll - - on cloud nine - - on pins and needles - - on the bandwagon - - on the money - - on the nose - - on the rocks - - on the spot - - on the tip of my tongue - - on the wagon - - on thin ice - - once bitten, twice shy - - one bad apple doesn't spoil the bushel - - one born every minute - - one brick short - - one foot in the grave - - one in a million - - one red cent - - only game in town - - open a can of worms - - open and shut case - - open the flood gates - - opportunity doesn't knock twice - - out of pocket - - out of sight, out of mind - - out of the frying pan into the fire - - out of the woods - - out on a limb - - over a barrel - - over the hump - - pain and suffering - - pain in the - - panic button - - par for the course - - part and parcel - - party pooper - - pass the buck - - patience is a virtue - - pay through the nose - - penny pincher - - perfect storm - - pig in a poke - - pile it on - - pillar of the community - - pin your hopes on - - pitter patter of little feet - - plain as day - - plain as the nose on your face - - play by the rules - - play your cards right - - playing the field - - playing with fire - - pleased as punch - - plenty of fish in the sea - - point with pride - - poor as a church mouse - - pot calling the kettle black - - pretty as a picture - - pull a fast one - - pull your punches - - pulling your leg - - pure as the driven snow - - put it in a nutshell - - put one over on you - - put the cart before the horse - - put the pedal to the metal - - put your best foot forward - - put your foot down - - quick as a bunny - - quick as a lick - - quick as a wink - - quick as lightning - - quiet as a dormouse - - rags to riches - - raining buckets - - raining cats and dogs - - rank and file - - rat race - - reap what you sow - - red as a beet - - red herring - - reinvent the wheel - - rich and famous - - rings a bell - - ripe old age - - ripped me off - - rise and shine - - road to hell is paved with good intentions - - rob Peter to pay Paul - - roll over in the grave - - rub the wrong way - - ruled the roost - - running in circles - - sad but true - - sadder but wiser - - salt of the earth - - scared stiff - - scared to death - - sealed with a kiss - - second to none - - see eye to eye - - seen the light - - seize the day - - set the record straight - - set the world on fire - - set your teeth on edge - - sharp as a tack - - shoot for the moon - - shoot the breeze - - shot in the dark - - shoulder to the wheel - - sick as a dog - - sigh of relief - - signed, sealed, and delivered - - sink or swim - - six of one, half a dozen of another - - skating on thin ice - - slept like a log - - slinging mud - - slippery as an eel - - slow as molasses - - smart as a whip - - smooth as a baby's bottom - - sneaking suspicion - - snug as a bug in a rug - - sow wild oats - - spare the rod, spoil the child - - speak of the devil - - spilled the beans - - spinning your wheels - - spitting image of - - spoke with relish - - spread like wildfire - - spring to life - - squeaky wheel gets the grease - - stands out like a sore thumb - - start from scratch - - stick in the mud - - still waters run deep - - stitch in time - - stop and smell the roses - - straight as an arrow - - straw that broke the camel's back - - strong as an ox - - stubborn as a mule - - stuff that dreams are made of - - stuffed shirt - - sweating blood - - sweating bullets - - take a load off - - take one for the team - - take the bait - - take the bull by the horns - - take the plunge - - takes one to know one - - takes two to tango - - the more the merrier - - the real deal - - the real McCoy - - the red carpet treatment - - the same old story - - there is no accounting for taste - - thick as a brick - - thick as thieves - - thin as a rail - - think outside of the box - - third time's the charm - - this day and age - - this hurts me worse than it hurts you - - this point in time - - three sheets to the wind - - through thick and thin - - throw in the towel - - tie one on - - tighter than a drum - - time and time again - - time is of the essence - - tip of the iceberg - - tired but happy - - to coin a phrase - - to each his own - - to make a long story short - - to the best of my knowledge - - toe the line - - tongue in cheek - - too good to be true - - too hot to handle - - too numerous to mention - - touch with a ten foot pole - - tough as nails - - trial and error - - trials and tribulations - - tried and true - - trip down memory lane - - twist of fate - - two cents worth - - two peas in a pod - - ugly as sin - - under the counter - - under the gun - - under the same roof - - under the weather - - until the cows come home - - unvarnished truth - - up the creek - - uphill battle - - upper crust - - upset the applecart - - vain attempt - - vain effort - - vanquish the enemy - - vested interest - - waiting for the other shoe to drop - - wakeup call - - warm welcome - - watch your p's and q's - - watch your tongue - - watching the clock - - water under the bridge - - weather the storm - - weed them out - - week of Sundays - - went belly up - - wet behind the ears - - what goes around comes around - - what you see is what you get - - when it rains, it pours - - when push comes to shove - - when the cat's away - - when the going gets tough, the tough get going - - white as a sheet - - whole ball of wax - - whole hog - - whole nine yards - - wild goose chase - - will wonders never cease? - - wisdom of the ages - - wise as an owl - - wolf at the door - - words fail me - - work like a dog - - world weary - - worst nightmare - - worth its weight in gold - - wrong side of the bed - - yanking your chain - - yappy as a dog - - years young - - you are what you eat - - you can run but you can't hide - - you only live once - - you're the boss - - young and foolish - - young and vibrant diff --git a/.github/styles/write-good/E-Prime.yml b/.github/styles/write-good/E-Prime.yml deleted file mode 100644 index 074a102b2..000000000 --- a/.github/styles/write-good/E-Prime.yml +++ /dev/null @@ -1,32 +0,0 @@ -extends: existence -message: "Try to avoid using '%s'." -ignorecase: true -level: suggestion -tokens: - - am - - are - - aren't - - be - - been - - being - - he's - - here's - - here's - - how's - - i'm - - is - - isn't - - it's - - she's - - that's - - there's - - they're - - was - - wasn't - - we're - - were - - weren't - - what's - - where's - - who's - - you're diff --git a/.github/styles/write-good/Illusions.yml b/.github/styles/write-good/Illusions.yml deleted file mode 100644 index b4f132185..000000000 --- a/.github/styles/write-good/Illusions.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: repetition -message: "'%s' is repeated!" -level: warning -alpha: true -action: - name: edit - params: - - truncate - - " " -tokens: - - '[^\s]+' diff --git a/.github/styles/write-good/Passive.yml b/.github/styles/write-good/Passive.yml deleted file mode 100644 index f472cb904..000000000 --- a/.github/styles/write-good/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' may be passive voice. Use active voice if you can." -ignorecase: true -level: warning -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/.github/styles/write-good/README.md b/.github/styles/write-good/README.md deleted file mode 100644 index 3edcc9b37..000000000 --- a/.github/styles/write-good/README.md +++ /dev/null @@ -1,27 +0,0 @@ -Based on [write-good](https://github.com/btford/write-good). - -> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. - -``` -The MIT License (MIT) - -Copyright (c) 2014 Brian Ford - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -``` diff --git a/.github/styles/write-good/So.yml b/.github/styles/write-good/So.yml deleted file mode 100644 index e57f099dc..000000000 --- a/.github/styles/write-good/So.yml +++ /dev/null @@ -1,5 +0,0 @@ -extends: existence -message: "Don't start a sentence with '%s'." -level: error -raw: - - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/.github/styles/write-good/ThereIs.yml b/.github/styles/write-good/ThereIs.yml deleted file mode 100644 index 8b82e8f6c..000000000 --- a/.github/styles/write-good/ThereIs.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "Don't start a sentence with '%s'." -ignorecase: false -level: error -raw: - - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' diff --git a/.github/styles/write-good/TooWordy.yml b/.github/styles/write-good/TooWordy.yml deleted file mode 100644 index 275701b19..000000000 --- a/.github/styles/write-good/TooWordy.yml +++ /dev/null @@ -1,221 +0,0 @@ -extends: existence -message: "'%s' is too wordy." -ignorecase: true -level: warning -tokens: - - a number of - - abundance - - accede to - - accelerate - - accentuate - - accompany - - accomplish - - accorded - - accrue - - acquiesce - - acquire - - additional - - adjacent to - - adjustment - - admissible - - advantageous - - adversely impact - - advise - - aforementioned - - aggregate - - aircraft - - all of - - all things considered - - alleviate - - allocate - - along the lines of - - already existing - - alternatively - - amazing - - ameliorate - - anticipate - - apparent - - appreciable - - as a matter of fact - - as a means of - - as far as I'm concerned - - as of yet - - as to - - as yet - - ascertain - - assistance - - at the present time - - at this time - - attain - - attributable to - - authorize - - because of the fact that - - belated - - benefit from - - bestow - - by means of - - by virtue of - - by virtue of the fact that - - cease - - close proximity - - commence - - comply with - - concerning - - consequently - - consolidate - - constitutes - - demonstrate - - depart - - designate - - discontinue - - due to the fact that - - each and every - - economical - - eliminate - - elucidate - - employ - - endeavor - - enumerate - - equitable - - equivalent - - evaluate - - evidenced - - exclusively - - expedite - - expend - - expiration - - facilitate - - factual evidence - - feasible - - finalize - - first and foremost - - for all intents and purposes - - for the most part - - for the purpose of - - forfeit - - formulate - - have a tendency to - - honest truth - - however - - if and when - - impacted - - implement - - in a manner of speaking - - in a timely manner - - in a very real sense - - in accordance with - - in addition - - in all likelihood - - in an effort to - - in between - - in excess of - - in lieu of - - in light of the fact that - - in many cases - - in my opinion - - in order to - - in regard to - - in some instances - - in terms of - - in the case of - - in the event that - - in the final analysis - - in the nature of - - in the near future - - in the process of - - inception - - incumbent upon - - indicate - - indication - - initiate - - irregardless - - is applicable to - - is authorized to - - is responsible for - - it is - - it is essential - - it seems that - - it was - - magnitude - - maximum - - methodology - - minimize - - minimum - - modify - - monitor - - multiple - - necessitate - - nevertheless - - not certain - - not many - - not often - - not unless - - not unlike - - notwithstanding - - null and void - - numerous - - objective - - obligate - - obtain - - on the contrary - - on the other hand - - one particular - - optimum - - overall - - owing to the fact that - - participate - - particulars - - pass away - - pertaining to - - point in time - - portion - - possess - - preclude - - previously - - prior to - - prioritize - - procure - - proficiency - - provided that - - purchase - - put simply - - readily apparent - - refer back - - regarding - - relocate - - remainder - - remuneration - - requirement - - reside - - residence - - retain - - satisfy - - shall - - should you wish - - similar to - - solicit - - span across - - strategize - - subsequent - - substantial - - successfully complete - - sufficient - - terminate - - the month of - - the point I am trying to make - - therefore - - time period - - took advantage of - - transmit - - transpire - - type of - - until such time as - - utilization - - utilize - - validate - - various different - - what I mean to say is - - whether or not - - with respect to - - with the exception of - - witnessed diff --git a/.github/styles/write-good/Weasel.yml b/.github/styles/write-good/Weasel.yml deleted file mode 100644 index e29391444..000000000 --- a/.github/styles/write-good/Weasel.yml +++ /dev/null @@ -1,207 +0,0 @@ -extends: existence -message: "'%s' is a weasel word!" -ignorecase: true -level: warning -tokens: - - absolutely - - accidentally - - additionally - - allegedly - - alternatively - - angrily - - anxiously - - approximately - - awkwardly - - badly - - barely - - beautifully - - blindly - - boldly - - bravely - - brightly - - briskly - - bristly - - bubbly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - clearly - - closely - - coldly - - completely - - consequently - - correctly - - courageously - - crinkly - - cruelly - - crumbly - - cuddly - - currently - - daily - - daringly - - deadly - - definitely - - deliberately - - doubtfully - - dumbly - - eagerly - - early - - easily - - elegantly - - enormously - - enthusiastically - - equally - - especially - - eventually - - exactly - - exceedingly - - exclusively - - extremely - - fairly - - faithfully - - fatally - - fiercely - - finally - - fondly - - few - - foolishly - - fortunately - - frankly - - frantically - - generously - - gently - - giggly - - gladly - - gracefully - - greedily - - happily - - hardly - - hastily - - healthily - - heartily - - helpfully - - honestly - - hourly - - hungrily - - hurriedly - - immediately - - impatiently - - inadequately - - ingeniously - - innocently - - inquisitively - - interestingly - - irritably - - jiggly - - joyously - - justly - - kindly - - largely - - lately - - lazily - - likely - - literally - - lonely - - loosely - - loudly - - loudly - - luckily - - madly - - many - - mentally - - mildly - - monthly - - mortally - - mostly - - mysteriously - - neatly - - nervously - - nightly - - noisily - - normally - - obediently - - occasionally - - only - - openly - - painfully - - particularly - - patiently - - perfectly - - politely - - poorly - - powerfully - - presumably - - previously - - promptly - - punctually - - quarterly - - quickly - - quietly - - rapidly - - rarely - - really - - recently - - recklessly - - regularly - - remarkably - - relatively - - reluctantly - - repeatedly - - rightfully - - roughly - - rudely - - sadly - - safely - - selfishly - - sensibly - - seriously - - sharply - - shortly - - shyly - - significantly - - silently - - simply - - sleepily - - slowly - - smartly - - smelly - - smoothly - - softly - - solemnly - - sparkly - - speedily - - stealthily - - sternly - - stupidly - - substantially - - successfully - - suddenly - - surprisingly - - suspiciously - - swiftly - - tenderly - - tensely - - thoughtfully - - tightly - - timely - - truthfully - - unexpectedly - - unfortunately - - usually - - very - - victoriously - - violently - - vivaciously - - warmly - - waverly - - weakly - - wearily - - weekly - - wildly - - wisely - - worldly - - wrinkly - - yearly diff --git a/.github/styles/write-good/meta.json b/.github/styles/write-good/meta.json deleted file mode 100644 index a115d2886..000000000 --- a/.github/styles/write-good/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/write-good/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml deleted file mode 100644 index ee0224dfa..000000000 --- a/.github/workflows/vale.yaml +++ /dev/null @@ -1,23 +0,0 @@ -name: Lint with Vale on pull request -on: - [pull_request] - -jobs: - vale: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Get Changed Files - id: get_changed_files - uses: lots0logs/gh-action-get-changed-files@2.2.2 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Vale - uses: errata-ai/vale-action@reviewdog - with: - files: '${{ steps.get_changed_files.outputs.all }}' - fail_on_error: true - filter_mode: file - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/vale.ini b/vale.ini deleted file mode 100644 index 4c550159f..000000000 --- a/vale.ini +++ /dev/null @@ -1,19 +0,0 @@ -StylesPath = .github/styles -MinAlertLevel = warning -IgnoredScopes = code, tt, table, tr, td - -Vocab = Docs - -Packages = Microsoft, write-good - -[formats] -mdx = md - -[*.md] -BasedOnStyles = Apify, write-good, Microsoft - -# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. -TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*) (http[^\n]+\[) - -# Disabling rules -Microsoft.Quotes = NO From a69ef4ab58351a08d3c6af29d173cb9514d1b8d2 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:44:06 +0100 Subject: [PATCH 25/57] add vale setup for testing --- .github/workflows/vale.yaml | 23 +++++++++++++++++++++++ vale.ini | 19 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 .github/workflows/vale.yaml create mode 100644 vale.ini diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml new file mode 100644 index 000000000..ee0224dfa --- /dev/null +++ b/.github/workflows/vale.yaml @@ -0,0 +1,23 @@ +name: Lint with Vale on pull request +on: + [pull_request] + +jobs: + vale: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Get Changed Files + id: get_changed_files + uses: lots0logs/gh-action-get-changed-files@2.2.2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + - name: Vale + uses: errata-ai/vale-action@reviewdog + with: + files: '${{ steps.get_changed_files.outputs.all }}' + fail_on_error: true + filter_mode: file + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/vale.ini b/vale.ini new file mode 100644 index 000000000..4c550159f --- /dev/null +++ b/vale.ini @@ -0,0 +1,19 @@ +StylesPath = .github/styles +MinAlertLevel = warning +IgnoredScopes = code, tt, table, tr, td + +Vocab = Docs + +Packages = Microsoft, write-good + +[formats] +mdx = md + +[*.md] +BasedOnStyles = Apify, write-good, Microsoft + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*) (http[^\n]+\[) + +# Disabling rules +Microsoft.Quotes = NO From 95f0552c585b21e80f72e292e13355c07c00a412 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:50:57 +0100 Subject: [PATCH 26/57] remove styles dir remove msoft style guide dir & writegood dir --- .gitignore | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 2333ee5bc..669a7ccf9 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,4 @@ sources/typedefs tsconfig.tsbuildinfo .turbo apify-docs-theme/package-lock.json -.github/styles/* -!.github/styles/Vocab -!.github/styles/Apify + From 479bda00ee48c2eeb552f8f74dac13990b8a77b6 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:51:26 +0100 Subject: [PATCH 27/57] add styles dir to gitignore --- .gitignore | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 669a7ccf9..2333ee5bc 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,6 @@ sources/typedefs tsconfig.tsbuildinfo .turbo apify-docs-theme/package-lock.json - +.github/styles/* +!.github/styles/Vocab +!.github/styles/Apify From 87487469253cf6195e078ec981e4cf65679bdff7 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:54:15 +0100 Subject: [PATCH 28/57] test - change branch of action --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index ee0224dfa..84e892be9 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -14,7 +14,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} - name: Vale - uses: errata-ai/vale-action@reviewdog + uses: errata-ai/vale-action@master with: files: '${{ steps.get_changed_files.outputs.all }}' fail_on_error: true From 91689ce02843e4319eebf6342152c60f29379385 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:54:59 +0100 Subject: [PATCH 29/57] revert change action branch --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 84e892be9..ee0224dfa 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -14,7 +14,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} - name: Vale - uses: errata-ai/vale-action@master + uses: errata-ai/vale-action@reviewdog with: files: '${{ steps.get_changed_files.outputs.all }}' fail_on_error: true From 63c2829763e37c6ed2c4788f5c4d4b694c7d3df3 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 12:56:42 +0100 Subject: [PATCH 30/57] remove unnecessary filter mode from action workflow --- .github/workflows/vale.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index ee0224dfa..9e9253e58 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -18,6 +18,5 @@ jobs: with: files: '${{ steps.get_changed_files.outputs.all }}' fail_on_error: true - filter_mode: file env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From a2db4f67dd245377f8e4755390a5f289b5cb9956 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 13:01:18 +0100 Subject: [PATCH 31/57] change steps to get modified, added & renamed files --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 9e9253e58..c8e361a40 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -16,7 +16,7 @@ jobs: - name: Vale uses: errata-ai/vale-action@reviewdog with: - files: '${{ steps.get_changed_files.outputs.all }}' + files: '["${{ steps.get_changed_files.outputs.added }}", "${{ steps.get_changed_files.outputs.modified }}", "${{ steps.get_changed_files.outputs.renamed }}"]' fail_on_error: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 43a046c69d5cbf5359c84e817ee3b5ee3f7221c4 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 13:13:18 +0100 Subject: [PATCH 32/57] test __onlyModified flag instead of separate gh action --- .github/workflows/vale.yaml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index c8e361a40..3e964d6ac 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -8,15 +8,10 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 - - name: Get Changed Files - id: get_changed_files - uses: lots0logs/gh-action-get-changed-files@2.2.2 - with: - token: ${{ secrets.GITHUB_TOKEN }} - name: Vale uses: errata-ai/vale-action@reviewdog with: - files: '["${{ steps.get_changed_files.outputs.added }}", "${{ steps.get_changed_files.outputs.modified }}", "${{ steps.get_changed_files.outputs.renamed }}"]' + files: __onlyModified fail_on_error: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From ec4e9db784d16ba1678892872ed281ca8f85b3c1 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 13:45:30 +0100 Subject: [PATCH 33/57] change approach to change files generation --- .github/workflows/vale.yaml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 3e964d6ac..6dde6247e 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -8,10 +8,18 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + - name: Get Changed Files + id: get_changed_files + uses: lots0logs/gh-action-get-changed-files@2.2.2 + with: + token: ${{ secrets.GITHUB_TOKEN }} - name: Vale uses: errata-ai/vale-action@reviewdog with: - files: __onlyModified + files: | + '${{ steps.get_changed_files.outputs.added }}' + '${{ steps.get_changed_files.outputs.modified }}' + '${{ steps.get_changed_files.outputs.renamed }}' fail_on_error: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 1c09399e834b1f632c3d8d745f6ba8511d202164 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 13:47:29 +0100 Subject: [PATCH 34/57] change approach to changed files generation use three different jobs to generate changed files and lint them --- .github/workflows/vale.yaml | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 6dde6247e..7a58b6172 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -2,6 +2,8 @@ name: Lint with Vale on pull request on: [pull_request] +env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} jobs: vale: runs-on: ubuntu-latest @@ -13,13 +15,18 @@ jobs: uses: lots0logs/gh-action-get-changed-files@2.2.2 with: token: ${{ secrets.GITHUB_TOKEN }} - - name: Vale + - name: Vale-added uses: errata-ai/vale-action@reviewdog with: - files: | - '${{ steps.get_changed_files.outputs.added }}' - '${{ steps.get_changed_files.outputs.modified }}' - '${{ steps.get_changed_files.outputs.renamed }}' + files: ${{ steps.get_changed_files.outputs.added }} + fail_on_error: true + - name: Vale-modified + uses: errata-ai/vale-action@reviewdog + with: + files: ${{ steps.get_changed_files.outputs.modified }} + fail_on_error: true + - name: Vale-renamed + uses: errata-ai/vale-action@reviewdog + with: + files: ${{ steps.get_changed_files.outputs.renamed }} fail_on_error: true - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 05d1726b8c0ecb1cf4a59be83b3e3b16085fc675 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 13:59:20 +0100 Subject: [PATCH 35/57] fix vale errors --- sources/platform/index.mdx | 2 +- vale.ini | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sources/platform/index.mdx b/sources/platform/index.mdx index 0707100ae..2f4f124cc 100644 --- a/sources/platform/index.mdx +++ b/sources/platform/index.mdx @@ -11,7 +11,7 @@ import homepageContent from "./homepage_content.json"; # Apify platform -> **apify** is a cloud platform that helps you build reliable web scrapers, fast, and automate anything you can do manually in a web browser. +> **Apify** is a cloud platform that helps you build reliable web scrapers, fast, and automate anything you can do manually in a web browser. > > **Actors** are serverless cloud programs running on the Apify platform that can easily crawl websites with millions of pages, but also perform arbitrary computing jobs such as sending emails or data transformations. They can be started manually, using our API or scheduler, and they can be easily integrated with other apps. diff --git a/vale.ini b/vale.ini index 4c550159f..3bee996e1 100644 --- a/vale.ini +++ b/vale.ini @@ -13,7 +13,7 @@ mdx = md BasedOnStyles = Apify, write-good, Microsoft # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. -TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*) (http[^\n]+\[) +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\[(?=.*\.com(?:\/.*)?).+?]) # Disabling rules Microsoft.Quotes = NO From 58c4249f7047ffa9385c6c0a4045868fc326fbf8 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 14:03:21 +0100 Subject: [PATCH 36/57] remove Microsoft package remove Microsoft Style Guide --- vale.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vale.ini b/vale.ini index 3bee996e1..03fe18c26 100644 --- a/vale.ini +++ b/vale.ini @@ -4,13 +4,13 @@ IgnoredScopes = code, tt, table, tr, td Vocab = Docs -Packages = Microsoft, write-good +Packages = write-good [formats] mdx = md [*.md] -BasedOnStyles = Apify, write-good, Microsoft +BasedOnStyles = Apify, write-good # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\[(?=.*\.com(?:\/.*)?).+?]) From 94f3a6680c40798489c90a48db23b8fb90b99221 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Thu, 21 Dec 2023 14:05:08 +0100 Subject: [PATCH 37/57] remove unnecassary rule disable --- vale.ini | 3 --- 1 file changed, 3 deletions(-) diff --git a/vale.ini b/vale.ini index 03fe18c26..476873f0d 100644 --- a/vale.ini +++ b/vale.ini @@ -14,6 +14,3 @@ BasedOnStyles = Apify, write-good # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\[(?=.*\.com(?:\/.*)?).+?]) - -# Disabling rules -Microsoft.Quotes = NO From f246ce751bf1e33732d0dbd149112ea25ab71c73 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 12:44:40 +0100 Subject: [PATCH 38/57] test new approach with files filtering add new action to filter files only within sources directory and README.md and CONTRIBUTING.md change action to get only modified files setup vale to run only on modified files --- .github/workflows/vale.yaml | 59 +++++++++++++++++++------------------ 1 file changed, 31 insertions(+), 28 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 7a58b6172..8f5b3e8a0 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -1,32 +1,35 @@ -name: Lint with Vale on pull request -on: - [pull_request] +name: Linting Workflow + +on: [pull_request] env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} jobs: - vale: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Get Changed Files - id: get_changed_files - uses: lots0logs/gh-action-get-changed-files@2.2.2 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Vale-added - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.get_changed_files.outputs.added }} - fail_on_error: true - - name: Vale-modified - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.get_changed_files.outputs.modified }} - fail_on_error: true - - name: Vale-renamed - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.get_changed_files.outputs.renamed }} - fail_on_error: true + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + # Filter paths + - uses: dorny/paths-filter@v2 + id: changes + with: + filters: | + sources: + - 'sources/**' + root_files: + - 'README.md' + - 'CONTRIBUTING.md' + + # Get changed files + - uses: tj-actions/changed-files@v40 + id: changed_files + with: + only_changed: true + + # Run Vale only if specified files are changed + - name: Run Vale Linter + if: steps.changes.outputs.sources == 'true' || steps.changes.outputs.root_files == 'true' + uses: errata-ai/vale-action@vreviewdog + with: + files: ${{ steps.changed_files.outputs.all_changed_files }} From 57814c6db23599b65a2905f831d4934fd22c9cfa Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 12:45:24 +0100 Subject: [PATCH 39/57] fix typo --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 8f5b3e8a0..97bd8a1e5 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -30,6 +30,6 @@ jobs: # Run Vale only if specified files are changed - name: Run Vale Linter if: steps.changes.outputs.sources == 'true' || steps.changes.outputs.root_files == 'true' - uses: errata-ai/vale-action@vreviewdog + uses: errata-ai/vale-action@reviewdog with: files: ${{ steps.changed_files.outputs.all_changed_files }} From a9d8020b4a5e8d02e06fd7f9dd710992d3bd8e08 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 12:58:32 +0100 Subject: [PATCH 40/57] fix test workflow remove unnecessary filter-paths action --- .github/workflows/vale.yaml | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 97bd8a1e5..6cf76fb3e 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -10,26 +10,18 @@ jobs: steps: - uses: actions/checkout@v4 - # Filter paths - - uses: dorny/paths-filter@v2 - id: changes - with: - filters: | - sources: - - 'sources/**' - root_files: - - 'README.md' - - 'CONTRIBUTING.md' - # Get changed files - uses: tj-actions/changed-files@v40 id: changed_files with: - only_changed: true + files: | + README.md + CONTRIBUTING.md + sources/* # Run Vale only if specified files are changed - name: Run Vale Linter - if: steps.changes.outputs.sources == 'true' || steps.changes.outputs.root_files == 'true' + if: steps.changed_files.outputs.any_changed_files == 'true' uses: errata-ai/vale-action@reviewdog with: files: ${{ steps.changed_files.outputs.all_changed_files }} From 17980f1c59511beada7a9cf9ea1669dfee3a7c5f Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 13:00:52 +0100 Subject: [PATCH 41/57] changes to Contributing.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e082c2f7e..1355a4f67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Architecture -Currently, there are 6 separate repositories that together make up the Apify documentation: +Apify documentation consists of six different repositories: - apify-client-js - apify-client-python From ad183409875e83dc0409a2d81f2c8357debb6b02 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 13:05:57 +0100 Subject: [PATCH 42/57] test changes to withing sources dir --- sources/platform/schedules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/schedules.md b/sources/platform/schedules.md index fbe88ecc2..762b559bb 100644 --- a/sources/platform/schedules.md +++ b/sources/platform/schedules.md @@ -16,7 +16,7 @@ Schedules allow you to run your Actors and tasks at specific times. You schedule Schedules allow timezone settings and support daylight saving time shifts (DST). ::: -There are few ways you can set up and manage your Schedules: +You can set up and manage your Schedules using: * [Apify Console](https://console.apify.com/schedules) * [Apify API](https://docs.apify.com/api/v2#/reference/schedules) From f272c66ca8781e5a499d117b8ae416c9267978ce Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 13:24:43 +0100 Subject: [PATCH 43/57] test action --- .github/workflows/vale.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 6cf76fb3e..096831539 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -21,7 +21,7 @@ jobs: # Run Vale only if specified files are changed - name: Run Vale Linter - if: steps.changed_files.outputs.any_changed_files == 'true' + if: steps.changed_files.outputs.any_changed == 'true' uses: errata-ai/vale-action@reviewdog with: - files: ${{ steps.changed_files.outputs.all_changed_files }} + files: ${{ steps.changed_files.outputs.any_changed }} From 75b2f11126c7a1c7c1bffdb0009902d5ff4be658 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 13:28:16 +0100 Subject: [PATCH 44/57] vale test --- sources/platform/schedules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/schedules.md b/sources/platform/schedules.md index 762b559bb..e0a8de72e 100644 --- a/sources/platform/schedules.md +++ b/sources/platform/schedules.md @@ -27,7 +27,7 @@ When scheduling a new Actor or task run, you can override its input settings usi :::note Events Startup Variability In most cases, scheduled events are fired within one second of their scheduled time.
-Occasionally, however, runs can be delayed because of a system overload or a server shutting down. +However, runs can be delayed because of a system overload or a server shutting down. ::: Each schedule can be associated with a maximum of _10_ Actors and _10_ Actor tasks. From 3c9985b0e27973f7300513d56f9a7fa78ec7331d Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 13:31:12 +0100 Subject: [PATCH 45/57] revert changes to vale workflow --- .github/workflows/vale.yaml | 51 ++++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 096831539..7a58b6172 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -1,27 +1,32 @@ -name: Linting Workflow - -on: [pull_request] +name: Lint with Vale on pull request +on: + [pull_request] env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} jobs: - lint: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - # Get changed files - - uses: tj-actions/changed-files@v40 - id: changed_files - with: - files: | - README.md - CONTRIBUTING.md - sources/* - - # Run Vale only if specified files are changed - - name: Run Vale Linter - if: steps.changed_files.outputs.any_changed == 'true' - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.changed_files.outputs.any_changed }} + vale: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Get Changed Files + id: get_changed_files + uses: lots0logs/gh-action-get-changed-files@2.2.2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + - name: Vale-added + uses: errata-ai/vale-action@reviewdog + with: + files: ${{ steps.get_changed_files.outputs.added }} + fail_on_error: true + - name: Vale-modified + uses: errata-ai/vale-action@reviewdog + with: + files: ${{ steps.get_changed_files.outputs.modified }} + fail_on_error: true + - name: Vale-renamed + uses: errata-ai/vale-action@reviewdog + with: + files: ${{ steps.get_changed_files.outputs.renamed }} + fail_on_error: true From 6be230720ac2810091401e878336def6b41b9bcf Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 13:33:47 +0100 Subject: [PATCH 46/57] fix contributing.md vale errors --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1355a4f67..bd23177aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ The theme is available on npm as `@apify/docs-theme` and can be installed in any #### Publishing the theme -There is a GitHub Action that automatically publishes the theme to npm whenever any changes are pushed to the `master` branch. However, this only happens if you update the version in the `package.json` file manually - if the current version already exists on npm, the publish will be skipped. +A GitHub Action automatically publishes the theme to npm whenever any changes are pushed to the `master` branch. However, this only happens if you update the version in the `package.json` file manually - if the current version already exists on npm, the publish will be skipped. Additionally, if there are any changes to the `apify-docs-theme` folder detected, the GitHub action will invoke docs builds in all the subprojects to make sure that all the pages are using the latest theme version. This is done in the `rebuild-docs` job. This job utilizes a matrix strategy to run the builds in parallel. The actual rebuild is initiated by the `workflow_dispatch` event in the respective repositories. Because of this, the `GITHUB_TOKEN` env var has to be replaced by the PAT token stored in the `GH_TOKEN` secret - the original token does not have the necessary permissions to trigger the workflows in other repositories. @@ -51,11 +51,11 @@ After updating the API docs, you should ALWAYS log into [Apiary](https://apiary. The homepage menu card items are in the `docs/homepage_content.json` file. The cards aim to suit three types of use cases: -- Beginners and people who just want to use the actors (**Get started**, **Use actors and scrapers**). +- Beginners and people who just want to use the Actors (**Get started**, **Use Actors and scrapers**). -- Experienced actor and platform users (**Reduce blocking**, **Use platform features**). +- Experienced Actor and platform users (**Reduce blocking**, **Use platform features**). -- Actor builders and advanced users (**Build actors**, **Advanced tutorials and debugging**). +- Actor builders and advanced users (**Build Actors**, **Advanced tutorials and debugging**). Each item has its own JSON object, in which "cardItem" is the title and "href" is the link. If the link leads to outside the Apify Docs site, add the `"isExternalLink": true` property. For local links, just use the article's path. E.g. `"/tutorials/apify-scrapers/web-scraper"`. @@ -121,7 +121,7 @@ server { } ``` -And add a record to `/etc/hosts` to map the docs.apify.loc hostname to localhost: +And add a record to `/etc/hosts` to map the `docs.apify.loc` hostname to localhost: ```text 127.0.0.1 docs.apify.loc From 8a9982d9f8f1ddcd775d7fde8bda448cbe0cdb76 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 15:32:49 +0100 Subject: [PATCH 47/57] vale action test --- .github/workflows/vale.yaml | 54 +++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 30 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 7a58b6172..7001eeb06 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -1,32 +1,26 @@ -name: Lint with Vale on pull request -on: - [pull_request] +name: Vale + +on: [pull_request] -env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} jobs: - vale: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Get Changed Files - id: get_changed_files - uses: lots0logs/gh-action-get-changed-files@2.2.2 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Vale-added - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.get_changed_files.outputs.added }} - fail_on_error: true - - name: Vale-modified - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.get_changed_files.outputs.modified }} - fail_on_error: true - - name: Vale-renamed - uses: errata-ai/vale-action@reviewdog - with: - files: ${{ steps.get_changed_files.outputs.renamed }} - fail_on_error: true + vale: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Get changed files + id: changed-files + uses: tj-actions/changed-files@v40.2.0 + with: + files: | + '**/*.md' + '**/*.mdx' + separator: "," + + - uses: errata-ai/vale-action@reviewdog + if: steps.changed-files.outputs.any_changed == "true" + with: + files: ${{ steps.changed-files.outputs.all_changed_files }} + separator: "," + fail_on_error: true From 2f64a089325142f55e67a52d1ab96b5ba0a27a93 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 15:34:44 +0100 Subject: [PATCH 48/57] fix symbol --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 7001eeb06..60eb491ec 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -19,7 +19,7 @@ jobs: separator: "," - uses: errata-ai/vale-action@reviewdog - if: steps.changed-files.outputs.any_changed == "true" + if: steps.changed-files.outputs.any_changed == 'true' with: files: ${{ steps.changed-files.outputs.all_changed_files }} separator: "," From ee298b76a73fa35e007844f13cfeae570449c545 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 15:36:57 +0100 Subject: [PATCH 49/57] add test error --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd23177aa..87cbb54bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,7 +121,7 @@ server { } ``` -And add a record to `/etc/hosts` to map the `docs.apify.loc` hostname to localhost: +And add a record to `/etc/hosts` to map the docs.apify.loc hostname to localhost: ```text 127.0.0.1 docs.apify.loc From 8292ddd665a06c2afed21fe8397a16f6bcb57721 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 15:45:30 +0100 Subject: [PATCH 50/57] add fetch-depth --- .github/workflows/vale.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 60eb491ec..6969c4299 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -8,14 +8,15 @@ jobs: steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Get changed files id: changed-files - uses: tj-actions/changed-files@v40.2.0 + uses: tj-actions/changed-files@v40.2.3 with: files: | - '**/*.md' - '**/*.mdx' + **/*.{md,mdx} separator: "," - uses: errata-ai/vale-action@reviewdog From 599840b7d03b418e5a77baf9ad9be8325439f22b Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 15:47:03 +0100 Subject: [PATCH 51/57] fix vale error --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87cbb54bd..bd23177aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,7 +121,7 @@ server { } ``` -And add a record to `/etc/hosts` to map the docs.apify.loc hostname to localhost: +And add a record to `/etc/hosts` to map the `docs.apify.loc` hostname to localhost: ```text 127.0.0.1 docs.apify.loc From d0f6e02283eeaafd970a2f7c5e3cd76e0df82d1a Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 16:08:20 +0100 Subject: [PATCH 52/57] add reporter flag to reviewdog --- .github/workflows/vale.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 6969c4299..0eaafe7cd 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -25,3 +25,4 @@ jobs: files: ${{ steps.changed-files.outputs.all_changed_files }} separator: "," fail_on_error: true + reporter: github-pr-check From 85e30a5a5f77c4d133c6eedb33fc525edec92b23 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 16:16:24 +0100 Subject: [PATCH 53/57] change reporter flag --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 0eaafe7cd..827b4fcfc 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -25,4 +25,4 @@ jobs: files: ${{ steps.changed-files.outputs.all_changed_files }} separator: "," fail_on_error: true - reporter: github-pr-check + reporter: github-check From 9a47676efc32787c33db5c842f64188358a8cbd9 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 16:17:29 +0100 Subject: [PATCH 54/57] Revert "change reporter flag" This reverts commit 85e30a5a5f77c4d133c6eedb33fc525edec92b23. --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 827b4fcfc..0eaafe7cd 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -25,4 +25,4 @@ jobs: files: ${{ steps.changed-files.outputs.all_changed_files }} separator: "," fail_on_error: true - reporter: github-check + reporter: github-pr-check From 37f3a697e0009d42b27643579ce146266ed4b79c Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 22 Dec 2023 16:19:10 +0100 Subject: [PATCH 55/57] . --- .github/workflows/vale.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yaml b/.github/workflows/vale.yaml index 0eaafe7cd..6a9b4e9d2 100644 --- a/.github/workflows/vale.yaml +++ b/.github/workflows/vale.yaml @@ -3,7 +3,7 @@ name: Vale on: [pull_request] jobs: - vale: + lint: runs-on: ubuntu-latest steps: From 48712af467027e7a2600c01fee9a8850cba477d8 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 5 Jan 2024 10:27:52 +0100 Subject: [PATCH 56/57] add msoft styleguide to vale.ini add msoft style guide to vale.ini make vale check .md and .mdx files based on write-good, Apify & Microsoft rules remove /styles from .gitignore --- .github/styles/Apify/Apify.yml | 2 +- .github/styles/Microsoft/AMPM.yml | 9 + .github/styles/Microsoft/Accessibility.yml | 25 + .github/styles/Microsoft/Acronyms.yml | 64 ++ .github/styles/Microsoft/Adverbs.yml | 270 +++++++ .github/styles/Microsoft/Auto.yml | 11 + .github/styles/Microsoft/Avoid.yml | 14 + .github/styles/Microsoft/ComplexWords.yml | 120 +++ .github/styles/Microsoft/Contractions.yml | 50 ++ .github/styles/Microsoft/Dashes.yml | 13 + .github/styles/Microsoft/DateFormat.yml | 8 + .github/styles/Microsoft/DateNumbers.yml | 40 + .github/styles/Microsoft/DateOrder.yml | 8 + .github/styles/Microsoft/Ellipses.yml | 9 + .github/styles/Microsoft/FirstPerson.yml | 16 + .github/styles/Microsoft/Foreign.yml | 13 + .github/styles/Microsoft/Gender.yml | 8 + .github/styles/Microsoft/GenderBias.yml | 44 ++ .github/styles/Microsoft/GeneralURL.yml | 11 + .github/styles/Microsoft/HeadingAcronyms.yml | 7 + .github/styles/Microsoft/HeadingColons.yml | 8 + .../styles/Microsoft/HeadingPunctuation.yml | 13 + .github/styles/Microsoft/Headings.yml | 28 + .github/styles/Microsoft/Hyphens.yml | 14 + .github/styles/Microsoft/Negative.yml | 13 + .github/styles/Microsoft/Ordinal.yml | 13 + .github/styles/Microsoft/OxfordComma.yml | 8 + .github/styles/Microsoft/Passive.yml | 183 +++++ .github/styles/Microsoft/Percentages.yml | 7 + .github/styles/Microsoft/Quotes.yml | 7 + .github/styles/Microsoft/RangeFormat.yml | 13 + .github/styles/Microsoft/RangeTime.yml | 13 + .github/styles/Microsoft/Ranges.yml | 7 + .github/styles/Microsoft/Semicolon.yml | 8 + .github/styles/Microsoft/SentenceLength.yml | 7 + .github/styles/Microsoft/Spacing.yml | 8 + .github/styles/Microsoft/Suspended.yml | 7 + .github/styles/Microsoft/Terms.yml | 41 + .github/styles/Microsoft/URLFormat.yml | 10 + .github/styles/Microsoft/Units.yml | 16 + .github/styles/Microsoft/Vocab.yml | 25 + .github/styles/Microsoft/We.yml | 11 + .github/styles/Microsoft/Wordiness.yml | 122 +++ .github/styles/Microsoft/meta.json | 4 + .github/styles/write-good/Cliches.yml | 702 ++++++++++++++++++ .github/styles/write-good/E-Prime.yml | 32 + .github/styles/write-good/Illusions.yml | 11 + .github/styles/write-good/Passive.yml | 183 +++++ .github/styles/write-good/README.md | 27 + .github/styles/write-good/So.yml | 5 + .github/styles/write-good/ThereIs.yml | 6 + .github/styles/write-good/TooWordy.yml | 221 ++++++ .github/styles/write-good/Weasel.yml | 207 ++++++ .github/styles/write-good/meta.json | 4 + .gitignore | 3 - vale.ini | 4 +- 56 files changed, 2727 insertions(+), 6 deletions(-) create mode 100644 .github/styles/Microsoft/AMPM.yml create mode 100644 .github/styles/Microsoft/Accessibility.yml create mode 100644 .github/styles/Microsoft/Acronyms.yml create mode 100644 .github/styles/Microsoft/Adverbs.yml create mode 100644 .github/styles/Microsoft/Auto.yml create mode 100644 .github/styles/Microsoft/Avoid.yml create mode 100644 .github/styles/Microsoft/ComplexWords.yml create mode 100644 .github/styles/Microsoft/Contractions.yml create mode 100644 .github/styles/Microsoft/Dashes.yml create mode 100644 .github/styles/Microsoft/DateFormat.yml create mode 100644 .github/styles/Microsoft/DateNumbers.yml create mode 100644 .github/styles/Microsoft/DateOrder.yml create mode 100644 .github/styles/Microsoft/Ellipses.yml create mode 100644 .github/styles/Microsoft/FirstPerson.yml create mode 100644 .github/styles/Microsoft/Foreign.yml create mode 100644 .github/styles/Microsoft/Gender.yml create mode 100644 .github/styles/Microsoft/GenderBias.yml create mode 100644 .github/styles/Microsoft/GeneralURL.yml create mode 100644 .github/styles/Microsoft/HeadingAcronyms.yml create mode 100644 .github/styles/Microsoft/HeadingColons.yml create mode 100644 .github/styles/Microsoft/HeadingPunctuation.yml create mode 100644 .github/styles/Microsoft/Headings.yml create mode 100644 .github/styles/Microsoft/Hyphens.yml create mode 100644 .github/styles/Microsoft/Negative.yml create mode 100644 .github/styles/Microsoft/Ordinal.yml create mode 100644 .github/styles/Microsoft/OxfordComma.yml create mode 100644 .github/styles/Microsoft/Passive.yml create mode 100644 .github/styles/Microsoft/Percentages.yml create mode 100644 .github/styles/Microsoft/Quotes.yml create mode 100644 .github/styles/Microsoft/RangeFormat.yml create mode 100644 .github/styles/Microsoft/RangeTime.yml create mode 100644 .github/styles/Microsoft/Ranges.yml create mode 100644 .github/styles/Microsoft/Semicolon.yml create mode 100644 .github/styles/Microsoft/SentenceLength.yml create mode 100644 .github/styles/Microsoft/Spacing.yml create mode 100644 .github/styles/Microsoft/Suspended.yml create mode 100644 .github/styles/Microsoft/Terms.yml create mode 100644 .github/styles/Microsoft/URLFormat.yml create mode 100644 .github/styles/Microsoft/Units.yml create mode 100644 .github/styles/Microsoft/Vocab.yml create mode 100644 .github/styles/Microsoft/We.yml create mode 100644 .github/styles/Microsoft/Wordiness.yml create mode 100644 .github/styles/Microsoft/meta.json create mode 100644 .github/styles/write-good/Cliches.yml create mode 100644 .github/styles/write-good/E-Prime.yml create mode 100644 .github/styles/write-good/Illusions.yml create mode 100644 .github/styles/write-good/Passive.yml create mode 100644 .github/styles/write-good/README.md create mode 100644 .github/styles/write-good/So.yml create mode 100644 .github/styles/write-good/ThereIs.yml create mode 100644 .github/styles/write-good/TooWordy.yml create mode 100644 .github/styles/write-good/Weasel.yml create mode 100644 .github/styles/write-good/meta.json diff --git a/.github/styles/Apify/Apify.yml b/.github/styles/Apify/Apify.yml index ad6fdcbad..7a41fb494 100644 --- a/.github/styles/Apify/Apify.yml +++ b/.github/styles/Apify/Apify.yml @@ -4,7 +4,7 @@ ignorecase: false level: warning swap: Apify Dashboard: Apify Console - apify freelancers: Apify Freelancers + apify freelancers: Apify freelancers Apify Platfrom: Apify platform '(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy circa: approx. diff --git a/.github/styles/Microsoft/AMPM.yml b/.github/styles/Microsoft/AMPM.yml new file mode 100644 index 000000000..8b9fed162 --- /dev/null +++ b/.github/styles/Microsoft/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: Use 'AM' or 'PM' (preceded by a space). +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.github/styles/Microsoft/Accessibility.yml b/.github/styles/Microsoft/Accessibility.yml new file mode 100644 index 000000000..05bf92739 --- /dev/null +++ b/.github/styles/Microsoft/Accessibility.yml @@ -0,0 +1,25 @@ +extends: existence +message: "Don't use language (such as '%s') that defines people by their disability." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms +level: suggestion +ignorecase: true +tokens: + - a victim of + - able-bodied + - affected by + - an epileptic + - crippled + - disabled + - dumb + - handicapped + - handicaps + - healthy + - lame + - maimed + - missing a limb + - mute + - normal + - sight-impaired + - stricken with + - suffers from + - vision-impaired diff --git a/.github/styles/Microsoft/Acronyms.yml b/.github/styles/Microsoft/Acronyms.yml new file mode 100644 index 000000000..308ff7c0e --- /dev/null +++ b/.github/styles/Microsoft/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "'%s' has no definition." +link: https://docs.microsoft.com/en-us/style-guide/acronyms +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/.github/styles/Microsoft/Adverbs.yml b/.github/styles/Microsoft/Adverbs.yml new file mode 100644 index 000000000..07d98d83e --- /dev/null +++ b/.github/styles/Microsoft/Adverbs.yml @@ -0,0 +1,270 @@ +extends: existence +message: "Consider removing '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: warning +action: + name: remove +tokens: + - abnormally + - absentmindedly + - accidentally + - adventurously + - anxiously + - arrogantly + - awkwardly + - bashfully + - beautifully + - bitterly + - bleakly + - blindly + - blissfully + - boastfully + - boldly + - bravely + - briefly + - brightly + - briskly + - broadly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - cleverly + - closely + - coaxingly + - colorfully + - continually + - coolly + - courageously + - crossly + - cruelly + - curiously + - daintily + - dearly + - deceivingly + - deeply + - defiantly + - deliberately + - delightfully + - diligently + - dimly + - doubtfully + - dreamily + - easily + - elegantly + - energetically + - enormously + - enthusiastically + - excitedly + - extremely + - fairly + - faithfully + - famously + - ferociously + - fervently + - fiercely + - fondly + - foolishly + - fortunately + - frankly + - frantically + - freely + - frenetically + - frightfully + - furiously + - generally + - generously + - gently + - gladly + - gleefully + - gracefully + - gratefully + - greatly + - greedily + - happily + - hastily + - healthily + - heavily + - helplessly + - honestly + - hopelessly + - hungrily + - innocently + - inquisitively + - intensely + - intently + - interestingly + - inwardly + - irritably + - jaggedly + - jealously + - jovially + - joyfully + - joyously + - jubilantly + - judgmentally + - justly + - keenly + - kiddingly + - kindheartedly + - knavishly + - knowingly + - knowledgeably + - lazily + - lightly + - limply + - lively + - loftily + - longingly + - loosely + - loudly + - lovingly + - loyally + - madly + - majestically + - meaningfully + - mechanically + - merrily + - miserably + - mockingly + - mortally + - mysteriously + - naturally + - nearly + - neatly + - nervously + - nicely + - noisily + - obediently + - obnoxiously + - oddly + - offensively + - optimistically + - overconfidently + - painfully + - partially + - patiently + - perfectly + - playfully + - politely + - poorly + - positively + - potentially + - powerfully + - promptly + - properly + - punctually + - quaintly + - queasily + - queerly + - questionably + - quickly + - quietly + - quirkily + - quizzically + - randomly + - rapidly + - rarely + - readily + - really + - reassuringly + - recklessly + - regularly + - reluctantly + - repeatedly + - reproachfully + - restfully + - righteously + - rightfully + - rigidly + - roughly + - rudely + - safely + - scarcely + - scarily + - searchingly + - sedately + - seemingly + - selfishly + - separately + - seriously + - shakily + - sharply + - sheepishly + - shrilly + - shyly + - silently + - sleepily + - slowly + - smoothly + - softly + - solemnly + - solidly + - speedily + - stealthily + - sternly + - strictly + - suddenly + - supposedly + - surprisingly + - suspiciously + - sweetly + - swiftly + - sympathetically + - tenderly + - tensely + - terribly + - thankfully + - thoroughly + - thoughtfully + - tightly + - tremendously + - triumphantly + - truthfully + - ultimately + - unabashedly + - unaccountably + - unbearably + - unethically + - unexpectedly + - unfortunately + - unimpressively + - unnaturally + - unnecessarily + - urgently + - usefully + - uselessly + - utterly + - vacantly + - vaguely + - vainly + - valiantly + - vastly + - verbally + - very + - viciously + - victoriously + - violently + - vivaciously + - voluntarily + - warmly + - weakly + - wearily + - wetly + - wholly + - wildly + - willfully + - wisely + - woefully + - wonderfully + - worriedly + - yawningly + - yearningly + - yieldingly + - youthfully + - zealously + - zestfully + - zestily diff --git a/.github/styles/Microsoft/Auto.yml b/.github/styles/Microsoft/Auto.yml new file mode 100644 index 000000000..4da439353 --- /dev/null +++ b/.github/styles/Microsoft/Auto.yml @@ -0,0 +1,11 @@ +extends: existence +message: "In general, don't hyphenate '%s'." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto +ignorecase: true +level: error +action: + name: convert + params: + - simple +tokens: + - 'auto-\w+' diff --git a/.github/styles/Microsoft/Avoid.yml b/.github/styles/Microsoft/Avoid.yml new file mode 100644 index 000000000..dab7822c7 --- /dev/null +++ b/.github/styles/Microsoft/Avoid.yml @@ -0,0 +1,14 @@ +extends: existence +message: "Don't use '%s'. See the A-Z word list for details." +# See the A-Z word list +link: https://docs.microsoft.com/en-us/style-guide +ignorecase: true +level: error +tokens: + - abortion + - and so on + - app(?:lication)?s? (?:developer|program) + - app(?:lication)? file + - backbone + - backend + - contiguous selection diff --git a/.github/styles/Microsoft/ComplexWords.yml b/.github/styles/Microsoft/ComplexWords.yml new file mode 100644 index 000000000..65b7a3472 --- /dev/null +++ b/.github/styles/Microsoft/ComplexWords.yml @@ -0,0 +1,120 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: suggestion +action: + name: replace +swap: + "approximate(?:ly)?": about + abundance: plenty + accelerate: speed up + accentuate: stress + accompany: go with + accomplish: carry out|do + accorded: given + accordingly: so + accrue: add + accurate: right|exact + acquiesce: agree + acquire: get|buy + additional: more|extra + address: discuss + addressees: you + adjacent to: next to + adjustment: change + admissible: allowed + advantageous: helpful + advise: tell + aggregate: total + aircraft: plane + alleviate: ease + allocate: assign|divide + alternatively: or + alternatives: choices|options + ameliorate: improve + amend: change + anticipate: expect + apparent: clear|plain + ascertain: discover|find out + assistance: help + attain: meet + attempt: try + authorize: allow + belated: late + bestow: give + cease: stop|end + collaborate: work together + commence: begin + compensate: pay + component: part + comprise: form|include + concept: idea + concerning: about + confer: give|award + consequently: so + consolidate: merge + constitutes: forms + contains: has + convene: meet + demonstrate: show|prove + depart: leave + designate: choose + desire: want|wish + determine: decide|find + detrimental: bad|harmful + disclose: share|tell + discontinue: stop + disseminate: send|give + eliminate: end + elucidate: explain + employ: use + enclosed: inside|included + encounter: meet + endeavor: try + enumerate: count + equitable: fair + equivalent: equal + exclusively: only + expedite: hurry + facilitate: ease + females: women + finalize: complete|finish + frequently: often + identical: same + incorrect: wrong + indication: sign + initiate: start|begin + itemized: listed + jeopardize: risk + liaise: work with|partner with + maintain: keep|support + methodology: method + modify: change + monitor: check|watch + multiple: many + necessitate: cause + notify: tell + numerous: many + objective: aim|goal + obligate: bind|compel + optimum: best|most + permit: let + portion: part + possess: own + previous: earlier + previously: before + prioritize: rank + procure: buy + provide: give|offer + purchase: buy + relocate: move + solicit: request + state-of-the-art: latest + subsequent: later|next + substantial: large + sufficient: enough + terminate: end + transmit: send + utilization: use + utilize: use diff --git a/.github/styles/Microsoft/Contractions.yml b/.github/styles/Microsoft/Contractions.yml new file mode 100644 index 000000000..8c81dcbce --- /dev/null +++ b/.github/styles/Microsoft/Contractions.yml @@ -0,0 +1,50 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions +level: error +ignorecase: true +action: + name: replace +swap: + are not: aren't + cannot: can't + could not: couldn't + did not: didn't + do not: don't + does not: doesn't + has not: hasn't + have not: haven't + how is: how's + is not: isn't + + 'it is(?!\.)': it's + 'it''s(?=\.)': it is + + should not: shouldn't + + "that is(?![.,])": that's + 'that''s(?=\.)': that is + + 'they are(?!\.)': they're + 'they''re(?=\.)': they are + + was not: wasn't + + 'we are(?!\.)': we're + 'we''re(?=\.)': we are + + 'we have(?!\.)': we've + 'we''ve(?=\.)': we have + + were not: weren't + + 'what is(?!\.)': what's + 'what''s(?=\.)': what is + + 'when is(?!\.)': when's + 'when''s(?=\.)': when is + + 'where is(?!\.)': where's + 'where''s(?=\.)': where is + + will not: won't diff --git a/.github/styles/Microsoft/Dashes.yml b/.github/styles/Microsoft/Dashes.yml new file mode 100644 index 000000000..2894cf722 --- /dev/null +++ b/.github/styles/Microsoft/Dashes.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Remove the spaces around '%s'." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes +ignorecase: true +nonword: true +level: error +action: + name: edit + params: + - remove + - ' ' +tokens: + - '[—–]\s|\s[—–]' diff --git a/.github/styles/Microsoft/DateFormat.yml b/.github/styles/Microsoft/DateFormat.yml new file mode 100644 index 000000000..196531394 --- /dev/null +++ b/.github/styles/Microsoft/DateFormat.yml @@ -0,0 +1,8 @@ +extends: existence +message: Use 'July 31, 2016' format, not '%s'. +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.github/styles/Microsoft/DateNumbers.yml b/.github/styles/Microsoft/DateNumbers.yml new file mode 100644 index 000000000..14d46747c --- /dev/null +++ b/.github/styles/Microsoft/DateNumbers.yml @@ -0,0 +1,40 @@ +extends: existence +message: "Don't use ordinal numbers for dates." +link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates +level: error +nonword: true +ignorecase: true +raw: + - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* +tokens: + - first + - second + - third + - fourth + - fifth + - sixth + - seventh + - eighth + - ninth + - tenth + - eleventh + - twelfth + - thirteenth + - fourteenth + - fifteenth + - sixteenth + - seventeenth + - eighteenth + - nineteenth + - twentieth + - twenty-first + - twenty-second + - twenty-third + - twenty-fourth + - twenty-fifth + - twenty-sixth + - twenty-seventh + - twenty-eighth + - twenty-ninth + - thirtieth + - thirty-first diff --git a/.github/styles/Microsoft/DateOrder.yml b/.github/styles/Microsoft/DateOrder.yml new file mode 100644 index 000000000..12d69ba51 --- /dev/null +++ b/.github/styles/Microsoft/DateOrder.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Always spell out the name of the month." +link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates +ignorecase: true +level: error +nonword: true +tokens: + - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/.github/styles/Microsoft/Ellipses.yml b/.github/styles/Microsoft/Ellipses.yml new file mode 100644 index 000000000..320457a8b --- /dev/null +++ b/.github/styles/Microsoft/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/.github/styles/Microsoft/FirstPerson.yml b/.github/styles/Microsoft/FirstPerson.yml new file mode 100644 index 000000000..77761af88 --- /dev/null +++ b/.github/styles/Microsoft/FirstPerson.yml @@ -0,0 +1,16 @@ +extends: existence +message: "Use first person (such as '%s') sparingly." +link: https://docs.microsoft.com/en-us/style-guide/grammar/person +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'd\b + - \bI'll\b + - \bI'm\b + - \bI've\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/.github/styles/Microsoft/Foreign.yml b/.github/styles/Microsoft/Foreign.yml new file mode 100644 index 000000000..0d3d6002a --- /dev/null +++ b/.github/styles/Microsoft/Foreign.yml @@ -0,0 +1,13 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)[\s,]': for example + '\b(?:ie|i\.e\.)[\s,]': that is + '\b(?:viz\.)[\s,]': namely + '\b(?:ergo)[\s,]': therefore diff --git a/.github/styles/Microsoft/Gender.yml b/.github/styles/Microsoft/Gender.yml new file mode 100644 index 000000000..47c080247 --- /dev/null +++ b/.github/styles/Microsoft/Gender.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Don't use '%s'." +link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender +level: error +ignorecase: true +tokens: + - he/she + - s/he diff --git a/.github/styles/Microsoft/GenderBias.yml b/.github/styles/Microsoft/GenderBias.yml new file mode 100644 index 000000000..3d873aa31 --- /dev/null +++ b/.github/styles/Microsoft/GenderBias.yml @@ -0,0 +1,44 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: error +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.github/styles/Microsoft/GeneralURL.yml b/.github/styles/Microsoft/GeneralURL.yml new file mode 100644 index 000000000..dcef503d9 --- /dev/null +++ b/.github/styles/Microsoft/GeneralURL.yml @@ -0,0 +1,11 @@ +extends: existence +message: "For a general audience, use 'address' rather than 'URL'." +link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses +level: warning +action: + name: replace + params: + - URL + - address +tokens: + - URL diff --git a/.github/styles/Microsoft/HeadingAcronyms.yml b/.github/styles/Microsoft/HeadingAcronyms.yml new file mode 100644 index 000000000..9dc3b6c2d --- /dev/null +++ b/.github/styles/Microsoft/HeadingAcronyms.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Avoid using acronyms in a title or heading." +link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings +level: warning +scope: heading +tokens: + - '[A-Z]{2,4}' diff --git a/.github/styles/Microsoft/HeadingColons.yml b/.github/styles/Microsoft/HeadingColons.yml new file mode 100644 index 000000000..7013c3914 --- /dev/null +++ b/.github/styles/Microsoft/HeadingColons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Capitalize '%s'." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons +nonword: true +level: error +scope: heading +tokens: + - ':\s[a-z]' diff --git a/.github/styles/Microsoft/HeadingPunctuation.yml b/.github/styles/Microsoft/HeadingPunctuation.yml new file mode 100644 index 000000000..af04b02eb --- /dev/null +++ b/.github/styles/Microsoft/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't use end punctuation in headings." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - remove + - '.?!' +tokens: + - '[a-z][.?!](?:\s|$)' diff --git a/.github/styles/Microsoft/Headings.yml b/.github/styles/Microsoft/Headings.yml new file mode 100644 index 000000000..63624edc1 --- /dev/null +++ b/.github/styles/Microsoft/Headings.yml @@ -0,0 +1,28 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: https://docs.microsoft.com/en-us/style-guide/capitalization +level: suggestion +scope: heading +match: $sentence +indicators: + - ':' +exceptions: + - Azure + - CLI + - Code + - Cosmos + - Docker + - Emmet + - I + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - REPL + - Studio + - TypeScript + - URLs + - Visual + - VS + - Windows diff --git a/.github/styles/Microsoft/Hyphens.yml b/.github/styles/Microsoft/Hyphens.yml new file mode 100644 index 000000000..90bbb5def --- /dev/null +++ b/.github/styles/Microsoft/Hyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens +level: warning +ignorecase: false +nonword: true +action: + name: edit + params: + - replace + - '-' + - ' ' +tokens: + - '\s[^\s-]+ly-' diff --git a/.github/styles/Microsoft/Negative.yml b/.github/styles/Microsoft/Negative.yml new file mode 100644 index 000000000..d6ff2f224 --- /dev/null +++ b/.github/styles/Microsoft/Negative.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Form a negative number with an en dash, not a hyphen." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +action: + name: edit + params: + - replace + - '-' + - '–' +tokens: + - '\s-\d+\s' diff --git a/.github/styles/Microsoft/Ordinal.yml b/.github/styles/Microsoft/Ordinal.yml new file mode 100644 index 000000000..e3483e380 --- /dev/null +++ b/.github/styles/Microsoft/Ordinal.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't add -ly to an ordinal number." +link: https://docs.microsoft.com/en-us/style-guide/numbers +level: error +action: + name: edit + params: + - trim + - ly +tokens: + - firstly + - secondly + - thirdly diff --git a/.github/styles/Microsoft/OxfordComma.yml b/.github/styles/Microsoft/OxfordComma.yml new file mode 100644 index 000000000..493b55c3c --- /dev/null +++ b/.github/styles/Microsoft/OxfordComma.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas +scope: sentence +level: suggestion +nonword: true +tokens: + - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/.github/styles/Microsoft/Passive.yml b/.github/styles/Microsoft/Passive.yml new file mode 100644 index 000000000..102d377ca --- /dev/null +++ b/.github/styles/Microsoft/Passive.yml @@ -0,0 +1,183 @@ +extends: existence +message: "'%s' looks like passive voice." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/.github/styles/Microsoft/Percentages.yml b/.github/styles/Microsoft/Percentages.yml new file mode 100644 index 000000000..b68a7363f --- /dev/null +++ b/.github/styles/Microsoft/Percentages.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use a numeral plus the units." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +tokens: + - '\b[a-zA-z]+\spercent\b' diff --git a/.github/styles/Microsoft/Quotes.yml b/.github/styles/Microsoft/Quotes.yml new file mode 100644 index 000000000..38f497606 --- /dev/null +++ b/.github/styles/Microsoft/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: 'Punctuation should be inside the quotes.' +link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks +level: error +nonword: true +tokens: + - '["“][^"”“]+["”][.,]' diff --git a/.github/styles/Microsoft/RangeFormat.yml b/.github/styles/Microsoft/RangeFormat.yml new file mode 100644 index 000000000..f1d736e9d --- /dev/null +++ b/.github/styles/Microsoft/RangeFormat.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use an en dash in a range of numbers." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +action: + name: edit + params: + - replace + - '-' + - '–' +tokens: + - '\b\d+\s?[-]\s?\d+\b' diff --git a/.github/styles/Microsoft/RangeTime.yml b/.github/styles/Microsoft/RangeTime.yml new file mode 100644 index 000000000..cdd4b3346 --- /dev/null +++ b/.github/styles/Microsoft/RangeTime.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use 'to' instead of a dash in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +action: + name: edit + params: + - replace + - '[-–]' + - 'to' +tokens: + - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/.github/styles/Microsoft/Ranges.yml b/.github/styles/Microsoft/Ranges.yml new file mode 100644 index 000000000..67d9702b0 --- /dev/null +++ b/.github/styles/Microsoft/Ranges.yml @@ -0,0 +1,7 @@ +extends: existence +message: "In most cases, use 'from' or 'through' to describe a range of numbers." +link: 'https://docs.microsoft.com/en-us/style-guide/numbers' +nonword: true +level: warning +tokens: + - '\b\d+\s?[-–]\s?\d+\b' diff --git a/.github/styles/Microsoft/Semicolon.yml b/.github/styles/Microsoft/Semicolon.yml new file mode 100644 index 000000000..4d905467d --- /dev/null +++ b/.github/styles/Microsoft/Semicolon.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Try to simplify this sentence." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/.github/styles/Microsoft/SentenceLength.yml b/.github/styles/Microsoft/SentenceLength.yml new file mode 100644 index 000000000..f248cf051 --- /dev/null +++ b/.github/styles/Microsoft/SentenceLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Try to keep sentences short (< 30 words)." +scope: sentence +level: suggestion +max: 30 +token: \b(\w+)\b + diff --git a/.github/styles/Microsoft/Spacing.yml b/.github/styles/Microsoft/Spacing.yml new file mode 100644 index 000000000..bbd10e51d --- /dev/null +++ b/.github/styles/Microsoft/Spacing.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should have one space." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods +level: error +nonword: true +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/.github/styles/Microsoft/Suspended.yml b/.github/styles/Microsoft/Suspended.yml new file mode 100644 index 000000000..7282e9c9c --- /dev/null +++ b/.github/styles/Microsoft/Suspended.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use '%s' unless space is limited." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens +ignorecase: true +level: warning +tokens: + - '\w+- and \w+-' diff --git a/.github/styles/Microsoft/Terms.yml b/.github/styles/Microsoft/Terms.yml new file mode 100644 index 000000000..7708900eb --- /dev/null +++ b/.github/styles/Microsoft/Terms.yml @@ -0,0 +1,41 @@ +extends: substitution +message: "Prefer '%s' over '%s'." +# term preference should be based on microsoft style guide, such as +link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/adapter +level: warning +ignorecase: true +action: + name: replace +swap: + '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant + '(?:drive C:|drive C>|C: drive)': drive C + '(?:internet bot|web robot)s?': bot(s) + '(?:microsoft cloud|the cloud)': cloud + '(?:mobile|smart) ?phone': phone + '24/7': every day + 'audio(?:-| )book': audiobook + 'back(?:-| )light': backlight + 'chat ?bots?': chatbot(s) + adaptor: adapter + administrate: administer + afterwards: afterward + alphabetic: alphabetical + alphanumerical: alphanumeric + anti-aliasing: antialiasing + anti-malware: antimalware + anti-spyware: antispyware + anti-virus: antivirus + appendixes: appendices + artificial intelligence: AI + '(?:assembler|machine language)': assembly language + caap: CaaP + conversation-as-a-platform: conversation as a platform + eb: EB + gb: GB + gbps: Gbps + kb: KB + keypress: keystroke + mb: MB + pb: PB + tb: TB + zb: ZB diff --git a/.github/styles/Microsoft/URLFormat.yml b/.github/styles/Microsoft/URLFormat.yml new file mode 100644 index 000000000..82e702f98 --- /dev/null +++ b/.github/styles/Microsoft/URLFormat.yml @@ -0,0 +1,10 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + URL for: URL of + an URL: a URL + diff --git a/.github/styles/Microsoft/Units.yml b/.github/styles/Microsoft/Units.yml new file mode 100644 index 000000000..f062418ee --- /dev/null +++ b/.github/styles/Microsoft/Units.yml @@ -0,0 +1,16 @@ +extends: existence +message: "Don't spell out the number in '%s'." +link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms +level: error +raw: + - '[a-zA-Z]+\s' +tokens: + - '(?:centi|milli)?meters' + - '(?:kilo)?grams' + - '(?:kilo)?meters' + - '(?:mega)?pixels' + - cm + - inches + - lb + - miles + - pounds diff --git a/.github/styles/Microsoft/Vocab.yml b/.github/styles/Microsoft/Vocab.yml new file mode 100644 index 000000000..eebe97b15 --- /dev/null +++ b/.github/styles/Microsoft/Vocab.yml @@ -0,0 +1,25 @@ +extends: existence +message: "Verify your use of '%s' with the A-Z word list." +link: 'https://docs.microsoft.com/en-us/style-guide' +level: suggestion +ignorecase: true +tokens: + - above + - accessible + - actionable + - against + - alarm + - alert + - alias + - allows? + - and/or + - as well as + - assure + - author + - avg + - beta + - ensure + - he + - insure + - sample + - she diff --git a/.github/styles/Microsoft/We.yml b/.github/styles/Microsoft/We.yml new file mode 100644 index 000000000..97c901c1b --- /dev/null +++ b/.github/styles/Microsoft/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/.github/styles/Microsoft/Wordiness.yml b/.github/styles/Microsoft/Wordiness.yml new file mode 100644 index 000000000..22a4c932c --- /dev/null +++ b/.github/styles/Microsoft/Wordiness.yml @@ -0,0 +1,122 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: warning +action: + name: replace +swap: + (?:give|gave) rise to: lead to + (?:previous|prior) to: before + a (?:large)? majority of: most + a (?:large)? number of: many + a myriad of: myriad + adversely impact: hurt + all across: across + all of a sudden: suddenly + all of these: these + all of: all + all-time record: record + almost all: most + almost never: seldom + along the lines of: similar to + an adequate number of: enough + an appreciable number of: many + an estimated: about + any and all: all + are in agreement: agree + as a matter of fact: in fact + as a means of: to + as a result of: because of + as of yet: yet + as per: per + at a later date: later + at all times: always + at the present time: now + at this point in time: at this point + based in large part on: based on + based on the fact that: because + basic necessity: necessity + because of the fact that: because + came to a realization: realized + came to an abrupt end: ended abruptly + carry out an evaluation of: evaluate + close down: close + closed down: closed + complete stranger: stranger + completely separate: separate + concerning the matter of: regarding + conduct a review of: review + conduct an investigation: investigate + conduct experiments: experiment + continue on: continue + despite the fact that: although + disappear from sight: disappear + drag and drop: drag + drag-and-drop: drag + doomed to fail: doomed + due to the fact that: because + during the period of: during + during the time that: while + emergency situation: emergency + except when: unless + excessive number: too many + extend an invitation: invite + fall down: fall + fell down: fell + for the duration of: during + gather together: gather + has the ability to: can + has the capacity to: can + has the opportunity to: could + hold a meeting: meet + if this is not the case: if not + in a careful manner: carefully + in a thoughtful manner: thoughtfully + in a timely manner: timely + in an effort to: to + in between: between + in lieu of: instead of + in many cases: often + in most cases: usually + in order to: to + in some cases: sometimes + in spite of the fact that: although + in spite of: despite + in the (?:very)? near future: soon + in the event that: if + in the neighborhood of: roughly + in the vicinity of: close to + it would appear that: apparently + lift up: lift + made reference to: referred to + make reference to: refer to + mix together: mix + none at all: none + not in a position to: unable + not possible: impossible + of major importance: important + perform an assessment of: assess + pertaining to: about + place an order: order + plays a key role in: is essential to + present time: now + readily apparent: apparent + some of the: some + span across: span + subsequent to: after + successfully complete: complete + sufficient number (?:of)?: enough + take action: act + take into account: consider + the question as to whether: whether + there is no doubt but that: doubtless + this day and age: this age + this is a subject that: this subject + time (?:frame|period): time + under the provisions of: under + until such time as: until + used for fuel purposes: used for fuel + whether or not: whether + with regard to: regarding + with the exception of: except for diff --git a/.github/styles/Microsoft/meta.json b/.github/styles/Microsoft/meta.json new file mode 100644 index 000000000..297719bbb --- /dev/null +++ b/.github/styles/Microsoft/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Microsoft/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.github/styles/write-good/Cliches.yml b/.github/styles/write-good/Cliches.yml new file mode 100644 index 000000000..c95314387 --- /dev/null +++ b/.github/styles/write-good/Cliches.yml @@ -0,0 +1,702 @@ +extends: existence +message: "Try to avoid using clichés like '%s'." +ignorecase: true +level: warning +tokens: + - a chip off the old block + - a clean slate + - a dark and stormy night + - a far cry + - a fine kettle of fish + - a loose cannon + - a penny saved is a penny earned + - a tough row to hoe + - a word to the wise + - ace in the hole + - acid test + - add insult to injury + - against all odds + - air your dirty laundry + - all fun and games + - all in a day's work + - all talk, no action + - all thumbs + - all your eggs in one basket + - all's fair in love and war + - all's well that ends well + - almighty dollar + - American as apple pie + - an axe to grind + - another day, another dollar + - armed to the teeth + - as luck would have it + - as old as time + - as the crow flies + - at loose ends + - at my wits end + - avoid like the plague + - babe in the woods + - back against the wall + - back in the saddle + - back to square one + - back to the drawing board + - bad to the bone + - badge of honor + - bald faced liar + - ballpark figure + - banging your head against a brick wall + - baptism by fire + - barking up the wrong tree + - bat out of hell + - be all and end all + - beat a dead horse + - beat around the bush + - been there, done that + - beggars can't be choosers + - behind the eight ball + - bend over backwards + - benefit of the doubt + - bent out of shape + - best thing since sliced bread + - bet your bottom dollar + - better half + - better late than never + - better mousetrap + - better safe than sorry + - between a rock and a hard place + - beyond the pale + - bide your time + - big as life + - big cheese + - big fish in a small pond + - big man on campus + - bigger they are the harder they fall + - bird in the hand + - bird's eye view + - birds and the bees + - birds of a feather flock together + - bit the hand that feeds you + - bite the bullet + - bite the dust + - bitten off more than he can chew + - black as coal + - black as pitch + - black as the ace of spades + - blast from the past + - bleeding heart + - blessing in disguise + - blind ambition + - blind as a bat + - blind leading the blind + - blood is thicker than water + - blood sweat and tears + - blow off steam + - blow your own horn + - blushing bride + - boils down to + - bolt from the blue + - bone to pick + - bored stiff + - bored to tears + - bottomless pit + - boys will be boys + - bright and early + - brings home the bacon + - broad across the beam + - broken record + - brought back to reality + - bull by the horns + - bull in a china shop + - burn the midnight oil + - burning question + - burning the candle at both ends + - burst your bubble + - bury the hatchet + - busy as a bee + - by hook or by crook + - call a spade a spade + - called onto the carpet + - calm before the storm + - can of worms + - can't cut the mustard + - can't hold a candle to + - case of mistaken identity + - cat got your tongue + - cat's meow + - caught in the crossfire + - caught red-handed + - checkered past + - chomping at the bit + - cleanliness is next to godliness + - clear as a bell + - clear as mud + - close to the vest + - cock and bull story + - cold shoulder + - come hell or high water + - cool as a cucumber + - cool, calm, and collected + - cost a king's ransom + - count your blessings + - crack of dawn + - crash course + - creature comforts + - cross that bridge when you come to it + - crushing blow + - cry like a baby + - cry me a river + - cry over spilt milk + - crystal clear + - curiosity killed the cat + - cut and dried + - cut through the red tape + - cut to the chase + - cute as a bugs ear + - cute as a button + - cute as a puppy + - cuts to the quick + - dark before the dawn + - day in, day out + - dead as a doornail + - devil is in the details + - dime a dozen + - divide and conquer + - dog and pony show + - dog days + - dog eat dog + - dog tired + - don't burn your bridges + - don't count your chickens + - don't look a gift horse in the mouth + - don't rock the boat + - don't step on anyone's toes + - don't take any wooden nickels + - down and out + - down at the heels + - down in the dumps + - down the hatch + - down to earth + - draw the line + - dressed to kill + - dressed to the nines + - drives me up the wall + - dull as dishwater + - dyed in the wool + - eagle eye + - ear to the ground + - early bird catches the worm + - easier said than done + - easy as pie + - eat your heart out + - eat your words + - eleventh hour + - even the playing field + - every dog has its day + - every fiber of my being + - everything but the kitchen sink + - eye for an eye + - face the music + - facts of life + - fair weather friend + - fall by the wayside + - fan the flames + - feast or famine + - feather your nest + - feathered friends + - few and far between + - fifteen minutes of fame + - filthy vermin + - fine kettle of fish + - fish out of water + - fishing for a compliment + - fit as a fiddle + - fit the bill + - fit to be tied + - flash in the pan + - flat as a pancake + - flip your lid + - flog a dead horse + - fly by night + - fly the coop + - follow your heart + - for all intents and purposes + - for the birds + - for what it's worth + - force of nature + - force to be reckoned with + - forgive and forget + - fox in the henhouse + - free and easy + - free as a bird + - fresh as a daisy + - full steam ahead + - fun in the sun + - garbage in, garbage out + - gentle as a lamb + - get a kick out of + - get a leg up + - get down and dirty + - get the lead out + - get to the bottom of + - get your feet wet + - gets my goat + - gilding the lily + - give and take + - go against the grain + - go at it tooth and nail + - go for broke + - go him one better + - go the extra mile + - go with the flow + - goes without saying + - good as gold + - good deed for the day + - good things come to those who wait + - good time was had by all + - good times were had by all + - greased lightning + - greek to me + - green thumb + - green-eyed monster + - grist for the mill + - growing like a weed + - hair of the dog + - hand to mouth + - happy as a clam + - happy as a lark + - hasn't a clue + - have a nice day + - have high hopes + - have the last laugh + - haven't got a row to hoe + - head honcho + - head over heels + - hear a pin drop + - heard it through the grapevine + - heart's content + - heavy as lead + - hem and haw + - high and dry + - high and mighty + - high as a kite + - hit paydirt + - hold your head up high + - hold your horses + - hold your own + - hold your tongue + - honest as the day is long + - horns of a dilemma + - horse of a different color + - hot under the collar + - hour of need + - I beg to differ + - icing on the cake + - if the shoe fits + - if the shoe were on the other foot + - in a jam + - in a jiffy + - in a nutshell + - in a pig's eye + - in a pinch + - in a word + - in hot water + - in the gutter + - in the nick of time + - in the thick of it + - in your dreams + - it ain't over till the fat lady sings + - it goes without saying + - it takes all kinds + - it takes one to know one + - it's a small world + - it's only a matter of time + - ivory tower + - Jack of all trades + - jockey for position + - jog your memory + - joined at the hip + - judge a book by its cover + - jump down your throat + - jump in with both feet + - jump on the bandwagon + - jump the gun + - jump to conclusions + - just a hop, skip, and a jump + - just the ticket + - justice is blind + - keep a stiff upper lip + - keep an eye on + - keep it simple, stupid + - keep the home fires burning + - keep up with the Joneses + - keep your chin up + - keep your fingers crossed + - kick the bucket + - kick up your heels + - kick your feet up + - kid in a candy store + - kill two birds with one stone + - kiss of death + - knock it out of the park + - knock on wood + - knock your socks off + - know him from Adam + - know the ropes + - know the score + - knuckle down + - knuckle sandwich + - knuckle under + - labor of love + - ladder of success + - land on your feet + - lap of luxury + - last but not least + - last hurrah + - last-ditch effort + - law of the jungle + - law of the land + - lay down the law + - leaps and bounds + - let sleeping dogs lie + - let the cat out of the bag + - let the good times roll + - let your hair down + - let's talk turkey + - letter perfect + - lick your wounds + - lies like a rug + - life's a bitch + - life's a grind + - light at the end of the tunnel + - lighter than a feather + - lighter than air + - like clockwork + - like father like son + - like taking candy from a baby + - like there's no tomorrow + - lion's share + - live and learn + - live and let live + - long and short of it + - long lost love + - look before you leap + - look down your nose + - look what the cat dragged in + - looking a gift horse in the mouth + - looks like death warmed over + - loose cannon + - lose your head + - lose your temper + - loud as a horn + - lounge lizard + - loved and lost + - low man on the totem pole + - luck of the draw + - luck of the Irish + - make hay while the sun shines + - make money hand over fist + - make my day + - make the best of a bad situation + - make the best of it + - make your blood boil + - man of few words + - man's best friend + - mark my words + - meaningful dialogue + - missed the boat on that one + - moment in the sun + - moment of glory + - moment of truth + - money to burn + - more power to you + - more than one way to skin a cat + - movers and shakers + - moving experience + - naked as a jaybird + - naked truth + - neat as a pin + - needle in a haystack + - needless to say + - neither here nor there + - never look back + - never say never + - nip and tuck + - nip it in the bud + - no guts, no glory + - no love lost + - no pain, no gain + - no skin off my back + - no stone unturned + - no time like the present + - no use crying over spilled milk + - nose to the grindstone + - not a hope in hell + - not a minute's peace + - not in my backyard + - not playing with a full deck + - not the end of the world + - not written in stone + - nothing to sneeze at + - nothing ventured nothing gained + - now we're cooking + - off the top of my head + - off the wagon + - off the wall + - old hat + - older and wiser + - older than dirt + - older than Methuselah + - on a roll + - on cloud nine + - on pins and needles + - on the bandwagon + - on the money + - on the nose + - on the rocks + - on the spot + - on the tip of my tongue + - on the wagon + - on thin ice + - once bitten, twice shy + - one bad apple doesn't spoil the bushel + - one born every minute + - one brick short + - one foot in the grave + - one in a million + - one red cent + - only game in town + - open a can of worms + - open and shut case + - open the flood gates + - opportunity doesn't knock twice + - out of pocket + - out of sight, out of mind + - out of the frying pan into the fire + - out of the woods + - out on a limb + - over a barrel + - over the hump + - pain and suffering + - pain in the + - panic button + - par for the course + - part and parcel + - party pooper + - pass the buck + - patience is a virtue + - pay through the nose + - penny pincher + - perfect storm + - pig in a poke + - pile it on + - pillar of the community + - pin your hopes on + - pitter patter of little feet + - plain as day + - plain as the nose on your face + - play by the rules + - play your cards right + - playing the field + - playing with fire + - pleased as punch + - plenty of fish in the sea + - point with pride + - poor as a church mouse + - pot calling the kettle black + - pretty as a picture + - pull a fast one + - pull your punches + - pulling your leg + - pure as the driven snow + - put it in a nutshell + - put one over on you + - put the cart before the horse + - put the pedal to the metal + - put your best foot forward + - put your foot down + - quick as a bunny + - quick as a lick + - quick as a wink + - quick as lightning + - quiet as a dormouse + - rags to riches + - raining buckets + - raining cats and dogs + - rank and file + - rat race + - reap what you sow + - red as a beet + - red herring + - reinvent the wheel + - rich and famous + - rings a bell + - ripe old age + - ripped me off + - rise and shine + - road to hell is paved with good intentions + - rob Peter to pay Paul + - roll over in the grave + - rub the wrong way + - ruled the roost + - running in circles + - sad but true + - sadder but wiser + - salt of the earth + - scared stiff + - scared to death + - sealed with a kiss + - second to none + - see eye to eye + - seen the light + - seize the day + - set the record straight + - set the world on fire + - set your teeth on edge + - sharp as a tack + - shoot for the moon + - shoot the breeze + - shot in the dark + - shoulder to the wheel + - sick as a dog + - sigh of relief + - signed, sealed, and delivered + - sink or swim + - six of one, half a dozen of another + - skating on thin ice + - slept like a log + - slinging mud + - slippery as an eel + - slow as molasses + - smart as a whip + - smooth as a baby's bottom + - sneaking suspicion + - snug as a bug in a rug + - sow wild oats + - spare the rod, spoil the child + - speak of the devil + - spilled the beans + - spinning your wheels + - spitting image of + - spoke with relish + - spread like wildfire + - spring to life + - squeaky wheel gets the grease + - stands out like a sore thumb + - start from scratch + - stick in the mud + - still waters run deep + - stitch in time + - stop and smell the roses + - straight as an arrow + - straw that broke the camel's back + - strong as an ox + - stubborn as a mule + - stuff that dreams are made of + - stuffed shirt + - sweating blood + - sweating bullets + - take a load off + - take one for the team + - take the bait + - take the bull by the horns + - take the plunge + - takes one to know one + - takes two to tango + - the more the merrier + - the real deal + - the real McCoy + - the red carpet treatment + - the same old story + - there is no accounting for taste + - thick as a brick + - thick as thieves + - thin as a rail + - think outside of the box + - third time's the charm + - this day and age + - this hurts me worse than it hurts you + - this point in time + - three sheets to the wind + - through thick and thin + - throw in the towel + - tie one on + - tighter than a drum + - time and time again + - time is of the essence + - tip of the iceberg + - tired but happy + - to coin a phrase + - to each his own + - to make a long story short + - to the best of my knowledge + - toe the line + - tongue in cheek + - too good to be true + - too hot to handle + - too numerous to mention + - touch with a ten foot pole + - tough as nails + - trial and error + - trials and tribulations + - tried and true + - trip down memory lane + - twist of fate + - two cents worth + - two peas in a pod + - ugly as sin + - under the counter + - under the gun + - under the same roof + - under the weather + - until the cows come home + - unvarnished truth + - up the creek + - uphill battle + - upper crust + - upset the applecart + - vain attempt + - vain effort + - vanquish the enemy + - vested interest + - waiting for the other shoe to drop + - wakeup call + - warm welcome + - watch your p's and q's + - watch your tongue + - watching the clock + - water under the bridge + - weather the storm + - weed them out + - week of Sundays + - went belly up + - wet behind the ears + - what goes around comes around + - what you see is what you get + - when it rains, it pours + - when push comes to shove + - when the cat's away + - when the going gets tough, the tough get going + - white as a sheet + - whole ball of wax + - whole hog + - whole nine yards + - wild goose chase + - will wonders never cease? + - wisdom of the ages + - wise as an owl + - wolf at the door + - words fail me + - work like a dog + - world weary + - worst nightmare + - worth its weight in gold + - wrong side of the bed + - yanking your chain + - yappy as a dog + - years young + - you are what you eat + - you can run but you can't hide + - you only live once + - you're the boss + - young and foolish + - young and vibrant diff --git a/.github/styles/write-good/E-Prime.yml b/.github/styles/write-good/E-Prime.yml new file mode 100644 index 000000000..074a102b2 --- /dev/null +++ b/.github/styles/write-good/E-Prime.yml @@ -0,0 +1,32 @@ +extends: existence +message: "Try to avoid using '%s'." +ignorecase: true +level: suggestion +tokens: + - am + - are + - aren't + - be + - been + - being + - he's + - here's + - here's + - how's + - i'm + - is + - isn't + - it's + - she's + - that's + - there's + - they're + - was + - wasn't + - we're + - were + - weren't + - what's + - where's + - who's + - you're diff --git a/.github/styles/write-good/Illusions.yml b/.github/styles/write-good/Illusions.yml new file mode 100644 index 000000000..b4f132185 --- /dev/null +++ b/.github/styles/write-good/Illusions.yml @@ -0,0 +1,11 @@ +extends: repetition +message: "'%s' is repeated!" +level: warning +alpha: true +action: + name: edit + params: + - truncate + - " " +tokens: + - '[^\s]+' diff --git a/.github/styles/write-good/Passive.yml b/.github/styles/write-good/Passive.yml new file mode 100644 index 000000000..f472cb904 --- /dev/null +++ b/.github/styles/write-good/Passive.yml @@ -0,0 +1,183 @@ +extends: existence +message: "'%s' may be passive voice. Use active voice if you can." +ignorecase: true +level: warning +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/.github/styles/write-good/README.md b/.github/styles/write-good/README.md new file mode 100644 index 000000000..3edcc9b37 --- /dev/null +++ b/.github/styles/write-good/README.md @@ -0,0 +1,27 @@ +Based on [write-good](https://github.com/btford/write-good). + +> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. + +``` +The MIT License (MIT) + +Copyright (c) 2014 Brian Ford + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/.github/styles/write-good/So.yml b/.github/styles/write-good/So.yml new file mode 100644 index 000000000..e57f099dc --- /dev/null +++ b/.github/styles/write-good/So.yml @@ -0,0 +1,5 @@ +extends: existence +message: "Don't start a sentence with '%s'." +level: error +raw: + - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/.github/styles/write-good/ThereIs.yml b/.github/styles/write-good/ThereIs.yml new file mode 100644 index 000000000..8b82e8f6c --- /dev/null +++ b/.github/styles/write-good/ThereIs.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Don't start a sentence with '%s'." +ignorecase: false +level: error +raw: + - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' diff --git a/.github/styles/write-good/TooWordy.yml b/.github/styles/write-good/TooWordy.yml new file mode 100644 index 000000000..275701b19 --- /dev/null +++ b/.github/styles/write-good/TooWordy.yml @@ -0,0 +1,221 @@ +extends: existence +message: "'%s' is too wordy." +ignorecase: true +level: warning +tokens: + - a number of + - abundance + - accede to + - accelerate + - accentuate + - accompany + - accomplish + - accorded + - accrue + - acquiesce + - acquire + - additional + - adjacent to + - adjustment + - admissible + - advantageous + - adversely impact + - advise + - aforementioned + - aggregate + - aircraft + - all of + - all things considered + - alleviate + - allocate + - along the lines of + - already existing + - alternatively + - amazing + - ameliorate + - anticipate + - apparent + - appreciable + - as a matter of fact + - as a means of + - as far as I'm concerned + - as of yet + - as to + - as yet + - ascertain + - assistance + - at the present time + - at this time + - attain + - attributable to + - authorize + - because of the fact that + - belated + - benefit from + - bestow + - by means of + - by virtue of + - by virtue of the fact that + - cease + - close proximity + - commence + - comply with + - concerning + - consequently + - consolidate + - constitutes + - demonstrate + - depart + - designate + - discontinue + - due to the fact that + - each and every + - economical + - eliminate + - elucidate + - employ + - endeavor + - enumerate + - equitable + - equivalent + - evaluate + - evidenced + - exclusively + - expedite + - expend + - expiration + - facilitate + - factual evidence + - feasible + - finalize + - first and foremost + - for all intents and purposes + - for the most part + - for the purpose of + - forfeit + - formulate + - have a tendency to + - honest truth + - however + - if and when + - impacted + - implement + - in a manner of speaking + - in a timely manner + - in a very real sense + - in accordance with + - in addition + - in all likelihood + - in an effort to + - in between + - in excess of + - in lieu of + - in light of the fact that + - in many cases + - in my opinion + - in order to + - in regard to + - in some instances + - in terms of + - in the case of + - in the event that + - in the final analysis + - in the nature of + - in the near future + - in the process of + - inception + - incumbent upon + - indicate + - indication + - initiate + - irregardless + - is applicable to + - is authorized to + - is responsible for + - it is + - it is essential + - it seems that + - it was + - magnitude + - maximum + - methodology + - minimize + - minimum + - modify + - monitor + - multiple + - necessitate + - nevertheless + - not certain + - not many + - not often + - not unless + - not unlike + - notwithstanding + - null and void + - numerous + - objective + - obligate + - obtain + - on the contrary + - on the other hand + - one particular + - optimum + - overall + - owing to the fact that + - participate + - particulars + - pass away + - pertaining to + - point in time + - portion + - possess + - preclude + - previously + - prior to + - prioritize + - procure + - proficiency + - provided that + - purchase + - put simply + - readily apparent + - refer back + - regarding + - relocate + - remainder + - remuneration + - requirement + - reside + - residence + - retain + - satisfy + - shall + - should you wish + - similar to + - solicit + - span across + - strategize + - subsequent + - substantial + - successfully complete + - sufficient + - terminate + - the month of + - the point I am trying to make + - therefore + - time period + - took advantage of + - transmit + - transpire + - type of + - until such time as + - utilization + - utilize + - validate + - various different + - what I mean to say is + - whether or not + - with respect to + - with the exception of + - witnessed diff --git a/.github/styles/write-good/Weasel.yml b/.github/styles/write-good/Weasel.yml new file mode 100644 index 000000000..e29391444 --- /dev/null +++ b/.github/styles/write-good/Weasel.yml @@ -0,0 +1,207 @@ +extends: existence +message: "'%s' is a weasel word!" +ignorecase: true +level: warning +tokens: + - absolutely + - accidentally + - additionally + - allegedly + - alternatively + - angrily + - anxiously + - approximately + - awkwardly + - badly + - barely + - beautifully + - blindly + - boldly + - bravely + - brightly + - briskly + - bristly + - bubbly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - clearly + - closely + - coldly + - completely + - consequently + - correctly + - courageously + - crinkly + - cruelly + - crumbly + - cuddly + - currently + - daily + - daringly + - deadly + - definitely + - deliberately + - doubtfully + - dumbly + - eagerly + - early + - easily + - elegantly + - enormously + - enthusiastically + - equally + - especially + - eventually + - exactly + - exceedingly + - exclusively + - extremely + - fairly + - faithfully + - fatally + - fiercely + - finally + - fondly + - few + - foolishly + - fortunately + - frankly + - frantically + - generously + - gently + - giggly + - gladly + - gracefully + - greedily + - happily + - hardly + - hastily + - healthily + - heartily + - helpfully + - honestly + - hourly + - hungrily + - hurriedly + - immediately + - impatiently + - inadequately + - ingeniously + - innocently + - inquisitively + - interestingly + - irritably + - jiggly + - joyously + - justly + - kindly + - largely + - lately + - lazily + - likely + - literally + - lonely + - loosely + - loudly + - loudly + - luckily + - madly + - many + - mentally + - mildly + - monthly + - mortally + - mostly + - mysteriously + - neatly + - nervously + - nightly + - noisily + - normally + - obediently + - occasionally + - only + - openly + - painfully + - particularly + - patiently + - perfectly + - politely + - poorly + - powerfully + - presumably + - previously + - promptly + - punctually + - quarterly + - quickly + - quietly + - rapidly + - rarely + - really + - recently + - recklessly + - regularly + - remarkably + - relatively + - reluctantly + - repeatedly + - rightfully + - roughly + - rudely + - sadly + - safely + - selfishly + - sensibly + - seriously + - sharply + - shortly + - shyly + - significantly + - silently + - simply + - sleepily + - slowly + - smartly + - smelly + - smoothly + - softly + - solemnly + - sparkly + - speedily + - stealthily + - sternly + - stupidly + - substantially + - successfully + - suddenly + - surprisingly + - suspiciously + - swiftly + - tenderly + - tensely + - thoughtfully + - tightly + - timely + - truthfully + - unexpectedly + - unfortunately + - usually + - very + - victoriously + - violently + - vivaciously + - warmly + - waverly + - weakly + - wearily + - weekly + - wildly + - wisely + - worldly + - wrinkly + - yearly diff --git a/.github/styles/write-good/meta.json b/.github/styles/write-good/meta.json new file mode 100644 index 000000000..a115d2886 --- /dev/null +++ b/.github/styles/write-good/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/write-good/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.gitignore b/.gitignore index 2333ee5bc..533fd6403 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,3 @@ sources/typedefs tsconfig.tsbuildinfo .turbo apify-docs-theme/package-lock.json -.github/styles/* -!.github/styles/Vocab -!.github/styles/Apify diff --git a/vale.ini b/vale.ini index 476873f0d..adde0fafe 100644 --- a/vale.ini +++ b/vale.ini @@ -4,13 +4,13 @@ IgnoredScopes = code, tt, table, tr, td Vocab = Docs -Packages = write-good +Packages = write-good, Microsoft [formats] mdx = md [*.md] -BasedOnStyles = Apify, write-good +BasedOnStyles = Apify, write-good, Microsoft # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\[(?=.*\.com(?:\/.*)?).+?]) From a93dfd1d55c0db6d1f49ff438a5f22a2eee6dd68 Mon Sep 17 00:00:00 2001 From: TCMO <92638966+TC-MO@users.noreply.github.com> Date: Fri, 5 Jan 2024 10:42:58 +0100 Subject: [PATCH 57/57] turn off few unnecessary msoft style guide rules & add info regarding vale to Contributing,md --- CONTRIBUTING.md | 16 +++++++++++++--- sources/platform/schedules.md | 4 ++-- vale.ini | 5 +++++ 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd23177aa..edb0cb8b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Apify documentation consists of six different repositories: - apify-cli - apify-docs (this repository) -The main documentation content for Platform docs and Academy is inside the `./sources` directory. Every project repository then has its own Docusaurus instance and is available on a URL prefix (used as the `baseUrl` in Docusaurus) that is routed via nginx reverse proxy to the main domain. All those Docusaurus instances are deployed to GH pages on push. +The main documentation content for Platform docs and Academy is inside the `./sources` directory. Every project repository then has its own Docusaurus instance and is available on a URL prefix (used as the `baseUrl` in Docusaurus) that's routed via nginx reverse proxy to the main domain. All those Docusaurus instances are deployed to GH pages on push. We use a shared Docusaurus theme published to NPM as `@apify/docs-theme`, which is automatically synced in all the repositories via CI. @@ -26,7 +26,7 @@ The theme is available on npm as `@apify/docs-theme` and can be installed in any A GitHub Action automatically publishes the theme to npm whenever any changes are pushed to the `master` branch. However, this only happens if you update the version in the `package.json` file manually - if the current version already exists on npm, the publish will be skipped. -Additionally, if there are any changes to the `apify-docs-theme` folder detected, the GitHub action will invoke docs builds in all the subprojects to make sure that all the pages are using the latest theme version. This is done in the `rebuild-docs` job. This job utilizes a matrix strategy to run the builds in parallel. The actual rebuild is initiated by the `workflow_dispatch` event in the respective repositories. Because of this, the `GITHUB_TOKEN` env var has to be replaced by the PAT token stored in the `GH_TOKEN` secret - the original token does not have the necessary permissions to trigger the workflows in other repositories. +Additionally, if there are any changes to the `apify-docs-theme` folder detected, the GitHub action will invoke docs builds in all the subprojects to make sure that all the pages are using the latest theme version. This is done in the `rebuild-docs` job. This job utilizes a matrix strategy to run the builds in parallel. The actual rebuild is initiated by the `workflow_dispatch` event in the respective repositories. Because of this, the `GITHUB_TOKEN` env var has to be replaced by the PAT token stored in the `GH_TOKEN` secret - the original token doesn't have the necessary permissions to trigger the workflows in other repositories. ### Redirects @@ -59,7 +59,7 @@ The homepage menu card items are in the `docs/homepage_content.json` file. The c Each item has its own JSON object, in which "cardItem" is the title and "href" is the link. If the link leads to outside the Apify Docs site, add the `"isExternalLink": true` property. For local links, just use the article's path. E.g. `"/tutorials/apify-scrapers/web-scraper"`. -In the title (`cardItem`), do not just give the article's name. Phrase the title in a way that answers a question or fulfills a goal the user might have. +In the title (`cardItem`), don't just give the article's name. Phrase the title in a way that answers a question or fulfills a goal the user might have. For example: @@ -129,6 +129,8 @@ And add a record to `/etc/hosts` to map the `docs.apify.loc` hostname to localho ## Linting +### Markdownlint + The **apify-docs** repo contains both Markdown and JavaScript/TypeScript files. We have two commands for linting them: - `npm run lint:md` and `npm run lint:md:fix` checks the `*.md` files. @@ -138,6 +140,14 @@ For Markdown, we use the [markdownlint](https://github.com/DavidAnson/markdownli For JavaScript, we use the [ESLint Markdown plugin](https://github.com/eslint/eslint-plugin-markdown). +### Vale + +Apart from `markdownlint` we also utilize Vale as linting solution for prose. You can either use Vale as a CLI tool (for more information how to set it up go [here](https://vale.sh/docs/vale-cli/installation/)) or you can use Vale with a VSCode [extension](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode). The rulesets that Vale will utilize while linting can be found within `.github/styles` directory. + +#### Exceptions for Vale + +If Vale catches some specific words that you feel that should not be subjected to linting you can add them to the `accept.txt` found within the `.github/styles/Vocab/Docs` directory. For more information hw it works visit Vale [docs](https://vale.sh/docs/topics/vocab/). + ## Pull requests Follow the semantic commit message format described in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. This will help us with automatic changelog generation and versioning. diff --git a/sources/platform/schedules.md b/sources/platform/schedules.md index e0a8de72e..e96c757ee 100644 --- a/sources/platform/schedules.md +++ b/sources/platform/schedules.md @@ -39,7 +39,7 @@ Before setting up a new schedule, you should have the [Actor](./actors/index.mdx To schedule an Actor, you need to have run it at least once before. To run the Actor, navigate to the Actor's page through [Apify Console](https://console.apify.com/store), where you can configure and initiate the Actor's run with your preferred settings by clicking on **Start** button. After this initial run, you can then use Schedules to automate future runs of the Actor :::info Name Length -Your schedule's name should be 3-63 characters long. +Your schedule's name should be 3–63 characters long. ::: ### Apify Console @@ -141,7 +141,7 @@ The minimum interval between runs is 10 seconds; if your next run is scheduled s ### Examples of cron expressions -* `0 8 * * *` - every day at 8am. +* `0 8 * * *` - every day at 8 AM. * `0 0 * * 0` - every 7 days (at 00:00 on Sunday). * `*/3 * * * *` - every 3rd minute. * `0 0 1 */2 *` - every other month (at 00:00 on the first day of month, every 2nd month). diff --git a/vale.ini b/vale.ini index adde0fafe..9722a6f6c 100644 --- a/vale.ini +++ b/vale.ini @@ -14,3 +14,8 @@ BasedOnStyles = Apify, write-good, Microsoft # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\[(?=.*\.com(?:\/.*)?).+?]) + +# Disabling rules (NO) +Microsoft.Contractions = NO +Microsoft.Foreign = NO +Microsoft.We = NO