@alauda/doom 1.0.0-next.8 → 1.0.0

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.
@@ -159,7 +159,7 @@ export const remarkReplace = function ({ lang, localBasePath, root, items, force
159
159
  continue;
160
160
  }
161
161
  if ((matched = node.value.match(isMdx ? MDX_RELEASE_PATTERN : MD_RELEASE_COMMENT_PATTERN))) {
162
- const releaseContent = await resolveRelease(releaseNotes?.queryTemplates ?? {}, matched[1].trim(), currLang);
162
+ const releaseContent = await resolveRelease(releaseNotes?.queryTemplates ?? {}, matched[1].trim(), currLang, isMdx);
163
163
  newAstChildren.push(releaseContent ?? node);
164
164
  continue;
165
165
  }
@@ -1,2 +1,2 @@
1
1
  import type { RootContent } from 'mdast';
2
- export declare const resolveRelease: (releaseTemplates: Record<string, string>, releaseQuery: string, lang: string) => Promise<RootContent | RootContent[] | undefined>;
2
+ export declare const resolveRelease: (releaseTemplates: Record<string, string>, releaseQuery: string, lang: string, isMdx: boolean) => Promise<RootContent | RootContent[] | undefined>;
@@ -8,7 +8,7 @@ const FIELD_MAPPER = {
8
8
  zh: 'customfield_13800',
9
9
  en: 'customfield_13801',
10
10
  };
11
- const issuesToListItems = (issues, lang) => issues
11
+ const issuesToListItems = (issues, lang, isMdx) => issues
12
12
  .map((issue) => {
13
13
  const description = ((FIELD_MAPPER[lang] && issue.fields[FIELD_MAPPER[lang]]) ||
14
14
  issue.fields[FIELD_MAPPER.en])?.trim();
@@ -25,9 +25,16 @@ const issuesToListItems = (issues, lang) => issues
25
25
  .map((line) => ({ type: 'text', value: line }))
26
26
  .reduce((acc, curr, index) => {
27
27
  if (index === 0) {
28
- return [curr];
28
+ acc.push(curr);
29
29
  }
30
- return acc.concat({ type: 'html', value: '<br>' }, curr);
30
+ else {
31
+ acc.push(
32
+ // @ts-expect-error -- seems like a typing issue in mdast or TypeScript
33
+ isMdx
34
+ ? { type: 'mdxJsxFlowElement', name: 'br' }
35
+ : { type: 'html', value: '<br>' }, curr);
36
+ }
37
+ return acc;
31
38
  }, []),
32
39
  },
33
40
  ],
@@ -40,7 +47,7 @@ const NO_ISSUE_MAPPER = {
40
47
  zh: '此次发版无相关问题。',
41
48
  en: 'No issues in this release.',
42
49
  };
43
- const resolveRelease_ = async (releaseTemplates, releaseQuery) => {
50
+ const resolveRelease_ = async (releaseTemplates, releaseQuery, isMdx) => {
44
51
  const query = new URLSearchParams(releaseQuery);
45
52
  const templateName = query.get('template');
46
53
  if (!templateName) {
@@ -93,7 +100,7 @@ const resolveRelease_ = async (releaseTemplates, releaseQuery) => {
93
100
  [lang]: issues.length
94
101
  ? {
95
102
  type: 'list',
96
- children: issuesToListItems(issues, lang),
103
+ children: issuesToListItems(issues, lang, isMdx),
97
104
  }
98
105
  : {
99
106
  type: 'paragraph',
@@ -106,12 +113,12 @@ const resolveRelease_ = async (releaseTemplates, releaseQuery) => {
106
113
  },
107
114
  }), {});
108
115
  };
109
- export const resolveRelease = async (releaseTemplates, releaseQuery, lang) => {
116
+ export const resolveRelease = async (releaseTemplates, releaseQuery, lang, isMdx) => {
110
117
  if (releaseCache.has(releaseQuery)) {
111
118
  const cached = await releaseCache.get(releaseQuery);
112
119
  return cached?.[lang] ?? cached?.en;
113
120
  }
114
- const resolving = resolveRelease_(releaseTemplates, releaseQuery);
121
+ const resolving = resolveRelease_(releaseTemplates, releaseQuery, isMdx);
115
122
  releaseCache.set(releaseQuery, resolving);
116
123
  const resolved = await resolving;
117
124
  return resolved?.[lang] ?? resolved?.en;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alauda/doom",
3
- "version": "1.0.0-next.8",
3
+ "version": "1.0.0",
4
4
  "type": "module",
5
5
  "description": "Doctor Doom making docs.",
6
6
  "repository": "git+https://github.com/alauda/doom.git",
@@ -39,12 +39,12 @@
39
39
  "@inquirer/prompts": "^7.5.3",
40
40
  "@openapi-contrib/openapi-schema-to-json-schema": "^5.1.0",
41
41
  "@playwright/browser-chromium": "^1.52.0",
42
- "@rsbuild/plugin-sass": "^1.3.1",
42
+ "@rsbuild/plugin-sass": "^1.3.2",
43
43
  "@rsbuild/plugin-yaml": "^1.0.2",
44
44
  "@rspress/core": "2.0.0-beta.10",
45
45
  "@rspress/plugin-algolia": "2.0.0-beta.10",
46
46
  "@rspress/plugin-llms": "^2.0.0-beta.10",
47
- "@shikijs/transformers": "^3.4.2",
47
+ "@shikijs/transformers": "^3.5.0",
48
48
  "chokidar": "^4.0.3",
49
49
  "cli-progress": "^3.12.0",
50
50
  "clsx": "^2.1.1",
@@ -70,7 +70,7 @@
70
70
  "remark-gfm": "^4.0.1",
71
71
  "remark-mdx": "^3.1.0",
72
72
  "remark-stringify": "^11.0.0",
73
- "shiki": "^3.4.2",
73
+ "shiki": "^3.5.0",
74
74
  "simple-git": "^3.27.0",
75
75
  "swagger2openapi": "^7.0.8",
76
76
  "tinyglobby": "^0.2.14",