@bccampus/utils 0.2.1 → 0.2.3

package/src/string/pluralize/rules/index.ts

@@ -1,4 +0,0 @@
-export { IRREGULAR_WORDS } from './irregular';
-export { PLURALIZATION_RULES } from './pluralization';
-export { SINGULARIZATION_RULES } from './singularization';
-export { UNCOUNTABLE_WORDS } from './uncountable';

package/src/string/pluralize/rules/irregular.ts

@@ -1,59 +0,0 @@
-export const IRREGULAR_WORDS: [string, string][] = [
-  // Pronouns.
-  ['I', 'we'],
-  ['me', 'us'],
-  ['he', 'they'],
-  ['she', 'they'],
-  ['them', 'them'],
-  ['myself', 'ourselves'],
-  ['yourself', 'yourselves'],
-  ['itself', 'themselves'],
-  ['herself', 'themselves'],
-  ['himself', 'themselves'],
-  ['themself', 'themselves'],
-  ['is', 'are'],
-  ['was', 'were'],
-  ['has', 'have'],
-  ['this', 'these'],
-  ['that', 'those'],
-  ['my', 'our'],
-  ['its', 'their'],
-  ['his', 'their'],
-  ['her', 'their'],
-  // Words ending in with a consonant and `o`.
-  ['echo', 'echoes'],
-  ['dingo', 'dingoes'],
-  ['volcano', 'volcanoes'],
-  ['tornado', 'tornadoes'],
-  ['torpedo', 'torpedoes'],
-  // Ends with `us`.
-  ['genus', 'genera'],
-  ['viscus', 'viscera'],
-  // Ends with `ma`.
-  ['stigma', 'stigmata'],
-  ['stoma', 'stomata'],
-  ['dogma', 'dogmata'],
-  ['lemma', 'lemmata'],
-  ['schema', 'schemata'],
-  ['anathema', 'anathemata'],
-  // Other irregular rules.
-  ['ox', 'oxen'],
-  ['axe', 'axes'],
-  ['die', 'dice'],
-  ['yes', 'yeses'],
-  ['foot', 'feet'],
-  ['eave', 'eaves'],
-  ['goose', 'geese'],
-  ['tooth', 'teeth'],
-  ['quiz', 'quizzes'],
-  ['human', 'humans'],
-  ['proof', 'proofs'],
-  ['carve', 'carves'],
-  ['valve', 'valves'],
-  ['looey', 'looies'],
-  ['thief', 'thieves'],
-  ['groove', 'grooves'],
-  ['pickaxe', 'pickaxes'],
-  ['passerby', 'passersby'],
-  ['canvas', 'canvases'],
-];

package/src/string/pluralize/rules/pluralization.ts

