@stacksjs/strings 0.51.0 → 0.52.0

package/README.md

@@ -18,19 +18,20 @@ Now, you can use it in your project:
 ```js
 import {
   // pluralize
+  isPlural, isSingular, singular, plural,
   addIrregularRule, addPluralRule, addSingularRule, addUncountableRule,
 
   // case
-  camelCase, capitalCase, constantCase, dotCase,
-  headerCase, isPlural, isSingular, kebabCase, noCase, paramCase, pascalCase,
-  pathCase, plural, sentenceCase, singular, snakeCase,
+  camelCase, capitalCase, constantCase, dotCase
+  headerCase, kebabCase, noCase, paramCase, pascalCase,
+  pathCase, sentenceCase , snakeCase, titleCase
 
   // validation
   isEmail, isStrongPassword, isAlphanumeric, validateUsername, isURL, isMobilePhone, isAlpha, isPostalCode, isDate, isNumeric, isBoolean, isHexColor, isHexadecimal, isBase64, isUUID, isJSON, isCreditCard, isISBN, isIP, isIPRange, isMACAddress, isLatLong, isLatitude, isLongitude, isCurrency, isDataURI, isMimeType, isJWT, isMongoId, isAscii, isBase32, isByteLength, isFQDN, isFullWidth, isHalfWidth, isHash, isHSL, isIBAN, isIdentityCard, isISIN, isISO8601, isISRC, isISSN, isISO31661Alpha2, isISO31661Alpha3
 } from '@stacksjs/strings'
 
-console.log(camelCase('hello world')) // helloWorld
-console.log(plural('dog')) // dogs
+console.log(camelCase('hello world')) //=> "helloWorld"
+console.log(plural('dog')) //=> "dogs"
 ```
 
 To view the full documentation, please visit [https://stacksjs.dev/strings](https://stacksjs.dev/strings).
@@ -45,7 +46,7 @@ pnpm test
 
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
-## 💪🏼 Contributing
+## 🚜 Contributing
 
 Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 

package/dist/index.d.ts

@@ -1,23 +1,45 @@
 export { camelCase, capitalCase, constantCase, dotCase, headerCase, paramCase as kebabCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase } from 'change-case';
-export { addIrregularRule, addPluralRule, addSingularRule, addUncountableRule, isPlural, isSingular, plural, singular } from 'pluralize';
+export { titleCase } from 'title-case';
+import pluralize from 'pluralize';
 import { HashAlgorithm } from '@stacksjs/types';
 
+interface SlugOptions {
+    replacement?: string;
+    remove?: RegExp;
+    lower?: boolean;
+    strict?: boolean;
+    locale?: string;
+    trim?: boolean;
+}
 /**
  * Replace backslash to slash
  *
  * @category String
+ * @example
+ * ```
+ * slash('C:\\Users\\Chris') => 'C:/Users/Chris'
+ * ```
  */
 declare function slash(str: string): string;
 /**
  * Ensure prefix of a string
  *
  * @category String
+ * @example
+ * ```
+ * ensurePrefix('https://', 'google.com') => 'https://google.com'
+ * ensurePrefix('https://', 'http://google.com') => 'https://google.com'
  */
 declare function ensurePrefix(prefix: string, str: string): string;
 /**
  * Ensure suffix of a string
  *
  * @category String
+ * @example
+ * ```
+ * ensureSuffix('.js', 'index') => 'index.js'
+ * ensureSuffix('.js', 'index.js') => 'index.js'
+ * ```
  */
 declare function ensureSuffix(suffix: string, str: string): string;
 /**
@@ -26,8 +48,7 @@ declare function ensureSuffix(suffix: string, str: string): string;
  * @category String
  * @example
  * ```
- * const result = template(
- *   'Hello {0}! My name is {1}.',
+ * const result = template('Hello {0}! My name is {1}.',
  *   'Buddy',
  *   'Chris'
  * ) // Hello Buddy! My name is Chris.
@@ -44,10 +65,28 @@ declare function randomStr(size?: number, dict?: string): string;
  * @category string
  * @example
  * ```
- * capitalize('hello') => 'Hello'
+ * capitalize('hello world') => 'Hello world'
  * ```
  */
 declare function capitalize(str: string): string;
+/**
+ * Slugify a string
+ * @category string
+ * @example
+ * ```
+ * slug('Hello World') => 'hello-world'
+ * ```
+ */
+declare function slug(str: string, options?: SlugOptions): string;
+
+declare const plural: typeof pluralize.plural;
+declare const singular: typeof pluralize.singular;
+declare const isPlural: typeof pluralize.isPlural;
+declare const isSingular: typeof pluralize.isSingular;
+declare const addPluralRule: typeof pluralize.addPluralRule;
+declare const addSingularRule: typeof pluralize.addSingularRule;
+declare const addIrregularRule: typeof pluralize.addIrregularRule;
+declare const addUncountableRule: typeof pluralize.addUncountableRule;
 
 declare function isEmail(email: string): boolean;
 declare function isStrongPassword(password: string): boolean;
@@ -95,4 +134,4 @@ declare function isISSN(issn: string): boolean;
 declare function isISO31661Alpha2(iso31661Alpha2: string): boolean;
 declare function isISO31661Alpha3(iso31661Alpha3: string): boolean;
 
-export { capitalize, ensurePrefix, ensureSuffix, isAlpha, isAlphanumeric, isAscii, isBase32, isBase64, isBoolean, isByteLength, isCreditCard, isCurrency, isDataURI, isDate, isEmail, isFQDN, isFullWidth, isHSL, isHalfWidth, isHash, isHexColor, isHexadecimal, isIBAN, isIP, isIPRange, isISBN, isISIN, isISO31661Alpha2, isISO31661Alpha3, isISO8601, isISRC, isISSN, isIdentityCard, isJSON, isJWT, isLatLong, isLatitude, isLongitude, isMACAddress, isMimeType, isMobilePhone, isMongoId, isNumeric, isPostalCode, isStrongPassword, isURL, isUUID, randomStr, slash, template, validateUsername };
+export { addIrregularRule, addPluralRule, addSingularRule, addUncountableRule, capitalize, ensurePrefix, ensureSuffix, isAlpha, isAlphanumeric, isAscii, isBase32, isBase64, isBoolean, isByteLength, isCreditCard, isCurrency, isDataURI, isDate, isEmail, isFQDN, isFullWidth, isHSL, isHalfWidth, isHash, isHexColor, isHexadecimal, isIBAN, isIP, isIPRange, isISBN, isISIN, isISO31661Alpha2, isISO31661Alpha3, isISO8601, isISRC, isISSN, isIdentityCard, isJSON, isJWT, isLatLong, isLatitude, isLongitude, isMACAddress, isMimeType, isMobilePhone, isMongoId, isNumeric, isPlural, isPostalCode, isSingular, isStrongPassword, isURL, isUUID, plural, randomStr, singular, slash, slug, template, validateUsername };

package/dist/index.mjs

@@ -1,7 +1,10 @@
 export { camelCase, capitalCase, constantCase, dotCase, headerCase, paramCase as kebabCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase } from 'change-case';
-export { addIrregularRule, addPluralRule, addSingularRule, addUncountableRule, isPlural, isSingular, plural, singular } from 'pluralize';
+export { titleCase } from 'title-case';
+import slugify from 'slugify';
+import pluralize from 'pluralize';
 import validator from 'validator';
 
+const urlAlphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
@@ -23,7 +26,6 @@ function template(str, ...args) {
     return args[index];
   });
 }
