Merge pull request #5 from zvakanaka/3-0-5

Get Types Working

color-json.d.ts → index.d.ts

@@ -27,8 +27,8 @@ export type Colors = {
  * @returns {string} Stringified JSON colored with ANSI escape characters.
  */
 export default function colorJson(
-  json: Object | string,
+  json: (Object | string),
   colors?: Colors,
   colorMap?: ColorMap,
-  spacing?: number
+  spacing?: number,
 ): string

color-json.js → index.js

@@ -20,11 +20,20 @@ export const defaultColors = {
   key: 'white'
 };
 
+/**
+ * Given an object, it returns its JSON representation colored using
+ * ANSI escape characters.
+ * @param {(Object | string)} json - JSON object to highlighter.
+ * @param {Colors} [colors] - A map with the ANSI characters for each supported color.
+ * @param {ColorMap} [colorMap] - An object to configure the coloring.
+ * @param {number} [spacing=2] - The indentation spaces.
+ * @returns {string} Stringified JSON colored with ANSI escape characters.
+ */
 export default function colorJson(json, colors = defaultColors, colorMap = defaultColorMap, spacing = 2) {
   if (supportsColor()) {
     if (typeof json != 'string') json = JSON.stringify(json, undefined, spacing);
     else json = JSON.stringify(JSON.parse(json), undefined, spacing);
-    return colorMap[colors.separator] + json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function (match) {
+    return colorMap[colors.separator] + json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function(match) {
       let colorCode = 'number';
       if (/^"/.test(match)) {
         if (/:$/.test(match)) colorCode = 'key';

package.json

@@ -1,15 +1,9 @@
 {
   "name": "color-json",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "description": "Color JSON in the console with no dependencies",
   "type": "module",
-  "directories": {
-    "test": "tests"
-  },
-  "exports": {
-    "types": "./color-json.d.ts",
-    "default": "./color-json.js"
-  },
+  "exports": "./index.js",
   "scripts": {
     "test": "node tests/test.js; TMP_FORCE_NO_COLOR=$FORCE_NO_COLOR; export FORCE_NO_COLOR=true; echo '=====================\nTesting without color\n====================='; node tests/test.js; export FORCE_NO_COLOR=$TMP_FORCE_NO_COLOR; unset TMP_FORCE_NO_COLOR"
   },

tests/test.js

@@ -1,4 +1,4 @@
-import colorJson from '../color-json.js';
+import colorJson from '../index.js';
 
 console.log('default usage:');
 const topPlanets = [