@@ -1,40 +0,0 @@
-/* eslint-disable no-control-regex */
-
-import type { Rule } from "../types";
-
-export const PLURALIZATION_RULES: Rule[] = [
-  [/s?$/i, "s"],
-  [/[^\u0000-\u007F]$/, "$0"],
-  [/([^aeiou]ese)$/i, "$1"],
-  [/(ax|test)is$/i, "$1es"],
-  [/(alias|[^aou]us|t[lm]as|gas|ris)$/i, "$1es"],
-  [/(e[mn]u)s?$/i, "$1s"],
-  [/([^l]ias|[aeiou]las|[ejzr]as|[iu]am)$/i, "$1"],
-  [
-    /(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$/i,
-    "$1i",
-  ],
-  [/(alumn|alg|vertebr)(?:a|ae)$/i, "$1ae"],
-  [/(seraph|cherub)(?:im)?$/i, "$1im"],
-  [/(her|at|gr)o$/i, "$1oes"],
-  [
-    /(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|automat|quor)(?:a|um)$/i,
-    "$1a",
-  ],
-  [
-    /(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)(?:a|on)$/i,
-    "$1a",
-  ],
-  [/sis$/i, "ses"],
-  [/(?:(kni|wi|li)fe|(ar|l|ea|eo|oa|hoo)f)$/i, "$1$2ves"],
-  [/([^aeiouy]|qu)y$/i, "$1ies"],
-  [/([^ch][ieo][ln])ey$/i, "$1ies"],
-  [/(x|ch|ss|sh|zz)$/i, "$1es"],
-  [/(matr|cod|mur|sil|vert|ind|append)(?:ix|ex)$/i, "$1ices"],
-  [/\b((?:tit)?m|l)(?:ice|ouse)$/i, "$1ice"],
-  [/(pe)(?:rson|ople)$/i, "$1ople"],
-  [/(child)(?:ren)?$/i, "$1ren"],
-  [/eaux$/i, "$0"],
-  [/m[ae]n$/i, "men"],
-  ["thou", "you"],
-];

package/src/string/pluralize/rules/singularization.ts

@@ -1,46 +0,0 @@
-import type { Rule } from "../types";
-
-export const SINGULARIZATION_RULES: Rule[] = [
-  [/s$/i, ""],
-  [/(ss)$/i, "$1"],
-  [/(wi|kni|(?:after|half|high|low|mid|non|night|\W|^)li)ves$/i, "$1fe"],
-  [/(ar|(?:wo|[ae])l|[eo][ao])ves$/i, "$1f"],
-  [/ies$/i, "y"],
-  [/(dg|ss|ois|lk|ok|wn|mb|th|ch|ec|oal|is|ck|ix|sser|ts|wb)ies$/i, "$1ie"],
-  [
-    /\b(l|(?:neck|cross|hog|aun)?t|coll|faer|food|gen|goon|group|hipp|junk|vegg|(?:pork)?p|charl|calor|cut)ies$/i,
-    "$1ie",
-  ],
-  [/\b(mon|smil)ies$/i, "$1ey"],
-  [/\b((?:tit)?m|l)ice$/i, "$1ouse"],
-  [/(seraph|cherub)im$/i, "$1"],
-  [
-    /(x|ch|ss|sh|zz|tto|go|cho|alias|[^aou]us|t[lm]as|gas|(?:her|at|gr)o|[aeiou]ris)(?:es)?$/i,
-    "$1",
-  ],
-  [
-    /(analy|diagno|parenthe|progno|synop|the|empha|cri|ne)(?:sis|ses)$/i,
-    "$1sis",
-  ],
-  [/(movie|twelve|abuse|e[mn]u)s$/i, "$1"],
-  [/(test)(?:is|es)$/i, "$1is"],
-  [
-    /(alumn|syllab|vir|radi|nucle|fung|cact|stimul|termin|bacill|foc|uter|loc|strat)(?:us|i)$/i,
-    "$1us",
-  ],
-  [
-    /(agend|addend|millenni|dat|extrem|bacteri|desiderat|strat|candelabr|errat|ov|symposi|curricul|quor)a$/i,
-    "$1um",
-  ],
-  [
-    /(apheli|hyperbat|periheli|asyndet|noumen|phenomen|criteri|organ|prolegomen|hedr|automat)a$/i,
-    "$1on",
-  ],
-  [/(alumn|alg|vertebr)ae$/i, "$1a"],
-  [/(cod|mur|sil|vert|ind)ices$/i, "$1ex"],
-  [/(matr|append)ices$/i, "$1ix"],
-  [/(pe)(rson|ople)$/i, "$1rson"],
-  [/(child)ren$/i, "$1"],
-  [/(eau)x?$/i, "$1"],
-  [/men$/i, "man"],
-];

package/src/string/pluralize/rules/uncountable.ts

@@ -1,107 +0,0 @@
-import type { RuleKey } from '../types';
-
-export const UNCOUNTABLE_WORDS: RuleKey[] = [
-  // Singular words with no plurals.
-  'adulthood',
-  'advice',
-  'agenda',
-  'aid',
-  'aircraft',
-  'alcohol',
-  'ammo',
-  'analytics',
-  'anime',
-  'athletics',
-  'audio',
-  'bison',
-  'blood',
-  'bream',
-  'buffalo',
-  'butter',
-  'carp',
-  'cash',
-  'chassis',
-  'chess',
-  'clothing',
-  'cod',
-  'commerce',
-  'cooperation',
-  'corps',
-  'debris',
-  'diabetes',
-  'digestion',
-  'elk',
-  'energy',
-  'equipment',
-  'excretion',
-  'expertise',
-  'firmware',
-  'flounder',
-  'fun',
-  'gallows',
-  'garbage',
-  'graffiti',
-  'hardware',
-  'headquarters',
-  'health',
-  'herpes',
-  'highjinks',
-  'homework',
-  'housework',
-  'information',
-  'jeans',
-  'justice',
-  'kudos',
-  'labour',
-  'literature',
-  'machinery',
-  'mackerel',
-  'mail',
-  'media',
-  'mews',
-  'moose',
-  'music',
-  'mud',
-  'manga',
-  'news',
-  'only',
-  'personnel',
-  'pike',
-  'plankton',
-  'pliers',
-  'police',
-  'pollution',
-  'premises',
-  'rain',
-  'research',
-  'rice',
-  'salmon',
-  'scissors',
-  'series',
-  'sewage',
-  'shambles',
-  'shrimp',
-  'software',
-  'staff',
-  'swine',
-  'tennis',
-  'traffic',
-  'transportation',
-  'trout',
-  'tuna',
-  'wealth',
-  'welfare',
-  'whiting',
-  'wildebeest',
-  'wildlife',
-  'you',
-  /pok[eé]mon$/i,
-  // Regexes.
-  /[^aeiou]ese$/i, // "chinese", "japanese"
-  /deer$/i, // "deer", "reindeer"
-  /fish$/i, // "fish", "blowfish", "angelfish"
-  /measles$/i,
-  /o[iu]s$/i, // "carnivorous"
-  /pox$/i, // "chickpox", "smallpox"
-  /sheep$/i,
-];

package/src/string/pluralize/types.ts

@@ -1,4 +0,0 @@
-export type RuleKey = string | RegExp;
-export type RuleValue = string;
-
-export type Rule = [RuleKey, RuleValue];

package/src/string/slugify/index.ts

@@ -1,3 +0,0 @@
-import slugifyNP from "@sindresorhus/slugify";
-
-export const slugify = (text: string) => slugifyNP(text);

package/src/string/strip-html-tags.ts

@@ -1,4 +0,0 @@
-const htmlTagRegExp = /(<([^>]+)>)/g;
-export function stripHtmlTags(text: string) {
-  return text.replace(htmlTagRegExp, "");
-}

package/src/string/to-int.ts

@@ -1,20 +0,0 @@
-/**
- * Converts a string (or a number) into a number.
- * If the input can not be successfully converted, it will return the fallback.
- * It will not return NaN.
- * @param value - The value to convert
- * @param fallback - The value to fallback to. Defaults to 0
- * @returns number
- */
-export function stringToInt(
-  value: string | number,
-  fallback: number = 0,
-): number {
-  let returnValue = value;
-  if (typeof returnValue === "string")
-    returnValue = Number.parseInt(returnValue);
-
-  if (Number.isNaN(returnValue)) returnValue = fallback;
-
-  return returnValue;
-}

package/src/string/to-sentence-case.ts

@@ -1,6 +0,0 @@
-const specialCharRegExp = /[\s-_.+]+/g;
-export const toSentenceCase = <T extends string>(s: T) =>
-  (s[0].toUpperCase() + s.slice(1).toLowerCase()).replace(
-    specialCharRegExp,
-    " ",
-  );

package/src/string/trim.ts

@@ -1,11 +0,0 @@
-export function trim(text: string, chars: string | string[] = " ") {
-  let start = 0;
-  let end = text.length;
-
-  if (!Array.isArray(chars)) chars = [chars];
-
-  while (start < end && chars.includes(text[start])) start += 1;
-  while (end > start && chars.includes(text[end - 1])) end -= 1;
-
-  return start > 0 || end < text.length ? text.substring(start, end) : text;
-}

package/src/string/truncate.ts

@@ -1,44 +0,0 @@
-export interface TruncateOptions {
-  /**
-   * The maximum number of character allowed in the text before truncating it
-   *
-   * @default 100
-   */
-  maxlength?: number;
-
-  /**
-   * The string to use at the end of the truncated text
-   *
-   * @default "..."
-   */
-  ending?: string;
-
-  /**
-   * If true, truncates the text at the next space char,
-   * so the returned string can exceed the specified `maxLength`
-   *
-   * @default false
-   */
-  noWordBreak?: boolean;
-}
-
-const defaultOptions: Required<TruncateOptions> = {
-  ending: "...",
-  maxlength: 100,
-  noWordBreak: false,
-};
-
-export function truncate(text: string, options?: TruncateOptions) {
-  const conf = { ...defaultOptions, ...options };
-  text = text.trim();
-  if (conf.noWordBreak) {
-    const lastSpaceIndex = text.indexOf(" ", conf.maxlength);
-
-    if (lastSpaceIndex >= conf.maxlength)
-      return text.substring(0, lastSpaceIndex) + conf.ending;
-  } else if (text.length > conf.maxlength + conf.ending.length) {
-    return text.substring(0, conf.maxlength) + conf.ending;
-  }
-
-  return text;
-}

package/src/value/index.ts

@@ -1 +0,0 @@
-export * from "./is-empty";

package/src/value/is-empty.ts

@@ -1,31 +0,0 @@
-/**
- * Checks if the value is `empty`
- *
- * returns `true`, if the value
- *
- * - `undefined`
- * - `null`
- * - `string` and there is no character in the string or all white space
- * - `array` and there is no item in the array
- * - `map` and there is no item in the map
- * - `set` and there is no item in the set
- * - `object` and there is no property in the object
- *
- * otherwise, false
- *
- */
-export const isEmpty = (value: unknown) => {
-  if (value === undefined) return true;
-  if (value === null) return true;
-
-  if (typeof value === "string") return value.trim() === "";
-  if (typeof value === "object") {
-    if (Array.isArray(value) && value.length === 0) return true;
-
-    if (value instanceof Map || value instanceof Set) return value.size === 0;
-
-    return Object.keys(value).length === 0;
-  }
-
-  return false;
-};

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "files": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.node.json"
-    }
-  ],
-  "compilerOptions": {
-    "paths": {
-      "@/*": [
-        "./src/*"
-      ]
-    }
-  },
-}

