├── .editorconfig ├── .eslintrc.json ├── .gitattributes ├── .gitignore ├── .travis.yml ├── .verb.md ├── LICENSE ├── README.md ├── index.js ├── package.json └── test.js /.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 -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Enforce Unix newlines 2 | *.* text eol=lf 3 | *.css text eol=lf 4 | *.html text eol=lf 5 | *.js text eol=lf 6 | *.json text eol=lf 7 | *.less text eol=lf 8 | *.md text eol=lf 9 | *.yml text eol=lf 10 | 11 | *.jpg binary 12 | *.gif binary 13 | *.png binary 14 | *.jpeg binary -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | os: 3 | - linux 4 | - osx 5 | language: node_js 6 | node_js: 7 | - 10 8 | - 12 9 | - 13 10 | -------------------------------------------------------------------------------- /.verb.md: -------------------------------------------------------------------------------- 1 | ## Usage 2 | 3 | ```js 4 | const pretty = require('{%= name %}'); 5 | 6 | pretty(STRING_OF_HTML); 7 | ``` 8 | 9 | Before 10 | 11 | ```html 12 | 13 | Home 14 | This is content. 15 | ``` 16 | 17 | After 18 | 19 | ```html 20 | 21 | 22 | 23 | 24 | Home 25 | 26 | 27 | This is content. 28 | 29 | 30 | ``` 31 | 32 | ## Options 33 | 34 | ### ocd 35 | 36 | ```js 37 | pretty(STRING_OF_HTML, {ocd: true}); 38 | ``` 39 | 40 | **Type**: `Boolean` 41 | 42 | **Default**: `undefined` 43 | 44 | - condenses multiple newlines to a single newline 45 | - trims leading and trailing whitespace 46 | - ensures that a trailing newline is inserted 47 | - normalizes whitespace before code comments 48 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2013-2015, 2017, 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pretty [![NPM version](https://img.shields.io/npm/v/pretty.svg?style=flat)](https://www.npmjs.com/package/pretty) [![NPM monthly downloads](https://img.shields.io/npm/dm/pretty.svg?style=flat)](https://npmjs.org/package/pretty) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/pretty.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/pretty) 2 | 3 | > Some tweaks for beautifying HTML with js-beautify according to my preferences. 4 | 5 | ## Install 6 | 7 | Install with [npm](https://www.npmjs.com/): 8 | 9 | ```sh 10 | $ npm install --save pretty 11 | ``` 12 | 13 | Install with [yarn](https://yarnpkg.com): 14 | 15 | ```sh 16 | $ yarn add pretty 17 | ``` 18 | 19 | ## Usage 20 | 21 | ```js 22 | var pretty = require('pretty'); 23 | 24 | pretty(STRING_OF_HTML); 25 | ``` 26 | 27 | Before 28 | 29 | ```html 30 | 31 | Home 32 | This is content. 33 | ``` 34 | 35 | After 36 | 37 | ```html 38 | 39 | 40 | 41 | 42 | Home 43 | 44 | 45 | This is content. 46 | 47 | 48 | ``` 49 | 50 | ## Options 51 | 52 | ### ocd 53 | 54 | ```js 55 | pretty(STRING_OF_HTML, {ocd: true}); 56 | ``` 57 | 58 | **Type**: `Boolean` 59 | 60 | **Default**: `undefined` 61 | 62 | * condenses multiple newlines to a single newline 63 | * trims leading and trailing whitespace 64 | * ensures that a trailing newline is inserted 65 | * normalizes whitespace before code comments 66 | 67 | ## About 68 | 69 | ### Contributing 70 | 71 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). 72 | 73 | ### Building docs 74 | 75 | _(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.)_ 76 | 77 | To generate the readme, run the following command: 78 | 79 | ```sh 80 | $ npm install -g verbose/verb#dev verb-generate-readme && verb 81 | ``` 82 | 83 | ### Running tests 84 | 85 | 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: 86 | 87 | ```sh 88 | $ npm install && npm test 89 | ``` 90 | 91 | ### Author 92 | 93 | **Jon Schlinkert** 94 | 95 | * [github/jonschlinkert](https://github.com/jonschlinkert) 96 | * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) 97 | 98 | ### License 99 | 100 | Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). 101 | Released under the [MIT License](LICENSE). 102 | 103 | *** 104 | 105 | _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 13, 2017._ -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * pretty 3 | * 4 | * Copyright (c) 2013-2015, 2017, Jon Schlinkert. 5 | * Released under the MIT License. 6 | */ 7 | 8 | 'use strict'; 9 | 10 | const beautify = require('js-beautify'); 11 | const condense = require('condense-newlines'); 12 | const defaults = { 13 | unformatted: ['code', 'pre', 'em', 'strong', 'span'], 14 | indent_inner_html: true, 15 | indent_char: ' ', 16 | indent_size: 2, 17 | sep: '\n' 18 | }; 19 | 20 | const ocd = (str, options) => { 21 | // Normalize and condense all newlines 22 | return condense(str, options) 23 | // Remove empty whitespace the top of a file. 24 | .replace(/^\s+/g, '') 25 | // Remove extra whitespace from eof 26 | .replace(/\s+$/g, '\n') 27 | 28 | // Add a space above each comment 29 | .replace(/(\s*', 39 | ' ', 40 | ' this is content... ', 41 | '', 42 | ].join('\n'); 43 | const expected = [ 44 | '', 45 | '', 46 | ' ', 47 | ' ', 48 | ' Document', 49 | '', 50 | ' ', 51 | ' ', 52 | ' this is content... ', 53 | '', 54 | ].join('\n'); 55 | assert.equal(pretty(fixture, {ocd: true}), expected); 56 | }); 57 | 58 | it('should move "closing" comments after closing tags', () => { 59 | const fixture = [ 60 | '', 61 | '', 62 | ' ', 63 | ' ', 64 | ' Document', 65 | ' ', 66 | ' this is content... ', 67 | '
foo
', 68 | ' ', 69 | '', 70 | ].join('\n'); 71 | const expected = [ 72 | '', 73 | '', 74 | ' ', 75 | ' ', 76 | ' Document', 77 | ' ', 78 | ' this is content... ', 79 | '
foo
', 80 | '', 81 | ].join('\n'); 82 | assert.equal(pretty(fixture, {ocd: true}), expected); 83 | }); 84 | }); 85 | 86 | --------------------------------------------------------------------------------