@chaffjs/lang-en 0.15.0 → 0.17.0

package/lexicons/enumeration-joiner.yaml

@@ -0,0 +1,9 @@
+# Words and marks that join the names of one list ("Windows, macOS and Linux"). Each entry is one token.
+id: enumeration-joiner
+language: en
+entries:
+  - pattern: ","
+  - pattern: and
+  - pattern: or
+  - pattern: "&"
+  - pattern: /

package/lexicons/enumeration-negation.yaml

@@ -0,0 +1,13 @@
+# Words that negate a sentence. A negated listing ("neither image is available on Docker Hub") names what is left out
+# of a list, not what belongs to it, so outside-announced-list does not read it. Each entry is one token.
+id: enumeration-negation
+language: en
+entries:
+  - pattern: not
+  - pattern: n't
+  - pattern: never
+  - pattern: neither
+  - pattern: nor
+  - pattern: "no"
+  - pattern: cannot
+  - pattern: unsupported

package/lexicons/figure-elsewhere.yaml

@@ -0,0 +1,8 @@
+# Words right after a figure's number that place it in another document ("Figure 5 of the 2024 report", "Table 9 in
+# the annual report"). Such a reference is not looked for in this document.
+id: figure-elsewhere
+language: en
+entries:
+  - pattern: of
+  - pattern: in
+  - pattern: from

package/lexicons/figure-label.yaml

@@ -0,0 +1,14 @@
+# Words that name a figure, a table or an appendix by its number (Figure 3, Table 2, Appendix B). A reference in the
+# text is looked for among the ones labelled at the start of a line (a caption or a heading). instead_of names the
+# word an abbreviation stands for, so that "Fig. 3" and "Figure 3" are the same figure. Matched as written, or in capitals.
+id: figure-label
+language: en
+entries:
+  - pattern: Figure
+  - pattern: Fig.
+    instead_of: Figure
+  - pattern: Table
+  - pattern: Appendix
+  - pattern: Annex
+  - pattern: Exhibit
+  - pattern: Chart

package/lexicons/measure-unit.yaml

@@ -0,0 +1,78 @@
+# Unit symbols written after a measured number (1.5 mM, 37 °C, 2.5 mg/kg). A decimal at the start of a line followed
+# by one of these is an amount, not a dotted section number. Matched as written, and only when no letter, digit or
+# hyphen follows ("2.1 mmap" and "5.2.2 min-fresh" stay section titles). Symbols that begin with a capital letter
+# (Da, Pa, GB, W, V) are left out: a section title begins with a capital too, and "3.1 Da Vinci" is a title.
+id: measure-unit
+language: en
+entries:
+  - pattern: "mM"
+  - pattern: "µM"
+  - pattern: "μM"
+  - pattern: "nM"
+  - pattern: "pM"
+  - pattern: "mol"
+  - pattern: "mmol"
+  - pattern: "µmol"
+  - pattern: "μmol"
+  - pattern: "nmol"
+  - pattern: "pmol"
+  - pattern: "kg"
+  - pattern: "mg"
+  - pattern: "µg"
+  - pattern: "μg"
+  - pattern: "ng"
+  - pattern: "pg"
+  - pattern: "kDa"
+  - pattern: "mL"
+  - pattern: "ml"
+  - pattern: "µL"
+  - pattern: "μL"
+  - pattern: "µl"
+  - pattern: "μl"
+  - pattern: "dL"
+  - pattern: "nL"
+  - pattern: "km"
+  - pattern: "cm"
+  - pattern: "mm"
+  - pattern: "µm"
+  - pattern: "μm"
+  - pattern: "nm"
+  - pattern: "ms"
+  - pattern: "µs"
+  - pattern: "μs"
+  - pattern: "ns"
+  - pattern: "min"
+  - pattern: "sec"
+  - pattern: "hr"
+  - pattern: "hrs"
+  - pattern: "kHz"
+  - pattern: "mA"
+  - pattern: "mV"
+  - pattern: "kV"
+  - pattern: "kW"
+  - pattern: "kWh"
+  - pattern: "mAh"
+  - pattern: "kPa"
+  - pattern: "mmHg"
+  - pattern: "atm"
+  - pattern: "psi"
+  - pattern: "kB"
+  - pattern: "bp"
+  - pattern: "kb"
+  - pattern: "kbp"
+  - pattern: "ppm"
+  - pattern: "ppb"
+  - pattern: "rpm"
+  - pattern: "dB"
+  - pattern: "mCi"
+  - pattern: "µCi"
+  - pattern: "μCi"
+  - pattern: "mGy"
+  - pattern: "mSv"
+  - pattern: "°C"
+  - pattern: "°F"
+  - pattern: "℃"
+  - pattern: "℉"
+  - pattern: "°"
+  - pattern: "%"
+  - pattern: "‰"

