feat: Reclassify diffs to risky in a merged document for no-bwc operation #54
Conversation
makeev-pavel
changed the title
| expect.objectContaining({ | ||
| scope: 'response', | ||
| action: DiffAction.replace, | ||
| type: risky, |
There was a problem hiding this comment.
extend expected values with "before/afterDeclarationPaths" to clarify where diffs are expected.
you may use expect.arrayContaining matcher to avoid copy-pasting whole addresses, if you want.
| expect.objectContaining({ | ||
| scope: 'response', | ||
| action: DiffAction.replace, | ||
| type: risky, |
There was a problem hiding this comment.
extend expected values with "before/afterDeclarationPaths" to clarify where diffs are expected.
you may use expect.arrayContaining matcher to avoid copy-pasting whole addresses, if you want.
| expect.objectContaining({ | ||
| scope: 'response', | ||
| action: DiffAction.replace, | ||
| type: breaking, |
There was a problem hiding this comment.
extend expected values with "before/afterDeclarationPaths" to clarify where diffs are expected.
you may use expect.arrayContaining matcher to avoid copy-pasting whole addresses, if you want.
| expect.objectContaining({ | ||
| scope: 'components', | ||
| action: DiffAction.replace, | ||
| type: breaking, |
There was a problem hiding this comment.
extend expected values with "before/afterDeclarationPaths" to clarify where diffs are expected.
you may use expect.arrayContaining matcher to avoid copy-pasting whole addresses, if you want.
| ])) | ||
| }) | ||
|
|
||
| it('should mark GET method as risky and POST as breaking when only GET is in scope', async () => { |
There was a problem hiding this comment.
One of these tests is excessive, since they are testing the same case, just on different data. One is enough, remove another one.
'should mark GET method as risky and POST as breaking when only GET is in scope'
'should mark POST method as breaking and GET as risky when only POST is in scope'
| import { | ||
| AdapterContext, | ||
| AdapterResolver, | ||
| BwcState, |
There was a problem hiding this comment.
Let's be consistent with naming.
BwcState -> ApiCompatibilityScope
ApiCompatibilityKind: OK
backwardCompatibility -> apiCompatibilityScope
bwcScopeFunction -> apiCompatibilityScopeFunction
BwcScopeFunction -> ApiCompatibilityScopeFunction
parentBwc -> parentApiCompatibilityScope
computedBwc -> computedApiCompatibilityScope
| "value": { | ||
| "type": "string" | ||
| }, | ||
| "currency": { |
There was a problem hiding this comment.
No need to have two fields here, simplify the case by removing field which is not changed.
| onCreateDiffError?: (message: string, diff: Diff, ctx: CompareContext) => void | ||
| beforeValueNormalizedProperty?: symbol | ||
| afterValueNormalizedProperty?: symbol | ||
| bwcScopeFunction?: BwcScopeFunction |
There was a problem hiding this comment.
Add a documentation for this function to clarify it's intended use-case.
… operation