@cjser/humanize-string 3.1.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,47 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/humanize-string.tmp-26-1778152025452/index.js
+var index_exports = {};
+__export(index_exports, {
+  default: () => humanizeString
+});
+module.exports = __toCommonJS(index_exports);
+var import_decamelize = __toESM(require("@cjser/decamelize"), 1);
+function humanizeString(string, options = {}) {
+  if (typeof string !== "string") {
+    throw new TypeError("Expected a string");
+  }
+  if (!options.preserveCase) {
+    string = (0, import_decamelize.default)(string);
+    string = string.toLowerCase();
+  }
+  string = string.replace(/[_-]+/g, " ").replace(/\s{2,}/g, " ").trim();
+  string = string.charAt(0).toUpperCase() + string.slice(1);
+  return string;
+}

package/index.d.ts

@@ -0,0 +1,40 @@
+export type Options = {
+	/**
+	Preserve the original case instead of lowercasing.
+
+	@default false
+
+	@example
+	```
+	import humanizeString from '@cjser/humanize-string';
+
+	humanizeString('The-NetApp-Guide-to-Kubernetes');
+	//=> 'The net app guide to kubernetes'
+
+	humanizeString('The-NetApp-Guide-to-Kubernetes', {preserveCase: true});
+	//=> 'The NetApp Guide to Kubernetes'
+	```
+	*/
+	readonly preserveCase?: boolean;
+};
+
+/**
+Convert a camelized/dasherized/underscored string into a humanized one: `fooBar-Baz_Faz` → `Foo bar baz faz`.
+
+@param text - The string to make human readable.
+
+@example
+```
+import humanizeString from '@cjser/humanize-string';
+
+humanizeString('fooBar');
+//=> 'Foo bar'
+
+humanizeString('foo-bar');
+//=> 'Foo bar'
+
+humanizeString('foo_bar');
+//=> 'Foo bar'
+```
+*/
+export default function humanizeString(text: string, options?: Options): string;

package/index.js

@@ -0,0 +1,17 @@
+import decamelize from '@cjser/decamelize';
+
+export default function humanizeString(string, options = {}) {
+	if (typeof string !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	if (!options.preserveCase) {
+		string = decamelize(string);
+		string = string.toLowerCase();
+	}
+
+	string = string.replace(/[_-]+/g, ' ').replace(/\s{2,}/g, ' ').trim();
+	string = string.charAt(0).toUpperCase() + string.slice(1);
+
+	return string;
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@cjser/humanize-string",
+  "version": "3.1.0-cjser.2",
+  "description": "Convert a camelized/dasherized/underscored string into a humanized one: `fooBar-Baz_Faz` → `Foo bar baz faz`",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "require": "./dist-cjser/index.cjs",
+    "default": "./index.js"
+  },
+  "types": "./index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "humanize",
+    "human",
+    "pretty",
+    "capitalize",
+    "uppercase",
+    "case",
+    "camelcase",
+    "dash",
+    "hyphen",
+    "underscore",
+    "string",
+    "text",
+    "convert"
+  ],
+  "dependencies": {
+    "@cjser/decamelize": "6.0.1-cjser.2"
+  },
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "tsd": "^0.18.0",
+    "xo": "^0.45.0"
+  },
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "3.1.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "humanize-string",
+      "version": "3.1.0",
+      "exports": "./index.js",
+      "repository": "sindresorhus/humanize-string",
+      "dependencies": {
+        "decamelize": "^6.0.0"
+      },
+      "files": [
+        "index.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava && tsd"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,65 @@
+# humanize-string
+
+> Convert a camelized/dasherized/underscored string into a humanized one
+> Example: `fooBar-Baz_Faz` → `Foo bar baz faz`
+
+## Install
+
+```sh
+npm install humanize-string
+```
+
+## Usage
+
+```js
+import humanizeString from 'humanize-string';
+
+humanizeString('fooBar');
+//=> 'Foo bar'
+
+humanizeString('foo-bar');
+//=> 'Foo bar'
+
+humanizeString('foo_bar');
+//=> 'Foo bar'
+```
+
+## API
+
+### humanizeString(input, options?)
+
+#### input
+
+Type: `string`
+
+The string to humanize.
+
+#### options
+
+Type: `object`
+
+##### preserveCase
+
+Type: `boolean`\
+Default: `false`
+
+Preserve the original case instead of lowercasing.
+
+```js
+import humanizeString from 'humanize-string';
+
+humanizeString('The-NetApp-Guide-to-Kubernetes');
+//=> 'The net app guide to kubernetes'
+
+humanizeString('The-NetApp-Guide-to-Kubernetes', {preserveCase: true});
+//=> 'The NetApp Guide to Kubernetes'
+```
+
+## Related
+
+- [camelcase](https://github.com/sindresorhus/camelcase) - Convert a dash/dot/underscore/space separated string to camelcase
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/humanize-string