@bccampus/utils 0.1.0 → 0.2.0

package/dist/path/file-url-to-path.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Browser compatible version of `node:url.fileURLToPath`
+ */
+export declare function fileURLToPath(fileUrl: string): string;

package/dist/path/file-url-to-path.js

@@ -0,0 +1,10 @@
+const windowsDriveRegExp = /^\/[a-zA-Z1-9_-]+:\//;
+function fileURLToPath(fileUrl) {
+  const url = new URL(fileUrl);
+  let path = decodeURIComponent(url.pathname);
+  if (windowsDriveRegExp.test(path)) path = path.slice(1);
+  return path;
+}
+export {
+  fileURLToPath
+};

package/dist/path/index.d.ts

@@ -0,0 +1,2 @@
+export * from './normalize';
+export * from './file-url-to-path';

package/dist/path/index.js

@@ -0,0 +1,6 @@
+import { normalize } from "./normalize.js";
+import { fileURLToPath } from "./file-url-to-path.js";
+export {
+  fileURLToPath,
+  normalize
+};

package/dist/path/normalize.d.ts

@@ -0,0 +1,31 @@
+export interface NormalizeOptions {
+    /**
+     * - `always`: ensure leading slash exists
+     * - `never`: ensure leading slash does not exist
+     * - `as-is`: do not modify the leading char
+     *
+     * @default "always"
+     */
+    leadingSlash?: "always" | "never" | "as-is";
+    /**
+     * - `always`: ensure trailing slash exists
+     * - `never`: ensure trailing slash does not exist
+     * - `as-is`: do not modify the trailing char
+     *
+     * @default "never"
+     */
+    trailingSlash?: "always" | "never" | "as-is";
+}
+/**
+ * Clears and converts the provided path to a Posix filepath
+ *
+ * By default, adds a leading slash and removes the trailing
+ *
+ * @example
+ * ```
+ *  normalize("src/test/"); //returns: /src/test
+ *  normalize("C:\\Users\\test\\folder\\"); //returns: C:/Users/test/folder
+ *  normalize("file:///C:/Users/test/folder/file.ts"); //returns: C:/Users/test/folder/file.ts
+ * ```
+ */
+export declare function normalize(path: string, options?: NormalizeOptions): string;

package/dist/path/normalize.js

@@ -0,0 +1,32 @@
+import { fileURLToPath } from "./file-url-to-path.js";
+const defaultOptions = {
+  leadingSlash: "always",
+  trailingSlash: "never"
+};
+const windowsPathSepRegExp = /[\\]+/g;
+const unixPathSepRegExp = /[/]+/g;
+const windowsDriveRegExp = /^[a-zA-Z1-9_-]+:\//;
+const fileProtocolRegExp = /^file:\/\//;
+const leadingSlashRegExp = /^\//g;
+const trailingSlashRegExp = /\/$/g;
+function normalize(path, options) {
+  const conf = { ...defaultOptions, ...options };
+  const sep = "\\";
+  let normalPath = path.trim();
+  if (fileProtocolRegExp.test(normalPath))
+    normalPath = fileURLToPath(normalPath);
+  normalPath = normalPath.replace(windowsPathSepRegExp, sep).replace(unixPathSepRegExp, sep);
+  if (conf.leadingSlash !== "as-is") {
+    normalPath = normalPath.replace(leadingSlashRegExp, "");
+    if (conf.leadingSlash === "always" && !windowsDriveRegExp.test(normalPath))
+      normalPath = `${sep}${normalPath}`;
+  }
+  if (conf.trailingSlash !== "as-is") {
+    normalPath = normalPath.replace(trailingSlashRegExp, "");
+    if (conf.trailingSlash === "always") normalPath = `${normalPath}${sep}`;
+  }
+  return normalPath;
+}
+export {
+  normalize
+};

package/dist/string/normalize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Trims white spaces and
+ * replaces multiple white space characters with a single space
+ */
+export declare function normalize(text: string): string;

package/dist/string/normalize.js

@@ -0,0 +1,6 @@
+function normalize(text) {
+  return text.trim().replace(/\s+/g, " ");
+}
+export {
+  normalize
+};

package/dist/string/pluralize/index.d.ts

@@ -1,2 +1,4 @@
-export * from './pluralize';
+import { Pluralize } from './pluralize';
+declare const pluralize: Pluralize;
 export type * from './types';
+export { pluralize, Pluralize };

package/dist/string/pluralize/index.js

@@ -1,4 +1,6 @@
 import { Pluralize } from "./pluralize.js";
+const pluralize = new Pluralize();
 export {
-  Pluralize
+  Pluralize,
+  pluralize
 };

package/dist/string/truncate.d.ts

@@ -1 +1,22 @@
-export declare function truncate(text: string, maxlength?: number, ending?: string): string;
+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;
+}
+export declare function truncate(text: string, options?: TruncateOptions): string;

package/dist/string/truncate.js

