axyseo 2.0.0-alpha.0.0.19 → 2.0.0-alpha.0.0.2

package/src/languageProcessing/languages/en/config/functionWords.js

@@ -0,0 +1,186 @@
+import {
+	all as passiveAuxiliaries,
+} from "./internal/passiveVoiceAuxiliaries.js";
+import { singleWords as transitionWords } from "./transitionWords.js";
+import transformWordsWithHyphens from "../../../helpers/transform/transformWordsWithHyphens";
+
+const articles = [ "the", "an", "a" ];
+const cardinalNumerals = [ "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve", "thirteen",
+	"fourteen", "fifteen", "sixteen", "seventeen", "eighteen", "nineteen", "twenty", "hundred", "hundreds", "thousand", "thousands",
+	"million", "millions", "billion", "billions" ];
+
+const ordinalNumerals = [ "first", "second", "third", "fourth", "fifth", "sixth", "seventh", "eighth", "ninth", "tenth",
+	"eleventh", "twelfth", "thirteenth", "fourteenth", "fifteenth", "sixteenth", "seventeenth", "eighteenth",
+	"nineteenth", "twentieth" ];
+
+const personalPronounsNominative = [ "i", "you", "he", "she", "it", "we", "they" ];
+const personalPronounsAccusative = [ "me", "him", "us", "them" ];
+const demonstrativePronouns = [ "this", "that", "these", "those" ];
+const possessivePronouns = [ "my", "your", "his", "her", "its", "their", "our", "mine", "yours", "hers", "theirs", "ours" ];
+const quantifiers = [ "all", "some", "many", "lot", "lots", "ton", "tons", "bit", "no", "every", "enough", "little",
+	"much", "more", "most", "plenty", "several", "few", "fewer", "kind", "kinds" ];
+const reflexivePronouns = [ "myself", "yourself", "himself", "herself", "itself", "oneself", "ourselves", "yourselves", "themselves" ];
+const indefinitePronouns = [ "none", "nobody", "everyone", "everybody", "someone", "somebody", "anyone", "anybody", "nothing",
+	"everything", "something", "anything", "each", "other", "whatever", "whichever", "whoever", "whomever",
+	"whomsoever", "whosoever", "others", "neither", "both", "either", "any", "such" ];
+const indefinitePronounsPossessive  = [ "one's", "nobody's", "everyone's", "everybody's", "someone's", "somebody's", "anyone's",
+	"anybody's", "nothing's", "everything's", "something's", "anything's", "whoever's", "others'", "other's", "another's",
+	"neither's", "either's" ];
+
+const interrogativeDeterminers = [ "which", "what", "whose" ];
+const interrogativePronouns = [ "who", "whom" ];
+const interrogativeProAdverbs = [ "where", "how", "why", "whether", "wherever", "whyever", "wheresoever", "whensoever", "howsoever",
+	"whysoever", "whatsoever", "whereso", "whomso", "whenso", "howso", "whyso", "whoso", "whatso" ];
+const pronominalAdverbs = [ "therefor", "therein", "hereby", "hereto", "wherein", "therewith", "herewith", "wherewith", "thereby" ];
+const locativeAdverbs = [ "there", "here", "whither", "thither", "hither", "whence", "thence" ];
+const adverbialGenitives = [ "always", "once", "twice", "thrice" ];
+const otherAuxiliaries = [ "can", "cannot", "can't", "could", "couldn't", "could've", "dare", "dares", "dared", "do",
+	"don't", "does", "doesn't", "did", "didn't", "done", "have", "haven't", "had", "hadn't", "has", "hasn't",
+	"i've", "you've", "we've", "they've", "i'd", "you'd", "he'd", "she'd", "it'd", "we'd", "they'd", "would", "wouldn't",
+	"would've", "may", "might", "must", "need", "needn't", "needs", "ought", "shall", "shalln't", "shan't", "should",
+	"shouldn't", "will", "won't", "i'll", "you'll", "he'll", "she'll", "it'll", "we'll", "they'll", "there's", "there're",
+	"there'll", "here's", "here're", "there'll" ];
+const copula = [ "appear", "appears", "appeared", "become", "becomes", "became", "come", "comes", "came", "keep", "keeps", "kept",
+	"remain", "remains", "remained", "stay", "stays", "stayed", "turn", "turns", "turned" ];
+
+// These verbs should only be included at the beginning of combinations.
+const continuousVerbs = [ "doing", "daring", "having", "appearing", "becoming", "coming", "keeping", "remaining", "staying",
+	"saying", "asking", "stating", "seeming", "letting", "making", "setting", "showing", "putting", "adding", "going", "using",
+	"trying", "containing" ];
+
+const prepositions = [ "in", "from", "with", "under", "throughout", "atop", "for", "on", "of", "to", "aboard", "about",
+	"above", "abreast", "absent", "across", "adjacent", "after", "against", "along", "alongside", "amid", "mid",
+	"among", "apropos", "apud", "around", "as", "astride", "at", "ontop", "afore", "tofore", "behind", "ahind",
+	"below", "ablow", "beneath", "neath", "beside", "between", "atween", "beyond", "ayond", "by", "chez",
+	"circa", "spite", "down", "except", "into", "less", "like", "minus", "near", "nearer", "nearest", "anear", "notwithstanding",
+	"off", "onto", "opposite", "out", "outen", "over", "past", "per", "pre", "qua", "sans", "sithence", "through",
+	"thru", "truout", "toward", "underneath", "up", "upon", "upside", "versus", "via", "vis-à-vis", "without", "ago",
+	"apart", "aside", "aslant", "away", "withal", "towards", "amidst", "amongst", "midst", "whilst" ];
+
+// Many prepositional adverbs are already listed as preposition.
+const prepositionalAdverbs = [ "back", "within", "forward", "backward", "ahead" ];
+
+const coordinatingConjunctions = [ "and", "or", "and/or", "yet" ];
+
+// 'sooner' is part of 'no sooner...than', 'just' is part of 'just as...so',
+// 'Only' is part of 'not only...but also'.
+const correlativeConjunctions = [ "sooner", "just", "only" ];
+const subordinatingConjunctions = [ "if", "even" ];
+
+// These verbs are frequently used in interviews to indicate questions and answers.
+// 'Claim','claims', 'state' and 'states' are not included, because these words are also nouns.
+const interviewVerbs = [ "say", "says", "said", "claimed", "ask", "asks", "asked", "stated", "explain", "explains", "explained",
+	"think", "thinks", "talks", "talked", "announces", "announced", "tells", "told", "discusses", "discussed", "suggests",
+	"suggested", "understands", "understood" ];
+
+// These transition words were not included in the list for the transition word assessment for various reasons.
+const additionalTransitionWords = [ "again", "definitely", "eternally", "expressively", "instead",
+	"expressly", "immediately", "including", "instantly", "namely", "naturally", "next", "notably", "now", "nowadays",
+	"ordinarily", "positively", "truly", "ultimately", "uniquely", "usually", "almost", "maybe",
+	"probably", "granted", "initially", "too", "actually", "already", "e.g", "i.e", "often", "regularly", "simply",
+	"optionally", "perhaps", "sometimes", "likely", "never", "ever", "else", "inasmuch", "provided", "currently", "incidentally",
+	"elsewhere", "particular", "recently", "relatively", "f.i", "clearly", "apparently" ];
+
+const intensifiers = [ "highly", "very", "really", "extremely", "absolutely", "completely", "totally", "utterly", "quite",
+	"somewhat", "seriously", "fairly", "fully", "amazingly" ];
+
+/* These verbs convey little meaning. 'Show', 'shows', 'uses', 'meaning', 'set', 'sets'
+ are not included, because these words could be relevant nouns.
+
+ */
+const delexicalizedVerbs = [ "seem", "seems", "seemed", "let", "let's", "lets", "make", "makes", "made", "want", "showed", "shown",
+	"go", "goes", "went", "gone", "take", "takes", "took", "taken",	"put", "puts", "use", "used", "try", "tries", "tried", "mean",
+	"means", "meant", "called", "based", "add", "adds", "added", "contain", "contains", "contained", "consist", "consists",
+	"consisted", "ensure", "ensures", "ensured" ];
+
+// These adjectives and adverbs are so general, they should never be suggested as a (single) keyword.
+// Keyword combinations containing these adjectives/adverbs are fine.
+const generalAdjectivesAdverbs = [ "new", "newer", "newest", "old", "older", "oldest", "previous", "good", "well", "better", "best",
+	"big", "bigger", "biggest", "easy", "easier", "easiest", "fast", "faster", "fastest", "far", "hard", "harder", "hardest",
+	"least", "own", "large", "larger", "largest", "long", "longer", "longest", "low", "lower", "lowest", "high", "higher",
+	"highest", "regular", "simple", "simpler", "simplest", "small", "smaller", "smallest", "tiny", "tinier", "tiniest",
+	"short", "shorter", "shortest", "main", "actual", "nice", "nicer", "nicest", "real", "same", "able", "certain", "usual",
+	"so-called", "mainly", "mostly", "recent", "anymore", "complete", "lately", "possible", "commonly", "constantly",
+	"continually", "directly", "easily", "nearly", "slightly", "somewhere", "estimated", "latest", "different", "similar",
+	"widely", "bad", "worse", "worst", "great", "specific",  "available", "average", "awful", "awesome", "basic", "beautiful",
+	"busy", "current", "entire", "everywhere", "important", "major", "multiple", "normal", "necessary", "obvious", "partly",
+	"special", "last", "early", "earlier", "earliest", "young", "younger", "youngest" ];
+
+const interjections = [ "oh", "wow", "tut-tut", "tsk-tsk", "ugh", "whew", "phew", "yeah", "yea", "shh", "oops", "ouch", "aha",
+	"yikes" ];
+
+// These words and abbreviations are frequently used in recipes in lists of ingredients.
+const recipeWords = [ "tbs", "tbsp", "spk", "lb", "qt", "pk", "bu", "oz", "pt", "mod", "doz", "hr", "f.g", "ml", "dl", "cl",
+	"l", "mg", "g", "kg", "quart" ];
+
+const timeWords = [ "seconds", "minute", "minutes", "hour", "hours", "day", "days", "week", "weeks", "month", "months",
+	"year", "years", "today", "tomorrow", "yesterday" ];
+
+// 'People' should only be removed in combination with 'some', 'many' and 'few' (and is therefore not yet included in the list below).
+const vagueNouns = [ "thing", "things", "way", "ways", "matter", "case", "likelihood", "ones", "piece", "pieces", "stuff", "times",
+	"part", "parts", "percent", "instance", "instances", "aspect", "aspects", "item", "items", "idea", "theme", "person", "instance",
+	"instances", "detail", "details", "factor", "factors", "difference", "differences" ];
+
+// 'No' is already included in the quantifier list.
+const miscellaneous = [ "not", "yes", "sure", "top", "bottom", "ok", "okay", "amen", "aka", "etc", "etcetera", "sorry", "please" ];
+
+const titlesPreceding = [ "ms", "mss", "mrs", "mr", "dr", "prof" ];
+
+const titlesFollowing = [ "jr", "sr" ];
+
+// These word categories are filtered at the ending of word combinations.
+export const filteredAtEnding = transformWordsWithHyphens( [].concat( ordinalNumerals, continuousVerbs, generalAdjectivesAdverbs ) );
+
+// These word categories are filtered at the beginning and ending of word combinations.
+export const filteredAtBeginningAndEnding = transformWordsWithHyphens( [].concat( articles, prepositions, coordinatingConjunctions,
+	demonstrativePronouns, intensifiers,
+	quantifiers, possessivePronouns ) );
+
+// These word categories are filtered everywhere within word combinations.
+export const filteredAnywhere = transformWordsWithHyphens( [].concat( transitionWords, adverbialGenitives, personalPronounsNominative,
+	personalPronounsAccusative, reflexivePronouns, interjections, cardinalNumerals, passiveAuxiliaries, otherAuxiliaries,
+	copula, interviewVerbs, delexicalizedVerbs, indefinitePronouns, correlativeConjunctions, subordinatingConjunctions, interrogativeDeterminers,
+	interrogativePronouns, interrogativeProAdverbs, locativeAdverbs, miscellaneous, prepositionalAdverbs, pronominalAdverbs,
+	recipeWords, timeWords, vagueNouns ) );
+
+// These categories are used in the passive voice assessment. If they directly precede a participle, the sentence part is not passive.
+export const cannotDirectlyPrecedePassiveParticiple = transformWordsWithHyphens( [].concat( articles, prepositions, demonstrativePronouns,
+	possessivePronouns, ordinalNumerals, continuousVerbs, quantifiers ) );
+
+/*
+These categories are used in the passive voice assessment. If they appear between an auxiliary and a participle,
+the sentence part is not passive.
+*/
+export const cannotBeBetweenPassiveAuxiliaryAndParticiple = transformWordsWithHyphens( [].concat( otherAuxiliaries, copula, interviewVerbs,
+	delexicalizedVerbs ) );
+
+/**
+  * These categories consist of function words that are not nouns.
+  * They are used in the inclusive language to recognize overgeneralizing phrases such as "the aged".
+  * @type{string[]}
+  */
+export const nonNouns = transformWordsWithHyphens( [].concat( articles, cardinalNumerals, ordinalNumerals, demonstrativePronouns,
+	possessivePronouns, reflexivePronouns, personalPronounsNominative, personalPronounsAccusative, quantifiers, indefinitePronouns, continuousVerbs,
+	indefinitePronounsPossessive, interrogativeDeterminers, interrogativePronouns, interrogativeProAdverbs,
+	pronominalAdverbs, locativeAdverbs, adverbialGenitives, prepositionalAdverbs, passiveAuxiliaries, otherAuxiliaries, copula, prepositions,
+	coordinatingConjunctions, correlativeConjunctions, subordinatingConjunctions, interviewVerbs,
+	transitionWords, additionalTransitionWords, intensifiers, delexicalizedVerbs, interjections, generalAdjectivesAdverbs,
+	recipeWords, miscellaneous, titlesFollowing ) );
+
+// This export contains all of the above words.
+export const all = transformWordsWithHyphens( [].concat( articles, cardinalNumerals, ordinalNumerals, demonstrativePronouns, possessivePronouns,
+	reflexivePronouns, personalPronounsNominative, personalPronounsAccusative, quantifiers, indefinitePronouns, continuousVerbs,
+	indefinitePronounsPossessive, interrogativeDeterminers, interrogativePronouns, interrogativeProAdverbs,
+	pronominalAdverbs, locativeAdverbs, adverbialGenitives, prepositionalAdverbs, passiveAuxiliaries, otherAuxiliaries, copula,
+	prepositions, coordinatingConjunctions, correlativeConjunctions, subordinatingConjunctions, interviewVerbs,
+	transitionWords, additionalTransitionWords, intensifiers, delexicalizedVerbs, interjections, generalAdjectivesAdverbs,
+	recipeWords, vagueNouns, miscellaneous, timeWords, titlesPreceding, titlesFollowing ) );
+
+export default {
+	filteredAtEnding,
+	filteredAtBeginningAndEnding,
+	filteredAnywhere,
+	cannotDirectlyPrecedePassiveParticiple,
+	cannotBeBetweenPassiveAuxiliaryAndParticiple,
+	all,
+};

