@asyncapi/diff

Diff is a library that compares two AsyncAPI Documents and provides information about the differences by pointing out explicitly information like breaking changes.

Showing:

Popularity

Downloads/wk

22

GitHub Stars

10

Maintenance

Last Commit

4d ago

Contributors

3

Package

Dependencies

1

License

Apache-2.0

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

AsyncAPI logo
Diff

AsyncDiff is a library that compares two AsyncAPI files and provides information about the differences by pointing out explicitly information like breaking changes.

npm npm

Installation

npm install @asyncapi/diff

Usage

NOTE: The library doesn't have a built-in parser to parse the given AsyncAPI document. Thus, you have to make sure they provide the valid & dereferenced AsyncAPI document as an input. You can use the AsyncAPI parser to parse and validate the AsyncAPI file first. You can use other tools, but you must make sure that the document is valid and dereferenced.

import { diff } from '@asyncapi/diff'; // const { diff } = require('@asyncapi/diff');

const output = diff(firstDocument, secondDocument, {
  overrides: {
    // object to override the standard
  },
});

Standard object

This library has a pre-configured standard which marks a change as breaking, non-breaking or unclassified. This standard data is stored as an object inside the standard.ts file.

The format of this standard object is explained in this document.

Overriding the standard

To understand the format of overriding object, take a look at this document.

The overrides object must be passed in the following format:

{
    [jsonPointer]: {
        add: 'breaking' | 'non-breaking' | 'unclassified'
        remove: 'breaking' | 'non-breaking' | 'unclassified'
        edit: 'breaking' | 'non-breaking' | 'unclassified'
    }
}

Example

See the API document to get all the helper methods this library offers.

  1. Without any overrides
const output = diff(firstDocument, secondDocument);

output.getOutput(); // the whole output data
output.breaking(); // the breaking changes
output.nonBreaking(); // the non-breaking changes
output.unclassified(); // the unclassified changes
  1. With overrides
const output = diff(firstDocument, secondDocument, {
  overrides: {
    '/servers/*/protocol': {
      add: 'non-breaking',
      remove: 'breaking',
      edit: 'unclassified',
    },
  },
});

API

Checkout the API document to see all the APIs this library offers.

Develop

  1. Write code and tests
  2. Make sure all tests pass npm run test
  3. Make sure code is well formatted and secure npm run lint

Contributing

Help us make this library more robust. Read CONTRIBUTING guide & start contributing.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100