Add a basic example project

Author: jevakallio

.gitignore

@@ -4,4 +4,4 @@ yarn-error.log
 build
 coverage
 .DS_Store
-package-lock.json
+/package-lock.json

.npmignore

@@ -0,0 +1,2 @@
+docs/
+example/

example/jest.config.js

@@ -0,0 +1,23 @@
+const rules = [
+  {
+    match: /^Received invalid input:/,
+    group: "Received invalid input",
+    keep: true,
+  },
+  {
+    match: /^Received a non-integer number:/,
+    group: "Received a non-integer number",
+  },
+  {
+    match: /^Received value:/,
+    group: null,
+  },
+];
+
+module.exports = {
+  reporters: [
+    ["jest-clean-console-reporter", { rules }],
+    "@jest/reporters/build/SummaryReporter",
+  ],
+  testMatch: ["<rootDir>/src/**/*.test.js"],
+};

example/package-lock.json

@@ -0,0 +1,14 @@
+{
+  "name": "jest-clean-console-reporter-test-app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "author": "Jani Eväkallio",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest --config jest.config.js"
+  },
+  "devDependencies": {
+    "jest": "^26.6.3",
+    "jest-clean-console-reporter": "latest"
+  }
+}

example/package.json

@@ -0,0 +1,8 @@
+"use strict";
+
+module.exports = function print(n) {
+  console.info("Received value: " + n);
+
+  // throws when "n" is not a number
+  return n.toFixed(2);
+};

example/src/print.js

@@ -0,0 +1,12 @@
+const print = require("./print");
+
+describe("print", () => {
+  it("prints a number", () => {
+    expect(print(25 / 2)).toBe("12.50");
+  });
+
+  it("crashes when passed a non-number", () => {
+    // this test will fail
+    expect(() => print("100")).toThrow();
+  });
+});

example/src/print.test.js

@@ -0,0 +1,17 @@
+module.exports = function square(n) {
+  // info
+  console.info("Received value: " + n);
+
+  if (typeof n !== "number") {
+    // this error is preserved with rule.keep
+    console.error("Received invalid input: " + n);
+    return NaN;
+  }
+
+  if (!Number.isInteger(n)) {
+    // warning
+    console.warn("Received a non-integer number: " + n);
+  }
+
+  return n * n;
+};

example/src/square.js

@@ -0,0 +1,15 @@
+const square = require("./square");
+
+describe("square", () => {
+  it("squares an integer", () => {
+    expect(square(3)).toBe(9);
+  });
+
+  it("squares a non-integer number", () => {
+    expect(square(2.5)).toBe(6.25);
+  });
+
+  it("fails to square a non-number", () => {
+    expect(square("bob")).toBe(NaN);
+  });
+});