package/src/languageProcessing/languages/en/config/internal/passiveVoiceAuxiliaries.js

@@ -0,0 +1,44 @@
+// All lists except for the `other` one are also used to create rules for some inclusive language assessments.
+// The auxiliaries are categorized into different lists because this categorization is needed for the inclusive language rules.
+export const formsOfToBe = [
+	"am",
+	"is",
+	"are",
+	"was",
+	"were",
+	"been",
+	"be",
+	"she's",
+	"he's",
+	"it's",
+	"i'm",
+	"we're",
+	"they're",
+	"you're",
+	"that's",
+	"being",
+];
+
+export const negatedFormsOfToBe = [
+	"isn't",
+	"weren't",
+	"wasn't",
+	"aren't",
+];
+
+export const formsOfToGet =  [
+	"get",
+	"gets",
+	"got",
+	"gotten",
+	"getting",
+];
+
+export const other = [
+	"having",
+	"what's",
+];
+
+export const all = formsOfToBe.concat( negatedFormsOfToBe, formsOfToGet, other );
+
+export default all;

package/src/languageProcessing/languages/en/config/internal/passiveVoiceIrregulars.js

@@ -0,0 +1,354 @@
+/**
+ * Returns a list of en irregulars.
+ *
+ * @type {string[]} English irregulars.
+ */
+export default [
+	"arisen",
+	"awoken",
+	"reawoken",
+	"babysat",
+	"backslid",
+	"backslidden",
+	"beat",
+	"beaten",
+	"become",
+	"begun",
+	"bent",
+	"unbent",
+	"bet",
+	"bid",
+	"outbid",
+	"rebid",
+	"underbid",
+	"overbid",
+	"bidden",
+	"bitten",
+	"blown",
+	"bought",
+	"overbought",
+	"bound",
+	"unbound",
+	"rebound",
+	"broadcast",
+	"rebroadcast",
+	"broken",
+	"brought",
+	"browbeat",
+	"browbeaten",
+	"built",
+	"prebuilt",
+	"rebuilt",
+	"overbuilt",
+	"burnt",
+	"burst",
+	"bust",
+	"cast",
+	"miscast",
+	"recast",
+	"caught",
+	"chosen",
+	"clung",
+	"come",
+	"overcome",
+	"cost",
+	"crept",
+	"cut",
+	"undercut",
+	"recut",
+	"daydreamt",
+	"dealt",
+	"misdealt",
+	"redealt",
+	"disproven",
+	"done",
+	"predone",
+	"outdone",
+	"misdone",
+	"redone",
+	"overdone",
+	"undone",
+	"drawn",
+	"outdrawn",
+	"redrawn",
+	"overdrawn",
+	"dreamt",
+	"driven",
+	"outdriven",
+	"drunk",
+	"outdrunk",
+	"overdrunk",
+	"dug",
+	"dwelt",
+	"eaten",
+	"overeaten",
+	"fallen",
+	"felt",
+	"fit",
+	"refit",
+	"retrofit",
+	"flown",
+	"outflown",
+	"flung",
+	"forbidden",
+	"forecast",
+	"foregone",
+	"foreseen",
+	"foretold",
+	"forgiven",
+	"forgotten",
+	"forsaken",
+	"fought",
+	"outfought",
+	"found",
+	"frostbitten",
+	"frozen",
+	"unfrozen",
+	"given",
+	"gone",
+	"undergone",
+	//	Is also auxiliary: "got",
+	"gotten",
+	"ground",
+	"reground",
+	"grown",
+	"outgrown",
+	"regrown",
+	"had",
+	"handwritten",
+	"heard",
+	"reheard",
+	"misheard",
+	"overheard",
+	"held",
+	"hewn",
+	"hidden",
+	"unhidden",
+	"hit",
+	"hung",
+	"rehung",
+	"overhung",
+	"unhung",
+	"hurt",
+	"inlaid",
+	"input",
+	"interwound",
+	"interwoven",
+	"jerry-built",
+	"kept",
+	"knelt",
+	"knit",
+	"reknit",
+	"unknit",
+	"known",
+	"laid",
+	"mislaid",
+	"relaid",
+	"overlaid",
+	"lain",
+	"underlain",
+	"leant",
+	"leapt",
+	"outleapt",
+	"learnt",
+	"unlearnt",
+	"relearnt",
+	"mislearnt",
+	"left",
+	"lent",
+	"let",
+	"lip-read",
+	"lit",
+	"relit",
+	"lost",
+	"made",
+	"premade",
+	"remade",
+	"meant",
+	"met",
+	"mown",
+	"offset",
+	"paid",
+	"prepaid",
+	"repaid",
+	"overpaid",
+	"partaken",
+	"proofread",
+	"proven",
+	"put",
+	"quick-frozen",
+	"quit",
+	"read",
+	"misread",
+	"reread",
+	"retread",
+	"rewaken",
+	"rid",
+	"ridden",
+	"outridden",
+	"overridden",
+	"risen",
+	"roughcast",
+	"run",
+	"outrun",
+	"rerun",
+	"overrun",
+	"rung",
+	"said",
+	"sand-cast",
+	"sat",
+	"outsat",
+	"sawn",
+	"seen",
+	"overseen",
+	"sent",
+	"resent",
+	"set",
+	"preset",
+	"reset",
+	"misset",
+	"sewn",
+	"resewn",
+	"oversewn",
+	"unsewn",
+	"shaken",
+	"shat",
+	"shaven",
+	"shit",
+	"shone",
+	"outshone",
+	"shorn",
+	"shot",
+	"outshot",
+	"overshot",
+	"shown",
+	"shrunk",
+	"preshrunk",
+	"shut",
+	"sight-read",
+	"slain",
+	"slept",
+	"outslept",
+	"overslept",
+	"slid",
+	"slit",
+	"slung",
+	"unslung",
+	"slunk",
+	"smelt",
+	"outsmelt",
+	"snuck",
+	"sold",
+	"undersold",
+	"presold",
+	"outsold",
+	"resold",
+	"oversold",
+	"sought",
+	"sown",
+	"spat",
+	"spelt",
+	"misspelt",
+	"spent",
+	"underspent",
+	"outspent",
+	"misspent",
+	"overspent",
+	"spilt",
+	"overspilt",
+	"spit",
+	"split",
+	"spoilt",
+	"spoken",
+	"outspoken",
+	"misspoken",
+	"overspoken",
+	"spread",
+	"sprung",
+	"spun",
+	"unspun",
+	"stolen",
+	"stood",
+	"understood",
+	"misunderstood",
+	"strewn",
+	"stricken",
+	"stridden",
+	"striven",
+	"struck",
+	"strung",
+	"unstrung",
+	"stuck",
+	"unstuck",
+	"stung",
+	"stunk",
+	"sublet",
+	"sunburnt",
+	"sung",
+	"outsung",
+	"sunk",
+	"sweat",
+	"swept",
+	"swollen",
+	"sworn",
+	"outsworn",
+	"swum",
+	"outswum",
+	"swung",
+	"taken",
+	"undertaken",
+	"mistaken",
+	"retaken",
+	"overtaken",
+	"taught",
+	"mistaught",
+	"retaught",
+	"telecast",
+	"test-driven",
+	"test-flown",
+	"thought",
+	"outthought",
+	"rethought",
+	"overthought",
+	"thrown",
+	"outthrown",
+	"overthrown",
+	"thrust",
+	"told",
+	"retold",
+	"torn",
+	"retorn",
+	"trod",
+	"trodden",
+	"typecast",
+	"typeset",
+	"upheld",
+	"upset",
+	"waylaid",
+	"wept",
+	"wet",
+	"rewet",
+	"withdrawn",
+	"withheld",
+	"withstood",
+	"woken",
+	"won",
+	"rewon",
+	"worn",
+	"reworn",
+	"wound",
+	"rewound",
+	"overwound",
+	"unwound",
+	"woven",
+	"rewoven",
+	"unwoven",
+	"written",
+	"typewritten",
+	"underwritten",
+	"outwritten",
+	"miswritten",
+	"rewritten",
+	"overwritten",
+	"wrung",
+];