Research
Security News
Malicious PyPI Package ‘pycord-self’ Targets Discord Developers with Token Theft and Backdoor Exploit
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
@asyncapi/diff
Advanced tools
AsyncDiff is a library which compares two AsyncAPI Documents and provides information about the differences by pointing out explicitly informations like breaking changes.
AsyncDiff is a library that compares two AsyncAPI files and provides information about the differences by pointing out explicitly information like breaking changes.
npm install @asyncapi/diff
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
},
});
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.
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'
}
}
See the index document to get all the helper methods this library offers.
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
const output = diff(firstDocument, secondDocument, {
overrides: {
"/servers/*/protocol": {
add: "non-breaking",
remove: "breaking",
edit: "unclassified",
},
},
});
This library supports outputs:
json
yaml
or yml
markdown
or md
const jsonOutput = diff(firstDocument, secondDocument, {
outputType: "json",
});
const yamlOutput = diff(firstDocument, secondDocument, {
outputType: "yaml" | "yml",
});
const markdownOutput = diff(firstDocument, secondDocument, {
outputType: "markdown" | "md",
});
With markdown output, you can also choose subtypes of the changes as JSON(json
) or YAML(yaml
or yml
).
const markdownOutput = diff(firstDocument, secondDocument, {
outputType: "markdown" | "md",
markdownSubtype: "json" | "yaml" | "yml",
});
Checkout the index document to see all the APIs this library offers.
npm run test
npm run lint
Help us make this library more robust. Read CONTRIBUTING guide & start contributing.
Thanks goes to these wonderful people (emoji key):
Aayush Kumar Sahu 💻 📖 🚧 🤔 👀 ⚠️ | Lukasz Gornicki 🤔 👀 🚧 | Maciej Urbańczyk 👀 | Jonas Lagoni 👀 | Vinit Shahdeo 👀 | Anubhav Vats 👀 |
Shiven Sinha 💻 ⚠️ | Debajyoti Halder 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
AsyncDiff is a library which compares two AsyncAPI Documents and provides information about the differences by pointing out explicitly informations like breaking changes.
We found that @asyncapi/diff demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.