eask analyze prints to stdout to filter messages

Author: joshbax189

lisp/core/analyze.el

@@ -93,35 +93,40 @@ Argument LEVEL and MSG are data from the debug log signal."
              (t             #'eask-analyze--write-plain-text))
        level msg))))
 
+(defun eask-stdout (msg &rest args)
+  "Like `eask-msg' but prints to stdout."
+  (eask-princ (apply #'eask--format-paint-kwds msg args) nil)
+  (eask-princ "\n" nil))
+
 (defun eask-analyze--file (files)
   "Lint list of Eask FILES."
   (let (checked-files content)
     ;; Linting
     (dolist (file files)
       (eask--silent-error
-        (eask--save-load-eask-file file
-            (push file checked-files))))
+       (eask--save-load-eask-file file
+                                  (push file checked-files))))
 
     ;; Print result
     (eask-msg "")
-    (cond ((and (eask-json-p)  ; JSON format
+    (cond ((and (eask-json-p)           ; JSON format
                 (or eask-analyze--warnings eask-analyze--errors))
            (setq content
                  (eask-analyze--pretty-json (json-encode
                                              `((warnings . ,eask-analyze--warnings)
                                                (errors   . ,eask-analyze--errors)))))
            ;; XXX: When printing the result, no color allow.
            (eask--with-no-color
-             (eask-msg content)))
-          (eask-analyze--log  ; Plain text
+            (eask-stdout content)))
+          (eask-analyze--log            ; Plain text
            (setq content
                  (with-temp-buffer
                    (dolist (msg (reverse eask-analyze--log))
                      (insert msg "\n"))
                    (buffer-string)))
            ;; XXX: When printing the result, no color allow.
            (eask--with-no-color
-             (mapc #'eask-msg (reverse eask-analyze--log))))
+             (mapc #'eask-stdout (reverse eask-analyze--log))))
           (t
            (eask-info "(Checked %s file%s)"
                       (length checked-files)

test/jest/__snapshots__/analyze.test.js.snap

@@ -3,7 +3,8 @@
 exports[`analyze in ./analyze/dsl matches snapshot 1`] = `
 {
   "stderr": "
-~/Eask:9:18 Error: ✗ Multiple definition of \`package'
+",
+  "stdout": "~/Eask:9:18 Error: ✗ Multiple definition of \`package'
 ~/Eask:12:55 Error: ✗ Multiple definition of \`website-url'
 ~/Eask:14:16 Error: ✗ Multiple definition of \`keywords'
 ~/Eask:17:15 Warning: 💡 Warning regarding duplicate author name, name
@@ -22,6 +23,5 @@ exports[`analyze in ./analyze/dsl matches snapshot 1`] = `
 ~/Eask:50:2 Error: ✗ Define dependencies with the same name \`f'
 ~/Eask:50:2 Error: ✗ Define dependencies with the same name \`f' with different version
 ",
-  "stdout": "",
 }
 `;

test/jest/analyze.test.js

@@ -1,5 +1,15 @@
 const { TestContext } = require("./helpers");
 
+/**
+ * Clean output and attempt to parse as JSON.
+ * Throws if failing.
+ * @param {string} s
+ * @returns {object} the parsed JSON.
+ */
+function tryJSON(s) {
+  return JSON.parse(s.trim() || "{}");
+}
+
 describe("analyze", () => {
   describe("in ./analyze/dsl", () => {
     const ctx = new TestContext("./test/jest/analyze/dsl");
@@ -10,11 +20,11 @@ describe("analyze", () => {
     });
 
     it("handles json option", async () => {
-      const { stderr } = await ctx.runEask("analyze --json");
+      const { stdout } = await ctx.runEask("analyze --json");
       await ctx.runEask("analyze Eask --json");
 
       // try to parse output, errors if not valid
-      JSON.parse(stderr);
+      tryJSON(stdout);
     });
 
     it("matches snapshot", async () => {
@@ -24,9 +34,9 @@ describe("analyze", () => {
     });
 
     it("should report multiple definitions", async () => {
-      const { stderr } = await ctx.runEask("analyze");
+      const { stdout } = await ctx.runEask("analyze");
       // expect this substring
-      expect(stderr).toMatch("Multiple definition of `package'");
+      expect(stdout).toMatch("Multiple definition of `package'");
     });
   });
 
@@ -71,6 +81,18 @@ describe("analyze", () => {
       await expect(ctx.runEask("analyze Eask-error")).rejects.toThrow();
     });
 
+    // JSON
+    it("handles json option when no errors", async () => {
+      const { stdout } = await ctx.runEask("analyze --json Eask-normal");
+      tryJSON(stdout);
+    });
+
+    it("handles json option when lexical binding warnings are present", async () => {
+      const { stdout } = await ctx.runEask("analyze --json Eask-lexical");
+      tryJSON(stdout);
+    });
+
+    // --strict and --allow-error
     it.failing("should error when using --strict on Eask-warn", async () => {
       await expect(ctx.runEask("analyze --strict Eask-warn")).rejects.toThrow();
     });

test/jest/analyze/errors/Eask-lexical

@@ -0,0 +1,2 @@
+(package "check-dsl" "0.0.1" "Test for DSL")
+(keywords "dsl")