From 895d2e7375934f446f1ff7e3ec6b73d2fd7b0865 Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Mon, 18 Mar 2024 12:10:48 +0100 Subject: [PATCH 1/2] Add Vale --- .vale.ini | 9 + .vale/Microsoft/AMPM.yml | 9 + .vale/Microsoft/Accessibility.yml | 25 + .vale/Microsoft/Acronyms.yml | 64 ++ .vale/Microsoft/Adverbs.yml | 270 +++++++ .vale/Microsoft/Auto.yml | 11 + .vale/Microsoft/Avoid.yml | 14 + .vale/Microsoft/ComplexWords.yml | 120 ++++ .vale/Microsoft/Contractions.yml | 50 ++ .vale/Microsoft/Dashes.yml | 13 + .vale/Microsoft/DateFormat.yml | 8 + .vale/Microsoft/DateNumbers.yml | 40 ++ .vale/Microsoft/DateOrder.yml | 8 + .vale/Microsoft/Ellipses.yml | 9 + .vale/Microsoft/FirstPerson.yml | 16 + .vale/Microsoft/Foreign.yml | 13 + .vale/Microsoft/Gender.yml | 8 + .vale/Microsoft/GenderBias.yml | 46 ++ .vale/Microsoft/GeneralURL.yml | 11 + .vale/Microsoft/HeadingAcronyms.yml | 7 + .vale/Microsoft/HeadingColons.yml | 8 + .vale/Microsoft/HeadingPunctuation.yml | 13 + .vale/Microsoft/Headings.yml | 28 + .vale/Microsoft/Hyphens.yml | 14 + .vale/Microsoft/Negative.yml | 13 + .vale/Microsoft/Ordinal.yml | 13 + .vale/Microsoft/OxfordComma.yml | 8 + .vale/Microsoft/Passive.yml | 183 +++++ .vale/Microsoft/Percentages.yml | 7 + .vale/Microsoft/Plurals.yml | 7 + .vale/Microsoft/Quotes.yml | 7 + .vale/Microsoft/RangeTime.yml | 13 + .vale/Microsoft/Semicolon.yml | 8 + .vale/Microsoft/SentenceLength.yml | 7 + .vale/Microsoft/Spacing.yml | 8 + .vale/Microsoft/Suspended.yml | 7 + .vale/Microsoft/Terms.yml | 41 ++ .vale/Microsoft/URLFormat.yml | 10 + .vale/Microsoft/Units.yml | 16 + .vale/Microsoft/Vocab.yml | 25 + .vale/Microsoft/We.yml | 11 + .vale/Microsoft/Wordiness.yml | 122 ++++ .vale/Microsoft/meta.json | 4 + .vale/config/vocabularies/Symfony/accept.txt | 7 + .vale/config/vocabularies/Symfony/reject.txt | 0 .vale/write-good/Cliches.yml | 702 +++++++++++++++++++ .vale/write-good/E-Prime.yml | 32 + .vale/write-good/Illusions.yml | 11 + .vale/write-good/Passive.yml | 183 +++++ .vale/write-good/README.md | 27 + .vale/write-good/So.yml | 5 + .vale/write-good/ThereIs.yml | 6 + .vale/write-good/TooWordy.yml | 221 ++++++ .vale/write-good/Weasel.yml | 207 ++++++ .vale/write-good/meta.json | 4 + 55 files changed, 2729 insertions(+) create mode 100644 .vale.ini create mode 100644 .vale/Microsoft/AMPM.yml create mode 100644 .vale/Microsoft/Accessibility.yml create mode 100644 .vale/Microsoft/Acronyms.yml create mode 100644 .vale/Microsoft/Adverbs.yml create mode 100644 .vale/Microsoft/Auto.yml create mode 100644 .vale/Microsoft/Avoid.yml create mode 100644 .vale/Microsoft/ComplexWords.yml create mode 100644 .vale/Microsoft/Contractions.yml create mode 100644 .vale/Microsoft/Dashes.yml create mode 100644 .vale/Microsoft/DateFormat.yml create mode 100644 .vale/Microsoft/DateNumbers.yml create mode 100644 .vale/Microsoft/DateOrder.yml create mode 100644 .vale/Microsoft/Ellipses.yml create mode 100644 .vale/Microsoft/FirstPerson.yml create mode 100644 .vale/Microsoft/Foreign.yml create mode 100644 .vale/Microsoft/Gender.yml create mode 100644 .vale/Microsoft/GenderBias.yml create mode 100644 .vale/Microsoft/GeneralURL.yml create mode 100644 .vale/Microsoft/HeadingAcronyms.yml create mode 100644 .vale/Microsoft/HeadingColons.yml create mode 100644 .vale/Microsoft/HeadingPunctuation.yml create mode 100644 .vale/Microsoft/Headings.yml create mode 100644 .vale/Microsoft/Hyphens.yml create mode 100644 .vale/Microsoft/Negative.yml create mode 100644 .vale/Microsoft/Ordinal.yml create mode 100644 .vale/Microsoft/OxfordComma.yml create mode 100644 .vale/Microsoft/Passive.yml create mode 100644 .vale/Microsoft/Percentages.yml create mode 100644 .vale/Microsoft/Plurals.yml create mode 100644 .vale/Microsoft/Quotes.yml create mode 100644 .vale/Microsoft/RangeTime.yml create mode 100644 .vale/Microsoft/Semicolon.yml create mode 100644 .vale/Microsoft/SentenceLength.yml create mode 100644 .vale/Microsoft/Spacing.yml create mode 100644 .vale/Microsoft/Suspended.yml create mode 100644 .vale/Microsoft/Terms.yml create mode 100644 .vale/Microsoft/URLFormat.yml create mode 100644 .vale/Microsoft/Units.yml create mode 100644 .vale/Microsoft/Vocab.yml create mode 100644 .vale/Microsoft/We.yml create mode 100644 .vale/Microsoft/Wordiness.yml create mode 100644 .vale/Microsoft/meta.json create mode 100644 .vale/config/vocabularies/Symfony/accept.txt create mode 100644 .vale/config/vocabularies/Symfony/reject.txt create mode 100644 .vale/write-good/Cliches.yml create mode 100644 .vale/write-good/E-Prime.yml create mode 100644 .vale/write-good/Illusions.yml create mode 100644 .vale/write-good/Passive.yml create mode 100644 .vale/write-good/README.md create mode 100644 .vale/write-good/So.yml create mode 100644 .vale/write-good/ThereIs.yml create mode 100644 .vale/write-good/TooWordy.yml create mode 100644 .vale/write-good/Weasel.yml create mode 100644 .vale/write-good/meta.json diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000000..46d403e62c3 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,9 @@ +StylesPath = .vale +MinAlertLevel = error +Packages = Microsoft, write-good +Vocab = Symfony + +[*] +BasedOnStyles = Vale, Microsoft, write-good +BlockIgnores = (?s) *(\.\. configuration-block::) +TokenIgnores = (:ref:`.*`) diff --git a/.vale/Microsoft/AMPM.yml b/.vale/Microsoft/AMPM.yml new file mode 100644 index 00000000000..8b9fed162ab --- /dev/null +++ b/.vale/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/.vale/Microsoft/Accessibility.yml b/.vale/Microsoft/Accessibility.yml new file mode 100644 index 00000000000..05bf9273900 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Acronyms.yml b/.vale/Microsoft/Acronyms.yml new file mode 100644 index 00000000000..308ff7c0ed8 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Adverbs.yml b/.vale/Microsoft/Adverbs.yml new file mode 100644 index 00000000000..07d98d83e30 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Auto.yml b/.vale/Microsoft/Auto.yml new file mode 100644 index 00000000000..4da4393530d --- /dev/null +++ b/.vale/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/.vale/Microsoft/Avoid.yml b/.vale/Microsoft/Avoid.yml new file mode 100644 index 00000000000..dab7822c792 --- /dev/null +++ b/.vale/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/.vale/Microsoft/ComplexWords.yml b/.vale/Microsoft/ComplexWords.yml new file mode 100644 index 00000000000..65b7a347215 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Contractions.yml b/.vale/Microsoft/Contractions.yml new file mode 100644 index 00000000000..8c81dcbce78 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Dashes.yml b/.vale/Microsoft/Dashes.yml new file mode 100644 index 00000000000..72b05ba3e56 --- /dev/null +++ b/.vale/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: + - trim + - " " +tokens: + - '\s[—–]\s|\s[—–]|[—–]\s' diff --git a/.vale/Microsoft/DateFormat.yml b/.vale/Microsoft/DateFormat.yml new file mode 100644 index 00000000000..196531394ac --- /dev/null +++ b/.vale/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/.vale/Microsoft/DateNumbers.yml b/.vale/Microsoft/DateNumbers.yml new file mode 100644 index 00000000000..14d46747ca2 --- /dev/null +++ b/.vale/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/.vale/Microsoft/DateOrder.yml b/.vale/Microsoft/DateOrder.yml new file mode 100644 index 00000000000..12d69ba51e4 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Ellipses.yml b/.vale/Microsoft/Ellipses.yml new file mode 100644 index 00000000000..320457a8bc5 --- /dev/null +++ b/.vale/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/.vale/Microsoft/FirstPerson.yml b/.vale/Microsoft/FirstPerson.yml new file mode 100644 index 00000000000..77761af8837 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Foreign.yml b/.vale/Microsoft/Foreign.yml new file mode 100644 index 00000000000..0d3d6002a9a --- /dev/null +++ b/.vale/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/.vale/Microsoft/Gender.yml b/.vale/Microsoft/Gender.yml new file mode 100644 index 00000000000..47c08024797 --- /dev/null +++ b/.vale/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/.vale/Microsoft/GenderBias.yml b/.vale/Microsoft/GenderBias.yml new file mode 100644 index 00000000000..a7f48887f63 --- /dev/null +++ b/.vale/Microsoft/GenderBias.yml @@ -0,0 +1,46 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +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/.vale/Microsoft/GeneralURL.yml b/.vale/Microsoft/GeneralURL.yml new file mode 100644 index 00000000000..dcef503d995 --- /dev/null +++ b/.vale/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/.vale/Microsoft/HeadingAcronyms.yml b/.vale/Microsoft/HeadingAcronyms.yml new file mode 100644 index 00000000000..9dc3b6c2de7 --- /dev/null +++ b/.vale/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/.vale/Microsoft/HeadingColons.yml b/.vale/Microsoft/HeadingColons.yml new file mode 100644 index 00000000000..7013c391486 --- /dev/null +++ b/.vale/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/.vale/Microsoft/HeadingPunctuation.yml b/.vale/Microsoft/HeadingPunctuation.yml new file mode 100644 index 00000000000..eea912a8c8b --- /dev/null +++ b/.vale/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: + - trim_right + - ".?!" +tokens: + - '[a-z][.?!](?:\s|$)' diff --git a/.vale/Microsoft/Headings.yml b/.vale/Microsoft/Headings.yml new file mode 100644 index 00000000000..63624edc1b4 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Hyphens.yml b/.vale/Microsoft/Hyphens.yml new file mode 100644 index 00000000000..7e5731c9955 --- /dev/null +++ b/.vale/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: + - regex + - "-" + - " " +tokens: + - '\b[^\s-]+ly-\w+\b' diff --git a/.vale/Microsoft/Negative.yml b/.vale/Microsoft/Negative.yml new file mode 100644 index 00000000000..d73221f5390 --- /dev/null +++ b/.vale/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: + - regex + - "-" + - "–" +tokens: + - '(?<=\s)-\d+(?:\.\d+)?\b' diff --git a/.vale/Microsoft/Ordinal.yml b/.vale/Microsoft/Ordinal.yml new file mode 100644 index 00000000000..e3483e380c7 --- /dev/null +++ b/.vale/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/.vale/Microsoft/OxfordComma.yml b/.vale/Microsoft/OxfordComma.yml new file mode 100644 index 00000000000..493b55c3ce4 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Passive.yml b/.vale/Microsoft/Passive.yml new file mode 100644 index 00000000000..102d377cac8 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Percentages.yml b/.vale/Microsoft/Percentages.yml new file mode 100644 index 00000000000..b68a7363f47 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Plurals.yml b/.vale/Microsoft/Plurals.yml new file mode 100644 index 00000000000..1bb6660ade8 --- /dev/null +++ b/.vale/Microsoft/Plurals.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add '%s' to a singular noun. Use plural instead." +ignorecase: true +level: error +link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/s/s-es +raw: + - '\(s\)|\(es\)' diff --git a/.vale/Microsoft/Quotes.yml b/.vale/Microsoft/Quotes.yml new file mode 100644 index 00000000000..38f49760619 --- /dev/null +++ b/.vale/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/.vale/Microsoft/RangeTime.yml b/.vale/Microsoft/RangeTime.yml new file mode 100644 index 00000000000..72d8bbfbe3e --- /dev/null +++ b/.vale/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: + - regex + - "[-–]" + - "to" +tokens: + - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/.vale/Microsoft/Semicolon.yml b/.vale/Microsoft/Semicolon.yml new file mode 100644 index 00000000000..4d905467dd2 --- /dev/null +++ b/.vale/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/.vale/Microsoft/SentenceLength.yml b/.vale/Microsoft/SentenceLength.yml new file mode 100644 index 00000000000..f248cf0513b --- /dev/null +++ b/.vale/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/.vale/Microsoft/Spacing.yml b/.vale/Microsoft/Spacing.yml new file mode 100644 index 00000000000..bbd10e51df7 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Suspended.yml b/.vale/Microsoft/Suspended.yml new file mode 100644 index 00000000000..7282e9c9cf5 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Terms.yml b/.vale/Microsoft/Terms.yml new file mode 100644 index 00000000000..7708900ebb3 --- /dev/null +++ b/.vale/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/.vale/Microsoft/URLFormat.yml b/.vale/Microsoft/URLFormat.yml new file mode 100644 index 00000000000..82e702f9817 --- /dev/null +++ b/.vale/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/.vale/Microsoft/Units.yml b/.vale/Microsoft/Units.yml new file mode 100644 index 00000000000..f062418ee0d --- /dev/null +++ b/.vale/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/.vale/Microsoft/Vocab.yml b/.vale/Microsoft/Vocab.yml new file mode 100644 index 00000000000..eebe97b15ee --- /dev/null +++ b/.vale/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/.vale/Microsoft/We.yml b/.vale/Microsoft/We.yml new file mode 100644 index 00000000000..97c901c1bae --- /dev/null +++ b/.vale/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/.vale/Microsoft/Wordiness.yml b/.vale/Microsoft/Wordiness.yml new file mode 100644 index 00000000000..9facc10e74c --- /dev/null +++ b/.vale/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 (?!a sudden|these): 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/.vale/Microsoft/meta.json b/.vale/Microsoft/meta.json new file mode 100644 index 00000000000..297719bbbff --- /dev/null +++ b/.vale/Microsoft/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Microsoft/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.vale/config/vocabularies/Symfony/accept.txt b/.vale/config/vocabularies/Symfony/accept.txt new file mode 100644 index 00000000000..6f6387578d5 --- /dev/null +++ b/.vale/config/vocabularies/Symfony/accept.txt @@ -0,0 +1,7 @@ +Symfony +namespace +autowiring +autowired +boolean +stderr +config diff --git a/.vale/config/vocabularies/Symfony/reject.txt b/.vale/config/vocabularies/Symfony/reject.txt new file mode 100644 index 00000000000..e69de29bb2d diff --git a/.vale/write-good/Cliches.yml b/.vale/write-good/Cliches.yml new file mode 100644 index 00000000000..c95314387ba --- /dev/null +++ b/.vale/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/.vale/write-good/E-Prime.yml b/.vale/write-good/E-Prime.yml new file mode 100644 index 00000000000..074a102b250 --- /dev/null +++ b/.vale/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/.vale/write-good/Illusions.yml b/.vale/write-good/Illusions.yml new file mode 100644 index 00000000000..b4f13218592 --- /dev/null +++ b/.vale/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/.vale/write-good/Passive.yml b/.vale/write-good/Passive.yml new file mode 100644 index 00000000000..f472cb9049f --- /dev/null +++ b/.vale/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/.vale/write-good/README.md b/.vale/write-good/README.md new file mode 100644 index 00000000000..3edcc9b3760 --- /dev/null +++ b/.vale/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/.vale/write-good/So.yml b/.vale/write-good/So.yml new file mode 100644 index 00000000000..e57f099dc0b --- /dev/null +++ b/.vale/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/.vale/write-good/ThereIs.yml b/.vale/write-good/ThereIs.yml new file mode 100644 index 00000000000..8b82e8f6ccc --- /dev/null +++ b/.vale/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/.vale/write-good/TooWordy.yml b/.vale/write-good/TooWordy.yml new file mode 100644 index 00000000000..275701b1962 --- /dev/null +++ b/.vale/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/.vale/write-good/Weasel.yml b/.vale/write-good/Weasel.yml new file mode 100644 index 00000000000..e29391444bc --- /dev/null +++ b/.vale/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/.vale/write-good/meta.json b/.vale/write-good/meta.json new file mode 100644 index 00000000000..a115d2886ac --- /dev/null +++ b/.vale/write-good/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/write-good/releases.atom", + "vale_version": ">=1.0.0" +} From ac3b26b28e807f79bd4ae73f575b576b08b6aecf Mon Sep 17 00:00:00 2001 From: Wouter de Jong Date: Sat, 20 Apr 2024 14:00:19 +0200 Subject: [PATCH 2/2] Use Vale on 'quick tour', 'create framework' and getting started sections --- .vale.ini | 9 ++++- .vale/Symfony/Headings.yml | 6 +++ .vale/config/vocabularies/Symfony/accept.txt | 37 ++++++++++++++++--- configuration.rst | 6 +-- controller.rst | 4 +- create_framework/dependency_injection.rst | 2 +- create_framework/http_foundation.rst | 8 ++-- .../http_kernel_controller_resolver.rst | 2 +- create_framework/routing.rst | 2 +- create_framework/unit_testing.rst | 2 +- page_creation.rst | 2 +- quick_tour/flex_recipes.rst | 2 +- quick_tour/the_big_picture.rst | 6 +-- routing.rst | 12 +++--- setup.rst | 4 +- templates.rst | 4 +- 16 files changed, 72 insertions(+), 36 deletions(-) create mode 100644 .vale/Symfony/Headings.yml diff --git a/.vale.ini b/.vale.ini index 46d403e62c3..df52085c52c 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,6 +4,11 @@ Packages = Microsoft, write-good Vocab = Symfony [*] -BasedOnStyles = Vale, Microsoft, write-good -BlockIgnores = (?s) *(\.\. configuration-block::) +BasedOnStyles = Vale, Microsoft, write-good, Symfony +BlockIgnores = (?s) *(\.\. (configuration-block|code-block)::[^\n]+(\n\s[^\n]+)+) TokenIgnores = (:ref:`.*`) + +Microsoft.Headings = NO +Microsoft.Foreign = NO +Microsoft.Quotes = NO +Microsoft.Contractions = NO diff --git a/.vale/Symfony/Headings.yml b/.vale/Symfony/Headings.yml new file mode 100644 index 00000000000..71ede8f059e --- /dev/null +++ b/.vale/Symfony/Headings.yml @@ -0,0 +1,6 @@ +extends: capitalization +message: "'%s' should be in title case" +level: warning +scope: heading +match: $title +style: Chicago diff --git a/.vale/config/vocabularies/Symfony/accept.txt b/.vale/config/vocabularies/Symfony/accept.txt index 6f6387578d5..7179147bd31 100644 --- a/.vale/config/vocabularies/Symfony/accept.txt +++ b/.vale/config/vocabularies/Symfony/accept.txt @@ -1,7 +1,32 @@ Symfony -namespace -autowiring -autowired -boolean -stderr -config +Ctype +iconv +Tokenizer +Monolog +nginx +Laravel +ezPublish +PHPUnit +Xdebug +webpack +(?i)autocompletes +(?i)autoload(ing|ed) +(?i)autoloader +(?i)autowir(ing|ed) +(?i)autowire +(?i)auto-(installing|escaping) +(?i)boolean +(?i)charset +(?i)config +(?i)env +(?i)hardcode(d|s) +(?i)hasser +(?i)inlined +(?i)isser +(?i)namespace +(?i)profiler +(?i)reusability +(?i)stderr +(?i)uncomment +(?i)unvalidated +(?i)validator diff --git a/configuration.rst b/configuration.rst index 56bc30fcf4c..36ec78a36a8 100644 --- a/configuration.rst +++ b/configuration.rst @@ -895,9 +895,9 @@ override environment variables defined in ``.env`` files. Configuring Environment Variables in Production ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In production, the ``.env`` files are also parsed and loaded on each request. So -the easiest way to define env vars is by creating a ``.env.local`` file on your -production server(s) with your production values. +In production, the ``.env`` files are also parsed and loaded on each request. +The easiest way to define env vars is by creating a ``.env.local`` file on your +production servers with your production values. To improve performance, you can optionally run the ``dump-env`` Composer command: diff --git a/controller.rst b/controller.rst index 7866a97818b..8aa25500e5c 100644 --- a/controller.rst +++ b/controller.rst @@ -104,7 +104,7 @@ Generating URLs ~~~~~~~~~~~~~~~ The :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController::generateUrl` -method is just a helper method that generates the URL for a given route:: +method is just a helper method that generates the URL of a given route:: $url = $this->generateUrl('app_lucky_number', ['max' => 10]); @@ -458,7 +458,7 @@ In Symfony, a controller is required to return a ``Response`` object:: $response->headers->set('Content-Type', 'text/css'); To facilitate this, different response objects are included to address different -response types. Some of these are mentioned below. To learn more about the +response types. Some of these are mentioned below. To learn more about the ``Request`` and ``Response`` (and different ``Response`` classes), see the :ref:`HttpFoundation component documentation `. diff --git a/create_framework/dependency_injection.rst b/create_framework/dependency_injection.rst index de3c4e11e4e..6a1d67bbf46 100644 --- a/create_framework/dependency_injection.rst +++ b/create_framework/dependency_injection.rst @@ -65,7 +65,7 @@ reporting turned on and errors displayed in the browser to ease debugging:: environment. Having two different front controllers gives you the opportunity to have a slightly different configuration for each of them. -So, moving code from the front controller to the framework class makes our +Moving code from the front controller to the framework class makes our framework more configurable, but at the same time, it introduces a lot of issues: diff --git a/create_framework/http_foundation.rst b/create_framework/http_foundation.rst index dd838e9a5e2..9a9385e2ac3 100644 --- a/create_framework/http_foundation.rst +++ b/create_framework/http_foundation.rst @@ -22,7 +22,7 @@ it suffers from a few problems:: printf('Hello %s', $name); First, if the ``name`` query parameter is not defined in the URL query string, -you will get a PHP warning; so let's fix it:: +you will get a PHP warning; let's fix it:: // framework/index.php $name = $_GET['name'] ?? 'World'; @@ -93,8 +93,8 @@ reading this book now and go back to whatever code you were working on before. Going OOP with the HttpFoundation Component ------------------------------------------- -Writing web code is about interacting with HTTP. So, the fundamental -principles of our framework should be around the `HTTP specification`_. +Writing web code is about interacting with HTTP. The fundamental principles +of our framework should be around the `HTTP specification`_. The HTTP specification describes how a client (a browser for instance) interacts with a server (our application via a web server). The dialog between @@ -261,7 +261,7 @@ explicitly trust your reverse proxies by calling ``setTrustedProxies()``:: // the client is a known one, so give it some more privilege } -So, the ``getClientIp()`` method works securely in all circumstances. You can +The ``getClientIp()`` method works securely in all circumstances. You can use it in all your projects, whatever the configuration is, it will behave correctly and safely. That's one of the goals of using a framework. If you were to write a framework from scratch, you would have to think about all these diff --git a/create_framework/http_kernel_controller_resolver.rst b/create_framework/http_kernel_controller_resolver.rst index 12d9efead6e..9cbd2ebe5ff 100644 --- a/create_framework/http_kernel_controller_resolver.rst +++ b/create_framework/http_kernel_controller_resolver.rst @@ -1,4 +1,4 @@ -The HttpKernel Component: the Controller Resolver +The HttpKernel Component: The Controller Resolver ================================================= You might think that our framework is already pretty solid and you are diff --git a/create_framework/routing.rst b/create_framework/routing.rst index f76167ec2fb..1aabc8f5433 100644 --- a/create_framework/routing.rst +++ b/create_framework/routing.rst @@ -157,7 +157,7 @@ With this knowledge in mind, let's write the new version of our framework:: $response->send(); -There are a few new things in the code: +This code has a few new things: * Route names are used for template names; diff --git a/create_framework/unit_testing.rst b/create_framework/unit_testing.rst index 916711de0ce..de64ab60478 100644 --- a/create_framework/unit_testing.rst +++ b/create_framework/unit_testing.rst @@ -196,7 +196,7 @@ controller. We check that the response status is 200 and that its content is the one we have set in the controller. To check that we have covered all possible use cases, run the PHPUnit test -coverage feature (you need to enable `XDebug`_ first): +coverage feature (you need to enable `Xdebug`_ first): .. code-block:: terminal diff --git a/page_creation.rst b/page_creation.rst index 24735ffbc85..eef63ef6b7b 100644 --- a/page_creation.rst +++ b/page_creation.rst @@ -305,7 +305,7 @@ project: Most of the time, you'll be working in ``src/``, ``templates/`` or ``config/``. As you keep reading, you'll learn what can be done inside each of these. -So what about the other directories in the project? +What about the other directories in the project? ``bin/`` The famous ``bin/console`` file lives here (and other, less important diff --git a/quick_tour/flex_recipes.rst b/quick_tour/flex_recipes.rst index a9b101016ea..81df944ac28 100644 --- a/quick_tour/flex_recipes.rst +++ b/quick_tour/flex_recipes.rst @@ -36,7 +36,7 @@ small, simple and *fast*. And you're in total control of what you add. Flex Recipes and Aliases ------------------------ -So how can we install and configure Twig? By running one single command: +How can we install and configure Twig? By running one single command: .. code-block:: terminal diff --git a/quick_tour/the_big_picture.rst b/quick_tour/the_big_picture.rst index 3c3c4e41bf6..ba26c3c5372 100644 --- a/quick_tour/the_big_picture.rst +++ b/quick_tour/the_big_picture.rst @@ -40,7 +40,7 @@ Symfony application: └─ vendor/ Can we already load the project in a browser? Yes! You can setup -:doc:`Nginx or Apache ` and configure their +:doc:`nginx or Apache ` and configure their document root to be the ``public/`` directory. But, for development, it's better to :doc:`install the Symfony local web server ` and run it as follows: @@ -100,7 +100,7 @@ A controller is just a normal function with *one* rule: it must return a Symfony ``Response`` object. But that response can contain anything: simple text, JSON or a full HTML page. -But the routing system is *much* more powerful. So let's make the route more interesting: +But the routing system is *much* more powerful. Let's make the route more interesting: .. code-block:: diff @@ -135,7 +135,7 @@ Try the page out by going to ``http://localhost:8000/hello/Symfony``. You should see: Hello Symfony! The value of the ``{name}`` in the URL is available as a ``$name`` argument in your controller. -But this can be even simpler! So let's install annotations support: +But this can be even simpler! Let's install annotations support: .. code-block:: terminal diff --git a/routing.rst b/routing.rst index b557763e118..aaeec66d221 100644 --- a/routing.rst +++ b/routing.rst @@ -1098,9 +1098,9 @@ Parameter Conversion A common routing need is to convert the value stored in some parameter (e.g. an integer acting as the user ID) into another value (e.g. the object that -represents the user). This feature is called a "param converter". +represents the user). This feature is called a "parameter converter". -To add support for "param converters" we need SensioFrameworkExtraBundle: +To add support for "parameter converters" we need SensioFrameworkExtraBundle: .. code-block:: terminal @@ -1133,11 +1133,11 @@ controller action. Instead of ``string $slug``, add ``BlogPost $post``:: } If your controller arguments include type-hints for objects (``BlogPost`` in -this case), the "param converter" makes a database request to find the object +this case), the "parameter converter" makes a database request to find the object using the request parameters (``slug`` in this case). If no object is found, Symfony generates a 404 response automatically. -Read the `full param converter documentation`_ to learn about the converters +Read the `full parameter converter documentation`_ to learn about the converters provided by Symfony and how to configure them. Special Parameters @@ -2635,7 +2635,7 @@ use the ``generateUrl()`` helper:: .. caution:: While objects are converted to string when used as placeholders, they are not - converted when used as extra parameters. So, if you're passing an object (e.g. an Uuid) + converted when used as extra parameters. If you're passing an object (e.g. an UUID) as value of an extra parameter, you need to explicitly convert it to a string:: $this->generateUrl('blog', ['uuid' => (string) $entity->getUuid()]); @@ -3067,5 +3067,5 @@ Learn more about Routing .. _`PHP regular expressions`: https://www.php.net/manual/en/book.pcre.php .. _`PCRE Unicode properties`: https://www.php.net/manual/en/regexp.reference.unicode.php -.. _`full param converter documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html +.. _`full parameter converter documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html .. _`FOSJsRoutingBundle`: https://github.com/FriendsOfSymfony/FOSJsRoutingBundle diff --git a/setup.rst b/setup.rst index 11a443f44e1..c95ee20ef33 100644 --- a/setup.rst +++ b/setup.rst @@ -114,7 +114,7 @@ to run this command which displays information about the project: Running Symfony Applications ---------------------------- -In production, you should install a web server like Nginx or Apache and +In production, you should install a web server like nginx or Apache and :doc:`configure it to run Symfony `. This method can also be used if you're not using the Symfony local web server for development. @@ -211,7 +211,7 @@ Symfony Packs Sometimes a single feature requires installing several packages and bundles. Instead of installing them individually, Symfony provides **packs**, which are -Composer metapackages that include several dependencies. +Composer meta-packages that include several dependencies. For example, to add debugging features in your application, you can run the ``composer require --dev debug`` command. This installs the ``symfony/debug-pack``, diff --git a/templates.rst b/templates.rst index 1ff0ab1d44f..36625488353 100644 --- a/templates.rst +++ b/templates.rst @@ -362,7 +362,7 @@ Build, Versioning & More Advanced CSS, JavaScript and Image Handling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For help building, versioning and minifying your JavaScript and -CSS assets in a modern way, read about :doc:`Symfony's Webpack Encore `. +CSS assets in a modern way, read about :doc:`Symfony's webpack Encore `. .. _twig-app-variable: @@ -1034,7 +1034,7 @@ JavaScript library. First, include the `hinclude.js`_ library in your page :ref:`linking to it ` from the template or adding it -to your application JavaScript :doc:`using Webpack Encore `. +to your application JavaScript :doc:`using webpack Encore `. As the embedded content comes from another page (or controller for that matter), Symfony uses a version of the standard ``render()`` function to configure