@trenskow/caseit 1.1.0 → 1.1.3

package/.eslintrc.js

@@ -1,49 +1,48 @@
 module.exports = {
-    "env": {
-        "es6": true,
-        "node": true,
-        "mocha": true
-    },
-    "parserOptions": {
-      "ecmaVersion": 2017
-    },
-    "extends": "eslint:recommended",
-    "rules": {
-        "indent": [
-            "error",
-            "tab"
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ],
-        "no-console": [
-          "error", {
-            "allow": [
-              "warn",
-              "error",
-              "info"
-            ]
-          }
-        ],
-        "no-unused-vars": [
-          "error", {
-            "argsIgnorePattern": "^_"
-          }
-        ],
-        "no-empty": [
-          "error", {
-            "allowEmptyCatch": true
-          }
-        ],
-        "require-atomic-updates": "off"
-    }
+	'env': {
+		'es6': true,
+		'node': true
+	},
+	'parserOptions': {
+		'ecmaVersion': 2017
+	},
+	'extends': 'eslint:recommended',
+	'rules': {
+		'indent': [
+			'error',
+			'tab'
+		],
+		'linebreak-style': [
+			'error',
+			'unix'
+		],
+		'quotes': [
+			'error',
+			'single'
+		],
+		'semi': [
+			'error',
+			'always'
+		],
+		'no-console': [
+			'error', {
+				'allow': [
+					'warn',
+					'error',
+					'info'
+				]
+			}
+		],
+		'no-unused-vars': [
+			'error', {
+				'argsIgnorePattern': '^_'
+			}
+		],
+		'no-empty': [
+			'error', {
+				'allowEmptyCatch': true
+			}
+		],
+		'require-atomic-updates': 'off'
+	}
 };

package/README.md

@@ -5,9 +5,25 @@ A small library for changing the case of a string.
 
 # Usage
 
-    const caseit = require('caseit');
-    
-    const myCamelCase = caseit('my_camel_case', 'camel'); // myCamelCase;
+Import using the following example.
+
+````javascript
+const caseit = require('@trenskow/caseit');
+````
+
+– or
+
+````javascript
+import caseit from '@trenskow/caseit'
+````
+
+## Converting
+
+To convert from one case type to another use the following example.
+
+```javascript
+const myCamelCase = caseit('my_camel_case', 'camel'); // return 'myCamelCase';
+```
 
 You can convert from any format to any other format. Supported formats are.
 
@@ -19,7 +35,24 @@ You can convert from any format to any other format. Supported formats are.
  * `title` - Title Case
  * `http` - Http-Case
 
-> Default format (if omitted) is `camel`.
+> Default format (if omitted) is `camel` (because it is the Javascript default).
+
+## Detecting
+
+To detect the casing of a string do as the following example.
+
+````javascript
+caseit.detect('MyCase'); // returns ['pascal']
+caseit.detect('Hello'); // returns ['pascal', 'title', 'http']
+````
+
+## Getting the words
+
+You can also get the lowercase variants of all the words in a string by using the following example.
+
+````javascript
+caseit.words('MyCase'); // returns ['my', 'case']
+````
 
 # LICENSE
 

package/index.js

@@ -1,43 +1,57 @@
 'use strict';
 
+const separators = {
+	'camel': '',
+	'pascal': '',
+	'snake': '_',
+	'domain': '.',
+	'kebab': '-',
+	'title': ' ',
+	'http': '-'
+};
+
+const supported = Object.keys(separators).sort();
+
 module.exports = exports = function(input, type = 'camel') {
 
-	const separators = {
-		'camel': '',
-		'pascal': '',
-		'snake': '_',
-		'domain': '.',
-		'kebab': '-',
-		'title': ' ',
-		'http': '-'
-	};
-
-	if (Object.keys(separators).indexOf(type) == -1) {
-		throw new TypeError('Type must either be `camel`, `pascal`, `snake`, `domain`, `kebab`, `title`.');
+	if (!supported.includes(type)) {
+		throw new TypeError(`Type must either be ${supported.slice(0, -1).join(', ')} or ${supported.slice(-1)[0]}.`);
 	}
 
-	const parts = input.split(/(?=[A-Z])|_|-| |\./)
+	const words = exports.words(input)
 		.filter((key) => key.length)
 		.map((key, idx) => {
 			switch (type) {
 			case 'camel':
 				if (idx == 0) return key.toLowerCase();
-				// falls through
+				// fallthrough
 			case 'title':
-				// falls through
+				// fallthrough
 			case 'http':
-				// falls through
+				// fallthrough
 			case 'pascal':
 				return key.charAt(0).toUpperCase() + key.substring(1).toLowerCase();
 			case 'domain':
-				// falls through
+				// fallthrough
 			case 'kebab':
-				// falls through
+				// fallthrough
 			case 'snake':
 				return key.toLowerCase();
 			}
 		});
 
-	return parts.join(separators[type]);
-					
+	return words.join(separators[type]);
+
 };
+
+exports.words = function(input) {
+	return input.split(/(?=[A-Z])|_|-| |\./)
+		.map((word) => word.toLowerCase());
+};
+
+exports.detect = function(input) {
+	return supported
+		.filter((type) => exports(input, type) === input);
+};
+
+exports.supported = supported;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trenskow/caseit",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "description": "Small library for converting between different casing.",
   "main": "index.js",
   "scripts": {
@@ -20,5 +20,8 @@
   "bugs": {
     "url": "https://github.com/trenskow/caseit/issues"
   },
-  "homepage": "https://github.com/trenskow/caseit#readme"
+  "homepage": "https://github.com/trenskow/caseit#readme",
+  "devDependencies": {
+    "eslint": "^8.2.0"
+  }
 }