From 334c5feb0d5a05107849fa336aa24af42f071d53 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 10:19:52 +0000 Subject: [PATCH 1/2] fix(deps): update dependency marked to v12 Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .changeset/renovate-6a81dd3.md | 5 +++++ plugins/adr-backend/package.json | 2 +- yarn.lock | 11 ++++++++++- 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 .changeset/renovate-6a81dd3.md diff --git a/.changeset/renovate-6a81dd3.md b/.changeset/renovate-6a81dd3.md new file mode 100644 index 0000000000..9cf6fee161 --- /dev/null +++ b/.changeset/renovate-6a81dd3.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-adr-backend': patch +--- + +Updated dependency `marked` to `^12.0.0`. diff --git a/plugins/adr-backend/package.json b/plugins/adr-backend/package.json index 73def32c34..ace4f5dbc7 100644 --- a/plugins/adr-backend/package.json +++ b/plugins/adr-backend/package.json @@ -41,7 +41,7 @@ "express": "^4.17.1", "express-promise-router": "^4.1.0", "luxon": "^3.0.0", - "marked": "^4.0.14", + "marked": "^12.0.0", "node-fetch": "^2.6.5", "winston": "^3.2.1", "yn": "^4.0.0" diff --git a/yarn.lock b/yarn.lock index ef671a6c59..d09104f1bd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4230,7 +4230,7 @@ __metadata: express: ^4.17.1 express-promise-router: ^4.1.0 luxon: ^3.0.0 - marked: ^4.0.14 + marked: ^12.0.0 node-fetch: ^2.6.5 supertest: ^6.1.3 winston: ^3.2.1 @@ -34176,6 +34176,15 @@ __metadata: languageName: node linkType: hard +"marked@npm:^12.0.0": + version: 12.0.0 + resolution: "marked@npm:12.0.0" + bin: + marked: bin/marked.js + checksum: 973e803debf7eca946213cd583792c2968ecab1b6698653604272d5406f9f07375a4865a7a28633a7200c8a4682761f8d866198fb36c10c686e3bda3a9b36fc9 + languageName: node + linkType: hard + "marked@npm:^4.0.14": version: 4.3.0 resolution: "marked@npm:4.3.0" From 20440140d29a4f3e3cddd85a31c3751a531cff2c Mon Sep 17 00:00:00 2001 From: Phil Kuang Date: Mon, 19 Feb 2024 16:11:24 -0500 Subject: [PATCH 2/2] fix(adr-backend): import built in types from marked Signed-off-by: Phil Kuang --- plugins/adr-backend/package.json | 1 - plugins/adr-backend/src/search/madrParser.ts | 20 +++++++++----------- yarn.lock | 8 -------- 3 files changed, 9 insertions(+), 20 deletions(-) diff --git a/plugins/adr-backend/package.json b/plugins/adr-backend/package.json index ace4f5dbc7..0216a8d4a1 100644 --- a/plugins/adr-backend/package.json +++ b/plugins/adr-backend/package.json @@ -48,7 +48,6 @@ }, "devDependencies": { "@backstage/cli": "workspace:^", - "@types/marked": "^5.0.0", "@types/supertest": "^2.0.8", "supertest": "^6.1.3" }, diff --git a/plugins/adr-backend/src/search/madrParser.ts b/plugins/adr-backend/src/search/madrParser.ts index 0dd1437538..bb466d13c3 100644 --- a/plugins/adr-backend/src/search/madrParser.ts +++ b/plugins/adr-backend/src/search/madrParser.ts @@ -15,29 +15,27 @@ */ import { DateTime } from 'luxon'; -import { marked } from 'marked'; +import { marked, Tokens, TokensList } from 'marked'; import { MADR_DATE_FORMAT, parseMadrWithFrontmatter, } from '@backstage/plugin-adr-common'; -const getTitle = (tokens: marked.TokensList): string | undefined => { +const getTitle = (tokens: TokensList): string | undefined => { return ( - tokens.find( - t => t.type === 'heading' && t.depth === 1, - ) as marked.Tokens.Heading + tokens.find(t => t.type === 'heading' && t.depth === 1) as Tokens.Heading )?.text; }; -const getStatusForV2Format = (tokens: marked.TokensList): string | undefined => - (tokens.find(t => t.type === 'list') as marked.Tokens.List)?.items +const getStatusForV2Format = (tokens: TokensList): string | undefined => + (tokens.find(t => t.type === 'list') as Tokens.List)?.items ?.find(t => /^status:/i.test(t.text)) ?.text.replace(/^status:/i, '') .trim() .toLocaleLowerCase('en-US'); -const getDateForV2Format = (tokens: marked.TokensList): string | undefined => { - const listTokens = (tokens.find(t => t.type === 'list') as marked.Tokens.List) +const getDateForV2Format = (tokens: TokensList): string | undefined => { + const listTokens = (tokens.find(t => t.type === 'list') as Tokens.List) ?.items; const adrDateTime = listTokens ?.find(t => /^date:/i.test(t.text)) @@ -47,13 +45,13 @@ const getDateForV2Format = (tokens: marked.TokensList): string | undefined => { }; const getStatus = ( - tokens: marked.TokensList, + tokens: TokensList, frontMatterStatus?: string, ): string | undefined => { return frontMatterStatus ?? getStatusForV2Format(tokens); }; const getDate = ( - tokens: marked.TokensList, + tokens: TokensList, dateFormat: string, frontMatterDate?: string, ): string | undefined => { diff --git a/yarn.lock b/yarn.lock index d09104f1bd..35933fbed2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4225,7 +4225,6 @@ __metadata: "@backstage/plugin-adr-common": "workspace:^" "@backstage/plugin-search-common": "workspace:^" "@types/express": ^4.17.6 - "@types/marked": ^5.0.0 "@types/supertest": ^2.0.8 express: ^4.17.1 express-promise-router: ^4.1.0 @@ -18900,13 +18899,6 @@ __metadata: languageName: node linkType: hard -"@types/marked@npm:^5.0.0": - version: 5.0.2 - resolution: "@types/marked@npm:5.0.2" - checksum: 2875618970bd5aaba472e313c799bbe241fe9e31d1e79782841a0cc04e08ab2a98653166f1fb99bf8bcf140d3878c3ab960a12aa8f0fb949d8277e8a01d3411b - languageName: node - linkType: hard - "@types/mdast@npm:^3.0.0, @types/mdast@npm:^3.0.3": version: 3.0.10 resolution: "@types/mdast@npm:3.0.10"