├── .gitattributes ├── .travis.yml ├── .editorconfig ├── .gitignore ├── index.js ├── LICENSE ├── .verb.md ├── package.json ├── test.js ├── .eslintrc.json └── README.md /.gitattributes: -------------------------------------------------------------------------------- 1 | # Enforce Unix newlines 2 | * text eol=lf 3 | 4 | # binaries 5 | *.ai binary 6 | *.psd binary 7 | *.jpg binary 8 | *.gif binary 9 | *.png binary 10 | *.jpeg binary 11 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | os: 3 | - linux 4 | - osx 5 | language: node_js 6 | node_js: 7 | - node 8 | - '7' 9 | - '6' 10 | - '5' 11 | - '4' 12 | - '0.12' 13 | - '0.10' 14 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | end_of_line = lf 6 | charset = utf-8 7 | indent_size = 2 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [{**/{actual,fixtures,expected,templates}/**,*.md}] 12 | trim_trailing_whitespace = false 13 | insert_final_newline = false -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # always ignore files 2 | *.DS_Store 3 | *.sublime-* 4 | 5 | # test related, or directories generated by tests 6 | test/actual 7 | actual 8 | coverage 9 | .nyc* 10 | 11 | # npm 12 | node_modules 13 | npm-debug.log 14 | 15 | # yarn 16 | yarn.lock 17 | yarn-error.log 18 | 19 | # misc 20 | _gh_pages 21 | _draft 22 | _drafts 23 | bower_components 24 | vendor 25 | temp 26 | tmp 27 | TODO.md 28 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * center-align 3 | * 4 | * Copycenter (c) 2015, Jon Schlinkert. 5 | * Licensed under the MIT License. 6 | */ 7 | 8 | 'use strict'; 9 | 10 | var repeat = require('repeat-string'); 11 | var align = require('align-text'); 12 | 13 | module.exports = function(val, width) { 14 | if (typeof width === 'number' && typeof val === 'string' && !/\n/.test(val)) { 15 | var padding = Math.floor((width - val.length) / 2); 16 | return repeat(' ', padding) + val + repeat(' ', padding); 17 | } 18 | 19 | return align(val, function(len, longest) { 20 | if (typeof width === 'number') { 21 | return Math.floor((width - len) / 2); 22 | } 23 | return Math.floor((longest - len) / 2); 24 | }); 25 | }; 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015-2016, Jon Schlinkert 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /.verb.md: -------------------------------------------------------------------------------- 1 | ## Usage 2 | 3 | ```js 4 | var center = require('{%= name %}'); 5 | center(val, width); 6 | ``` 7 | 8 | **Params** 9 | 10 | - `val` **{String|Array}**: the string or array of strings to center align 11 | - `width` **{Number}** (optional): the total width of each line in the expected result, after it's centered. 12 | 13 | ## Examples 14 | 15 | ```js 16 | console.log(center('foo')); //=> 'foo' (does nothing) 17 | console.log(center('foo', 12)); //=> ' foo ' 18 | console.log(center('foo', 10)); //=> ' foo ' 19 | console.log(center('foo', 8)); //=> ' foo ' 20 | ``` 21 | 22 | ### Multiple lines 23 | 24 | If expected `width` is not provided, the _length of the longest line_ will be used. 25 | 26 | **Example** 27 | 28 | If used on the following: 29 | 30 | ```js 31 | // value can be a string, or an array of strings 32 | center([ 33 | 'Lorem ipsum dolor sit amet,', 34 | 'consectetur adipiscing', 35 | 'elit, sed do eiusmod tempor incididunt', 36 | 'ut labore et dolore', 37 | 'magna aliqua. Ut enim ad minim', 38 | 'veniam, quis' 39 | ]); 40 | ``` 41 | 42 | The result would be: 43 | 44 | ``` 45 | Lorem ipsum dolor sit amet, 46 | consectetur adipiscing 47 | elit, sed do eiusmod tempor incididunt 48 | ut labore et dolore 49 | magna aliqua. Ut enim ad minim 50 | veniam, quis 51 | ``` 52 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "center-align", 3 | "description": "Center-align the text in a string.", 4 | "version": "1.0.1", 5 | "homepage": "https://github.com/jonschlinkert/center-align", 6 | "author": "Jon Schlinkert (https://github.com/jonschlinkert)", 7 | "repository": "jonschlinkert/center-align", 8 | "bugs": { 9 | "url": "https://github.com/jonschlinkert/center-align/issues" 10 | }, 11 | "license": "MIT", 12 | "files": [ 13 | "index.js" 14 | ], 15 | "main": "index.js", 16 | "engines": { 17 | "node": ">=0.10.0" 18 | }, 19 | "scripts": { 20 | "test": "mocha" 21 | }, 22 | "dependencies": { 23 | "align-text": "^1.0.0", 24 | "repeat-string": "^1.6.1" 25 | }, 26 | "devDependencies": { 27 | "gulp-format-md": "^0.1.12", 28 | "mocha": "^3.4.2" 29 | }, 30 | "keywords": [ 31 | "align", 32 | "align-center", 33 | "center", 34 | "center-align", 35 | "right", 36 | "right-align", 37 | "text", 38 | "typography" 39 | ], 40 | "verb": { 41 | "toc": false, 42 | "layout": "default", 43 | "tasks": [ 44 | "readme" 45 | ], 46 | "plugins": [ 47 | "gulp-format-md" 48 | ], 49 | "related": { 50 | "list": [ 51 | "align-text", 52 | "justified", 53 | "right-align", 54 | "word-wrap" 55 | ] 56 | }, 57 | "lint": { 58 | "reflinks": true 59 | } 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * center-align 3 | * 4 | * Copycenter (c) 2015 Jon Schlinkert. 5 | * Licensed under the MIT license. 6 | */ 7 | 8 | 'use strict'; 9 | 10 | require('mocha'); 11 | var assert = require('assert'); 12 | var centerAlign = require('./'); 13 | 14 | var fixture = [ 15 | 'Lorem ipsum dolor sit amet,', 16 | 'consectetur adipiscing', 17 | 'elit, sed do eiusmod tempor incididunt', 18 | 'ut labore et dolore', 19 | 'magna aliqua. Ut enim ad minim', 20 | 'veniam, quis' 21 | ]; 22 | 23 | var expected = [ 24 | ' Lorem ipsum dolor sit amet,', 25 | ' consectetur adipiscing', 26 | 'elit, sed do eiusmod tempor incididunt', 27 | ' ut labore et dolore', 28 | ' magna aliqua. Ut enim ad minim', 29 | ' veniam, quis' 30 | ]; 31 | 32 | describe('center-align', function () { 33 | it('should center align the strings in an array of strings', function () { 34 | assert.deepEqual(centerAlign(fixture), expected); 35 | }); 36 | 37 | it('should center align a string to the expected width', function () { 38 | assert.deepEqual(centerAlign(fixture, 40), [ 39 | ' Lorem ipsum dolor sit amet,', 40 | ' consectetur adipiscing', 41 | ' elit, sed do eiusmod tempor incididunt', 42 | ' ut labore et dolore', 43 | ' magna aliqua. Ut enim ad minim', 44 | ' veniam, quis' 45 | ]); 46 | 47 | assert.deepEqual(centerAlign(fixture, 50), [ 48 | ' Lorem ipsum dolor sit amet,', 49 | ' consectetur adipiscing', 50 | ' elit, sed do eiusmod tempor incididunt', 51 | ' ut labore et dolore', 52 | ' magna aliqua. Ut enim ad minim', 53 | ' veniam, quis' 54 | ]); 55 | }); 56 | 57 | it('should center align a string to the given width', function () { 58 | assert.deepEqual(centerAlign('foo', 9), ' foo '); 59 | assert.deepEqual(centerAlign('foo', 10), ' foo '); 60 | assert.deepEqual(centerAlign('foo', 11), ' foo '); 61 | assert.deepEqual(centerAlign('foo', 12), ' foo '); 62 | }); 63 | 64 | it('should center align the lines in a string', function () { 65 | assert.equal(centerAlign(fixture.join('\n')), expected.join('\n')); 66 | }); 67 | }); 68 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "ecmaFeatures": { 3 | "modules": true, 4 | "experimentalObjectRestSpread": true 5 | }, 6 | 7 | "env": { 8 | "browser": false, 9 | "es6": true, 10 | "node": true, 11 | "mocha": true 12 | }, 13 | 14 | "globals": { 15 | "document": false, 16 | "navigator": false, 17 | "window": false 18 | }, 19 | 20 | "rules": { 21 | "accessor-pairs": 2, 22 | "arrow-spacing": [2, { "before": true, "after": true }], 23 | "block-spacing": [2, "always"], 24 | "brace-style": [2, "1tbs", { "allowSingleLine": true }], 25 | "comma-dangle": [2, "never"], 26 | "comma-spacing": [2, { "before": false, "after": true }], 27 | "comma-style": [2, "last"], 28 | "constructor-super": 2, 29 | "curly": [2, "multi-line"], 30 | "dot-location": [2, "property"], 31 | "eol-last": 2, 32 | "eqeqeq": [2, "allow-null"], 33 | "generator-star-spacing": [2, { "before": true, "after": true }], 34 | "handle-callback-err": [2, "^(err|error)$" ], 35 | "indent": [2, 2, { "SwitchCase": 1 }], 36 | "key-spacing": [2, { "beforeColon": false, "afterColon": true }], 37 | "keyword-spacing": [2, { "before": true, "after": true }], 38 | "new-cap": [2, { "newIsCap": true, "capIsNew": false }], 39 | "new-parens": 2, 40 | "no-array-constructor": 2, 41 | "no-caller": 2, 42 | "no-class-assign": 2, 43 | "no-cond-assign": 2, 44 | "no-const-assign": 2, 45 | "no-control-regex": 2, 46 | "no-debugger": 2, 47 | "no-delete-var": 2, 48 | "no-dupe-args": 2, 49 | "no-dupe-class-members": 2, 50 | "no-dupe-keys": 2, 51 | "no-duplicate-case": 2, 52 | "no-empty-character-class": 2, 53 | "no-eval": 2, 54 | "no-ex-assign": 2, 55 | "no-extend-native": 2, 56 | "no-extra-bind": 2, 57 | "no-extra-boolean-cast": 2, 58 | "no-extra-parens": [2, "functions"], 59 | "no-fallthrough": 2, 60 | "no-floating-decimal": 2, 61 | "no-func-assign": 2, 62 | "no-implied-eval": 2, 63 | "no-inner-declarations": [2, "functions"], 64 | "no-invalid-regexp": 2, 65 | "no-irregular-whitespace": 2, 66 | "no-iterator": 2, 67 | "no-label-var": 2, 68 | "no-labels": 2, 69 | "no-lone-blocks": 2, 70 | "no-mixed-spaces-and-tabs": 2, 71 | "no-multi-spaces": 2, 72 | "no-multi-str": 2, 73 | "no-multiple-empty-lines": [2, { "max": 1 }], 74 | "no-native-reassign": 0, 75 | "no-negated-in-lhs": 2, 76 | "no-new": 2, 77 | "no-new-func": 2, 78 | "no-new-object": 2, 79 | "no-new-require": 2, 80 | "no-new-wrappers": 2, 81 | "no-obj-calls": 2, 82 | "no-octal": 2, 83 | "no-octal-escape": 2, 84 | "no-proto": 0, 85 | "no-redeclare": 2, 86 | "no-regex-spaces": 2, 87 | "no-return-assign": 2, 88 | "no-self-compare": 2, 89 | "no-sequences": 2, 90 | "no-shadow-restricted-names": 2, 91 | "no-spaced-func": 2, 92 | "no-sparse-arrays": 2, 93 | "no-this-before-super": 2, 94 | "no-throw-literal": 2, 95 | "no-trailing-spaces": 0, 96 | "no-undef": 2, 97 | "no-undef-init": 2, 98 | "no-unexpected-multiline": 2, 99 | "no-unneeded-ternary": [2, { "defaultAssignment": false }], 100 | "no-unreachable": 2, 101 | "no-unused-vars": [2, { "vars": "all", "args": "none" }], 102 | "no-useless-call": 0, 103 | "no-with": 2, 104 | "one-var": [0, { "initialized": "never" }], 105 | "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], 106 | "padded-blocks": [0, "never"], 107 | "quotes": [2, "single", "avoid-escape"], 108 | "radix": 2, 109 | "semi": [2, "always"], 110 | "semi-spacing": [2, { "before": false, "after": true }], 111 | "space-before-blocks": [2, "always"], 112 | "space-before-function-paren": [2, "never"], 113 | "space-in-parens": [2, "never"], 114 | "space-infix-ops": 2, 115 | "space-unary-ops": [2, { "words": true, "nonwords": false }], 116 | "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], 117 | "use-isnan": 2, 118 | "valid-typeof": 2, 119 | "wrap-iife": [2, "any"], 120 | "yoda": [2, "never"] 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # center-align [![NPM version](https://img.shields.io/npm/v/center-align.svg?style=flat)](https://www.npmjs.com/package/center-align) [![NPM monthly downloads](https://img.shields.io/npm/dm/center-align.svg?style=flat)](https://npmjs.org/package/center-align) [![NPM total downloads](https://img.shields.io/npm/dt/center-align.svg?style=flat)](https://npmjs.org/package/center-align) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/center-align.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/center-align) 2 | 3 | > Center-align the text in a string. 4 | 5 | ## Install 6 | 7 | Install with [npm](https://www.npmjs.com/): 8 | 9 | ```sh 10 | $ npm install --save center-align 11 | ``` 12 | 13 | ## Usage 14 | 15 | ```js 16 | var center = require('center-align'); 17 | center(val, width); 18 | ``` 19 | 20 | **Params** 21 | 22 | * `val` **{String|Array}**: the string or array of strings to center align 23 | * `width` **{Number}** (optional): the total width of each line in the expected result, after it's centered. 24 | 25 | ## Examples 26 | 27 | ```js 28 | console.log(center('foo')); //=> 'foo' (does nothing) 29 | console.log(center('foo', 12)); //=> ' foo ' 30 | console.log(center('foo', 10)); //=> ' foo ' 31 | console.log(center('foo', 8)); //=> ' foo ' 32 | ``` 33 | 34 | ### Multiple lines 35 | 36 | If expected `width` is not provided, the _length of the longest line_ will be used. 37 | 38 | **Example** 39 | 40 | If used on the following: 41 | 42 | ```js 43 | // value can be a string, or an array of strings 44 | center([ 45 | 'Lorem ipsum dolor sit amet,', 46 | 'consectetur adipiscing', 47 | 'elit, sed do eiusmod tempor incididunt', 48 | 'ut labore et dolore', 49 | 'magna aliqua. Ut enim ad minim', 50 | 'veniam, quis' 51 | ]); 52 | ``` 53 | 54 | The result would be: 55 | 56 | ``` 57 | Lorem ipsum dolor sit amet, 58 | consectetur adipiscing 59 | elit, sed do eiusmod tempor incididunt 60 | ut labore et dolore 61 | magna aliqua. Ut enim ad minim 62 | veniam, quis 63 | ``` 64 | 65 | ## About 66 | 67 | ### Related projects 68 | 69 | * [align-text](https://www.npmjs.com/package/align-text): Align the text in a string. | [homepage](https://github.com/jonschlinkert/align-text "Align the text in a string.") 70 | * [justified](https://www.npmjs.com/package/justified): Wrap words to a specified length and justified the text. | [homepage](https://github.com/jonschlinkert/justified "Wrap words to a specified length and justified the text.") 71 | * [right-align](https://www.npmjs.com/package/right-align): Right-align the text in a string. | [homepage](https://github.com/jonschlinkert/right-align "Right-align the text in a string.") 72 | * [word-wrap](https://www.npmjs.com/package/word-wrap): Wrap words to a specified length. | [homepage](https://github.com/jonschlinkert/word-wrap "Wrap words to a specified length.") 73 | 74 | ### Contributing 75 | 76 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). 77 | 78 | ### Building docs 79 | 80 | _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ 81 | 82 | To generate the readme, run the following command: 83 | 84 | ```sh 85 | $ npm install -g verbose/verb#dev verb-generate-readme && verb 86 | ``` 87 | 88 | ### Running tests 89 | 90 | Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: 91 | 92 | ```sh 93 | $ npm install && npm test 94 | ``` 95 | 96 | ### Author 97 | 98 | **Jon Schlinkert** 99 | 100 | * [github/jonschlinkert](https://github.com/jonschlinkert) 101 | * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) 102 | 103 | ### License 104 | 105 | Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). 106 | Released under the [MIT License](LICENSE). 107 | 108 | *** 109 | 110 | _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 26, 2017._ --------------------------------------------------------------------------------