pipetteur - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0

package.json

 {
   "name": "pipetteur",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "A function to extract any colors from a string",
   "main": "pipetteur.js",
   "scripts": {
-    "test": "mocha"
+    "test": "npm run lint && mocha",
+    "lint": "jshint .",
+    "travis": "npm run lint && NODE_ENV=development ./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- --reporter dot && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
   },
@@ -31,8 +33,13 @@ "repository": {
   "dependencies": {
-    "css-color-names": "0.0.1"
+    "onecolor": "^2.4.0",
+    "synesthesia": "^1.0.0"
   },
   "devDependencies": {
+    "coveralls": "^2.11.1",
+    "istanbul": "^0.3.0",
+    "jshint": "^2.5.2",
     "mocha": "^1.20.1",
+    "mocha-lcov-reporter": "0.0.1",
     "unexpected": "^3.2.3"
   }
 }

pipetteur.js

@@ -1,65 +0,28 @@
-var colorNames = require('css-color-names');
+var synesthesia = require('synesthesia');
+var color = require('onecolor');
 
-var hexRegExp = /(?:^|\b)#(?:[0-9a-f]{6}|[0-9a-f]{3})(?:^|\b)/gi;
-var channelRegExp = /\s*(\.\d+|\d+(?:\.\d+)?)(%)?\s*/,
-    alphaChannelRegExp = /\s*(\.\d+|\d+(?:\.\d+)?)\s*/,
-    cssColorRegExp = new RegExp(
-                         '\\b(rgb|hsl|hsv)a?' +
-                         '\\(' +
-                             channelRegExp.source + ',' +
-                             channelRegExp.source + ',' +
-                             channelRegExp.source +
-                             '(?:,' + alphaChannelRegExp.source + ')?' +
-                         '\\)\\b', 'gi');
-
-var colorMatcher = function (str) {
+var pipetteur = function (str) {
     if (typeof str !== 'string') {
-        throw new Error('pipeteur: Expected string input, got ' + typeof str);
+        throw new Error('pipetteur: Expected string input, got ' + typeof str);
     }
 
     var matches = [],
-        parts = str.split(' '),
-        hexmatch,
-        cssmatch;
+        match,
+        lines;
 
-    // Match named colors
-    parts.forEach(function (part, idx) {
-        if (part in colorNames) {
-            matches.push({
-                index: parts.slice(0, idx).join(' ').length,
-                match: part
-            });
-        }
-    });
+    // Match colors incrementally
+    while ((match = synesthesia.all.exec(str)) !== null) {
+        lines = str.slice(0, match.index).split('\n');
 
-    // Object.keys(colorNames).forEach(function (name) {
-    //     var idx = str.indexOf(name);
-
-    //     if (idx !== -1) {
-    //         matches.push({
-    //             index: idx,
-    //             match: name
-    //         });
-    //     }
-    // });
-
-    // Match hex colors
-    while (hexmatch = hexRegExp.exec(str)) {
         matches.push({
-            index: hexmatch.index,
-            match: hexmatch[0]
+            index: match.index,
+            line: lines.length,
+            column: lines[lines.length - 1].length + 1,
+            match: match[0],
+            color: color(match[0])
         });
     }
 
-    // Match CSS colors
-    while (cssmatch = cssColorRegExp.exec(str)) {
-        matches.push({
-            index: cssmatch.index,
-            match: cssmatch[0]
-        });
-    }
-
     // Reset search indexes
-    hexRegExp.lastIndex = 0;
-    cssColorRegExp.lastIndex = 0;
+    synesthesia.all.lastIndex = 0;
 
@@ -69,7 +32,2 @@ return matches;
 
-colorMatcher.regexp = {
-    hex: hexRegExp,
-    css: cssColorRegExp
-};
-
-module.exports = colorMatcher;
+module.exports = pipetteur;

test/hex.js

@@ -22,5 +22,9 @@ var expect = require('unexpected');
             expect(matches, 'to have length', 1);
-            expect(matches[0], 'to have properties', ['index', 'match']);
+            expect(matches[0], 'to have properties', ['line', 'column', 'index', 'match', 'color']);
+            expect(matches[0].line, 'to be', 1);
+            expect(matches[0].column, 'to be', 1);
             expect(matches[0].index, 'to be', 0);
             expect(matches[0].match, 'to be', hex);
+            expect(matches[0].color.isColor, 'to be', true);
+            expect(matches[0].color.hex(), 'to be', hex.toLowerCase());
         });
@@ -55,2 +59,154 @@
     });
