Meta tweaks

Author: sindresorhus

index.d.ts

@@ -9,7 +9,7 @@ declare namespace cliTruncate {
 
 		/**
 		Add a space between the text and the ellipsis.
-		
+
 		@default false
 
 		@example

index.js

@@ -2,6 +2,24 @@
 const sliceAnsi = require('slice-ansi');
 const stringWidth = require('string-width');
 
+function getIndexOfNearestSpace(string, index, shouldSearchRight) {
+	if (string.charAt(index) === ' ') {
+		return index;
+	}
+
+	for (let i = 1; i <= 3; i++) {
+		if (shouldSearchRight) {
+			if (string.charAt(index + i) === ' ') {
+				return index + i;
+			}
+		} else if (string.charAt(index - i) === ' ') {
+			return index - i;
+		}
+	}
+
+	return index;
+}
+
 module.exports = (text, columns, options) => {
 	options = {
 		position: 'end',
@@ -86,21 +104,3 @@ module.exports = (text, columns, options) => {
 
 	throw new Error(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
 };
-
-function getIndexOfNearestSpace(string, index, shouldSearchRight) {
-	if (string.charAt(index) === ' ') {
-		return index;
-	}
-
-	for (let i = 1; i <= 3; i++) {
-		if (shouldSearchRight) {
-			if (string.charAt(index + i) === ' ') {
-				return index + i;
-			}
-		} else if (string.charAt(index - i) === ' ') {
-			return index - i;
-		}
-	}
-
-	return index;
-}

package.json

@@ -30,14 +30,15 @@
 		"term",
 		"shell",
 		"width",
-		"ansi"
+		"ansi",
+		"string"
 	],
 	"dependencies": {
 		"slice-ansi": "^2.1.0",
 		"string-width": "^4.1.0"
 	},
 	"devDependencies": {
-		"ava": "^1.4.1",
+		"ava": "^2.1.0",
 		"tsd": "^0.7.2",
 		"xo": "^0.24.0"
 	}

readme.md

@@ -50,7 +50,7 @@ cliTruncate(paragraph, process.stdout.columns));
 
 ## API
 
-### cliTruncate(text, columns, [options])
+### cliTruncate(text, columns, options?)
 
 #### text
 
@@ -66,13 +66,13 @@ Columns to occupy in the terminal.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
 ##### position
 
 Type: `string`<br>
-Default: `end`<br>
-Values: `start` `middle` `end`
+Default: `'end'`<br>
+Values: `'start'` `'middle'` `'end'`
 
 Position to truncate the string.
 
@@ -118,17 +118,13 @@ cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncatio
 cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true})
 //=> 'unico…'
 
-// preferTruncationOnSpace would have no effect if space isn't found within next 3 indexes  
+// preferTruncationOnSpace would have no effect if space isn't found within next 3 indexes
 cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true})
 //=> 'uni…ns'
 ```
 
+
 ## Related
 
 - [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes
 - [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)