package/lexicons/nominalization-phrase.yaml

@@ -0,0 +1,27 @@
+# Hidden verbs: a verb turned into a noun and carried by a weak verb ("make a decision" for "decide"). nominalization
+# reads them. The Federal Plain Language Guidelines ("Use the active voice" / "Avoid hidden verbs") and GOV.UK ("Use
+# clear language") ask for the verb. instead_of is the verb. A verb in the pattern matches its other forms (made, makes).
+id: nominalization-phrase
+language: en
+entries:
+  - { pattern: make a decision, instead_of: decide }
+  - { pattern: reach a decision, instead_of: decide }
+  - { pattern: conduct an investigation, instead_of: investigate }
+  - { pattern: carry out an investigation, instead_of: investigate }
+  - { pattern: conduct an analysis, instead_of: analyze }
+  - { pattern: perform an analysis, instead_of: analyze }
+  - { pattern: carry out an analysis, instead_of: analyze }
+  - { pattern: make an assessment, instead_of: assess }
+  - { pattern: conduct an assessment, instead_of: assess }
+  - { pattern: conduct a review, instead_of: review }
+  - { pattern: perform a review, instead_of: review }
+  - { pattern: make a recommendation, instead_of: recommend }
+  - { pattern: make a determination, instead_of: determine }
+  - { pattern: give consideration to, instead_of: consider }
+  - { pattern: provide assistance, instead_of: help }
+  - { pattern: make an application, instead_of: apply }
+  - { pattern: make a payment, instead_of: pay }
+  - { pattern: make an adjustment, instead_of: adjust }
+  - { pattern: come to a conclusion, instead_of: conclude }
+  - { pattern: have a discussion, instead_of: discuss }
+  - { pattern: make reference to, instead_of: refer to }

package/lexicons/numbered-label.yaml

@@ -0,0 +1,26 @@
+# Words written before a number to name an item of a series (Step 3, Example 4). At the head of a heading they are a
+# label, which the text below never repeats, so heading-echo does not count them in the overlap. position is the side
+# of the number the word is written on. Matched as written.
+id: numbered-label
+language: en
+entries:
+  - pattern: Step
+    position: before
+  - pattern: Example
+    position: before
+  - pattern: Case
+    position: before
+  - pattern: Exercise
+    position: before
+  - pattern: Question
+    position: before
+  - pattern: Problem
+    position: before
+  - pattern: Lesson
+    position: before
+  - pattern: Stage
+    position: before
+  - pattern: Figure
+    position: before
+  - pattern: Table
+    position: before

package/lexicons/percent-unit.yaml

@@ -0,0 +1,7 @@
+# The marks and words written as the unit of a percentage.
+id: percent-unit
+language: en
+entries:
+  - pattern: "%"
+  - pattern: percent
+  - pattern: per cent

package/lexicons/place-region.yaml