+
+    it('should match a set of valid 6-char hex substrings', function (done) {
+        var hexes = [
+            {
+                string: 'foo #000000 bar',
+                hex: '#000000',
+                index: 4
+            },
+            {
+                string: 'one, two, #FFFFFF, three',
+                hex: '#FFFFFF',
+                index: 10
+            },
+            {
+                string: 'hvid (#ffffff) er pænt',
+                hex: '#ffffff',
+                index: 6
+            },
+            {
+                string: '#123456 are numbers',
+                hex: '#123456',
+                index: 0
+            },
+            {
+                string: 'alphabet song: #abcdef',
+                hex: '#abcdef',
+                index: 15
+            },
+            {
+                string: '#alphab et #ABCDEF gehijkl',
+                hex: '#ABCDEF',
+                index: 11
+            },
+            {
+                string: 'background:#fedcba',
+                hex: '#fedcba',
+                index: 11
+            },
+            {
+                string: '$color=#FEDCBA',
+                hex: '#FEDCBA',
+                index: 7
+            }
+        ];
+
+        expect(hexes, 'to be an array whose items satisfy', function (obj) {
+            var matches = pipetteur(obj.string);
+
+            expect(matches, 'to be a non-empty array');
+            expect(matches, 'to have length', 1);
+            expect(matches[0], 'to have properties', ['index', 'match']);
+            expect(matches[0].index, 'to be', obj.index);
+            expect(matches[0].match, 'to be', obj.hex);
+        });
+
+        done();
+    });
+
+    it('should match a set of valid 3-char hex substrings', function (done) {
+        var hexes = [
+            {
+                string: 'foo #000 bar',
+                hex: '#000',
+                index: 4
+            },
+            {
+                string: 'one, two, #FFF, three',
+                hex: '#FFF',
+                index: 10
+            },
+            {
+                string: 'hvid (#fff) er pænt',
+                hex: '#fff',
+                index: 6
+            },
+            {
+                string: '#123 are numbers',
+                hex: '#123',
+                index: 0
+            },
+            {
+                string: 'alphabet song: #abc',
+                hex: '#abc',
+                index: 15
+            },
+            {
+                string: '#alphab et #ABC gehijkl',
+                hex: '#ABC',
+                index: 11
+            },
+            {
+                string: 'background:#fed',
+                hex: '#fed',
+                index: 11
+            },
+            {
+                string: '$color=#FED',
+                hex: '#FED',
+                index: 7
+            }
+        ];
+
+        expect(hexes, 'to be an array whose items satisfy', function (obj) {
+            var matches = pipetteur(obj.string);
+
+            expect(matches, 'to be a non-empty array');
+            expect(matches, 'to have length', 1);
+            expect(matches[0], 'to have properties', ['index', 'match']);
+            expect(matches[0].line, 'to be', 1);
+            expect(matches[0].column, 'to be', obj.index + 1);
+            expect(matches[0].index, 'to be', obj.index);
+            expect(matches[0].match, 'to be', obj.hex);
+        });
+
+        done();
+    });
+
+    it('should not match non-hex strings', function (done) {
+        var hexes = [
+            '#',
+            '#0',
+            '#00',
+            '#0000',
+            '#00000',
+            '#0000000'
+        ];
+
+        expect(hexes, 'to be an array whose items satisfy', function (hex) {
+            var matches = pipetteur(hex);
+
+            expect(matches, 'to be an empty array');
+        });
+
+        done();
+    });
+
+    it('should match multiple colors in the same string', function (done) {
+        var strings = [
+            '#000000 #ffffff',
+            '#123456 and #234567',
+            'First: #123, Second: #fff000',
+            'Unlikely combination: #123#321'
+        ];
+
+        expect(strings, 'to be an array whose items satisfy', function (str) {
+            var matches = pipetteur(str);
+
+            expect(matches, 'to have length', 2);
+        });
+
+        done();
+    });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21446

increased by102.59%

Number of package files

12

increased by100%

Lines of code

325

increased by200.93%

Number of low quality alerts

0

decreased by-100%

Number of medium quality alerts

0

decreased by-100%

Number of lines in readme file

88

increased byInfinity%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

6

increased by200%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedonecolor@^2.4.0

• + Addedsynesthesia@^1.0.0

• + Addedcss-color-names@0.0.3(transitive)

• + Addedonecolor@2.5.0(transitive)

• + Addedsynesthesia@1.0.1(transitive)

• - Removedcss-color-names@0.0.1

• - Removedcss-color-names@0.0.1(transitive)