Don't allow console logging statements (#96)

* Don't allow `console` logging statements

.eslintrc.json

@@ -14,5 +14,6 @@
     "prettier",
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended"
-  ]
+  ],
+  "rules": { "no-console": ["error", { "allow": ["time", "timeEnd"] }] }
 }

README.md

@@ -52,9 +52,7 @@ $ svg-path-bbox "M5 10c3 0 3 3 0 3z" "M2 8m5 5z"
 import svgPathBbox from "svg-path-bbox";
 import type { BBox } from "svg-path-bbox";
 
-type CasesTuple = Array<[string, BBox]>;
-
-const cases: CasesTuple = [["M0 0H3V6Z", [0, 0, 3, 6]]];
+const cases: [string, BBox][] = [["M0 0H3V6Z", [0, 0, 3, 6]]];
 console.log(svgPathBbox(cases[0]));
 ```
 

examples/common.js

@@ -1,3 +1,5 @@
+const util = require("util")
 const svgPathBbox = require("../dist/wrapper.js");
 
-console.log(svgPathBbox("M0 0H3V6Z"));
+const bbox = svgPathBbox("M0 0H3V6Z");
+process.stdout.write(`${util.inspect(bbox)}\n`)

examples/esm.mjs

@@ -1,3 +1,5 @@
+import { inspect } from "node:util";
 import svgPathBbox from "../dist/wrapper.js";
 
-console.log(svgPathBbox("M0 0H3V6Z"));
+const bbox = svgPathBbox("M0 0H3V6Z");
+process.stdout.write(`${inspect(bbox)}\n`)

examples/typescript.ts

@@ -1,17 +1,15 @@
+import { inspect } from "node:util";
 import svgPathBbox from "../src";
 import type { BBox } from "../src";
 
-type CasesTuple = Array<[string, BBox]>;
-
-const cases: CasesTuple = [["M0 0H3V6Z", [0, 0, 3, 6]]];
+const cases: [string, BBox][] = [["M0 0H3V6Z", [0, 0, 3, 6]]];
 
 for (const [path, expectedBbox] of cases) {
-  const result = svgPathBbox(path);
-  const stringResult = JSON.stringify(result);
-  if (stringResult !== JSON.stringify(expectedBbox)) {
-    console.error(`UNEXPECTED BBOX: ${result}`);
+  const bbox = svgPathBbox(path);
+  if (JSON.stringify(bbox) !== JSON.stringify(expectedBbox)) {
+    process.stderr.write(`UNEXPECTED BBOX: ${inspect(bbox)}\n`);
     process.exit(1);
   } else {
-    console.log(result);
+    process.stdout.write(`${inspect(bbox)}\n`);
   }
 }

scripts/benchmark.ts

@@ -1,3 +1,5 @@
+import { inspect } from "node:util";
+
 import svgPathBbox from "../src";
 import * as svgPathBoundingBox from "svg-path-bounding-box";
 import type { BBox } from "../src";
@@ -47,7 +49,7 @@ const runLibrariesBenchmark = (
         process.stdout.write(`${key} - `);
       }
 
-      console.log(`${pathSummary} (type ${pathType}) [${e} epochs]`);
+      process.stdout.write(`${pathSummary} (type ${pathType}) [${e} epochs]\n`);
       for (const library in LIBRARIES) {
         console.time(library);
         const func = LIBRARIES[library]["func"];
@@ -56,10 +58,12 @@ const runLibrariesBenchmark = (
         for (let r = 0; r < e; r++) {
           try {
             result = func(path);
-          } catch (Error) {
+          } catch (err) {
             if (!_errorRaised) {
-              console.error(`Error computing bbox with library ${library}:`);
-              console.error(Error);
+              process.stderr.write(
+                `Error computing bbox with library ${library}:\n`
+              );
+              process.stderr.write(`${err}\n`);
             }
             _errorRaised = true;
           }
@@ -72,10 +76,12 @@ const runLibrariesBenchmark = (
           result = resultParser(result as BoundingBoxView);
         }
         if (result) {
-          console.log("    + result:", result);
+          process.stdout.write(
+            `    + result: ${inspect(result, { colors: true })}\n`
+          );
         }
       }
-      console.log();
+      process.stdout.write("\n");
     }
   }
 };

tests/changelog.test.ts

@@ -1,6 +1,6 @@
 import * as fs from "node:fs";
 
-test("Latest version has a CHANGELOG entry", () => {
+test("Current version has a CHANGELOG entry", () => {
   const changelog = fs.readFileSync("CHANGELOG.md", "utf8");
   const packageJson = JSON.parse(fs.readFileSync("package.json", "utf8"));