@@ -0,0 +1,247 @@
+# The names a place is followed by, after a comma, to say where it is: US states and the District of Columbia, and
+# countries ("New London, Wisconsin, and …", "Lyon, France, and …"). The comma between a place and its state or country
+# is part of the name, not a list's comma. Matched as written, word by word. A name with position: after is written only
+# after a place's name (Washington, D.C.), so it is read as one even after a state's name.
+id: place-region
+language: en
+entries:
+  - pattern: Alabama
+  - pattern: Alaska
+  - pattern: Arizona
+  - pattern: Arkansas
+  - pattern: California
+  - pattern: Colorado
+  - pattern: Connecticut
+  - pattern: Delaware
+  - pattern: Florida
+  - pattern: Georgia
+  - pattern: Hawaii
+  - pattern: Idaho
+  - pattern: Illinois
+  - pattern: Indiana
+  - pattern: Iowa
+  - pattern: Kansas
+  - pattern: Kentucky
+  - pattern: Louisiana
+  - pattern: Maine
+  - pattern: Maryland
+  - pattern: Massachusetts
+  - pattern: Michigan
+  - pattern: Minnesota
+  - pattern: Mississippi
+  - pattern: Missouri
+  - pattern: Montana
+  - pattern: Nebraska
+  - pattern: Nevada
+  - pattern: New Hampshire
+  - pattern: New Jersey
+  - pattern: New Mexico
+  - pattern: New York
+  - pattern: North Carolina
+  - pattern: North Dakota
+  - pattern: Ohio
+  - pattern: Oklahoma
+  - pattern: Oregon
+  - pattern: Pennsylvania
+  - pattern: Rhode Island
+  - pattern: South Carolina
+  - pattern: South Dakota
+  - pattern: Tennessee
+  - pattern: Texas
+  - pattern: Utah
+  - pattern: Vermont
+  - pattern: Virginia
+  - pattern: Washington
+  - pattern: West Virginia
+  - pattern: Wisconsin
+  - pattern: Wyoming
+  - pattern: D.C.
+    position: after
+  - pattern: Puerto Rico
+  - pattern: Guam
+  - pattern: Afghanistan
+  - pattern: Albania
+  - pattern: Algeria
+  - pattern: Andorra
+  - pattern: Angola
+  - pattern: Argentina
+  - pattern: Armenia
+  - pattern: Australia
+  - pattern: Austria
+  - pattern: Azerbaijan
+  - pattern: Bahamas
+  - pattern: Bahrain
+  - pattern: Bangladesh
+  - pattern: Barbados
+  - pattern: Belarus
+  - pattern: Belgium
+  - pattern: Belize
+  - pattern: Benin
+  - pattern: Bhutan
+  - pattern: Bolivia
+  - pattern: Bosnia and Herzegovina
+  - pattern: Botswana
+  - pattern: Brazil
+  - pattern: Brunei
+  - pattern: Bulgaria
+  - pattern: Burkina Faso
+  - pattern: Burundi
+  - pattern: Cambodia
+  - pattern: Cameroon
+  - pattern: Canada
+  - pattern: Chad
+  - pattern: Chile
+  - pattern: China
+  - pattern: Colombia
+  - pattern: Costa Rica
+  - pattern: Croatia
+  - pattern: Cuba
+  - pattern: Cyprus
+  - pattern: Czechia
+  - pattern: Czech Republic
+  - pattern: Denmark
+  - pattern: Djibouti
+  - pattern: Dominican Republic
+  - pattern: Ecuador
+  - pattern: Egypt
+  - pattern: El Salvador
+  - pattern: England
+  - pattern: Eritrea
+  - pattern: Estonia
+  - pattern: Eswatini
+  - pattern: Ethiopia
+  - pattern: Fiji
+  - pattern: Finland
+  - pattern: France
+  - pattern: Gabon
+  - pattern: Gambia
+  - pattern: Germany
+  - pattern: Ghana
+  - pattern: Greece
+  - pattern: Guatemala
+  - pattern: Guinea
+  - pattern: Guyana
+  - pattern: Haiti
+  - pattern: Honduras
+  - pattern: Hungary
+  - pattern: Iceland
+  - pattern: India
+  - pattern: Indonesia
+  - pattern: Iran
+  - pattern: Iraq
+  - pattern: Ireland
+  - pattern: Israel
+  - pattern: Italy
+  - pattern: Jamaica
+  - pattern: Japan
+  - pattern: Jordan
+  - pattern: Kazakhstan
+  - pattern: Kenya
+  - pattern: Kosovo
+  - pattern: Kuwait
+  - pattern: Kyrgyzstan
+  - pattern: Laos
+  - pattern: Latvia
+  - pattern: Lebanon
+  - pattern: Lesotho
+  - pattern: Liberia
+  - pattern: Libya
+  - pattern: Liechtenstein
+  - pattern: Lithuania
+  - pattern: Luxembourg
+  - pattern: Madagascar
+  - pattern: Malawi
+  - pattern: Malaysia
+  - pattern: Maldives
+  - pattern: Mali
+  - pattern: Malta
+  - pattern: Mauritania
+  - pattern: Mauritius
+  - pattern: Mexico
+  - pattern: Moldova
+  - pattern: Monaco
+  - pattern: Mongolia
+  - pattern: Montenegro
+  - pattern: Morocco
+  - pattern: Mozambique
+  - pattern: Myanmar
+  - pattern: Namibia
+  - pattern: Nepal
+  - pattern: Netherlands
+  - pattern: New Zealand
+  - pattern: Nicaragua
+  - pattern: Niger
+  - pattern: Nigeria
+  - pattern: North Korea
+  - pattern: North Macedonia
+  - pattern: Northern Ireland
+  - pattern: Norway
+  - pattern: Oman
+  - pattern: Pakistan
+  - pattern: Panama
+  - pattern: Papua New Guinea
+  - pattern: Paraguay
+  - pattern: Peru
+  - pattern: Philippines
+  - pattern: Poland
+  - pattern: Portugal
+  - pattern: Qatar
+  - pattern: Romania
+  - pattern: Russia
+  - pattern: Rwanda
+  - pattern: Saudi Arabia
+  - pattern: Scotland
+  - pattern: Senegal
+  - pattern: Serbia
+  - pattern: Sierra Leone
+  - pattern: Singapore
+  - pattern: Slovakia
+  - pattern: Slovenia
+  - pattern: Somalia
+  - pattern: South Africa
+  - pattern: South Korea
+  - pattern: South Sudan
+  - pattern: Spain
+  - pattern: Sri Lanka
+  - pattern: Sudan
+  - pattern: Suriname
+  - pattern: Sweden
+  - pattern: Switzerland
+  - pattern: Syria
+  - pattern: Taiwan
+  - pattern: Tajikistan
+  - pattern: Tanzania
+  - pattern: Thailand
+  - pattern: Togo
+  - pattern: Trinidad and Tobago
+  - pattern: Tunisia
+  - pattern: Turkey
+  - pattern: Türkiye
+  - pattern: Turkmenistan
+  - pattern: Uganda
+  - pattern: Ukraine
+  - pattern: United Arab Emirates
+  - pattern: United Kingdom
+  - pattern: UK
+  - pattern: U.K.
+  - pattern: United States
+  - pattern: USA
+  - pattern: U.S.
+  - pattern: U.S.A.
+  - pattern: Uruguay
+  - pattern: Uzbekistan
+  - pattern: Venezuela
+  - pattern: Vietnam
+  - pattern: Wales
+  - pattern: Yemen
+  - pattern: Zambia
+  - pattern: Zimbabwe
+  - pattern: Alberta
+  - pattern: British Columbia
+  - pattern: Manitoba
+  - pattern: New Brunswick
+  - pattern: Newfoundland and Labrador
+  - pattern: Nova Scotia
+  - pattern: Ontario
+  - pattern: Quebec
+  - pattern: Saskatchewan

