color-shorthand-hex-to-six-digit

Convert shorthand hex colour codes into full. #abc => #aabbcc

• PostHTML Plugin: posthtml-color-shorthand-hex-to-six-digit

Table of Contents

• Install
• Purpose
• Concept
• Examples
• API
• Testing, linting and coverage
• Contributing
• Licence

Install

$ npm install --save color-shorthand-hex-to-six-digit

Purpose

Email newsletters use a lot of styling using HTML attributes, for example, <td bgcolor='#cccccc'>. As you know, there is alternative way to write color codes in HEX — shorthand, for example, <td bgcolor='#ccc'>.

Certain contemporary email consumption software doesn't accept shorthand hex colour codes, what means you have to ensure all your email templates use only full-length colour codes. Some tooling libraries that work with SASS shorten the colour hex codes, and that's a best practice for web development, but not for email. We need a tool/library which could convert any shorthand hex codes from any input (array, plain object or string) into full notation.

color-shorthand-hex-to-six-digit is an internal library either to be used in JS applications, or as a core dependency for plugins (for example PostHTML).

This library takes any input: array (of strings, plain objects, other arrays or nested combination thereof), plain object (containing anything in values, including nested plain objects, arrays or strings) or string. Once received, it traverses the input and converts all found shorthand hex colour codes (#abc) into full-length (#aabbcc).

Concept

Here's the idea of this library:

• color-shorthand-hex-to-six-digit is one-way only: any the hex code is accepted, but all and only shorthand is converted to full-hand.
• color-shorthand-hex-to-six-digit doesn't throw errors when it encounters full hex codes (or, for actually, even stupid things in the input — simply returns them back)
• color-shorthand-hex-to-six-digit is AST-ready and accept whatever, including nested spaghetti trees, not just strings. You can pass anything: plain objects, arrays or strings — that's fine, shorthand hexes will be found and converted.
• if you pass something weird as input into color-shorthand-hex-to-six-digit, it will not throw, but simply return it back. This is on purpose, to play well inside other libraries.

Additionally, all letters in all hex codes are converted to lowercase.

Examples

var conv = require('color-shorthand-hex-to-six-digit')

// converts shorthand hex color codes within strings:
conv('aaaa #f0c zzzz\n\t\t\t#fc0')
// => 'aaaa #ff00cc zzzz\n\t\t\t#ffcc00'

// converts shorthand hex colour codes within plain objects:
conv(
  {
    a: '#ffcc00',
    b: '#f0c',
    c: 'text'
  }
)
// => {
//   a: '#ffcc00',
//   b: '#ff00cc',
//   c: 'text'
// }

// converts shorthand hex colour codes within arrays:
conv(
  [
    '#fc0', '#f0c', 'text', ''
  ]
)
// => [
//   '#ffcc00', '#ff00cc', 'text', ''
// ]

// converts shorthand hex colour codes within nested spaghetti's:
conv(
  [
    [[[[[{x: ['#fc0']}]]]]], {z: '#f0c'}, ['text'], {y: ''}
  ]
)
// => [
//   [[[[[{x: ['#ffcc00']}]]]]], {z: '#ff00cc'}, ['text'], {y: ''}
// ]

// in all other cases it silently returns the input:
conv(null)
// => null

API

Input arguments are not mutated in any way. This package will clone the inputs and work on the copies.

conv(
  input  // Anything: array, plain object or string or anything else
)
// => Anything, with all shorthand hex occurrences inside of it, converted to full hand.
// if an input is of an unrecognised type (array, plain object or string), it will be returned without errors.

Testing, linting and coverage

$ npm test

Unit tests use AVA and JS Standard notation. Coverage is measured by Istanbul CLI, which we aim to be 100%.

Contributing

All contributions are welcome. Please stick to Standard JavaScript notation and supplement the test.js with new unit tests covering your feature(s).

If you see anything incorrect whatsoever, do raise an issue. If you file a pull request, I'll do my best to review it promptly. If you have any comments on the code, including ideas how to improve things, don't hesitate to contact me by email.

Licence

MIT License (MIT)

Copyright (c) 2017 Codsen Ltd, Roy Reveltas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.