Skip to content

Commit 145b6d0

Browse files
JCopeland-PIFSCJCopeland-PIFSC
authored
Resolve node forge vulnerability (#208)
* Update deprecated use of onBrokenMarkdownLinks * Update to clean up linter warnings * Update Github action workflows to node.js lts 22.x * Update package versions to latest
1 parent 9561d78 commit 145b6d0

File tree

5 files changed

+3624
-1770
lines changed

5 files changed

+3624
-1770
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
fetch-depth: 0
1515
- uses: actions/setup-node@v4
1616
with:
17-
node-version: 20
17+
node-version: 22
1818

1919
- name: Install dependencies
2020
run: npm install

‎.github/workflows/test-deploy.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
fetch-depth: 0
1818
- uses: actions/setup-node@v4
1919
with:
20-
node-version: 20
20+
node-version: 22
2121

2222
- name: Install dependencies
2323
run: npm install

‎docusaurus.config.js‎

Lines changed: 60 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ const config = {
2525
projectName: "documentation", // Usually your repo name.
2626

2727
onBrokenLinks: "warn",
28-
onBrokenMarkdownLinks: "warn",
28+
markdown: {
29+
hooks: {
30+
onBrokenMarkdownLinks: "warn",
31+
},
32+
},
2933

3034
// Even if you don't use internationalization, you can use this field to set
3135
// useful metadata like html lang. For example, if your site is Chinese, you
@@ -82,7 +86,10 @@ const config = {
8286
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
8387
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
8488
documents: ["computed-form-fields/README.md"], // the file to download
85-
modifyContent(filename, content) {
89+
modifyContent(
90+
/** @type {string} */ filename,
91+
/** @type {string} */ content
92+
) {
8693
return {
8794
filename: readmeToNamedMd(filename),
8895
content: `---
@@ -120,7 +127,10 @@ ${content}`,
120127
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
121128
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
122129
documents: ["conditional-form-fields/README.md"], // the file to download
123-
modifyContent(filename, content) {
130+
modifyContent(
131+
/** @type {string} */ filename,
132+
/** @type {string} */ content
133+
) {
124134
return {
125135
filename: readmeToNamedMd(filename),
126136
content: `---
@@ -158,7 +168,10 @@ ${content}`,
158168
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
159169
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
160170
documents: ["field-validators/README.md"], // the file to download
161-
modifyContent(filename, content) {
171+
modifyContent(
172+
/** @type {string} */ filename,
173+
/** @type {string} */ content
174+
) {
162175
return {
163176
filename: readmeToNamedMd(filename),
164177
content: `---
@@ -196,7 +209,10 @@ ${content}`,
196209
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
197210
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
198211
documents: ["network-status/README.md"], // the file to download
199-
modifyContent(filename, content) {
212+
modifyContent(
213+
/** @type {string} */ filename,
214+
/** @type {string} */ content
215+
) {
200216
return {
201217
filename: readmeToNamedMd(filename),
202218
content: `---
@@ -234,7 +250,10 @@ ${content}`,
234250
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
235251
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
236252
documents: ["mock-api/README.md"], // the file to download
237-
modifyContent(filename, content) {
253+
modifyContent(
254+
/** @type {string} */ filename,
255+
/** @type {string} */ content
256+
) {
238257
return {
239258
filename: readmeToNamedMd(filename),
240259
content: `---
@@ -272,7 +291,10 @@ ${content}`,
272291
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
273292
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
274293
documents: ["on-device-storage/README.md"], // the file to download
275-
modifyContent(filename, content) {
294+
modifyContent(
295+
/** @type {string} */ filename,
296+
/** @type {string} */ content
297+
) {
276298
return {
277299
filename: readmeToNamedMd(filename),
278300
content: `---
@@ -310,7 +332,10 @@ ${content}`,
310332
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
311333
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
312334
documents: ["multistep-form/README.md"], // the file to download
313-
modifyContent(filename, content) {
335+
modifyContent(
336+
/** @type {string} */ filename,
337+
/** @type {string} */ content
338+
) {
314339
return {
315340
filename: readmeToNamedMd(filename),
316341
content: `---
@@ -348,7 +373,10 @@ ${content}`,
348373
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
349374
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
350375
documents: ["server-sync/README.md"], // the file to download
351-
modifyContent(filename, content) {
376+
modifyContent(
377+
/** @type {string} */ filename,
378+
/** @type {string} */ content
379+
) {
352380
return {
353381
filename: readmeToNamedMd(filename),
354382
content: `---
@@ -386,7 +414,10 @@ ${content}`,
386414
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
387415
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
388416
documents: ["react-query/README.md"], // the file to download
389-
modifyContent(filename, content) {
417+
modifyContent(
418+
/** @type {string} */ filename,
419+
/** @type {string} */ content
420+
) {
390421
return {
391422
filename: readmeToNamedMd(filename),
392423
content: `---
@@ -424,7 +455,10 @@ ${content}`,
424455
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
425456
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
426457
documents: ["persisted-form/README.md"], // the file to download
427-
modifyContent(filename, content) {
458+
modifyContent(
459+
/** @type {string} */ filename,
460+
/** @type {string} */ content
461+
) {
428462
return {
429463
filename: readmeToNamedMd(filename),
430464
content: `---
@@ -462,7 +496,10 @@ ${content}`,
462496
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
463497
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
464498
documents: ["simple-table/README.md"], // the file to download
465-
modifyContent(filename, content) {
499+
modifyContent(
500+
/** @type {string} */ filename,
501+
/** @type {string} */ content
502+
) {
466503
return {
467504
filename: readmeToNamedMd(filename),
468505
content: `---
@@ -500,7 +537,10 @@ ${content}`,
500537
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
501538
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
502539
documents: ["form-structure/README.md"], // the file to download
503-
modifyContent(filename, content) {
540+
modifyContent(
541+
/** @type {string} */ filename,
542+
/** @type {string} */ content
543+
) {
504544
return {
505545
filename: readmeToNamedMd(filename),
506546
content: `---
@@ -571,18 +611,18 @@ ${content}`,
571611
line: "diff-add",
572612
block: {
573613
start: "diff-add-start",
574-
end: "diff-add-end"
575-
}
614+
end: "diff-add-end",
615+
},
576616
},
577617
{
578618
className: "code-block-diff-remove-line",
579619
line: "diff-remove",
580620
block: {
581621
start: "diff-remove-start",
582-
end: "diff-remove-end"
583-
}
584-
}
585-
]
622+
end: "diff-remove-end",
623+
},
624+
},
625+
],
586626
},
587627
}),
588628
};
@@ -592,6 +632,6 @@ export default config;
592632
// This function path stub to a README.md file
593633
// and returns the .md renamed as the parent folder.
594634
// eg. "network-status/README.md" --> "network-status.md"
595-
function readmeToNamedMd(filename) {
635+
function readmeToNamedMd(/** @type {string} */ filename) {
596636
return filename.split("/")[0].concat(".md");
597637
}

0 commit comments

Comments
 (0)