@docusaurus/mdx-loader 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/lib/index.d.ts +24 -0
  2. package/lib/index.d.ts.map +1 -0
  3. package/lib/index.js +178 -0
  4. package/lib/index.js.map +1 -0
  5. package/lib/remark/headings/index.d.ts +9 -0
  6. package/lib/remark/headings/index.d.ts.map +1 -0
  7. package/lib/remark/headings/index.js +60 -0
  8. package/lib/remark/headings/index.js.map +1 -0
  9. package/lib/remark/toc/index.d.ts +13 -0
  10. package/lib/remark/toc/index.d.ts.map +1 -0
  11. package/lib/remark/toc/index.js +81 -0
  12. package/lib/remark/toc/index.js.map +1 -0
  13. package/lib/remark/transformImage/index.d.ts +14 -0
  14. package/lib/remark/transformImage/index.d.ts.map +1 -0
  15. package/lib/remark/transformImage/index.js +109 -0
  16. package/lib/remark/transformImage/index.js.map +1 -0
  17. package/lib/remark/transformLinks/index.d.ts +14 -0
  18. package/lib/remark/transformLinks/index.d.ts.map +1 -0
  19. package/lib/remark/transformLinks/index.js +100 -0
  20. package/lib/remark/transformLinks/index.js.map +1 -0
  21. package/lib/remark/unwrapMdxCodeBlocks/index.d.ts +9 -0
  22. package/lib/remark/unwrapMdxCodeBlocks/index.d.ts.map +1 -0
  23. package/lib/remark/unwrapMdxCodeBlocks/index.js +29 -0
  24. package/lib/remark/unwrapMdxCodeBlocks/index.js.map +1 -0
  25. package/lib/remark/utils/index.d.ts +11 -0
  26. package/lib/remark/utils/index.d.ts.map +1 -0
  27. package/lib/remark/utils/index.js +38 -0
  28. package/lib/remark/utils/index.js.map +1 -0
  29. package/package.json +19 -16
  30. package/src/deps.d.ts +30 -0
  31. package/src/index.ts +225 -0
  32. package/src/{index.d.ts → mdx-loader.d.ts} +7 -8
  33. package/src/remark/headings/{index.js → index.ts} +22 -23
  34. package/src/remark/toc/index.ts +102 -0
  35. package/src/remark/transformImage/index.ts +167 -0
  36. package/src/remark/transformLinks/index.ts +150 -0
  37. package/src/remark/unwrapMdxCodeBlocks/{index.js → index.ts} +14 -15
  38. package/src/remark/utils/index.ts +37 -0
  39. package/src/index.js +0 -107
  40. package/src/remark/headings/__tests__/index.test.js +0 -315
  41. package/src/remark/toc/__tests__/__snapshots__/index.test.js.snap +0 -85
  42. package/src/remark/toc/__tests__/fixtures/empty-headings.md +0 -5
  43. package/src/remark/toc/__tests__/fixtures/inline-code.md +0 -9
  44. package/src/remark/toc/__tests__/fixtures/insert-below-imports.md +0 -11
  45. package/src/remark/toc/__tests__/fixtures/just-content.md +0 -15
  46. package/src/remark/toc/__tests__/fixtures/name-exist.md +0 -7
  47. package/src/remark/toc/__tests__/fixtures/non-text-content.md +0 -9
  48. package/src/remark/toc/__tests__/index.test.js +0 -212
  49. package/src/remark/toc/index.js +0 -79
  50. package/src/remark/toc/search.js +0 -73
  51. package/src/remark/transformImage/__tests__/__snapshots__/index.test.js.snap +0 -31
  52. package/src/remark/transformImage/__tests__/fixtures/fail.md +0 -1
  53. package/src/remark/transformImage/__tests__/fixtures/img.md +0 -17
  54. package/src/remark/transformImage/__tests__/fixtures/img.png +0 -0
  55. package/src/remark/transformImage/__tests__/fixtures/noUrl.md +0 -1
  56. package/src/remark/transformImage/__tests__/fixtures/pathname.md +0 -1
  57. package/src/remark/transformImage/__tests__/index.test.js +0 -59
  58. package/src/remark/transformImage/index.js +0 -106
  59. package/src/remark/transformLinks/__tests__/__snapshots__/index.test.js.snap +0 -41
  60. package/src/remark/transformLinks/__tests__/fixtures/asset.md +0 -29
  61. package/src/remark/transformLinks/__tests__/fixtures/asset.pdf +0 -0
  62. package/src/remark/transformLinks/__tests__/fixtures/noUrl.md +0 -1
  63. package/src/remark/transformLinks/__tests__/fixtures/pathname.md +0 -1
  64. package/src/remark/transformLinks/__tests__/fixtures/static/staticAsset.pdf +0 -0
  65. package/src/remark/transformLinks/__tests__/fixtures/static/staticAssetImage.png +0 -0
  66. package/src/remark/transformLinks/__tests__/index.test.js +0 -44
  67. package/src/remark/transformLinks/index.js +0 -143
  68. package/src/remark/unwrapMdxCodeBlocks/__tests__/__snapshots__/index.test.js.snap +0 -819
  69. package/src/remark/unwrapMdxCodeBlocks/__tests__/fixtures/has-mdx-code-blocks.mdx +0 -95
  70. package/src/remark/unwrapMdxCodeBlocks/__tests__/index.test.js +0 -38
  71. package/src/remark/utils/index.js +0 -39
  72. package/tsconfig.json +0 -9
