@langri-sha/projen-jest-config 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,34 @@
+{
+  "name": "@langri-sha/projen-jest-config",
+  "entries": [
+    {
+      "date": "Sat, 25 May 2024 03:25:02 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-jest-config_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-jest-config",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "feat(jest-config): Add package for configuring Jest"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-jest-config",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "feat(project): Add projenrc file to subprojects"
+          }
+        ],
+        "patch": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-jest-config",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "fix(jest): Update documentation URL"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log - @langri-sha/projen-jest-config
+
+This log was last generated on Sat, 25 May 2024 03:25:02 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Sat, 25 May 2024 03:25:02 GMT
+
+### Minor changes
+
+- feat(jest-config): Add package for configuring Jest (filip.dupanovic@gmail.com)
+- feat(project): Add projenrc file to subprojects (filip.dupanovic@gmail.com)
+
+### Patches
+
+- fix(jest): Update documentation URL (filip.dupanovic@gmail.com)

package/lib/index.d.ts

@@ -0,0 +1,28 @@
+import { FileBase, IResolver, Project } from 'projen';
+import { Config } from 'jest';
+/**
+ * Options for configuring Jest.
+ */
+export interface JestConfigOptions {
+    /**
+     * Name of the Jest config module.
+     *
+     * @default 'jest.config.ts'
+     */
+    filename?: string;
+    /**
+     * Name of a Jest configuration package to extend from.
+     */
+    extends?: string;
+    /**
+     * Jest configuration object.
+     */
+    config?: Config;
+}
+export declare class JestConfig extends FileBase {
+    #private;
+    config: Config;
+    constructor(project: Project, options?: JestConfigOptions);
+    protected synthesizeContent(_: IResolver): string | undefined;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAG7B;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,qBAAa,UAAW,SAAQ,QAAQ;;IAEtC,MAAM,EAAE,MAAM,CAAA;gBAEF,OAAO,EAAE,OAAO,EAAE,OAAO,GAAE,iBAAsB;cAY1C,iBAAiB,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;CAgBvE"}

package/lib/index.js

@@ -0,0 +1,42 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _JestConfig_extends;
+import { FileBase } from 'projen';
+import serialize from 'serialize-javascript';
+export class JestConfig extends FileBase {
+    constructor(project, options = {}) {
+        const filename = options.filename ?? 'jest.config.ts';
+        super(project, filename, {
+            readonly: true,
+            marker: true,
+        });
+        _JestConfig_extends.set(this, void 0);
+        __classPrivateFieldSet(this, _JestConfig_extends, options.extends, "f");
+        this.config = options.config ?? {};
+    }
+    synthesizeContent(_) {
+        const config = {
+            ...this.config,
+        };
+        const serialized = serialize(config);
+        return `import type { Config } from 'jest'${__classPrivateFieldGet(this, _JestConfig_extends, "f") ? `\nimport defaults from '${__classPrivateFieldGet(this, _JestConfig_extends, "f")}'` : ''}
+
+    const config: Config = {
+      ${__classPrivateFieldGet(this, _JestConfig_extends, "f") ? `...defaults,` : ''}
+      ${serialized.slice(1)}
+
+    export default config
+    `;
+    }
+}
+_JestConfig_extends = new WeakMap();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAsB,MAAM,QAAQ,CAAA;AAErD,OAAO,SAAS,MAAM,sBAAsB,CAAA;AAwB5C,MAAM,OAAO,UAAW,SAAQ,QAAQ;IAItC,YAAY,OAAgB,EAAE,UAA6B,EAAE;QAC3D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAA;QAErD,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvB,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;QATJ,sCAAiB;QAWf,uBAAA,IAAI,uBAAY,OAAO,CAAC,OAAO,MAAA,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAA;IACpC,CAAC;IAEkB,iBAAiB,CAAC,CAAY;QAC/C,MAAM,MAAM,GAAW;YACrB,GAAG,IAAI,CAAC,MAAM;SACf,CAAA;QAED,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;QAEpC,OAAO,qCAAqC,uBAAA,IAAI,2BAAS,CAAC,CAAC,CAAC,2BAA2B,uBAAA,IAAI,2BAAS,GAAG,CAAC,CAAC,CAAC,EAAE;;;QAGxG,uBAAA,IAAI,2BAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE;QACnC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;;;KAGtB,CAAA;IACH,CAAC;CACF"}

package/license

@@ -0,0 +1,10 @@
+
+MIT License
+
+Copyright (c) 2024 Filip Dupanović <filip.dupanovic@gmail.com> (https://langri-sha.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@langri-sha/projen-jest-config",
+  "version": "0.1.0",
+  "license": "MIT",
+  "author": {
+    "name": "Filip Dupanović",
+    "email": "filip.dupanovic@gmail.com",
+    "url": "https://langri-sha.com",
+    "organization": false
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "scripts": {
+    "prepublishOnly": "rm -rf lib; tsc --project tsconfig.build.json"
+  },
+  "dependencies": {
+    "serialize-javascript": "6.0.2"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.7.1",
+    "@langri-sha/tsconfig": "0.9.0",
+    "@types/serialize-javascript": "5.0.4",
+    "jest": "^28.00 || ^29.00",
+    "projen": "0.81.15"
+  },
+  "peerDependencies": {
+    "jest": "^28.00 || ^29.00",
+    "projen": "^0.81.15"
+  },
+  "engines": {
+    "node": ">= 20.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.mts and run \"npx projen\".",
+  "types": "lib/index.d.ts"
+}

package/readme

@@ -0,0 +1,54 @@
+# @langri-sha/projen-jest-config
+
+A [projen] component for authoring [Jest] configurations. This component is
+suitable for monorepos and offers support for extending from an existing Jest
+configuration.
+
+## Usage
+
+Install required dependencies:
+
+```sh
+npm install -D jest @langri-sha/projen-jest-config
+```
+
+Configure Jest for your project:
+
+```ts
+// .projenrc.ts
+import { Project } from 'projen'
+import { JestConfig } from '@langri-sha/projen-jest-config'
+
+const project = new Project({
+  name: 'my-project',
+})
+
+new JestConfig(project, {
+  // Configure the desired Jest configuration module. Optional.
+  filename: 'jest.config.ts',
+  // Choose a desired Jest configuration module. Optional.
+  extends: '@langri-sha/jest-config',
+  // Inline your preferred configuration overrides.
+  config: {
+    testEnvironment: 'node',
+  },
+})
+```
+
+This should produce the following output:
+
+```ts
+// jest.config.ts
+import type { Config } from 'jest'
+import defaults from '@langri-sha/jest-config'
+
+const config: Config = {
+  ...defaults,
+  testEnvironment: 'node',
+}
+
+export default config
+```
+
+[projen]: https://projen.io/
+[jest]: https://jestjs.io/docs/

package/src/index.ts

@@ -0,0 +1,59 @@
+import { FileBase, IResolver, Project } from 'projen'
+import { Config } from 'jest'
+import serialize from 'serialize-javascript'
+
+/**
+ * Options for configuring Jest.
+ */
+export interface JestConfigOptions {
+  /**
+   * Name of the Jest config module.
+   *
+   * @default 'jest.config.ts'
+   */
+  filename?: string
+
+  /**
+   * Name of a Jest configuration package to extend from.
+   */
+  extends?: string
+
+  /**
+   * Jest configuration object.
+   */
+  config?: Config
+}
+
+export class JestConfig extends FileBase {
+  #extends?: string
+  config: Config
+
+  constructor(project: Project, options: JestConfigOptions = {}) {
+    const filename = options.filename ?? 'jest.config.ts'
+
+    super(project, filename, {
+      readonly: true,
+      marker: true,
+    })
+
+    this.#extends = options.extends
+    this.config = options.config ?? {}
+  }
+
+  protected override synthesizeContent(_: IResolver): string | undefined {
+    const config: Config = {
+      ...this.config,
+    }
+
+    const serialized = serialize(config)
+
+    return `import type { Config } from 'jest'${this.#extends ? `\nimport defaults from '${this.#extends}'` : ''}
+
+    const config: Config = {
+      ${this.#extends ? `...defaults,` : ''}
+      ${serialized.slice(1)}
+
+    export default config
+    `
+  }
+}