-const urlAlphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";
 function randomStr(size = 16, dict = urlAlphabet) {
   let id = "";
   let i = size;
@@ -35,6 +37,16 @@ function randomStr(size = 16, dict = urlAlphabet) {
 function capitalize(str) {
   return str[0].toUpperCase() + str.slice(1).toLowerCase();
 }
+function slug(str, options) {
+  if (options)
+    return slugify(str, options);
+  return slugify(str, {
+    lower: true,
+    strict: true
+  });
+}
+
+const { plural, singular, isPlural, isSingular, addPluralRule, addSingularRule, addIrregularRule, addUncountableRule } = pluralize;
 
 function isEmail(email) {
   return validator.isEmail(email);
@@ -172,4 +184,4 @@ function isISO31661Alpha3(iso31661Alpha3) {
   return validator.isISO31661Alpha3(iso31661Alpha3);
 }
 
-export { capitalize, ensurePrefix, ensureSuffix, isAlpha, isAlphanumeric, isAscii, isBase32, isBase64, isBoolean, isByteLength, isCreditCard, isCurrency, isDataURI, isDate, isEmail, isFQDN, isFullWidth, isHSL, isHalfWidth, isHash, isHexColor, isHexadecimal, isIBAN, isIP, isIPRange, isISBN, isISIN, isISO31661Alpha2, isISO31661Alpha3, isISO8601, isISRC, isISSN, isIdentityCard, isJSON, isJWT, isLatLong, isLatitude, isLongitude, isMACAddress, isMimeType, isMobilePhone, isMongoId, isNumeric, isPostalCode, isStrongPassword, isURL, isUUID, randomStr, slash, template, validateUsername };
+export { addIrregularRule, addPluralRule, addSingularRule, addUncountableRule, capitalize, ensurePrefix, ensureSuffix, isAlpha, isAlphanumeric, isAscii, isBase32, isBase64, isBoolean, isByteLength, isCreditCard, isCurrency, isDataURI, isDate, isEmail, isFQDN, isFullWidth, isHSL, isHalfWidth, isHash, isHexColor, isHexadecimal, isIBAN, isIP, isIPRange, isISBN, isISIN, isISO31661Alpha2, isISO31661Alpha3, isISO8601, isISRC, isISSN, isIdentityCard, isJSON, isJWT, isLatLong, isLatitude, isLongitude, isMACAddress, isMimeType, isMobilePhone, isMongoId, isNumeric, isPlural, isPostalCode, isSingular, isStrongPassword, isURL, isUUID, plural, randomStr, singular, slash, slug, template, validateUsername };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/strings",
   "type": "module",
-  "version": "0.51.0",
-  "packageManager": "pnpm@7.26.3",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
   "description": "The Stacks string utilities.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -34,7 +34,12 @@
     "functions",
     "stacks"
   ],
-  "main": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "contributors": [
@@ -44,24 +49,19 @@
     "dist",
     "README.md"
   ],
-  "engines": {
-    "node": ">=v18.14.0",
-    "pnpm": ">=7.26.3"
-  },
   "peerDependencies": {
     "@types/pluralize": "^0.0.29",
-    "@types/validator": "^13.7.11",
+    "@types/validator": "^13.7.17",
     "change-case": "^4.1.2",
     "pluralize": "^8.0.0",
+    "slugify": "^1.6.6",
+    "title-case": "^3.0.3",
     "validator": "^13.9.0",
-    "@stacksjs/alias": "0.51.0",
-    "@stacksjs/types": "0.51.0"
+    "@stacksjs/alias": "0.52.0",
+    "@stacksjs/types": "0.52.0"
   },
   "devDependencies": {
-    "mkdist": "^1.1.0",
-    "typescript": "^4.9.5",
-    "unbuild": "^1.1.1",
-    "@stacksjs/testing": "0.51.0"
+    "@stacksjs/development": "0.52.0"
   },
   "scripts": {
     "build": "unbuild",

package/dist/index.cjs

@@ -1,247 +0,0 @@
-'use strict';
-
-const changeCase = require('change-case');
-const pluralize = require('pluralize');
-const validator = require('validator');
-
-function slash(str) {
-  return str.replace(/\\/g, "/");
-}
-function ensurePrefix(prefix, str) {
-  if (!str.startsWith(prefix))
-    return prefix + str;
-  return str;
-}
-function ensureSuffix(suffix, str) {
-  if (!str.endsWith(suffix))
-    return str + suffix;
-  return str;
-}
-function template(str, ...args) {
-  return str.replace(/{(\d+)}/g, (match, key) => {
-    const index = Number(key);
-    if (Number.isNaN(index))
-      return match;
-    return args[index];
-  });
-}
-const urlAlphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";
-function randomStr(size = 16, dict = urlAlphabet) {
-  let id = "";
-  let i = size;
-  const len = dict.length;
-  while (i--)
-    id += dict[Math.random() * len | 0];
-  return id;
-}
-function capitalize(str) {
-  return str[0].toUpperCase() + str.slice(1).toLowerCase();
-}
-
-function isEmail(email) {
-  return validator.isEmail(email);
-}
-function isStrongPassword(password) {
-  return validator.isStrongPassword(password);
-}
-function isAlphanumeric(username) {
-  return validator.isAlphanumeric(username);
-}
-function validateUsername(username) {
-  return isAlphanumeric(username);
-}
-function isURL(url) {
-  return validator.isURL(url);
-}
-function isMobilePhone(phoneNumber) {
-  return validator.isMobilePhone(phoneNumber);
-}
-function isAlpha(name) {
-  return validator.isAlpha(name);
-}
-function isPostalCode(zipCode) {
-  return validator.isPostalCode(zipCode, "any");
-}
-function isDate(date) {
-  return validator.isDate(date);
-}
-function isNumeric(number) {
-  return validator.isNumeric(number);
-}
-function isBoolean(boolean) {
-  return validator.isBoolean(boolean);
-}
-function isHexColor(color) {
-  return validator.isHexColor(color);
-}
-function isHexadecimal(hex) {
-  return validator.isHexadecimal(hex);
-}
-function isBase64(base64) {
-  return validator.isBase64(base64);
-}
-function isUUID(uuid) {
-  return validator.isUUID(uuid);
-}
-function isJSON(json) {
-  return validator.isJSON(json);
-}
-function isCreditCard(creditCard) {
-  return validator.isCreditCard(creditCard);
-}
-function isISBN(isbn) {
-  return validator.isISBN(isbn);
-}
-function isIP(ip) {
-  return validator.isIP(ip);
-}
-function isIPRange(ip) {
-  return validator.isIPRange(ip);
-}
-function isMACAddress(macAddress) {
-  return validator.isMACAddress(macAddress);
-}
-function isLatLong(latitude) {
-  return validator.isLatLong(latitude);
-}
-function isLatitude(longitude) {
-  return validator.isLatLong(longitude);
-}
-function isLongitude(longitude) {
-  return validator.isLatLong(longitude);
-}
-function isCurrency(currency) {
-  return validator.isCurrency(currency);
-}
-function isDataURI(dataURI) {
-  return validator.isDataURI(dataURI);
-}
-function isMimeType(mimeType) {
-  return validator.isMimeType(mimeType);
-}
-function isJWT(jwt) {
-  return validator.isJWT(jwt);
-}
-function isMongoId(mongoId) {
-  return validator.isMongoId(mongoId);
-}
-function isAscii(ascii) {
-  return validator.isAscii(ascii);
-}
-function isBase32(base32) {
-  return validator.isBase32(base32);
-}
-function isByteLength(byteLength) {
-  return validator.isByteLength(byteLength);
-}
-function isFQDN(fqdn) {
-  return validator.isFQDN(fqdn);
-}
-function isFullWidth(fullWidth) {
-  return validator.isFullWidth(fullWidth);
-}
-function isHalfWidth(halfWidth) {
-  return validator.isHalfWidth(halfWidth);
-}
-function isHash(hash, algorithm) {
-  return validator.isHash(hash, algorithm);
-}
-function isHSL(hsl) {
-  return validator.isHSL(hsl);
-}
-function isIBAN(iban) {
-  return validator.isIBAN(iban);
-}
-function isIdentityCard(identityCard) {
-  return validator.isIdentityCard(identityCard);
-}
-function isISIN(isin) {
-  return validator.isISIN(isin);
-}
-function isISO8601(iso8601) {
-  return validator.isISO8601(iso8601);
-}
-function isISRC(isrc) {
-  return validator.isISRC(isrc);
-}
-function isISSN(issn) {
-  return validator.isISSN(issn);
-}
-function isISO31661Alpha2(iso31661Alpha2) {
-  return validator.isISO31661Alpha2(iso31661Alpha2);
-}
-function isISO31661Alpha3(iso31661Alpha3) {
-  return validator.isISO31661Alpha3(iso31661Alpha3);
-}
-
-exports.camelCase = changeCase.camelCase;
-exports.capitalCase = changeCase.capitalCase;
-exports.constantCase = changeCase.constantCase;
-exports.dotCase = changeCase.dotCase;
-exports.headerCase = changeCase.headerCase;
-exports.kebabCase = changeCase.paramCase;
-exports.noCase = changeCase.noCase;
-exports.paramCase = changeCase.paramCase;
-exports.pascalCase = changeCase.pascalCase;
-exports.pathCase = changeCase.pathCase;
-exports.sentenceCase = changeCase.sentenceCase;
-exports.snakeCase = changeCase.snakeCase;
-exports.addIrregularRule = pluralize.addIrregularRule;
-exports.addPluralRule = pluralize.addPluralRule;
-exports.addSingularRule = pluralize.addSingularRule;
-exports.addUncountableRule = pluralize.addUncountableRule;
-exports.isPlural = pluralize.isPlural;
-exports.isSingular = pluralize.isSingular;
-exports.plural = pluralize.plural;
-exports.singular = pluralize.singular;
-exports.capitalize = capitalize;
-exports.ensurePrefix = ensurePrefix;
-exports.ensureSuffix = ensureSuffix;
-exports.isAlpha = isAlpha;
-exports.isAlphanumeric = isAlphanumeric;
-exports.isAscii = isAscii;
-exports.isBase32 = isBase32;
-exports.isBase64 = isBase64;
-exports.isBoolean = isBoolean;
-exports.isByteLength = isByteLength;
-exports.isCreditCard = isCreditCard;
-exports.isCurrency = isCurrency;
-exports.isDataURI = isDataURI;
-exports.isDate = isDate;
-exports.isEmail = isEmail;
-exports.isFQDN = isFQDN;
-exports.isFullWidth = isFullWidth;
-exports.isHSL = isHSL;
-exports.isHalfWidth = isHalfWidth;
-exports.isHash = isHash;
-exports.isHexColor = isHexColor;
-exports.isHexadecimal = isHexadecimal;
-exports.isIBAN = isIBAN;
-exports.isIP = isIP;
-exports.isIPRange = isIPRange;
-exports.isISBN = isISBN;
-exports.isISIN = isISIN;
-exports.isISO31661Alpha2 = isISO31661Alpha2;
-exports.isISO31661Alpha3 = isISO31661Alpha3;
-exports.isISO8601 = isISO8601;
-exports.isISRC = isISRC;
-exports.isISSN = isISSN;
-exports.isIdentityCard = isIdentityCard;
-exports.isJSON = isJSON;
-exports.isJWT = isJWT;
-exports.isLatLong = isLatLong;
-exports.isLatitude = isLatitude;
-exports.isLongitude = isLongitude;
-exports.isMACAddress = isMACAddress;
-exports.isMimeType = isMimeType;
-exports.isMobilePhone = isMobilePhone;
-exports.isMongoId = isMongoId;
-exports.isNumeric = isNumeric;
-exports.isPostalCode = isPostalCode;
-exports.isStrongPassword = isStrongPassword;
-exports.isURL = isURL;
-exports.isUUID = isUUID;
-exports.randomStr = randomStr;
-exports.slash = slash;
-exports.template = template;
-exports.validateUsername = validateUsername;