jest-serializer-simple 5.0.0-0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# jest-serializer-simple
+
+## 5.0.0-0.1
+
+### Patch Changes
+
+- [#125](https://github.com/benjie/postgraphile-private/pull/125)
+  [`91f2256b3`](https://github.com/benjie/postgraphile-private/commit/91f2256b3fd699bec19fc86f1ca79df057e58639)
+  Thanks [@benjie](https://github.com/benjie)! - Initial changesets release

package/README.md

@@ -0,0 +1,79 @@
+# jest-serializer-simple
+
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/benjie?color=ff69b4&label=github%20sponsors)](https://github.com/sponsors/benjie)
+[![Patreon sponsor button](https://img.shields.io/badge/sponsor-via%20Patreon-orange.svg)](https://patreon.com/benjie)
+[![Discord chat room](https://img.shields.io/discord/489127045289476126.svg)](http://discord.gg/graphile)
+[![Follow](https://img.shields.io/badge/twitter-@GraphileHQ-blue.svg)](https://twitter.com/GraphileHQ)
+
+A Jest serializer to simplify your snapshots.
+
+Sometimes you just want to print an object or a string without all the escapes
+and `Object [null prototype] {` annotations. When you want that, this is a
+simple solution for it.
+
+<!-- SPONSORS_BEGIN -->
+
+## Crowd-funded open-source software
+
+To help us develop this software sustainably under the MIT license, we ask all
+individuals and businesses that use it to help support its ongoing maintenance
+and development via sponsorship.
+
+### [Click here to find out more about sponsors and sponsorship.](https://www.graphile.org/sponsor/)
+
+And please give some love to our featured sponsors 🤩:
+
+<table><tr>
+<td align="center"><a href="https://surge.io/"><img src="https://graphile.org/images/sponsors/surge.png" width="90" height="90" alt="Surge" /><br />Surge</a> *</td>
+<td align="center"><a href="https://www.netflix.com/"><img src="https://graphile.org/images/sponsors/Netflix.png" width="90" height="90" alt="Netflix" /><br />Netflix</a> *</td>
+<td align="center"><a href="https://qwick.com/"><img src="https://graphile.org/images/sponsors/qwick.png" width="90" height="90" alt="Qwick" /><br />Qwick</a> *</td>
+<td align="center"><a href="https://www.the-guild.dev/"><img src="https://graphile.org/images/sponsors/theguild.png" width="90" height="90" alt="The Guild" /><br />The Guild</a> *</td>
+</tr><tr>
+<td align="center"><a href="http://chads.website"><img src="https://graphile.org/images/sponsors/chadf.png" width="90" height="90" alt="Chad Furman" /><br />Chad Furman</a> *</td>
+<td align="center"><a href="https://www.fanatics.com/"><img src="https://graphile.org/images/sponsors/fanatics.png" width="90" height="90" alt="Fanatics" /><br />Fanatics</a> *</td>
+<td align="center"><a href="https://dovetailapp.com/"><img src="https://graphile.org/images/sponsors/dovetail.png" width="90" height="90" alt="Dovetail" /><br />Dovetail</a> *</td>
+<td align="center"><a href="https://www.enzuzo.com/"><img src="https://graphile.org/images/sponsors/enzuzo.png" width="90" height="90" alt="Enzuzo" /><br />Enzuzo</a> *</td>
+</tr><tr>
+<td align="center"><a href="https://stellate.co/"><img src="https://graphile.org/images/sponsors/Stellate.png" width="90" height="90" alt="Stellate" /><br />Stellate</a> *</td>
+</tr></table>
+
+<em>\* Sponsors the entire Graphile suite</em>
+
+<!-- SPONSORS_END -->
+
+## Usage:
+
+```
+yarn add jest-serializer-simple
+```
+
+Then add it to your Jest config:
+
+```js
+module.exports = {
+  testEnvironment: "node",
+  snapshotSerializers: [`jest-serializer-simple`],
+  //...
+};
+```
+
+To tell Jest that you want the object to be printed simply, you must wrap it in
+an object with just the `__` key: `{ __: YOUR_VALUE_HERE }`, for example:
+
+```js
+expect({ __: data }).toMatchInlineSnapshot(`
+  {
+    forums: [
+      {
+        name: 'Cats',
+      },
+      {
+        name: 'Dogs',
+      },
+      {
+        name: 'Postgres',
+      },
+    ],
+  }
+`);
+```

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin } from "pretty-format";
+export interface FormattedObject {
+    __: string | JSON | null | undefined;
+}
+declare function printFormattedObject(val: FormattedObject): string;
+export declare const test: Plugin["test"];
+export declare const serialize: typeof printFormattedObject;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAYD,iBAAS,oBAAoB,CAAC,GAAG,EAAE,eAAe,GAAG,MAAM,CAe1D;AAED,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,CAAqB,CAAC;AACtD,eAAO,MAAM,SAAS,6BAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serialize = exports.test = void 0;
+const tslib_1 = require("tslib");
+const json5_1 = tslib_1.__importDefault(require("json5"));
+function isFormattedObject(val) {
+    return ((typeof val === "object" &&
+        val &&
+        Object.keys(val).length === 1 &&
+        "__" in val) ||
+        false);
+}
+function printFormattedObject(val) {
+    return typeof val.__ === "string"
+        ? String(val.__)
+        : typeof val.__ === "undefined"
+            ? "undefined"
+            : json5_1.default.stringify(val.__, {
+                space: 2,
+                quote: '"',
+            }).trim();
+    // prettier
+    //     .format(JSON5.stringify(val.__), {
+    //       printWidth: 120,
+    //       parser: "json5",
+    //     })
+    //     .trim();
+}
+exports.test = isFormattedObject;
+exports.serialize = printFormattedObject;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,0DAA0B;AAQ1B,SAAS,iBAAiB,CAAC,GAAY;IACrC,OAAO,CACL,CAAC,OAAO,GAAG,KAAK,QAAQ;QACtB,GAAG;QACH,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC;QAC7B,IAAI,IAAI,GAAG,CAAC;QACd,KAAK,CACN,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAoB;IAChD,OAAO,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;QAC/B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QAChB,CAAC,CAAC,OAAO,GAAG,CAAC,EAAE,KAAK,WAAW;YAC/B,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,eAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE;gBACtB,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,GAAG;aACX,CAAC,CAAC,IAAI,EAAE,CAAC;IACd,WAAW;IACX,yCAAyC;IACzC,yBAAyB;IACzB,yBAAyB;IACzB,SAAS;IACT,eAAe;AACjB,CAAC;AAEY,QAAA,IAAI,GAAmB,iBAAiB,CAAC;AACzC,QAAA,SAAS,GAAG,oBAAoB,CAAC"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "jest-serializer-simple",
+  "version": "5.0.0-0.1",
+  "description": "Jest serializer that gives really simple formatting",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prepack": "tsc -b",
+    "watch": "tsc -b --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/graphile/heart.git"
+  },
+  "keywords": [
+    "jest",
+    "graphql",
+    "schema",
+    "graphile",
+    "graphite"
+  ],
+  "author": "Benjie Gillam <code@benjiegillam.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/graphile/heart/issues"
+  },
+  "homepage": "https://github.com/graphile/heart/tree/main/utils/jest-serializer-simple",
+  "dependencies": {
+    "@types/json5": "^2.2.0",
+    "json5": "^2.2.0",
+    "prettier": "^2.5.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.5.1",
+    "jest": "^28.1.0",
+    "pretty-format": "^27.4.2",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.4.0",
+    "typescript": "^4.8.1-rc"
+  },
+  "files": [
+    "dist"
+  ]
+}