@systemfsoftware/stryker-ignorer-effect-schema-declarations 0.0.0

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright (c) 2026 Ryan Lee (systemfsoftware)
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ryan Lee (systemfsoftware)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,72 @@
+# @systemfsoftware/stryker-ignorer-effect-schema-declarations
+
+![version](https://img.shields.io/npm/v/@systemfsoftware/stryker-ignorer-effect-schema-declarations)
+![license](https://img.shields.io/npm/l/@systemfsoftware/stryker-ignorer-effect-schema-declarations)
+
+> Stop Effect `Schema` declarations from dragging your Stryker score below 100%.
+
+A brand description, a `_tag`, a `title` — mutate any of them and the source changes but the behaviour does not, so no test can ever kill the mutant. Those unkillable mutants sit in your report forever, indistinguishable from real coverage gaps. This [Stryker](https://stryker-mutator.io) ignorer removes them, so the score that remains is behaviour.
+
+## Install
+
+```bash
+pnpm add -D @systemfsoftware/stryker-ignorer-effect-schema-declarations
+```
+
+In `stryker.config.ts`, the plugin module and the ignorer name travel as a pair:
+
+| Config key | Value                                                         |
+| ---------- | ------------------------------------------------------------- |
+| `plugins`  | `@systemfsoftware/stryker-ignorer-effect-schema-declarations` |
+| `ignorers` | `effect-schema-declarations`                                  |
+
+```ts
+export default {
+  plugins: [
+    '@systemfsoftware/stryker-js-vitest-runner',
+    '@systemfsoftware/stryker-js-typescript-checker',
+    '@systemfsoftware/stryker-ignorer-effect-schema-declarations',
+  ],
+  ignorers: ['effect-schema-declarations'],
+}
+```
+
+Mutants it recognizes are reported as `Ignored`, each carrying the reason it was safe to skip.
+
+> [!WARNING]
+> A name in `ignorers` that no loaded plugin answers is silently skipped — the run proceeds and the mutants stay in your score. Copy the name from the table, not from memory.
+
+> [!NOTE]
+> Requires `@systemfsoftware/stryker-js-engine` 4.1.0 or later (the first version whose plugin loader speaks the plain ignorer protocol). The package has no peer dependencies, no Effect anywhere — not in `dependencies`, not in `devDependencies`, and not on its published surface — and two dependencies: `@systemfsoftware/stryker-ignorer-interface`, whose node types declare the AST shapes the visitors read, and `@systemfsoftware/stryker-ignorer-kit`, which compiles the visitor declaration to the wire contract and verifies it from source snippets.
+
+## Migrating from `@systemfsoftware/stryker-plugins`
+
+| Before                                            | After                                                                        |
+| ------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `"plugins": ["@systemfsoftware/stryker-plugins"]` | `"plugins": ["@systemfsoftware/stryker-ignorer-effect-schema-declarations"]` |
+| `"ignorers": ["effect-schema-declarations"]`      | unchanged                                                                    |
+
+## What it ignores
+
+| Declaration                                               | Example                                                           |
+| --------------------------------------------------------- | ----------------------------------------------------------------- |
+| Brand descriptions                                        | `Symbol.for('UserId')`                                            |
+| `TaggedClass` / `TaggedError` tags                        | `S.TaggedClass<A>()('Placed', {…})`                               |
+| The field schemas of those declarations                   | the `{…}` above                                                   |
+| `optionalWith` defaults                                   | `S.optionalWith(S.Number, { default: () => 0 })`                  |
+| Documentation annotations                                 | `identifier`, `description`, `title`, `documentation`, `examples` |
+| An `annotations({…})` object that is _only_ documentation | `S.annotations({ title: 'Amount' })`                              |
+
+## Where the line is
+
+Every ignore is proven redundant, never merely assumed — anything a test could observe keeps its mutants.
+
+`arbitrary`, `pretty`, `equivalence`, `message`, `jsonSchema` and `parseIssueTitle` are **not** documentation: each changes what the schema does, so a survivor there is a test gap to close. That is why the two `annotations` rules differ — a `title` is ignored wherever it appears, but the enclosing object is ignored only when every entry documents, since emptying an object holding an `arbitrary` would silently change what your property tests generate.
+
+## Contributing
+
+Development setup and workflow: [AGENTS.md](AGENTS.md).
+
+## License
+
+[Apache 2.0](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { Ignorer } from "@systemfsoftware/stryker-ignorer-interface";
+//#region src/SchemaDeclarationIgnore.d.ts
+export declare const SYMBOL_DESCRIPTION_IGNORED: 'Symbol.for() brand description is identity-only data, not behaviour';
+export declare const TAGGED_TAG_IGNORED: 'TaggedClass/TaggedError _tag is a declaration discriminant, not behaviour';
+export declare const TAGGED_FIELDS_IGNORED: 'TaggedClass/TaggedError field schema is a declaration, not behaviour';
+export declare const CLASS_ID_IGNORED: 'Schema.Class identifier is a declaration name, not behaviour';
+export declare const BRAND_NAME_IGNORED: 'Schema.brand name is identity-only data, not behaviour';
+export declare const OPTIONAL_DEFAULT_IGNORED: 'optionalWith default value is config, not behaviour';
+export declare const ANNOTATION_OBJECT_IGNORED: 'annotations object holding only documentation is a declaration, not behaviour';
+export declare const ANNOTATION_TEXT_IGNORED: 'annotation documentation value is declaration data, not behaviour';
+export declare const strykerIgnorers: readonly Ignorer[];
+//#endregion

package/dist/index.mjs

@@ -0,0 +1,87 @@
+import { defineIgnorer } from "@systemfsoftware/stryker-ignorer-kit";
+//#region src/SchemaDeclarationIgnore.ts
+const SYMBOL_DESCRIPTION_IGNORED = "Symbol.for() brand description is identity-only data, not behaviour";
+const TAGGED_TAG_IGNORED = "TaggedClass/TaggedError _tag is a declaration discriminant, not behaviour";
+const TAGGED_FIELDS_IGNORED = "TaggedClass/TaggedError field schema is a declaration, not behaviour";
+const CLASS_ID_IGNORED = "Schema.Class identifier is a declaration name, not behaviour";
+const BRAND_NAME_IGNORED = "Schema.brand name is identity-only data, not behaviour";
+const OPTIONAL_DEFAULT_IGNORED = "optionalWith default value is config, not behaviour";
+const ANNOTATION_OBJECT_IGNORED = "annotations object holding only documentation is a declaration, not behaviour";
+const ANNOTATION_TEXT_IGNORED = "annotation documentation value is declaration data, not behaviour";
+const DOCUMENTATION_KEYS = {
+	identifier: true,
+	description: true,
+	title: true,
+	documentation: true,
+	examples: true
+};
+const TAGGED_FACTORIES = ["TaggedClass", "TaggedError"];
+const CLASS_FACTORY = "Class";
+const isIdentifierNamed = (node, name) => node.type === "Identifier" && node.name === name;
+const isIdentifierAmong = (node, names) => node.type === "Identifier" && names.includes(node.name);
+const isPlainMember = (node) => node.type === "MemberExpression" && node.computed === false;
+const isMemberObjectNamed = (node, object) => isPlainMember(node) && isIdentifierNamed(node.object, object);
+const isMemberPropertyNamed = (node, property) => isPlainMember(node) && isIdentifierNamed(node.property, property);
+const isSymbolForCallee = (callee) => isMemberObjectNamed(callee, "Symbol") && isMemberPropertyNamed(callee, "for");
+const isFactoryReference = (reference, factories) => isPlainMember(reference) && isIdentifierAmong(reference.property, factories);
+const isTaggedFactoryCallee = (callee) => callee.type === "CallExpression" && isFactoryReference(callee.callee, TAGGED_FACTORIES);
+const isClassFactoryCallee = (callee) => isMemberPropertyNamed(callee, CLASS_FACTORY);
+const isBrandCallee = (callee) => isMemberPropertyNamed(callee, "brand");
+const isAnnotationsCallee = (callee) => isMemberPropertyNamed(callee, "annotations");
+const isOptionalWithCallee = (callee) => isMemberObjectNamed(callee, "S") && isMemberPropertyNamed(callee, "optionalWith");
+const holdsCallOf = (call, callee) => call !== void 0 && callee(call.callee);
+const holdsArgumentOf = (node, call, index, callee) => holdsCallOf(call, callee) && call.arguments[index] === node;
+const isDocumentationKey = (value) => typeof value === "string" && DOCUMENTATION_KEYS[value] === true;
+const isLiteralKeyNamed = (key) => key.type === "Literal" && isDocumentationKey(key.value);
+const isDocumentationKeyNode = (key) => key.type === "Identifier" ? isDocumentationKey(key.name) : isLiteralKeyNamed(key);
+const isComputedFreeProperty = (property) => property.type === "Property" && property.computed === false;
+const isDocumentationEntry = (property) => isComputedFreeProperty(property) && isDocumentationKeyNode(property.key);
+const holdsDocumentationEntries = (properties) => properties.length > 0 && properties.every(isDocumentationEntry);
+const isDocumentationOnlyObject = (node) => node.type === "ObjectExpression" && holdsDocumentationEntries(node.properties);
+const holdsDocumentationObjectArgument = (node, call) => isDocumentationOnlyObject(node) && holdsArgumentOf(node, call, 0, isAnnotationsCallee);
+const isCallNode = (node) => node !== void 0 && node.type === "CallExpression";
+const asCall = (node) => isCallNode(node) ? node : void 0;
+const isEntryNode = (property) => property !== void 0 && isDocumentationEntry(property);
+const isDocumentationEntryValue = (property, node) => isEntryNode(property) && property.value === node;
+const isObjectNode = (node) => node !== void 0 && node.type === "ObjectExpression";
+const isObjectArgumentOfAnnotations = (object, call) => isObjectNode(object) && holdsArgumentOf(object, asCall(call), 0, isAnnotationsCallee);
+const argumentRule = (index, callee, reason) => ({
+	holds: (node, call) => holdsArgumentOf(node, call, index, callee),
+	reason
+});
+const LITERAL_ARGUMENT_RULES = [
+	argumentRule(0, isSymbolForCallee, SYMBOL_DESCRIPTION_IGNORED),
+	argumentRule(0, isTaggedFactoryCallee, TAGGED_TAG_IGNORED),
+	argumentRule(0, isClassFactoryCallee, CLASS_ID_IGNORED),
+	argumentRule(0, isBrandCallee, BRAND_NAME_IGNORED)
+];
+const OBJECT_ARGUMENT_RULES = [argumentRule(1, isTaggedFactoryCallee, TAGGED_FIELDS_IGNORED), {
+	holds: holdsDocumentationObjectArgument,
+	reason: ANNOTATION_OBJECT_IGNORED
+}];
+const ARROW_ARGUMENT_RULES = [argumentRule(1, isOptionalWithCallee, OPTIONAL_DEFAULT_IGNORED)];
+const firstArgumentReason = (rules, node, call) => rules.find((rule) => rule.holds(node, call))?.reason;
+const isDocumentedAnnotationValue = (node, ctx) => {
+	const property = ctx.parentIf("Property");
+	return isDocumentationEntryValue(property, node) && isObjectArgumentOfAnnotations(ctx.ancestors[1], ctx.ancestors[2]);
+};
+const documentationValueReason = (node, ctx) => isDocumentedAnnotationValue(node, ctx) ? ANNOTATION_TEXT_IGNORED : void 0;
+const strykerIgnorers = [defineIgnorer({
+	name: "effect-schema-declarations",
+	visitors: {
+		Literal: (node, ctx) => {
+			const parent = ctx.parentIf("CallExpression");
+			return firstArgumentReason(LITERAL_ARGUMENT_RULES, node, parent) ?? documentationValueReason(node, ctx);
+		},
+		ObjectExpression: (node, ctx) => {
+			const parent = ctx.parentIf("CallExpression");
+			return firstArgumentReason(OBJECT_ARGUMENT_RULES, node, parent);
+		},
+		ArrowFunctionExpression: (node, ctx) => {
+			const parent = ctx.parentIf("CallExpression");
+			return firstArgumentReason(ARROW_ARGUMENT_RULES, node, parent);
+		}
+	}
+})];
+//#endregion
+export { ANNOTATION_OBJECT_IGNORED, ANNOTATION_TEXT_IGNORED, BRAND_NAME_IGNORED, CLASS_ID_IGNORED, OPTIONAL_DEFAULT_IGNORED, SYMBOL_DESCRIPTION_IGNORED, TAGGED_FIELDS_IGNORED, TAGGED_TAG_IGNORED, strykerIgnorers };

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@systemfsoftware/stryker-ignorer-effect-schema-declarations",
+  "license": "Apache-2.0",
+  "version": "0.0.0",
+  "author": "Ryan Lee <drdgvhbh@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/systemfsoftware/stryker-js-effect.git",
+    "directory": "packages/ignorers/effect-schema-declarations"
+  },
+  "homepage": "https://github.com/systemfsoftware/stryker-js-effect/tree/main/packages/ignorers/effect-schema-declarations#readme",
+  "bugs": {
+    "url": "https://github.com/systemfsoftware/stryker-js-effect/issues"
+  },
+  "description": "Stryker ignorer that removes proven-equivalent mutants on Effect Schema declarations — brands, tags, field schemas, defaults, and documentation annotations.",
+  "keywords": [
+    "stryker",
+    "stryker-mutator",
+    "mutation-testing",
+    "effect-schema",
+    "ignorer"
+  ],
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@systemfsoftware/stryker-ignorer-interface": "^0.0.0",
+    "@systemfsoftware/stryker-ignorer-kit": "^0.0.0"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7",
+    "@systemfsoftware/arethetypeswrong-cli": "^4",
+    "@systemfsoftware/tsconfig": "^1",
+    "@types/node": "^24",
+    "@vitest/coverage-v8": "^4",
+    "oxlint": "^1",
+    "rimraf": "^6.1.3",
+    "tsdown": "^0.23.0",
+    "typescript": "^7",
+    "vitest": "^4",
+    "@effect/tsgo": "^0.45.0",
+    "@systemfsoftware/tsdown-config": "^0.1.0",
+    "@systemfsoftware/oxlint-ignorer-config": "^0.0.0",
+    "@systemfsoftware/vitest-config": "^0.1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit --incremental && tsc -p tsconfig.node.json --noEmit",
+    "test": "vitest run",
+    "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint . --format=${f:-default}",
+    "attw": "attw --pack .",
+    "api:check": "api-extractor run",
+    "api:update": "api-extractor run --local",
+    "lint:tsgo": "effect-tsgo diagnostics --project tsconfig.json --format ${TSGO_FORMAT:-text}"
+  }
+}