package/lexicons/placeholder-word.yaml

@@ -0,0 +1,17 @@
+# What a template writes inside the brackets of a blank: [Your Name], [Insert Date], [Company Name].
+# A bracket counts when it holds one of these, alone or followed by more words.
+id: placeholder-word
+language: en
+entries:
+  - pattern: your
+  - pattern: insert
+  - pattern: recipient
+  - pattern: name
+  - pattern: company name
+  - pattern: client name
+  - pattern: project name
+  - pattern: product name
+  - pattern: date
+  - pattern: describe
+  - pattern: specific
+  - pattern: add

package/lexicons/range-connector.yaml

@@ -0,0 +1,12 @@
+# Marks and words that, alone between two dates, make a period ("5 April – 9 April", "May 1 through May 5").
+# "to" is not one: "moved from March 10 to March 3" changes a date rather than spanning a period.
+id: range-connector
+language: en
+entries:
+  - pattern: "-"
+  - pattern: –
+  - pattern: —
+  - pattern: through
+  - pattern: thru
+  - pattern: until
+  - pattern: till

package/lexicons/range-frame.yaml

@@ -0,0 +1,9 @@
+# A word before the first date and a word between the two dates that together make a period: "from 1 May 2026 to
+# 31 May 2026". Written as "lead … joint". "to" alone is not a range-connector because "moved from March 10 to March 3"
+# changes a date; date-change-word says when the frame is a change instead. "between … and" is not a frame: "choose
+# between 1 May and 30 April" names two dates to pick from.
+id: range-frame
+language: en
+entries:
+  - pattern: from … to
+  - pattern: from … up to

