Skip to content

Commit

Permalink
BREAKING: Change name of YarnBerry to Yarn2And3 (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
quinnturner committed Jun 1, 2024
1 parent 221b377 commit 5aa54a7
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 14 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# audit-types

This project contains the TypeScript typings for all major dependency manager's audit output in JSON format.
This project contains the TypeScript typings for most major dependency managers' audit output in JSON format.

- ✅ NPM V6
- ✅ NPM V7+
- ✅ Yarn Classic
- ✅ Yarn Berry
- ✅ Yarn Berry v2 and v3
- ❌ Yarn Berry v4
- ✅ PNPM
7 changes: 4 additions & 3 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -252,15 +252,16 @@ declare namespace NPMAuditReportV1 {
}

/**
* Yarn Berry's audit seems to be identical in structure to NPM's v6 audit format.
* Yarn 2 and 3 audit seems to be identical in structure to NPM's v6 audit format
* except that `runId` is not required.
*/
declare namespace YarnBerryAuditReport {
declare namespace Yarn2And3AuditReport {
interface Audit {
readonly actions: Action[];
readonly advisories: AdvisoryMap;
readonly muted: any[];
readonly metadata: AuditMetadata;
readonly runId: string;
readonly runId?: string;
}

interface AuditMetadata {
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "audit-types",
"version": "0.5.6",
"version": "0.6.0",
"description": "Type definitions for package manager json audit responses",
"private": false,
"publishConfig": {
Expand All @@ -26,7 +26,7 @@
"homepage": "https://github.com/quinnturner/audit-types#readme",
"dependencies": {},
"devDependencies": {
"typescript": "^4.9.4"
"typescript": "^5.4.5"
},
"files": [
"index.d.ts",
Expand Down
17 changes: 10 additions & 7 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5aa54a7

Please sign in to comment.