.editorconfig

@@ -7,6 +7,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[{package.json,*.yml}]
+[*.yml]
 indent_style = space
 indent_size = 2

.gitattributes

@@ -1 +1 @@
-* text=auto
+* text=auto eol=lf

.github/funding.yml

@@ -0,0 +1,4 @@
+github: sindresorhus
+open_collective: sindresorhus
+tidelift: npm/boxen
+custom: https://sindresorhus.com/donate

.github/security.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

.gitignore

@@ -1 +1,3 @@
 node_modules
+yarn.lock
+.nyc_output

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
-  - '5'
-  - '4'
-  - '0.12'
-  - '0.10'
+  - '12'
+  - '10'
+  - '8'

example.js

@@ -1,6 +1,6 @@
 'use strict';
-var chalk = require('chalk');
-var boxen = require('./');
+const chalk = require('chalk');
+const boxen = require('.');
 
 console.log('\n\n' + boxen(chalk.blue.bold('unicorn'), {
 	padding: 1,
@@ -15,6 +15,21 @@ console.log('\n\n' + boxen(chalk.blue.bold('unicorn'), {
 	borderStyle: 'double'
 }) + '\n');
 
+console.log('\n\n' + boxen(chalk.blue.bold('unicorn'), {
+	padding: 1,
+	margin: 1,
+	borderColor: '#eebbaa',
+	borderStyle: 'double'
+}) + '\n');
+
+console.log('\n\n' + boxen(chalk.blue.bold('unicorn'), {
+	padding: 1,
+	margin: 1,
+	borderColor: '#ffc0cb',
+	backgroundColor: '#00ffff',
+	borderStyle: 'double'
+}) + '\n');
+
 console.log('\n\n' + boxen(chalk.blue.bold('unicorn'), {
 	padding: 1,
 	margin: 1,

index.d.ts

@@ -0,0 +1,175 @@
+import {LiteralUnion} from 'type-fest';
+import cliBoxes, {BoxStyle} from 'cli-boxes';
+
+declare namespace boxen {
+	/**
+	Characters used for custom border.
+
+	@example
+	```
+	// affffb
+	// e    e
+	// dffffc
+
+	const border: CustomBorderStyle = {
+		topLeft: 'a',
+		topRight: 'b',
+		bottomRight: 'c',
+		bottomLeft: 'd',
+		vertical: 'e',
+		horizontal: 'f'
+	};
+	```
+	*/
+	interface CustomBorderStyle extends BoxStyle {}
+
+	/**
+	Spacing used for `padding` and `margin`.
+	*/
+	interface Spacing {
+		readonly top: number;
+		readonly right: number;
+		readonly bottom: number;
+		readonly left: number;
+	}
+
+	interface Options {
+		/**
+		Color of the box border.
+		*/
+		readonly borderColor?: LiteralUnion<
+			| 'black'
+			| 'red'
+			| 'green'
+			| 'yellow'
+			| 'blue'
+			| 'magenta'
+			| 'cyan'
+			| 'white'
+			| 'gray'
+			| 'grey'
+			| 'blackBright'
+			| 'redBright'
+			| 'greenBright'
+			| 'yellowBright'
+			| 'blueBright'
+			| 'magentaBright'
+			| 'cyanBright'
+			| 'whiteBright',
+			string
+		>;
+
+		/**
+		Style of the box border.
+
+		@default BorderStyle.Single
+		*/
+		readonly borderStyle?: BorderStyle | CustomBorderStyle;
+
+		/**
+		Reduce opacity of the border.
+
+		@default false
+		*/
+		readonly dimBorder?: boolean;
+
+		/**
+		Space between the text and box border.
+
+		@default 0
+		*/
+		readonly padding?: number | Spacing;
+
+		/**
+		Space around the box.
+
+		@default 0
+		*/
+		readonly margin?: number | Spacing;
+
+		/**
+		Float the box on the available terminal screen space.
+
+		@default 'left'
+		*/
+		readonly float?: 'left' | 'right' | 'center';
+
+		/**
+		Color of the background.
+		*/
+		readonly backgroundColor?: LiteralUnion<
+			| 'black'
+			| 'red'
+			| 'green'
+			| 'yellow'
+			| 'blue'
+			| 'magenta'
+			| 'cyan'
+			| 'white'
+			| 'blackBright'
+			| 'redBright'
+			| 'greenBright'
+			| 'yellowBright'
+			| 'blueBright'
+			| 'magentaBright'
+			| 'cyanBright'
+			| 'whiteBright',
+			string
+		>;
+
+		/**
+		Align the text in the box based on the widest line.
+
+		@default 'left'
+		*/
+		readonly align?: 'left' | 'right' | 'center';
+	}
+}
+
+declare const enum BorderStyle {
+	Single = 'single',
+	Double = 'double',
+	Round = 'round',
+	Bold = 'bold',
+	SingleDouble = 'singleDouble',
+	DoubleSingle = 'doubleSingle',
+	Classic = 'classic'
+}
+
+declare const boxen: {
+	/**
+	Creates a box in the terminal.
+
+	@param text - The text inside the box.
+	@returns The box.
+
+	@example
+	```
+	import boxen = require('boxen');
+
+	console.log(boxen('unicorn', {padding: 1}));
+	// ┌─────────────┐
+	// │             │
+	// │   unicorn   │
+	// │             │
+	// └─────────────┘
+
+	console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
+	//
+	// ╔═════════════╗
+	// ║             ║
+	// ║   unicorn   ║
+	// ║             ║
+	// ╚═════════════╝
+	//
+	```
+	*/
+	(text: string, options?: boxen.Options): string;
+
+	/**
+	Border styles from [`cli-boxes`](https://github.com/sindresorhus/cli-boxes).
+	*/
+	BorderStyle: typeof BorderStyle;
+};
+
+export = boxen;