mirror of https://github.com/thangisme/notes.git synced 2024-11-06 21:27:27 -05:00

History

Patrick Marsceill b7b0d0d7bf Initial commit		2017-03-09 13:16:08 -05:00
..
test	Initial commit	2017-03-09 13:16:08 -05:00
.coveralls.yml	Initial commit	2017-03-09 13:16:08 -05:00
.editorconfig	Initial commit	2017-03-09 13:16:08 -05:00
.jshintignore	Initial commit	2017-03-09 13:16:08 -05:00
.jshintrc	Initial commit	2017-03-09 13:16:08 -05:00
.npmignore	Initial commit	2017-03-09 13:16:08 -05:00
.travis.yml	Initial commit	2017-03-09 13:16:08 -05:00
package.json	Initial commit	2017-03-09 13:16:08 -05:00
pipetteur.js	Initial commit	2017-03-09 13:16:08 -05:00
README.md	Initial commit	2017-03-09 13:16:08 -05:00

README.md

Pipetteur

A module to find all color syntax substrings in a string with their offsets and their color instance. It's an automated eyedropper tool for your text, css, html, svg etc.

It takes a single string argument and returns an array of objects like this:

{
    match: '#FF0000', // The found color match
    index: 0, // Zero based index of the match in the string
    line: 1, // 1-based line number
    column: 1, // 1-based column number
    color: <one-color>
}

The color object returned is an instance of one-color, giving you instant access to highlevel color manipulation without having to think about color space conversions.

Usage

var pipetteur = require('pipetteur');

pipetteur('Roses are rgb(255,0,0), violet are #00f');

[ { index: 10,
    line: 1,
    column: 11,
    match: 'rgb(255,0,0)',
    color:
     { _red: 1,
       _green: 0,
       _blue: 0,
       _alpha: 1 } },
  { index: 24,
    line: 1,
    column: 25,
    match: 'violet',
    color:
     { _red: 0.9333333333333333,
       _green: 0.5098039215686274,
       _blue: 0.9333333333333333,
       _alpha: 1 } },
  { index: 35,
    line: 1,
    column: 36,
    match: '#00f',
    color:
     { _red: 0,
       _green: 0,
       _blue: 1,
       _alpha: 1 } } ]

License

The MIT License (MIT)

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.