refactor!: simplify code by removing override parameters

they just return the giving parameter and therefore make no sense at all

Author: p-kuen

src/inflection.ts

@@ -597,27 +597,18 @@ const underbarPrefix = new RegExp('^_');
  *
  *     applyRules( 'cows', singular_rules ); // === 'cow'
  */
-function applyRules(
-  str: string,
-  rules: [RegExp, string?][],
-  skip: string[],
-  override?: string
-) {
-  if (override) {
-    return override;
-  } else {
-    if (skip.includes(str.toLocaleLowerCase())) {
-      return str;
-    }
-
-    for (const rule of rules) {
-      if (str.match(rule[0])) {
-        if (rule[1] !== undefined) {
-          return str.replace(rule[0], rule[1]);
-        }
+function applyRules(str: string, rules: [RegExp, string?][], skip: string[]) {
+  if (skip.includes(str.toLocaleLowerCase())) {
+    return str;
+  }
 
-        return str;
+  for (const rule of rules) {
+    if (str.match(rule[0])) {
+      if (rule[1] !== undefined) {
+        return str.replace(rule[0], rule[1]);
       }
+
+      return str;
     }
   }
 
@@ -636,10 +627,9 @@ function applyRules(
  *     inflection.pluralize( 'person' ); // === 'people'
  *     inflection.pluralize( 'octopus' ); // === 'octopuses'
  *     inflection.pluralize( 'Hat' ); // === 'Hats'
- *     inflection.pluralize( 'person', 'guys' ); // === 'guys'
  */
-export function pluralize(str: string, plural?: string) {
-  return applyRules(str, pluralRules, uncountableWords, plural);
+export function pluralize(str: string) {
+  return applyRules(str, pluralRules, uncountableWords);
 }
 
 /**
@@ -654,10 +644,9 @@ export function pluralize(str: string, plural?: string) {
  *     inflection.singularize( 'people' ); // === 'person'
  *     inflection.singularize( 'octopuses' ); // === 'octopus'
  *     inflection.singularize( 'Hats' ); // === 'Hat'
- *     inflection.singularize( 'guys', 'person' ); // === 'person'
  */
-export function singularize(str: string, singular?: string) {
-  return applyRules(str, singularRules, uncountableWords, singular);
+export function singularize(str: string) {
+  return applyRules(str, singularRules, uncountableWords);
 }
 
 /**
@@ -679,20 +668,14 @@ export function singularize(str: string, singular?: string) {
  *     inflection.inflect( 'person', 2 ); // === 'people'
  *     inflection.inflect( 'octopus', 2 ); // === 'octopuses'
  *     inflection.inflect( 'Hat', 2 ); // === 'Hats'
- *     inflection.inflect( 'person', 2, null, 'guys' ); // === 'guys'
  */
-export function inflect(
-  str: string,
-  count: number,
-  singular?: string,
-  plural?: string
-) {
+export function inflect(str: string, count: number) {
   if (isNaN(count)) return str;
 
   if (count === 1) {
-    return applyRules(str, singularRules, uncountableWords, singular);
+    return applyRules(str, singularRules, uncountableWords);
   } else {
-    return applyRules(str, pluralRules, uncountableWords, plural);
+    return applyRules(str, pluralRules, uncountableWords);
   }
 }
 

test/inflection.test.ts

@@ -31,7 +31,6 @@ describe("test .pluralize", function () {
     expect(inflection.pluralize("meta")).toEqual("meta");
     expect(inflection.pluralize("summons")).toEqual("summonses");
     expect(inflection.pluralize("whereas")).toEqual("whereases");
-    expect(inflection.pluralize("person", "guys")).toEqual("guys");
     expect(inflection.pluralize("index")).toEqual("indices");
     expect(inflection.pluralize("matrix")).toEqual("matrices");
     expect(inflection.pluralize("vertex")).toEqual("vertices");
@@ -81,7 +80,6 @@ describe("test .singularize", function () {
     expect(inflection.singularize("data")).toEqual("datum");
     expect(inflection.singularize("meta")).toEqual("metum");
     expect(inflection.singularize("whereases")).toEqual("whereas");
-    expect(inflection.singularize("guys", "person")).toEqual("person");
     expect(inflection.singularize("matrices")).toEqual("matrix");
     expect(inflection.singularize("vertices")).toEqual("vertex");
     expect(inflection.singularize("canvases")).toEqual("canvas");
@@ -109,7 +107,6 @@ describe("test .inflect", function () {
     expect(inflection.inflect("Hat", 0)).toEqual("Hats");
     expect(inflection.inflect("data", 0)).toEqual("data");
     expect(inflection.inflect("meta", 0)).toEqual("meta");
-    expect(inflection.inflect("person", 0, "guy", "guys")).toEqual("guys");
     expect(inflection.inflect("drive", 0)).toEqual("drives");
     // greater than 1 should use plural state
     expect(inflection.inflect("people", 2)).toEqual("people");
@@ -119,7 +116,6 @@ describe("test .inflect", function () {
     expect(inflection.inflect("Hat", 2)).toEqual("Hats");
     expect(inflection.inflect("data", 2)).toEqual("data");
     expect(inflection.inflect("meta", 2)).toEqual("meta");
-    expect(inflection.inflect("person", 2, "guy", "guys")).toEqual("guys");
     expect(inflection.inflect("drive", 2)).toEqual("drives");
     // 1 should use singular state
     expect(inflection.inflect("status", 1)).toEqual("status");
@@ -134,7 +130,6 @@ describe("test .inflect", function () {
     expect(inflection.inflect("Hats", 1)).toEqual("Hat");
     expect(inflection.inflect("data", 1)).toEqual("datum");
     expect(inflection.inflect("meta", 1)).toEqual("metum");
-    expect(inflection.inflect("guys", 1, "person", "people")).toEqual("person");
     // not a number should return original value
     expect(inflection.inflect("drive", 1)).toEqual("drive");
     expect(inflection.inflect("drives", 1)).toEqual("drive");