package/lexicons/requirement-either.yaml

@@ -0,0 +1,5 @@
+# "and/or" (Berry et al. 2003): the reader cannot tell whether both are meant, or either one is enough.
+id: requirement-either
+language: en
+entries:
+  - pattern: and/or

package/lexicons/requirement-loophole.yaml

@@ -0,0 +1,17 @@
+# Phrases that open a loophole in a requirement or leave it unverifiable (Femmer et al. 2017; the terms ISO/IEC/IEEE
+# 29148 says to avoid). The reader cannot tell how much is enough to meet it.
+id: requirement-loophole
+language: en
+entries:
+  - pattern: as far as possible
+  - pattern: as much as possible
+  - pattern: as soon as possible
+  - pattern: as fast as possible
+  - pattern: to the extent possible
+  - pattern: if possible
+  - pattern: where possible
+  - pattern: as appropriate
+  - pattern: where appropriate
+  - pattern: as applicable
+  - pattern: if necessary
+  - pattern: as needed

package/lexicons/requirement-marker.yaml

@@ -0,0 +1,9 @@
+# What makes a sentence a requirement for requirement-smell: the forms ISO/IEC/IEEE 29148 and the Federal Plain Language
+# Guidelines use for an obligation. Only a sentence with one of them is read as a requirement.
+id: requirement-marker
+language: en
+entries:
+  - pattern: shall
+  - pattern: must
+  - pattern: is required to
+  - pattern: are required to

package/lexicons/requirement-modal-must.yaml

@@ -0,0 +1,7 @@
+# "shall" and what to write instead (instead_of), read by requirement-modal when shall: must is set.
+# The Federal Plain Language Guidelines (PLAIN 2011) say to use "must" for an obligation: "shall" is ambiguous, read as
+# an obligation, a future or a permission, and courts have read it each way.
+id: requirement-modal-must
+language: en
+entries:
+  - { pattern: shall, instead_of: must }

package/lexicons/requirement-open-end.yaml

@@ -0,0 +1,9 @@
+# Words that leave a list open (Femmer et al. 2017, open-ended terms; ISO/IEC/IEEE 29148 names "but not limited to").
+# In a requirement the reader cannot tell what else it covers.
+id: requirement-open-end
+language: en
+entries:
+  - pattern: etc.
+  - pattern: and so on
+  - pattern: and the like
+  - pattern: but not limited to

package/lexicons/share-exception.yaml

@@ -0,0 +1,10 @@
+# Words that mark a count whose percentages need not add up to 100%. When the header or the text above has one, the
+# percentages are not added.
+id: share-exception
+language: en
+entries:
+  - pattern: multiple answers
+  - pattern: multiple responses
+  - pattern: more than one
+  - pattern: select all
+  - pattern: all that apply

package/lexicons/share-label.yaml

@@ -0,0 +1,12 @@
+# Words that name the parts of one whole (they add up to 100%). When a table's header, or the sentence or heading right
+# above a list or a table, has one of these, its percentages are added and compared with 100%.
+# "rate" and "percentage" are left out: they also name a rate per row. So is a bare "share" ("share price return").
+id: share-label
+language: en
+entries:
+  - pattern: breakdown
+  - pattern: market share
+  - pattern: share of
+  - pattern: composition
+  - pattern: split
+  - pattern: allocation