@@ -1,6 +1,17 @@
-function truncate(text, maxlength = 100, ending = "...") {
-  if (text.length > maxlength) {
-    return text.substring(0, maxlength - ending.length) + ending;
+const defaultOptions = {
+  ending: "...",
+  maxlength: 100,
+  noWordBreak: false
+};
+function truncate(text, options) {
+  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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bccampus/utils",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "BCcampus' utility box",
   "type": "module",
   "license": "UNLICENSED",
@@ -25,6 +25,10 @@
       "types": "./dist/object/index.d.ts",
       "import": "./dist/object/index.js"
     },
+    "./path": {
+      "types": "./dist/path/index.d.ts",
+      "import": "./dist/path/index.js"
+    },
     "./set": {
       "types": "./dist/set/index.d.ts",
       "import": "./dist/set/index.js"

package/src/path/file-url-to-path.ts

@@ -0,0 +1,12 @@
+const windowsDriveRegExp = /^\/[a-zA-Z1-9_-]+:\//;
+
+/**
+ * Browser compatible version of `node:url.fileURLToPath`
+ */
+export function fileURLToPath(fileUrl: string) {
+  const url = new URL(fileUrl);
+  let path = decodeURIComponent(url.pathname);
+  if (windowsDriveRegExp.test(path)) path = path.slice(1);
+
+  return path;
+}

package/src/path/index.ts

@@ -0,0 +1,2 @@
+export * from "./normalize";
+export * from "./file-url-to-path";

package/src/path/normalize.ts

@@ -0,0 +1,72 @@
+import { fileURLToPath } from "./file-url-to-path";
+
+export interface NormalizeOptions {
+  /**
+   * - `always`: ensure leading slash exists
+   * - `never`: ensure leading slash does not exist
+   * - `as-is`: do not modify the leading char
+   *
+   * @default "always"
+   */
+  leadingSlash?: "always" | "never" | "as-is";
+
+  /**
+   * - `always`: ensure trailing slash exists
+   * - `never`: ensure trailing slash does not exist
+   * - `as-is`: do not modify the trailing char
+   *
+   * @default "never"
+   */
+  trailingSlash?: "always" | "never" | "as-is";
+}
+
+const defaultOptions: Required<NormalizeOptions> = {
+  leadingSlash: "always",
+  trailingSlash: "never",
+};
+
+const windowsPathSepRegExp = /[\\]+/g;
+const unixPathSepRegExp = /[/]+/g;
+const windowsDriveRegExp = /^[a-zA-Z1-9_-]+:\//;
+const fileProtocolRegExp = /^file:\/\//;
+const leadingSlashRegExp = /^\//g;
+const trailingSlashRegExp = /\/$/g;
+
+/**
+ * Clears and converts the provided path to a Posix filepath
+ *
+ * By default, adds a leading slash and removes the trailing
+ *
+ * @example
+ * ```
+ *  normalize("src/test/"); //returns: /src/test
+ *  normalize("C:\\Users\\test\\folder\\"); //returns: C:/Users/test/folder
+ *  normalize("file:///C:/Users/test/folder/file.ts"); //returns: C:/Users/test/folder/file.ts
+ * ```
+ */
+export function normalize(path: string, options?: NormalizeOptions) {
+  const conf = { ...defaultOptions, ...options };
+  const sep = "\\";
+  let normalPath = path.trim();
+
+  if (fileProtocolRegExp.test(normalPath))
+    normalPath = fileURLToPath(normalPath);
+
+  normalPath = normalPath
+    .replace(windowsPathSepRegExp, sep) // windows -> linux
+    .replace(unixPathSepRegExp, sep); // multiple -> single
+
+  if (conf.leadingSlash !== "as-is") {
+    normalPath = normalPath.replace(leadingSlashRegExp, "");
+
+    if (conf.leadingSlash === "always" && !windowsDriveRegExp.test(normalPath))
+      normalPath = `${sep}${normalPath}`;
+  }
+
+  if (conf.trailingSlash !== "as-is") {
+    normalPath = normalPath.replace(trailingSlashRegExp, "");
+    if (conf.trailingSlash === "always") normalPath = `${normalPath}${sep}`;
+  }
+
+  return normalPath;
+}

package/src/string/normalize.ts

@@ -0,0 +1,7 @@
+/**
+ * Trims white spaces and
+ * replaces multiple white space characters with a single space
+ */
+export function normalize(text: string) {
+  return text.trim().replace(/\s+/g, " ");
+}

package/src/string/pluralize/index.ts

@@ -1,2 +1,7 @@
-export * from "./pluralize";
-export type * from "./types";
+import { Pluralize } from "./pluralize";
+
+const pluralize = new Pluralize();
+
+export type * from "./types";
+
+export { pluralize, Pluralize };

package/src/string/truncate.ts

@@ -1,11 +1,44 @@
-export function truncate(
-  text: string,
-  maxlength: number = 100,
-  ending: string = "...",
-) {
-  if (text.length > maxlength) {
-    return text.substring(0, maxlength - ending.length) + ending;
-  }
-
-  return text;
-}
+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/tsconfig.lib.json

@@ -1,36 +1,37 @@
-{
-  "compilerOptions": {
-    "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"
-  ]
+{
+  "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.lib.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["./src/array/chunk.ts","./src/array/index.ts","./src/date/index.ts","./src/date/iso-date-time.ts","./src/duration/add-durations.ts","./src/duration/index.ts","./src/duration/is-duration.ts","./src/duration/to-number.ts","./src/format/formatter.ts","./src/format/index.ts","./src/format/stringify.ts","./src/format/template.ts","./src/object/get.ts","./src/object/index.ts","./src/object/is-object.ts","./src/object/omit.ts","./src/object/pick.ts","./src/object/set.ts","./src/set/difference.ts","./src/set/index.ts","./src/set/intersection.ts","./src/set/is-superset.ts","./src/set/symmetric-difference.ts","./src/set/union.ts","./src/string/capitalize.ts","./src/string/index.ts","./src/string/strip-html-tags.ts","./src/string/to-int.ts","./src/string/to-sentence-case.ts","./src/string/trim.ts","./src/string/truncate.ts","./src/string/pluralize/index.ts","./src/string/pluralize/pluralize.ts","./src/string/pluralize/types.ts","./src/string/pluralize/rules/index.ts","./src/string/pluralize/rules/irregular.ts","./src/string/pluralize/rules/pluralization.ts","./src/string/pluralize/rules/singularization.ts","./src/string/pluralize/rules/uncountable.ts","./src/string/slugify/index.ts"],"version":"5.9.3"}