package/lib/index.d.ts ADDED
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
8
+ import type { LoaderContext } from 'webpack';
9
+ declare type Options = RemarkAndRehypePluginOptions & {
10
+ staticDirs: string[];
11
+ siteDir: string;
12
+ isMDXPartial?: (filePath: string) => boolean;
13
+ isMDXPartialFrontMatterWarningDisabled?: boolean;
14
+ removeContentTitle?: boolean;
15
+ metadataPath?: string | ((filePath: string) => string);
16
+ createAssets?: (metadata: {
17
+ frontMatter: Record<string, unknown>;
18
+ metadata: Record<string, unknown>;
19
+ }) => Record<string, unknown>;
20
+ filepath: string;
21
+ };
22
+ export default function mdxLoader(this: LoaderContext<Options>, fileString: string): Promise<void>;
23
+ export {};
24
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkBH,OAAO,KAAK,EAAC,4BAA4B,EAAC,MAAM,wBAAwB,CAAC;AACzE,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAa3C,aAAK,OAAO,GAAG,4BAA4B,GAAG;IAC5C,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7C,sCAAsC,CAAC,EAAE,OAAO,CAAC;IACjD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACvD,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE;QACxB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACrC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AA6DF,wBAA8B,SAAS,CACrC,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,EAC5B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CA+Gf"}
package/lib/index.js ADDED
@@ -0,0 +1,178 @@
1
+ "use strict";
2
+ /**
3
+ * Copyright (c) Facebook, Inc. and its affiliates.
4
+ *
5
+ * This source code is licensed under the MIT license found in the
6
+ * LICENSE file in the root directory of this source tree.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ const tslib_1 = require("tslib");
10
+ const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
11
+ const mdx_1 = tslib_1.__importDefault(require("@mdx-js/mdx"));
12
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
13
+ const remark_emoji_1 = tslib_1.__importDefault(require("remark-emoji"));
14
+ const utils_1 = require("@docusaurus/utils");
15
+ const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
16
+ const headings_1 = tslib_1.__importDefault(require("./remark/headings"));
17
+ const toc_1 = tslib_1.__importDefault(require("./remark/toc"));
18
+ const unwrapMdxCodeBlocks_1 = tslib_1.__importDefault(require("./remark/unwrapMdxCodeBlocks"));
19
+ const transformImage_1 = tslib_1.__importDefault(require("./remark/transformImage"));
20
+ const transformLinks_1 = tslib_1.__importDefault(require("./remark/transformLinks"));
21
+ const { loaders: { inlineMarkdownImageFileLoader }, } = (0, utils_1.getFileLoaderUtils)();
22
+ const DEFAULT_OPTIONS = {
23
+ rehypePlugins: [],
24
+ remarkPlugins: [unwrapMdxCodeBlocks_1.default, remark_emoji_1.default, headings_1.default, toc_1.default],
25
+ beforeDefaultRemarkPlugins: [],
26
+ beforeDefaultRehypePlugins: [],
27
+ };
28
+ /**
29
+ * When this throws, it generally means that there's no metadata file associated
30
+ * with this MDX document. It can happen when using MDX partials (usually
31
+ * starting with _). That's why it's important to provide the `isMDXPartial`
32
+ * function in config
33
+ */
34
+ async function readMetadataPath(metadataPath) {
35
+ try {
36
+ return await fs_extra_1.default.readFile(metadataPath, 'utf8');
37
+ }
38
+ catch (err) {
39
+ logger_1.default.error `MDX loader can't read MDX metadata file path=${metadataPath}. Maybe the isMDXPartial option function was not provided?`;
40
+ throw err;
41
+ }
42
+ }
43
+ /**
44
+ * Converts assets an object with Webpack require calls code.
45
+ * This is useful for mdx files to reference co-located assets using relative
46
+ * paths. Those assets should enter the Webpack assets pipeline and be hashed.
47
+ * For now, we only handle that for images and paths starting with `./`:
48
+ *
49
+ * `{image: "./myImage.png"}` => `{image: require("./myImage.png")}`
50
+ */
51
+ function createAssetsExportCode(assets) {
52
+ if (Object.keys(assets).length === 0) {
53
+ return 'undefined';
54
+ }
55
+ // TODO implementation can be completed/enhanced
56
+ function createAssetValueCode(assetValue) {
57
+ if (Array.isArray(assetValue)) {
58
+ const arrayItemCodes = assetValue.map((item) => createAssetValueCode(item) ?? 'undefined');
59
+ return `[${arrayItemCodes.join(', ')}]`;
60
+ }
61
+ // Only process string values starting with ./
62
+ // We could enhance this logic and check if file exists on disc?
63
+ if (typeof assetValue === 'string' && assetValue.startsWith('./')) {
64
+ // TODO do we have other use-cases than image assets?
65
+ // Probably not worth adding more support, as we want to move to Webpack 5 new asset system (https://github.com/facebook/docusaurus/pull/4708)
66
+ const inlineLoader = inlineMarkdownImageFileLoader;
67
+ return `require("${inlineLoader}${(0, utils_1.escapePath)(assetValue)}").default`;
68
+ }
69
+ return undefined;
70
+ }
71
+ const assetEntries = Object.entries(assets);
72
+ const codeLines = assetEntries
73
+ .map(([key, value]) => {
74
+ const assetRequireCode = createAssetValueCode(value);
75
+ return assetRequireCode ? `"${key}": ${assetRequireCode},` : undefined;
76
+ })
77
+ .filter(Boolean);
78
+ return `{\n${codeLines.join('\n')}\n}`;
79
+ }
80
+ async function mdxLoader(fileString) {
81
+ const callback = this.async();
82
+ const filePath = this.resourcePath;
83
+ const reqOptions = this.getOptions() || {};
84
+ const { frontMatter, content: contentWithTitle } = (0, utils_1.parseFrontMatter)(fileString);
85
+ const { content, contentTitle } = (0, utils_1.parseMarkdownContentTitle)(contentWithTitle, {
86
+ removeContentTitle: reqOptions.removeContentTitle,
87
+ });
88
+ const hasFrontMatter = Object.keys(frontMatter).length > 0;
89
+ const options = {
90
+ ...reqOptions,
91
+ remarkPlugins: [
92
+ ...(reqOptions.beforeDefaultRemarkPlugins || []),
93
+ ...DEFAULT_OPTIONS.remarkPlugins,
94
+ [
95
+ transformImage_1.default,
96
+ {
97
+ staticDirs: reqOptions.staticDirs,
98
+ siteDir: reqOptions.siteDir,
99
+ },
100
+ ],
101
+ [
102
+ transformLinks_1.default,
103
+ {
104
+ staticDirs: reqOptions.staticDirs,
105
+ siteDir: reqOptions.siteDir,
106
+ },
107
+ ],
108
+ ...(reqOptions.remarkPlugins || []),
109
+ ],
110
+ rehypePlugins: [
111
+ ...(reqOptions.beforeDefaultRehypePlugins || []),
112
+ ...DEFAULT_OPTIONS.rehypePlugins,
113
+ ...(reqOptions.rehypePlugins || []),
114
+ ],
115
+ filepath: filePath,
116
+ };
117
+ let result;
118
+ try {
119
+ result = await (0, mdx_1.default)(content, options);
120
+ }
121
+ catch (err) {
122
+ return callback(err);
123
+ }
124
+ // MDX partials are MDX files starting with _ or in a folder starting with _
125
+ // Partial are not expected to have associated metadata files or front matter
126
+ const isMDXPartial = options.isMDXPartial && options.isMDXPartial(filePath);
127
+ if (isMDXPartial && hasFrontMatter) {
128
+ const errorMessage = `Docusaurus MDX partial files should not contain FrontMatter.
129
+ Those partial files use the _ prefix as a convention by default, but this is configurable.
130
+ File at ${filePath} contains FrontMatter that will be ignored:
131
+ ${JSON.stringify(frontMatter, null, 2)}`;
132
+ if (!options.isMDXPartialFrontMatterWarningDisabled) {
133
+ const shouldError = process.env.NODE_ENV === 'test' || process.env.CI;
134
+ if (shouldError) {
135
+ return callback(new Error(errorMessage));
136
+ }
137
+ logger_1.default.warn(errorMessage);
138
+ }
139
+ }
140
+ function getMetadataPath() {
141
+ if (!isMDXPartial) {
142
+ // Read metadata for this MDX and export it.
143
+ if (options.metadataPath && typeof options.metadataPath === 'function') {
144
+ return options.metadataPath(filePath);
145
+ }
146
+ }
147
+ return undefined;
148
+ }
149
+ const metadataPath = getMetadataPath();
150
+ if (metadataPath) {
151
+ this.addDependency(metadataPath);
152
+ }
153
+ const metadataJsonString = metadataPath
154
+ ? await readMetadataPath(metadataPath)
155
+ : undefined;
156
+ const metadata = metadataJsonString
157
+ ? JSON.parse(metadataJsonString)
158
+ : undefined;
159
+ const assets = reqOptions.createAssets && metadata
160
+ ? reqOptions.createAssets({ frontMatter, metadata })
161
+ : undefined;
162
+ const exportsCode = `
163
+ export const frontMatter = ${(0, stringify_object_1.default)(frontMatter)};
164
+ export const contentTitle = ${(0, stringify_object_1.default)(contentTitle)};
165
+ ${metadataJsonString ? `export const metadata = ${metadataJsonString};` : ''}
166
+ ${assets ? `export const assets = ${createAssetsExportCode(assets)};` : ''}
167
+ `;
168
+ const code = `
169
+ import React from 'react';
170
+ import { mdx } from '@mdx-js/react';
171
+
172
+ ${exportsCode}
173
+ ${result}
174
+ `;
175
+ return callback(null, code);
176
+ }
177
+ exports.default = mdxLoader;
178
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,gEAA0B;AAC1B,8DAA8B;AAC9B,wEAAwC;AACxC,wEAAiC;AACjC,6CAK2B;AAC3B,gFAA+C;AAC/C,yEAAyC;AACzC,+DAA+B;AAC/B,+FAA+D;AAC/D,qFAAqD;AACrD,qFAAqD;AAIrD,MAAM,EACJ,OAAO,EAAE,EAAC,6BAA6B,EAAC,GACzC,GAAG,IAAA,0BAAkB,GAAE,CAAC;AAEzB,MAAM,eAAe,GAAiC;IACpD,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,CAAC,6BAAmB,EAAE,sBAAK,EAAE,kBAAQ,EAAE,aAAG,CAAC;IAC1D,0BAA0B,EAAE,EAAE;IAC9B,0BAA0B,EAAE,EAAE;CAC/B,CAAC;AAgBF;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,YAAoB;IAClD,IAAI;QACF,OAAO,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KAChD;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAM,CAAC,KAAK,CAAA,gDAAgD,YAAY,4DAA4D,CAAC;QACrI,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAAC,MAA+B;IAC7D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACpC,OAAO,WAAW,CAAC;KACpB;IAED,gDAAgD;IAChD,SAAS,oBAAoB,CAAC,UAAmB;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CACnC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,WAAW,CACpD,CAAC;YACF,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SACzC;QACD,8CAA8C;QAC9C,gEAAgE;QAChE,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACjE,qDAAqD;YACrD,8IAA8I;YAC9I,MAAM,YAAY,GAAG,6BAA6B,CAAC;YACnD,OAAO,YAAY,YAAY,GAAG,IAAA,kBAAU,EAAC,UAAU,CAAC,YAAY,CAAC;SACtE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,SAAS,GAAG,YAAY;SAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,gBAAgB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,OAAO,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;AACzC,CAAC;AAEc,KAAK,UAAU,SAAS,CAErC,UAAkB;IAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;IAE3C,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,gBAAgB,EAAC,GAAG,IAAA,wBAAgB,EAAC,UAAU,CAAC,CAAC;IAE9E,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,IAAA,iCAAyB,EAAC,gBAAgB,EAAE;QAC1E,kBAAkB,EAAE,UAAU,CAAC,kBAAkB;KAClD,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3D,MAAM,OAAO,GAAY;QACvB,GAAG,UAAU;QACb,aAAa,EAAE;YACb,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;YAChD,GAAG,eAAe,CAAC,aAAa;YAChC;gBACE,wBAAc;gBACd;oBACE,UAAU,EAAE,UAAU,CAAC,UAAU;oBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B;aACF;YACD;gBACE,wBAAc;gBACd;oBACE,UAAU,EAAE,UAAU,CAAC,UAAU;oBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B;aACF;YACD,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;SACpC;QACD,aAAa,EAAE;YACb,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;YAChD,GAAG,eAAe,CAAC,aAAa;YAChC,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;SACpC;QACD,QAAQ,EAAE,QAAQ;KACnB,CAAC;IAEF,IAAI,MAAc,CAAC;IACnB,IAAI;QACF,MAAM,GAAG,MAAM,IAAA,aAAG,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KACtC;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,QAAQ,CAAC,GAAY,CAAC,CAAC;KAC/B;IAED,4EAA4E;IAC5E,6EAA6E;IAC7E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC5E,IAAI,YAAY,IAAI,cAAc,EAAE;QAClC,MAAM,YAAY,GAAG;;UAEf,QAAQ;EAChB,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QAErC,IAAI,CAAC,OAAO,CAAC,sCAAsC,EAAE;YACnD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtE,IAAI,WAAW,EAAE;gBACf,OAAO,QAAQ,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;aAC1C;YACD,gBAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC3B;KACF;IAED,SAAS,eAAe;QACtB,IAAI,CAAC,YAAY,EAAE;YACjB,4CAA4C;YAC5C,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU,EAAE;gBACtE,OAAO,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvC;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,IAAI,YAAY,EAAE;QAChB,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;KAClC;IAED,MAAM,kBAAkB,GAAG,YAAY;QACrC,CAAC,CAAC,MAAM,gBAAgB,CAAC,YAAY,CAAC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,kBAAkB;QACjC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,MAAM,GACV,UAAU,CAAC,YAAY,IAAI,QAAQ;QACjC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,WAAW,GAAG;6BACO,IAAA,0BAAe,EAAC,WAAW,CAAC;8BAC3B,IAAA,0BAAe,EAAC,YAAY,CAAC;EACzD,kBAAkB,CAAC,CAAC,CAAC,2BAA2B,kBAAkB,GAAG,CAAC,CAAC,CAAC,EAAE;EAC1E,MAAM,CAAC,CAAC,CAAC,yBAAyB,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;CACzE,CAAC;IAEA,MAAM,IAAI,GAAG;;;;EAIb,WAAW;EACX,MAAM;CACP,CAAC;IAEA,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC;AAlHD,4BAkHC"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { Transformer } from 'unified';
8
+ export default function plugin(): Transformer;
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/headings/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAIzC,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,WAAW,CAwD5C"}
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ /**
3
+ * Copyright (c) Facebook, Inc. and its affiliates.
4
+ *
5
+ * This source code is licensed under the MIT license found in the
6
+ * LICENSE file in the root directory of this source tree.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ const tslib_1 = require("tslib");
10
+ /* Based on remark-slug (https://github.com/remarkjs/remark-slug) and gatsby-remark-autolink-headers (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-remark-autolink-headers) */
11
+ const utils_1 = require("@docusaurus/utils");
12
+ const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
13
+ const mdast_util_to_string_1 = tslib_1.__importDefault(require("mdast-util-to-string"));
14
+ function plugin() {
15
+ return (root) => {
16
+ const slugs = (0, utils_1.createSlugger)();
17
+ (0, unist_util_visit_1.default)(root, 'heading', (headingNode) => {
18
+ const data = headingNode.data || (headingNode.data = {});
19
+ const properties = (data.hProperties || (data.hProperties = {}));
20
+ let { id } = properties;
21
+ if (id) {
22
+ id = slugs.slug(id, { maintainCase: true });
23
+ }
24
+ else {
25
+ const headingTextNodes = headingNode.children.filter(({ type }) => !['html', 'jsx'].includes(type));
26
+ const heading = (0, mdast_util_to_string_1.default)(headingTextNodes.length > 0
27
+ ? { children: headingTextNodes }
28
+ : headingNode);
29
+ // Support explicit heading IDs
30
+ const parsedHeading = (0, utils_1.parseMarkdownHeadingId)(heading);
31
+ id = parsedHeading.id || slugs.slug(heading);
32
+ if (parsedHeading.id) {
33
+ // When there's an id, it is always in the last child node
34
+ // Sometimes heading is in multiple "parts" (** syntax creates a child
35
+ // node):
36
+ // ## part1 *part2* part3 {#id}
37
+ const lastNode = headingNode.children[headingNode.children.length - 1];
38
+ if (headingNode.children.length > 1) {
39
+ const lastNodeText = (0, utils_1.parseMarkdownHeadingId)(lastNode.value).text;
40
+ // When last part contains test+id, remove the id
41
+ if (lastNodeText) {
42
+ lastNode.value = lastNodeText;
43
+ }
44
+ // When last part contains only the id: completely remove that node
45
+ else {
46
+ headingNode.children.pop();
47
+ }
48
+ }
49
+ else {
50
+ lastNode.value = parsedHeading.text;
51
+ }
52
+ }
53
+ }
54
+ data.id = id;
55
+ properties.id = id;
56
+ });
57
+ };
58
+ }
59
+ exports.default = plugin;
60
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/headings/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,gMAAgM;AAEhM,6CAAwE;AACxE,gFAAqC;AACrC,wFAA4C;AAK5C,SAAwB,MAAM;IAC5B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,KAAK,GAAG,IAAA,qBAAa,GAAE,CAAC;QAC9B,IAAA,0BAAK,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,WAAoB,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;YACzD,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAE9D,CAAC;YACF,IAAI,EAAC,EAAE,EAAC,GAAG,UAAU,CAAC;YAEtB,IAAI,EAAE,EAAE;gBACN,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAC,YAAY,EAAE,IAAI,EAAC,CAAC,CAAC;aAC3C;iBAAM;gBACL,MAAM,gBAAgB,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAClD,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAC5C,CAAC;gBACF,MAAM,OAAO,GAAG,IAAA,8BAAQ,EACtB,gBAAgB,CAAC,MAAM,GAAG,CAAC;oBACzB,CAAC,CAAE,EAAC,QAAQ,EAAE,gBAAgB,EAAY;oBAC1C,CAAC,CAAC,WAAW,CAChB,CAAC;gBAEF,+BAA+B;gBAC/B,MAAM,aAAa,GAAG,IAAA,8BAAsB,EAAC,OAAO,CAAC,CAAC;gBAEtD,EAAE,GAAG,aAAa,CAAC,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE7C,IAAI,aAAa,CAAC,EAAE,EAAE;oBACpB,0DAA0D;oBAC1D,sEAAsE;oBACtE,SAAS;oBACT,+BAA+B;oBAC/B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CACnC,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CACxB,CAAC;oBAEV,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;wBACnC,MAAM,YAAY,GAAG,IAAA,8BAAsB,EAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;wBACjE,iDAAiD;wBACjD,IAAI,YAAY,EAAE;4BAChB,QAAQ,CAAC,KAAK,GAAG,YAAY,CAAC;yBAC/B;wBACD,mEAAmE;6BAC9D;4BACH,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;yBAC5B;qBACF;yBAAM;wBACL,QAAQ,CAAC,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC;qBACrC;iBACF;aACF;YAED,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;YACb,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAxDD,yBAwDC"}
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { Transformer } from 'unified';
8
+ interface PluginOptions {
9
+ name?: string;
10
+ }
11
+ export default function plugin(options?: PluginOptions): Transformer;
12
+ export {};
13
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAWzC,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAyCD,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,WAAW,CA6BvE"}
@@ -0,0 +1,81 @@
1
+ "use strict";
2
+ /**
3
+ * Copyright (c) Facebook, Inc. and its affiliates.
4
+ *
5
+ * This source code is licensed under the MIT license found in the
6
+ * LICENSE file in the root directory of this source tree.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ const tslib_1 = require("tslib");
10
+ const parser_1 = require("@babel/parser");
11
+ const traverse_1 = tslib_1.__importDefault(require("@babel/traverse"));
12
+ const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
13
+ const mdast_util_to_string_1 = tslib_1.__importDefault(require("mdast-util-to-string"));
14
+ const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
15
+ const utils_1 = require("../utils");
16
+ const parseOptions = {
17
+ plugins: ['jsx'],
18
+ sourceType: 'module',
19
+ };
20
+ const isImport = (child) => child.type === 'import';
21
+ const hasImports = (index) => index > -1;
22
+ const isExport = (child) => child.type === 'export';
23
+ const isTarget = (child, name) => {
24
+ let found = false;
25
+ const ast = (0, parser_1.parse)(child.value, parseOptions);
26
+ (0, traverse_1.default)(ast, {
27
+ VariableDeclarator: (path) => {
28
+ if (path.node.id.name === name) {
29
+ found = true;
30
+ }
31
+ },
32
+ });
33
+ return found;
34
+ };
35
+ const getOrCreateExistingTargetIndex = (children, name) => {
36
+ let importsIndex = -1;
37
+ let targetIndex = -1;
38
+ children.forEach((child, index) => {
39
+ if (isImport(child)) {
40
+ importsIndex = index;
41
+ }
42
+ else if (isExport(child) && isTarget(child, name)) {
43
+ targetIndex = index;
44
+ }
45
+ });
46
+ if (targetIndex === -1) {
47
+ const target = {
48
+ default: false,
49
+ type: 'export',
50
+ value: `export const ${name} = [];`,
51
+ };
52
+ targetIndex = hasImports(importsIndex) ? importsIndex + 1 : 0;
53
+ children.splice(targetIndex, 0, target);
54
+ }
55
+ return targetIndex;
56
+ };
57
+ function plugin(options = {}) {
58
+ const name = options.name || 'toc';
59
+ return (root) => {
60
+ const headings = [];
61
+ (0, unist_util_visit_1.default)(root, 'heading', (child, _index, parent) => {
62
+ const value = (0, mdast_util_to_string_1.default)(child);
63
+ // depth:1 headings are titles and not included in the TOC
64
+ if (parent !== root || !value || child.depth < 2) {
65
+ return;
66
+ }
67
+ headings.push({
68
+ value: (0, utils_1.toValue)(child),
69
+ id: child.data.id,
70
+ level: child.depth,
71
+ });
72
+ });
73
+ const { children } = root;
74
+ const targetIndex = getOrCreateExistingTargetIndex(children, name);
75
+ if (headings && headings.length) {
76
+ children[targetIndex].value = `export const ${name} = ${(0, stringify_object_1.default)(headings)};`;
77
+ }
78
+ };
79
+ }
80
+ exports.default = plugin;
81
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,0CAAwD;AAExD,uEAAuC;AACvC,gFAA+C;AAC/C,wFAA4C;AAC5C,gFAAqC;AACrC,oCAAiC;AAOjC,MAAM,YAAY,GAAkB;IAClC,OAAO,EAAE,CAAC,KAAK,CAAC;IAChB,UAAU,EAAE,QAAQ;CACrB,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,KAAW,EAAoB,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;AAC5E,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACjD,MAAM,QAAQ,GAAG,CAAC,KAAW,EAAoB,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;AAM5E,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAE,IAAY,EAAE,EAAE;IAChD,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,MAAM,GAAG,GAAG,IAAA,cAAK,EAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC7C,IAAA,kBAAQ,EAAC,GAAG,EAAE;QACZ,kBAAkB,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3B,IAAK,IAAI,CAAC,IAAI,CAAC,EAAiB,CAAC,IAAI,KAAK,IAAI,EAAE;gBAC9C,KAAK,GAAG,IAAI,CAAC;aACd;QACH,CAAC;KACF,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,CAAC,QAAgB,EAAE,IAAY,EAAE,EAAE;IACxE,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,WAAW,GAAG,CAAC,CAAC,CAAC;IAErB,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAChC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;YACnB,YAAY,GAAG,KAAK,CAAC;SACtB;aAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE;YACnD,WAAW,GAAG,KAAK,CAAC;SACrB;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE;QACtB,MAAM,MAAM,GAAG;YACb,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,gBAAgB,IAAI,QAAQ;SACpC,CAAC;QAEF,WAAW,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;KACzC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,SAAwB,MAAM,CAAC,UAAyB,EAAE;IACxD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IAEnC,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,QAAQ,GAAc,EAAE,CAAC;QAE/B,IAAA,0BAAK,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,KAAc,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,IAAA,8BAAQ,EAAC,KAAK,CAAC,CAAC;YAE9B,0DAA0D;YAC1D,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE;gBAChD,OAAO;aACR;YAED,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,IAAA,eAAO,EAAC,KAAK,CAAC;gBACrB,EAAE,EAAE,KAAK,CAAC,IAAK,CAAC,EAAY;gBAC5B,KAAK,EAAE,KAAK,CAAC,KAAK;aACnB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,EAAC,QAAQ,EAAC,GAAG,IAAuB,CAAC;QAC3C,MAAM,WAAW,GAAG,8BAA8B,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEnE,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,EAAE;YAC/B,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK,GAAG,gBAAgB,IAAI,MAAM,IAAA,0BAAe,EACrE,QAAQ,CACT,GAAG,CAAC;SACN;IACH,CAAC,CAAC;AACJ,CAAC;AA7BD,yBA6BC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { Transformer } from 'unified';
8
+ declare type PluginOptions = {
9
+ staticDirs: string[];
10
+ siteDir: string;
11
+ };
12
+ export default function plugin(options: PluginOptions): Transformer;
13
+ export {};
14
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/transformImage/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAgBH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAQzC,aAAK,aAAa,GAAG;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AA4HF,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,WAAW,CAUlE"}
@@ -0,0 +1,109 @@
1
+ "use strict";
2
+ /**
3
+ * Copyright (c) Facebook, Inc. and its affiliates.
4
+ *
5
+ * This source code is licensed under the MIT license found in the
6
+ * LICENSE file in the root directory of this source tree.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ const tslib_1 = require("tslib");
10
+ const utils_1 = require("@docusaurus/utils");
11
+ const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
12
+ const path_1 = tslib_1.__importDefault(require("path"));
13
+ const url_1 = tslib_1.__importDefault(require("url"));
14
+ const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
15
+ const escape_html_1 = tslib_1.__importDefault(require("escape-html"));
16
+ const image_size_1 = tslib_1.__importDefault(require("image-size"));
17
+ const util_1 = require("util");
18
+ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
19
+ const { loaders: { inlineMarkdownImageFileLoader }, } = (0, utils_1.getFileLoaderUtils)();
20
+ async function toImageRequireNode(node, imagePath, filePath) {
21
+ const jsxNode = node;
22
+ let relativeImagePath = (0, utils_1.posixPath)(path_1.default.relative(path_1.default.dirname(filePath), imagePath));
23
+ relativeImagePath = `./${relativeImagePath}`;
24
+ const parsedUrl = url_1.default.parse(node.url);
25
+ const hash = parsedUrl.hash ?? '';
26
+ const search = parsedUrl.search ?? '';
27
+ const alt = node.alt ? `alt={"${(0, escape_html_1.default)(node.alt)}"} ` : '';
28
+ const src = `require("${inlineMarkdownImageFileLoader}${(0, utils_1.escapePath)(relativeImagePath) + search}").default${hash ? ` + '${hash}'` : ''}`;
29
+ const title = node.title ? ` title="${(0, escape_html_1.default)(node.title)}"` : '';
30
+ let width = '';
31
+ let height = '';
32
+ try {
33
+ const size = (await (0, util_1.promisify)(image_size_1.default)(imagePath));
34
+ if (size.width) {
35
+ width = ` width="${size.width}"`;
36
+ }
37
+ if (size.height) {
38
+ height = ` height="${size.height}"`;
39
+ }
40
+ }
41
+ catch (err) {
42
+ // Workaround for https://github.com/yarnpkg/berry/pull/3889#issuecomment-1034469784
43
+ // TODO remove this check once fixed in Yarn PnP
44
+ if (!process.versions.pnp) {
45
+ logger_1.default.warn `The image at path=${imagePath} can't be read correctly. Please ensure it's a valid image.
46
+ ${err.message}`;
47
+ }
48
+ }
49
+ Object.keys(jsxNode).forEach((key) => delete jsxNode[key]);
50
+ jsxNode.type = 'jsx';
51
+ jsxNode.value = `<img loading="lazy" ${alt}src={${src}}${title}${width}${height} />`;
52
+ }
53
+ async function ensureImageFileExist(imagePath, sourceFilePath) {
54
+ const imageExists = await fs_extra_1.default.pathExists(imagePath);
55
+ if (!imageExists) {
56
+ throw new Error(`Image ${(0, utils_1.toMessageRelativeFilePath)(imagePath)} used in ${(0, utils_1.toMessageRelativeFilePath)(sourceFilePath)} not found.`);
57
+ }
58
+ }
59
+ async function getImageAbsolutePath(imagePath, { siteDir, filePath, staticDirs }) {
60
+ if (imagePath.startsWith('@site/')) {
61
+ const imageFilePath = path_1.default.join(siteDir, imagePath.replace('@site/', ''));
62
+ await ensureImageFileExist(imageFilePath, filePath);
63
+ return imageFilePath;
64
+ }
65
+ else if (path_1.default.isAbsolute(imagePath)) {
66
+ // absolute paths are expected to exist in the static folder
67
+ const possiblePaths = staticDirs.map((dir) => path_1.default.join(dir, imagePath));
68
+ const imageFilePath = await (0, utils_1.findAsyncSequential)(possiblePaths, fs_extra_1.default.pathExists);
69
+ if (!imageFilePath) {
70
+ throw new Error(`Image ${possiblePaths
71
+ .map((p) => (0, utils_1.toMessageRelativeFilePath)(p))
72
+ .join(' or ')} used in ${(0, utils_1.toMessageRelativeFilePath)(filePath)} not found.`);
73
+ }
74
+ return imageFilePath;
75
+ }
76
+ // relative paths are resolved against the source file's folder
77
+ const imageFilePath = path_1.default.join(path_1.default.dirname(filePath), decodeURIComponent(imagePath));
78
+ await ensureImageFileExist(imageFilePath, filePath);
79
+ return imageFilePath;
80
+ }
81
+ async function processImageNode(node, context) {
82
+ if (!node.url) {
83
+ throw new Error(`Markdown image URL is mandatory in "${(0, utils_1.toMessageRelativeFilePath)(context.filePath)}" file`);
84
+ }
85
+ const parsedUrl = url_1.default.parse(node.url);
86
+ if (parsedUrl.protocol || !parsedUrl.pathname) {
87
+ // pathname:// is an escape hatch, in case user does not want her images to
88
+ // be converted to require calls going through webpack loader
89
+ if (parsedUrl.protocol === 'pathname:') {
90
+ node.url = node.url.replace('pathname://', '');
91
+ }
92
+ return;
93
+ }
94
+ // We try to convert image urls without protocol to images with require calls
95
+ // going through webpack ensures that image assets exist at build time
96
+ const imagePath = await getImageAbsolutePath(parsedUrl.pathname, context);
97
+ await toImageRequireNode(node, imagePath, context.filePath);
98
+ }
99
+ function plugin(options) {
100
+ return async (root, vfile) => {
101
+ const promises = [];
102
+ (0, unist_util_visit_1.default)(root, 'image', (node) => {
103
+ promises.push(processImageNode(node, { ...options, filePath: vfile.path }));
104
+ });
105
+ await Promise.all(promises);
106
+ };
107
+ }
108
+ exports.default = plugin;
109
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/transformImage/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6CAM2B;AAC3B,gFAAqC;AACrC,wDAAwB;AACxB,sDAAsB;AACtB,gEAA0B;AAC1B,sEAAqC;AACrC,oEAAgC;AAChC,+BAA+B;AAG/B,wEAAwC;AAExC,MAAM,EACJ,OAAO,EAAE,EAAC,6BAA6B,EAAC,GACzC,GAAG,IAAA,0BAAkB,GAAE,CAAC;AAWzB,KAAK,UAAU,kBAAkB,CAC/B,IAAW,EACX,SAAiB,EACjB,QAAgB;IAEhB,MAAM,OAAO,GAAG,IAAgC,CAAC;IACjD,IAAI,iBAAiB,GAAG,IAAA,iBAAS,EAC/B,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CACjD,CAAC;IACF,iBAAiB,GAAG,KAAK,iBAAiB,EAAE,CAAC;IAE7C,MAAM,SAAS,GAAG,aAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;IAClC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,IAAI,EAAE,CAAC;IAEtC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,IAAA,qBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,MAAM,GAAG,GAAG,YAAY,6BAA6B,GACnD,IAAA,kBAAU,EAAC,iBAAiB,CAAC,GAAG,MAClC,aAAa,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,IAAA,qBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI;QACF,MAAM,IAAI,GAAG,CAAC,MAAM,IAAA,gBAAS,EAAC,oBAAM,CAAC,CAAC,SAAS,CAAC,CAAE,CAAC;QACnD,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,KAAK,GAAG,WAAW,IAAI,CAAC,KAAK,GAAG,CAAC;SAClC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,GAAG,YAAY,IAAI,CAAC,MAAM,GAAG,CAAC;SACrC;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,oFAAoF;QACpF,gDAAgD;QAChD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;YACzB,gBAAM,CAAC,IAAI,CAAA,qBAAqB,SAAS;EAC5C,GAAa,CAAC,OAAO,EAAE,CAAC;SACtB;KACF;IAED,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAC1B,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,OAAO,CAAC,GAA2B,CAAC,CACrD,CAAC;IAED,OAAmB,CAAC,IAAI,GAAG,KAAK,CAAC;IAClC,OAAO,CAAC,KAAK,GAAG,uBAAuB,GAAG,QAAQ,GAAG,IAAI,KAAK,GAAG,KAAK,GAAG,MAAM,KAAK,CAAC;AACvF,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,SAAiB,EAAE,cAAsB;IAC3E,MAAM,WAAW,GAAG,MAAM,kBAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACnD,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CACb,SAAS,IAAA,iCAAyB,EAChC,SAAS,CACV,YAAY,IAAA,iCAAyB,EAAC,cAAc,CAAC,aAAa,CACpE,CAAC;KACH;AACH,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,SAAiB,EACjB,EAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAU;IAExC,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAClC,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1E,MAAM,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QACpD,OAAO,aAAa,CAAC;KACtB;SAAM,IAAI,cAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QACrC,4DAA4D;QAC5D,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACzE,MAAM,aAAa,GAAG,MAAM,IAAA,2BAAmB,EAC7C,aAAa,EACb,kBAAE,CAAC,UAAU,CACd,CAAC;QACF,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,SAAS,aAAa;iBACnB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iCAAyB,EAAC,CAAC,CAAC,CAAC;iBACxC,IAAI,CAAC,MAAM,CAAC,YAAY,IAAA,iCAAyB,EAClD,QAAQ,CACT,aAAa,CACf,CAAC;SACH;QACD,OAAO,aAAa,CAAC;KACtB;IACD,+DAA+D;IAC/D,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAC7B,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EACtB,kBAAkB,CAAC,SAAS,CAAC,CAC9B,CAAC;IACF,MAAM,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACpD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,IAAW,EAAE,OAAgB;IAC3D,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;QACb,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAA,iCAAyB,EAC9D,OAAO,CAAC,QAAQ,CACjB,QAAQ,CACV,CAAC;KACH;IAED,MAAM,SAAS,GAAG,aAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,SAAS,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;QAC7C,2EAA2E;QAC3E,6DAA6D;QAC7D,IAAI,SAAS,CAAC,QAAQ,KAAK,WAAW,EAAE;YACtC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;SAChD;QACD,OAAO;KACR;IAED,6EAA6E;IAC7E,sEAAsE;IACtE,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC1E,MAAM,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC9D,CAAC;AAED,SAAwB,MAAM,CAAC,OAAsB;IACnD,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QAC3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,IAAA,0BAAK,EAAC,IAAI,EAAE,OAAO,EAAE,CAAC,IAAW,EAAE,EAAE;YACnC,QAAQ,CAAC,IAAI,CACX,gBAAgB,CAAC,IAAI,EAAE,EAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAK,EAAC,CAAC,CAC5D,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC;AAVD,yBAUC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { Transformer } from 'unified';
8
+ declare type PluginOptions = {
9
+ staticDirs: string[];
10
+ siteDir: string;
11
+ };
12
+ export default function plugin(options: PluginOptions): Transformer;
13
+ export {};
14
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/transformLinks/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAeH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAOzC,aAAK,aAAa,GAAG;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AA+GF,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,WAAW,CAQlE"}