docs(mutators): add mutant operator name proposal #1458
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,47 +28,47 @@ All Stryker versions support a variety of different mutators. We've aligned on a | |
|
|
||
| ## Arithmetic Operator | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------------- | -------- | ------- | | ||
| | AdditionNegation | `a + b` | `a - b` | | ||
| | SubtractionNegation | `a - b` | `a + b` | | ||
| | MultiplicationNegation | `a * b` | `a / b` | | ||
| | DivisionNegation | `a / b` | `a * b` | | ||
| | RemainderToMultiplication | `a % b` | `a * b` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Array Declaration | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ---------------------------- | ----------------------- | ------------- | | ||
| | ArrayConstructorItemsRemoval | `new Array(1, 2, 3, 4)` | `new Array()` | | ||
| | ArrayLiteralItemsRemoval | `[1, 2, 3, 4]` | `[ ]` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Assignment Expression | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | --------------------------------------------- | -------------------- | -------------------- | | ||
| | AdditionAssignmentNegation | `+=` | `-=` | | ||
| | SubtractionAssignmentNegation | `-=` | `+=` | | ||
| | MultiplicationAssignmentNegation | `*=` | `/=` | | ||
| | DivisionAssignmentNegation | `/=` | `*=` | | ||
| | RemainderAssignmentToMultiplicationAssignment | `%=` | `*=` | | ||
| | LeftShiftAssignmentNegation | `<<=` | `>>=` | | ||
| | RightShiftAssignmentNegation | `>>=` | `<<=` | | ||
| | BitwiseAndAssignmentNegation | `&=` | <code>|=</code> | | ||
| | BitwiseOrAssignmentNegation | <code>|=</code> | `&=` | | ||
| | NullCoalescingAssignmentToAndAssignment | `??=` | `&&=`¹ | | ||
|
|
||
| - ¹: Only supported by Stryker-JS | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Block Statement | ||
|
|
||
| This group has one mutant operator, the `BlockRemoval` mutant operator. This mutant operator removes the content of every block statement. For example the code: | ||
|
|
||
| ```javascript | ||
| function saySomething() { | ||
|
|
@@ -86,11 +86,11 @@ function saySomething() {} | |
|
|
||
| ## Boolean Literal | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | --------------- | ----------- | ---------- | | ||
| | TrueNegation | `true` | `false` | | ||
| | FalseNegation | `false` | `true` | | ||
| | NotRemoval | `!(a == b)` | `a == b` ¹ | | ||
|
|
||
| - ¹: Not supported by Stryker4s | ||
|
|
||
|
|
@@ -100,56 +100,56 @@ function saySomething() {} | |
|
|
||
| Stryker.NET _specific mutator_ | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | --------------- | ---------------- | ------- | | ||
| | CheckedRemoval | `checked(2 + 4)` | `2 + 4` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Conditional Expression | ||
|
|
||
| | Mutant Operator | Original | Mutated | | ||
| | ------------------ | ---------------------------------- | ----------------------------------- | | ||
| | LessThanToFalse | `for (var i = 0; i < 10; i++) { }` | `for (var i = 0; false; i++) { }` ¹ | | ||
| | GreaterThanToFalse | `while (a > b) { }` | `while (false) { }` | | ||
| | GreaterThanToFalse | `do { } while (a > b);` | `do { } while (false);` | | ||
| | GreaterThanToTrue | `if (a > b) { }` | `if (true) { }` | | ||
| | GreaterThanToFalse | `if (a > b) { }` | `if (false) { }` | | ||
| | GreaterThanToTrue | `var x = a > b ? 1 : 2;` | `var x = true ? 1 : 2;` ¹ | | ||
| | GreaterThanToFalse | `var x = a > b ? 1 : 2;` | `var x = false ? 1 : 2;` ¹ | | ||
|
|
||
| - ¹: Not supported by Stryker4s | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Equality Operator | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------------ | --------- | ----------- | | ||
| | LessThanBoundary | `a < b` | `a <= b` | | ||
| | LessThanNegation | `a < b` | `a >= b` | | ||
| | LessThanEqualBoundary | `a <= b` | `a < b` | | ||
| | LessThanEqualNegation | `a <= b` | `a > b` | | ||
| | GreaterThanBoundary | `a > b` | `a >= b` | | ||
| | GreaterThanNegation | `a > b` | `a <= b` | | ||
| | GreaterThanEqualBoundary | `a >= b` | `a > b` | | ||
| | GreaterThanEqualNegation | `a >= b` | `a < b` | | ||
| | EqualityNegation | `a == b` | `a != b` | | ||
| | InequalityNegation | `a != b` | `a == b` | | ||
| | StrictEqualityNegation | `a === b` | `a !== b` ¹ | | ||
| | StrictInequalityNegation | `a !== b` | `a === b` ¹ | | ||
|
|
||
| - ¹: Only supported on StrykerJS and Stryker4s | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Logical Operator | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------- | ----------------------------- | ----------------------------- | | ||
| | AndNegation | `a && b` | <code>a || b</code> | | ||
| | OrNegation | <code>a || b</code> | `a && b` | | ||
| | NullCoalescingToAnd | `a ?? b` | `a && b` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
|
|
@@ -159,92 +159,94 @@ Due to differences in language syntax, method expressions are implemented differ | |
|
|
||
| ### StrykerJS | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------------------ | -------------------- | -------------------- | | ||
| | EndsWithToStartsWith | `endsWith()` | `startsWith()` | | ||
| | StartsWithToEndsWith | `startsWith()` | `endsWith()` | | ||
| | TrimToTrimEnd | `trim()` | `trimEnd()` | | ||
| | TrimToTrimStart | `trimEnd()` | `trimStart()` | | ||
| | TrimToTrimEnd | `trimStart()` | `trimEnd()` | | ||
| | SubstrRemoval | `substr()` | ` ` | | ||
| | SubstringRemoval | `substring()` | ` ` | | ||
| | UpperCaseToLowerCase | `toUpperCase()` | `toLowerCase()` | | ||
| | LowerCaseToUpperCase | `toLowerCase()` | `toUpperCase()` | | ||
| | LocalLowerCaseToLocalUpperCase | `toLocalLowerCase()` | `toLocalUpperCase()` | | ||
| | LocalUpperCaseToLocalLowerCase | `toLocalUpperCase()` | `toLocalLowerCase()` | | ||
| | SortRemoval | `sort()` | ` ` | | ||
| | SomeToEvery | `some()` | `every()` | | ||
| | EveryToSome | `every()` | `some()` | | ||
| | ReverseRemoval | `reverse()` | ` ` | | ||
| | FilterRemoval | `filter()` | ` ` | | ||
| | SliceRemoval | `slice()` | ` ` | | ||
| | CharAtRemoval | `charAt()` | ` ` | | ||
| | MinToMax | `min()` | `max()` | | ||
| | MaxToMin | `max()` | `min()` | | ||
|
|
||
| ### Stryker.NET | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------------------- | --------------------- | ------------------- | | ||
| | DistinctRemoval | `Distinct()` | ` ` | | ||
| | ReverseRemoval | `Reverse()` | ` ` | | ||
| | OrderByRemoval | `OrderBy()` | ` ` | | ||
| | OrderByDescendingRemoval | `OrderByDescending()` | ` ` | | ||
| | SingleOrDefaultToFirstOrDefault | `SingleOrDefault()` | `FirstOrDefault()` | | ||
| | FirstOrDefaultToSingleOrDefault | `FirstOrDefault()` | `SingleOrDefault()` | | ||
| | FirstToLast | `First()` | `Last()` | | ||
| | LastToFirst | `Last()` | `First()` | | ||
| | AllToAny | `All()` | `Any()` | | ||
| | AnyToAll | `Any()` | `All()` | | ||
| | SkipToTake | `Skip()` | `Take()` | | ||
| | TakeToSkip | `Take()` | `Skip()` | | ||
| | SkipWhileToTakeWhile | `SkipWhile()` | `TakeWhile()` | | ||
| | TakeWhileToSkipWhile | `TakeWhile()` | `SkipWhile()` | | ||
| | MinToMax | `Min()` | `Max()` | | ||
| | MaxToMin | `Max()` | `Min()` | | ||
| | SumToCount | `Sum()` | `Count()` | | ||
| | CountToSum | `Count()` | `Sum()` | | ||
|
|
||
| ### Stryker4s | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | -------------------- | ------------------ | ------------------ | | ||
| | FilterNegation | `a.filter(b)` | `a.filterNot(b)` | | ||
| | FilterNotNegation | `a.filterNot(b)` | `a.filter(b)` | | ||
| | ExistsToForAll | `a.exists(b)` | `a.forall(b)` | | ||
| | ForAllToExists | `a.forall(b)` | `a.exists(b)` | | ||
| | TakeToDrop | `a.take(b)` | `a.drop(b)` | | ||
| | DropToTake | `a.drop(b)` | `a.take(b)` | | ||
| | TakeRightNegation | `a.takeRight(b)` | `a.dropRight(b)` | | ||
| | DropRightNegation | `a.dropRight(b)` | `a.takeRight(b)` | | ||
| | TakeWhileToDropWile | `a.takeWhile(b)` | `a.dropWhile(b)` | | ||
| | DropWhileToTakeWhile | `a.dropWhile(b)` | `a.takeWhile(b)` | | ||
| | IsEmptyNegation | `a.isEmpty` | `a.nonEmpty` | | ||
| | IsNonEmptyNegation | `a.nonEmpty` | `a.isEmpty` | | ||
| | IndexOfToLastIndexOf | `a.indexOf` | `a.lastIndexOf(b)` | | ||
| | LastIndexOfToIndexOf | `a.lastIndexOf(b)` | `a.indexOf(b)` | | ||
| | MaxToMin | `a.max` | `a.min` | | ||
| | MinToMax | `a.min` | `a.max` | | ||
| | MaxByToMinBy | `a.maxBy(b)` | `a.minBy(b)` | | ||
| | MinByToMaxBy | `a.minBy(b)` | `a.maxBy(b)` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Object literal | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ----------------------- | ---------------- | ------- | | ||
| | ObjectPropertiesRemoval | `{ foo: 'bar' }` | `{ }` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Optional chaining | ||
|
|
||
| StrykerJS _specific mutator_ | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | -------------------------- | ---------- | --------- | | ||
| | OptionalMemberToRequired | `foo?.bar` | `foo.bar` | | ||
| | OptionalComputedToRequired | `foo?.[1]` | `foo[1]` | | ||
| | OptionalCallToRequired | `foo?.()` | `foo()` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
|
|
@@ -293,32 +295,33 @@ Strings and literals identified to a regex are mutated in the following way: | |
|
|
||
| ## String Literal | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------------------- | -------------------------------------- | --------------------- | | ||
| | FilledStringToEmpty | `"foo"` (filled string) | `""` (empty string) | | ||
| | EmptyStringToFilled | `""` (empty string) | `"Stryker was here!"` | | ||
| | FilledInterpolatedStringToEmpty | `s"foo ${bar}"` (string interpolation) | `s""` ¹ | | ||
| | FilledInterpolatedStringToEmpty | `\`foo ${bar}\`` | `\`\`` | | ||
|
Comment on lines
+302
to
+303
There was a problem hiding this comment. These lines break the website build: https://github.com/stryker-mutator/stryker-mutator.github.io/actions/runs/8295994425/job/22704167287#step:7:39 There was a problem hiding this comment. Yep, sorry! #3066 fixes that. Btw, it's not the line breaks, but the way of escaping backticks. |
||
|
|
||
| ¹ For Stryker4s, only works with string interpolation and not other types of interpolation (like [Scalameta quasiquotes](https://scalameta.org/docs/trees/guide.html#with-quasiquotes)) to avoid compile errors | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Unary Operator | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | --------------- | -------- | ------- | | ||
| | PlusNegation | `+a` | `-a` | | ||
| | MinusNegation | `-a` | `+a` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
|
|
||
| ## Update Operator | ||
|
|
||
| | Mutant operator | Original | Mutated | | ||
| | ------------------------ | -------- | ------- | | ||
| | PostfixIncrementNegation | `a++` | `a--` | | ||
| | PostfixDecrementNegation | `a--` | `a++` | | ||
| | PrefixIncrementNegation | `++a` | `--a` | | ||
| | PrefixDecrementNegation | `--a` | `++a` | | ||
|
|
||
| [🔝 Back to Top](#) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.