asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fix references generator (#10271)

Browse Source
This commit is contained in:
Shahed Nasser
2024-11-25 19:13:21 +02:00
committed by GitHub
parent 6e447da33c
commit 5eccd4e87d
4 changed files with 265 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
www/utils/packages/typedoc-generate-references/src/constants/base-options.ts
View File

@@ -2,14 +2,12 @@ import path from "path"
import { TypeDocOptions } from "typedoc"
import { rootPathPrefix } from "./general.js"
console.log(rootPathPrefix)
export const baseOptions: Partial<TypeDocOptions> = {
plugin: ["typedoc-plugin-custom"],
readme: "none",
eslintPathName: path.join(
rootPathPrefix,
"www/packages/eslint-config-docs/content.js"
"www/apps/resources/.content.eslintrc.mjs"
),
pluginsResolvePath: path.join(rootPathPrefix, "www"),
exclude: ["**/node_modules/**"],

4
www/utils/packages/typedoc-plugin-custom/package.json
View File

@@ -22,7 +22,7 @@
"typedoc": "0.26.x"
},
"devDependencies": {
"@types/eslint": "^8.56.6",
"@types/eslint": "^9.6.1",
"@types/node": "^20.12.10",
"types": "*",
"typescript": "^5.6.2"
@@ -34,7 +34,7 @@
"typedoc"
],
"dependencies": {
"eslint": "^8.53.0",
"eslint": "^9.13.0",
"glob": "^10.3.10",
"minimatch": "^10.0.1",
"utils": "*",

4
www/utils/packages/typedoc-plugin-custom/src/eslint-example.ts
View File

@@ -20,15 +20,11 @@ export function load(app: Application) {
})
app.converter.on(Converter.EVENT_RESOLVE_BEGIN, async (context: Context) => {
const eslintConfigPath = app.options.getValue("eslintPathName") as string
const pluginsResolvePath = app.options.getValue(
"pluginsResolvePath"
) as string
if (!eslintConfigPath) {
return
}
const eslint = new ESLint({
overrideConfigFile: eslintConfigPath,
resolvePluginsRelativeTo: pluginsResolvePath,
fix: true,
})
for (const reflection of context.project.getReflectionsByKind(

267
www/utils/yarn.lock
View File

@@ -395,6 +395,13 @@ __metadata:
languageName: node
linkType: hard
"@eslint-community/regexpp@npm:^4.12.1":
version: 4.12.1
resolution: "@eslint-community/regexpp@npm:4.12.1"
checksum: a03d98c246bcb9109aec2c08e4d10c8d010256538dcb3f56610191607214523d4fb1b00aa81df830b6dffb74c5fa0be03642513a289c567949d3e550ca11cdf6
languageName: node
linkType: hard
"@eslint-community/regexpp@npm:^4.5.1, @eslint-community/regexpp@npm:^4.6.1":
version: 4.10.0
resolution: "@eslint-community/regexpp@npm:4.10.0"
@@ -402,6 +409,24 @@ __metadata:
languageName: node
linkType: hard
"@eslint/config-array@npm:^0.19.0":
version: 0.19.0
resolution: "@eslint/config-array@npm:0.19.0"
dependencies:
"@eslint/object-schema": ^2.1.4
debug: ^4.3.1
minimatch: ^3.1.2
checksum: def23c6c67a8f98dc88f1b87e17a5668e5028f5ab9459661aabfe08e08f2acd557474bbaf9ba227be0921ae4db232c62773dbb7739815f8415678eb8f592dbf5
languageName: node
linkType: hard
"@eslint/core@npm:^0.9.0":
version: 0.9.0
resolution: "@eslint/core@npm:0.9.0"
checksum: 6d8e8e0991cef12314c49425d8d2d9394f5fb1a36753ff82df7c03185a4646cb7c8736cf26638a4a714782cedf4b23cfc17667d282d3e5965b3920a0e7ce20d4
languageName: node
linkType: hard
"@eslint/eslintrc@npm:^2.1.3":
version: 2.1.3
resolution: "@eslint/eslintrc@npm:2.1.3"
@@ -436,6 +461,23 @@ __metadata:
languageName: node
linkType: hard
"@eslint/eslintrc@npm:^3.2.0":
version: 3.2.0
resolution: "@eslint/eslintrc@npm:3.2.0"
dependencies:
ajv: ^6.12.4
debug: ^4.3.2
espree: ^10.0.1
globals: ^14.0.0
ignore: ^5.2.0
import-fresh: ^3.2.1
js-yaml: ^4.1.0
minimatch: ^3.1.2
strip-json-comments: ^3.1.1
checksum: 43867a07ff9884d895d9855edba41acf325ef7664a8df41d957135a81a477ff4df4196f5f74dc3382627e5cc8b7ad6b815c2cea1b58f04a75aced7c43414ab8b
languageName: node
linkType: hard
"@eslint/js@npm:8.54.0":
version: 8.54.0
resolution: "@eslint/js@npm:8.54.0"
@@ -450,6 +492,29 @@ __metadata:
languageName: node
linkType: hard
"@eslint/js@npm:9.15.0":
version: 9.15.0
resolution: "@eslint/js@npm:9.15.0"
checksum: 56552966ab1aa95332f70d0e006db5746b511c5f8b5e0c6a9b2d6764ff6d964e0b2622731877cbc4e3f0e74c5b39191290d5f48147be19175292575130d499ab
languageName: node
linkType: hard
"@eslint/object-schema@npm:^2.1.4":
version: 2.1.4
resolution: "@eslint/object-schema@npm:2.1.4"
checksum: e9885532ea70e483fb007bf1275968b05bb15ebaa506d98560c41a41220d33d342e19023d5f2939fed6eb59676c1bda5c847c284b4b55fce521d282004da4dda
languageName: node
linkType: hard
"@eslint/plugin-kit@npm:^0.2.3":
version: 0.2.3
resolution: "@eslint/plugin-kit@npm:0.2.3"
dependencies:
levn: ^0.4.1
checksum: 89a8035976bb1780e3fa8ffe682df013bd25f7d102d991cecd3b7c297f4ce8c1a1b6805e76dd16465b5353455b670b545eff2b4ec3133e0eab81a5f9e99bd90f
languageName: node
linkType: hard
"@faker-js/faker@npm:^8.4.0":
version: 8.4.0
resolution: "@faker-js/faker@npm:8.4.0"
@@ -513,6 +578,23 @@ __metadata:
languageName: node
linkType: hard
"@humanfs/core@npm:^0.19.1":
version: 0.19.1
resolution: "@humanfs/core@npm:0.19.1"
checksum: aa4e0152171c07879b458d0e8a704b8c3a89a8c0541726c6b65b81e84fd8b7564b5d6c633feadc6598307d34564bd53294b533491424e8e313d7ab6c7bc5dc67
languageName: node
linkType: hard
"@humanfs/node@npm:^0.16.6":
version: 0.16.6
resolution: "@humanfs/node@npm:0.16.6"
dependencies:
"@humanfs/core": ^0.19.1
"@humanwhocodes/retry": ^0.3.0
checksum: 8356359c9f60108ec204cbd249ecd0356667359b2524886b357617c4a7c3b6aace0fd5a369f63747b926a762a88f8a25bc066fa1778508d110195ce7686243e1
languageName: node
linkType: hard
"@humanwhocodes/config-array@npm:^0.11.13":
version: 0.11.13
resolution: "@humanwhocodes/config-array@npm:0.11.13"
@@ -538,6 +620,20 @@ __metadata:
languageName: node
linkType: hard
"@humanwhocodes/retry@npm:^0.3.0":
version: 0.3.1
resolution: "@humanwhocodes/retry@npm:0.3.1"
checksum: f0da1282dfb45e8120480b9e2e275e2ac9bbe1cf016d046fdad8e27cc1285c45bb9e711681237944445157b430093412b4446c1ab3fc4bb037861b5904101d3b
languageName: node
linkType: hard
"@humanwhocodes/retry@npm:^0.4.1":
version: 0.4.1
resolution: "@humanwhocodes/retry@npm:0.4.1"
checksum: be7bb6841c4c01d0b767d9bb1ec1c9359ee61421ce8ba66c249d035c5acdfd080f32d55a5c9e859cdd7868788b8935774f65b2caf24ec0b7bd7bf333791f063b
languageName: node
linkType: hard
"@isaacs/cliui@npm:^8.0.2":
version: 8.0.2
resolution: "@isaacs/cliui@npm:8.0.2"
@@ -1471,6 +1567,16 @@ __metadata:
languageName: node
linkType: hard
"@types/eslint@npm:^9.6.1":
version: 9.6.1
resolution: "@types/eslint@npm:9.6.1"
dependencies:
"@types/estree": "*"
"@types/json-schema": "*"
checksum: 69ba24fee600d1e4c5abe0df086c1a4d798abf13792d8cfab912d76817fe1a894359a1518557d21237fbaf6eda93c5ab9309143dee4c59ef54336d1b3570420e
languageName: node
linkType: hard
"@types/estree@npm:*":
version: 1.0.5
resolution: "@types/estree@npm:1.0.5"
@@ -1478,6 +1584,13 @@ __metadata:
languageName: node
linkType: hard
"@types/estree@npm:^1.0.6":
version: 1.0.6
resolution: "@types/estree@npm:1.0.6"
checksum: cdfd751f6f9065442cd40957c07fd80361c962869aa853c1c2fd03e101af8b9389d8ff4955a43a6fcfa223dd387a089937f95be0f3eec21ca527039fd2d9859a
languageName: node
linkType: hard
"@types/hast@npm:^3.0.0, @types/hast@npm:^3.0.4":
version: 3.0.4
resolution: "@types/hast@npm:3.0.4"
@@ -1487,7 +1600,7 @@ __metadata:
languageName: node
linkType: hard
"@types/json-schema@npm:*, @types/json-schema@npm:^7.0.12":
"@types/json-schema@npm:*, @types/json-schema@npm:^7.0.12, @types/json-schema@npm:^7.0.15":
version: 7.0.15
resolution: "@types/json-schema@npm:7.0.15"
checksum: a996a745e6c5d60292f36731dd41341339d4eeed8180bb09226e5c8d23759067692b1d88e5d91d72ee83dfc00d3aca8e7bd43ea120516c17922cbcb7c3e252db
@@ -1763,6 +1876,15 @@ __metadata:
languageName: node
linkType: hard
"acorn@npm:^8.14.0":
version: 8.14.0
resolution: "acorn@npm:8.14.0"
bin:
acorn: bin/acorn
checksum: 6d4ee461a7734b2f48836ee0fbb752903606e576cc100eb49340295129ca0b452f3ba91ddd4424a1d4406a98adfb2ebb6bd0ff4c49d7a0930c10e462719bbfd7
languageName: node
linkType: hard
"acorn@npm:^8.4.1, acorn@npm:^8.5.0, acorn@npm:^8.9.0":
version: 8.11.2
resolution: "acorn@npm:8.11.2"
@@ -2365,6 +2487,17 @@ __metadata:
languageName: node
linkType: hard
"cross-spawn@npm:^7.0.5":
version: 7.0.6
resolution: "cross-spawn@npm:7.0.6"
dependencies:
path-key: ^3.1.0
shebang-command: ^2.0.0
which: ^2.0.1
checksum: 053ea8b2135caff68a9e81470e845613e374e7309a47731e81639de3eaeb90c3d01af0e0b44d2ab9d50b43467223b88567dfeb3262db942dc063b9976718ffc1
languageName: node
linkType: hard
"crypt@npm:0.0.2":
version: 0.0.2
resolution: "crypt@npm:0.0.2"
@@ -2384,6 +2517,18 @@ __metadata:
languageName: node
linkType: hard
"debug@npm:^4.3.1":
version: 4.3.7
resolution: "debug@npm:4.3.7"
dependencies:
ms: ^2.1.3
peerDependenciesMeta:
supports-color:
optional: true
checksum: 1471db19c3b06d485a622d62f65947a19a23fbd0dd73f7fd3eafb697eec5360cde447fb075919987899b1a2096e85d35d4eb5a4de09a57600ac9cf7e6c8e768b
languageName: node
linkType: hard
"deep-is@npm:^0.1.3":
version: 0.1.4
resolution: "deep-is@npm:0.1.4"
@@ -2693,6 +2838,16 @@ __metadata:
languageName: node
linkType: hard
"eslint-scope@npm:^8.2.0":
version: 8.2.0
resolution: "eslint-scope@npm:8.2.0"
dependencies:
esrecurse: ^4.3.0
estraverse: ^5.2.0
checksum: 8d2d58e2136d548ac7e0099b1a90d9fab56f990d86eb518de1247a7066d38c908be2f3df477a79cf60d70b30ba18735d6c6e70e9914dca2ee515a729975d70d6
languageName: node
linkType: hard
"eslint-visitor-keys@npm:^2.1.0":
version: 2.1.0
resolution: "eslint-visitor-keys@npm:2.1.0"
@@ -2707,6 +2862,13 @@ __metadata:
languageName: node
linkType: hard
"eslint-visitor-keys@npm:^4.2.0":
version: 4.2.0
resolution: "eslint-visitor-keys@npm:4.2.0"
checksum: 2ed81c663b147ca6f578312919483eb040295bbab759e5a371953456c636c5b49a559883e2677112453728d66293c0a4c90ab11cab3428cf02a0236d2e738269
languageName: node
linkType: hard
"eslint@npm:^8.36.0, eslint@npm:^8.53.0":
version: 8.54.0
resolution: "eslint@npm:8.54.0"
@@ -2803,6 +2965,55 @@ __metadata:
languageName: node
linkType: hard
"eslint@npm:^9.13.0":
version: 9.15.0
resolution: "eslint@npm:9.15.0"
dependencies:
"@eslint-community/eslint-utils": ^4.2.0
"@eslint-community/regexpp": ^4.12.1
"@eslint/config-array": ^0.19.0
"@eslint/core": ^0.9.0
"@eslint/eslintrc": ^3.2.0
"@eslint/js": 9.15.0
"@eslint/plugin-kit": ^0.2.3
"@humanfs/node": ^0.16.6
"@humanwhocodes/module-importer": ^1.0.1
"@humanwhocodes/retry": ^0.4.1
"@types/estree": ^1.0.6
"@types/json-schema": ^7.0.15
ajv: ^6.12.4
chalk: ^4.0.0
cross-spawn: ^7.0.5
debug: ^4.3.2
escape-string-regexp: ^4.0.0
eslint-scope: ^8.2.0
eslint-visitor-keys: ^4.2.0
espree: ^10.3.0
esquery: ^1.5.0
esutils: ^2.0.2
fast-deep-equal: ^3.1.3
file-entry-cache: ^8.0.0
find-up: ^5.0.0
glob-parent: ^6.0.2
ignore: ^5.2.0
imurmurhash: ^0.1.4
is-glob: ^4.0.0
json-stable-stringify-without-jsonify: ^1.0.1
lodash.merge: ^4.6.2
minimatch: ^3.1.2
natural-compare: ^1.4.0
optionator: ^0.9.3
peerDependencies:
jiti: "*"
peerDependenciesMeta:
jiti:
optional: true
bin:
eslint: bin/eslint.js
checksum: d0d7606f36bfcccb1c3703d0a24df32067b207a616f17efe5fb1765a91d13f085afffc4fc97ecde4ab9c9f4edd64d9b4ce750e13ff7937a25074b24bee15b20f
languageName: node
linkType: hard
"esm@npm:^3.2.25":
version: 3.2.25
resolution: "esm@npm:3.2.25"
@@ -2810,6 +3021,17 @@ __metadata:
languageName: node
linkType: hard
"espree@npm:^10.0.1, espree@npm:^10.3.0":
version: 10.3.0
resolution: "espree@npm:10.3.0"
dependencies:
acorn: ^8.14.0
acorn-jsx: ^5.3.2
eslint-visitor-keys: ^4.2.0
checksum: 272beeaca70d0a1a047d61baff64db04664a33d7cfb5d144f84bc8a5c6194c6c8ebe9cc594093ca53add88baa23e59b01e69e8a0160ab32eac570482e165c462
languageName: node
linkType: hard
"espree@npm:^9.6.0, espree@npm:^9.6.1":
version: 9.6.1
resolution: "espree@npm:9.6.1"
@@ -2830,6 +3052,15 @@ __metadata:
languageName: node
linkType: hard
"esquery@npm:^1.5.0":
version: 1.6.0
resolution: "esquery@npm:1.6.0"
dependencies:
estraverse: ^5.1.0
checksum: cb9065ec605f9da7a76ca6dadb0619dfb611e37a81e318732977d90fab50a256b95fee2d925fba7c2f3f0523aa16f91587246693bc09bc34d5a59575fe6e93d2
languageName: node
linkType: hard
"esrecurse@npm:^4.3.0":
version: 4.3.0
resolution: "esrecurse@npm:4.3.0"
@@ -2986,6 +3217,15 @@ __metadata:
languageName: node
linkType: hard
"file-entry-cache@npm:^8.0.0":
version: 8.0.0
resolution: "file-entry-cache@npm:8.0.0"
dependencies:
flat-cache: ^4.0.0
checksum: 9e2b5938b1cd9b6d7e3612bdc533afd4ac17b2fc646569e9a8abbf2eb48e5eb8e316bc38815a3ef6a1b456f4107f0d0f055a614ca613e75db6bf9ff4d72c1638
languageName: node
linkType: hard
"fill-range@npm:^7.0.1":
version: 7.0.1
resolution: "fill-range@npm:7.0.1"
@@ -3016,6 +3256,16 @@ __metadata:
languageName: node
linkType: hard
"flat-cache@npm:^4.0.0":
version: 4.0.1
resolution: "flat-cache@npm:4.0.1"
dependencies:
flatted: ^3.2.9
keyv: ^4.5.4
checksum: 2c59d93e9faa2523e4fda6b4ada749bed432cfa28c8e251f33b25795e426a1c6dbada777afb1f74fcfff33934fdbdea921ee738fcc33e71adc9d6eca984a1cfc
languageName: node
linkType: hard
"flatted@npm:^3.2.9":
version: 3.2.9
resolution: "flatted@npm:3.2.9"
@@ -3223,6 +3473,13 @@ __metadata:
languageName: node
linkType: hard
"globals@npm:^14.0.0":
version: 14.0.0
resolution: "globals@npm:14.0.0"
checksum: b96ff42620c9231ad468d4c58ff42afee7777ee1c963013ff8aabe095a451d0ceeb8dcd8ef4cbd64d2538cef45f787a78ba3a9574f4a634438963e334471302d
languageName: node
linkType: hard
"globby@npm:11.1.0, globby@npm:^11.1.0":
version: 11.1.0
resolution: "globby@npm:11.1.0"
@@ -3715,7 +3972,7 @@ __metadata:
languageName: node
linkType: hard
"keyv@npm:^4.5.3":
"keyv@npm:^4.5.3, keyv@npm:^4.5.4":
version: 4.5.4
resolution: "keyv@npm:4.5.4"
dependencies:
@@ -4205,7 +4462,7 @@ __metadata:
languageName: node
linkType: hard
"ms@npm:^2.0.0, ms@npm:^2.1.1":
"ms@npm:^2.0.0, ms@npm:^2.1.1, ms@npm:^2.1.3":
version: 2.1.3
resolution: "ms@npm:2.1.3"
checksum: d924b57e7312b3b63ad21fc5b3dc0af5e78d61a1fc7cfb5457edaf26326bf62be5307cc87ffb6862ef1c2b33b0233cdb5d4f01c4c958cc0d660948b65a287a48
@@ -5641,9 +5898,9 @@ __metadata:
version: 0.0.0-use.local
resolution: "typedoc-plugin-custom@workspace:packages/typedoc-plugin-custom"
dependencies:
"@types/eslint": ^8.56.6
"@types/eslint": ^9.6.1
"@types/node": ^20.12.10
eslint: ^8.53.0
eslint: ^9.13.0
glob: ^10.3.10
minimatch: ^10.0.1
types: "*"