Non-Permeable Membrane

    @asyncapi/diff
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.0 • Public • Published

    AsyncAPI 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 index 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 index 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.

    Keywords

    Install

    npm i @asyncapi/diff

    DownloadsWeekly Downloads

    860

    Version

    0.4.0

    License

    Apache-2.0

    Unpacked Size

    113 kB

    Total Files

    51

    Last publish

    Collaborators

    • fmvilas
    • derberg
    • asyncapi-bot