package/tsconfig.lib.json

@@ -1,37 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./dist",
-    "module": "ESNext",
-    "target": "ESNext",
-    "lib": [
-      "DOM",
-      "ESNext"
-    ],
-    "strict": true,
-    "esModuleInterop": true,
-    "jsx": "preserve",
-    "skipLibCheck": true,
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "noUnusedLocals": true,
-    "strictNullChecks": true,
-    "allowJs": true,
-    "forceConsistentCasingInFileNames": true,
-    "noEmit": true,
-    "types": [
-      "node",
-    ],
-    "paths": {
-      "@/*": [
-        "./src/*"
-      ],
-    }
-  },
-  "include": [
-    "src/**/*",
-  ],
-  "exclude": [
-    "dist",
-    "node_modules"
-  ]
-}

package/tsconfig.node.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
-    "target": "ES2023",
-    "lib": ["ES2023"],
-    "module": "ESNext",
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "moduleDetection": "force",
-    "noEmit": true,
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "erasableSyntaxOnly": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true
-  },
-  "include": ["vite.config.ts"]
-}

package/vite.config.ts

@@ -1,75 +0,0 @@
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import { globSync } from "tinyglobby";
-import { defineConfig } from "vite";
-import dts from "vite-plugin-dts";
-import packageConfig from "./package.json";
-import { writeFileSync } from "node:fs";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const outDir = "./dist";
-
-const createEntries = () => {
-  const entries = new Map<string, string>();
-  const exports = new Map<
-    string,
-    {
-      types: string;
-      import: string;
-      require: string;
-    }
-  >();
-
-  const files = globSync("src/**/*.ts", {
-    cwd: __dirname,
-  });
-
-  for (const file of files) {
-    const filePath = file.split(".")[0].replace(/^src[/\\]/, "");
-
-    if (!filePath) {
-      continue;
-    }
-
-    const filePathParts = filePath.split("/");
-    if (filePathParts.at(-1) === "index" && filePathParts.length <= 3) {
-      const exportPath = filePathParts.length === 1 ? "." : `./${filePathParts.slice(0, -1).join("/")}`;
-
-      exports.set(exportPath, {
-        types: `${outDir}/${filePath}.d.ts`,
-        import: `${outDir}/${filePath}.js`,
-        require: `${outDir}/${filePath}.cjs`,
-      });
-    }
-
-    entries.set(filePath, fileURLToPath(new URL(file, import.meta.url)));
-  }
-
-  const _packageConfig = {
-    ...packageConfig,
-    exports: Object.fromEntries(exports),
-  };
-
-  writeFileSync("./package.json", JSON.stringify(_packageConfig, null, 2), {
-    encoding: "utf-8",
-  });
-
-  return Object.fromEntries(entries);
-};
-
-export default defineConfig({
-  plugins: [dts({ tsconfigPath: "./tsconfig.lib.json" })],
-  resolve: {
-    alias: {
-      "@": path.resolve(__dirname, "./src"),
-    },
-  },
-  build: {
-    minify: false,
-    copyPublicDir: false,
-    lib: {
-      entry: createEntries(),
-      name: "utils",
-    },
-  },
-});