@theholocron/jest-config 1.16.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @theholocron/jest-config
+
+## 1.16.0
+
+### Minor Changes
+
+- [`4309ce8`](https://github.com/theholocron/configs/commit/4309ce860374743fa4a4ea781820f3875e647a46) Thanks [@iamnewton](https://github.com/iamnewton)! - Releasing more, as a test

package/README.md

@@ -0,0 +1,29 @@
+# Jest Preset
+
+A [Jest preset](https://facebook.github.io/jest/docs/en/configuration.html#preset-string) for testing code within the Galaxy.
+
+## Installation
+
+```bash
+npm install --save-dev @theholocron/jest-preset
+```
+
+## Usage
+
+In your project `package.json` add the following:
+
+```json
+{
+  "jest": {
+    "displayName": "<project>",
+    "preset": "@theholocron/jest-config"
+  }
+}
+```
+
+## How We Test
+
+Currently we use [Jest](https://jestjs.io/) for our testing framework.  There isn't much to our configuration that differs from what Jest provides out of the box with the following exceptions:
+
+- **Coverage**: we enforce coverage collection and require that all work be covered at least 80% at this time, with negligible reduction (< 1%) of coverage per PR
+- **Directory Naming**: while we do support the [same regex that Jest provides](https://jestjs.io/docs/en/configuration#testregex-string--arraystring), our convention is to co-locate all test files as close to the source as possible with the suffix of `.test` added.

package/jest-preset.js

@@ -0,0 +1,26 @@
+/**
+ * @see https://jestjs.io/docs/configuration
+ * @type {import("jest").Config}
+ */
+export default {
+	collectCoverage: true,
+	collectCoverageFrom: [
+		"<rootDir>/src/**/*.{js,jsx,ts,tsx}",
+		"!<rootDir>/**/{__mocks__,mocks}/**",
+		"!<rootDir>/**/*.{mocks,mock}.js",
+		"!<rootDir>/**/{__stories__,stories}/**",
+		"!<rootDir>/**/*.{stories,story}/**",
+		"!<rootDir>/**/__snapshots__/**"
+	],
+	coverageThreshold: {
+		global: {
+			statements: 80,
+			branches: 80,
+			lines: 80,
+			functions: 80
+		}
+	},
+	modulePathIgnorePatterns: [
+		"<rootDir>/dist/",
+	],
+};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@theholocron/jest-config",
+  "homepage": "https://github.com/the-holocron/configs/tree/master/packages/jest-preset#readme",
+  "description": "A Jest preset for testing code within the Galaxy.",
+  "author": "Newton Koumantzelis",
+  "version": "1.16.0",
+  "main": "jest-preset.js",
+  "type": "module",
+  "repository": "https://github.com/theholocron/configs.git",
+  "bugs": "https://github.com/theholocron/configs/issues",
+  "releases": "https://github.com/theholocron/configs/releases",
+  "wiki": "https://github.com/theholocron/configs/wiki",
+  "license": "GPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "jest": "29.7.0"
+  }
+}