ant-design/scripts/generate-component-changelog.ts

225 lines
5.5 KiB
TypeScript
Raw Normal View History

// Collect from `changelog.md` to get all components changelog
import path from 'path';
import fs from 'fs-extra';
import { globSync } from 'glob';
const output = '.dumi/preset';
// Collect components
const componentNames = globSync(
path
.join(process.cwd(), 'components/!(version|icon|col|row)/index.zh-CN.md')
.split(path.sep)
.join('/'),
)
.map((filePath) => filePath.replace(/\\/g, '/').match(/components\/([^/]*)\//)![1])
.filter((name) => name !== 'overview');
const camelComponentNames = componentNames.map((componentName) =>
componentName
.split('-')
.map((cell) => (cell.length <= 2 ? cell.toUpperCase() : cell[0].toUpperCase() + cell.slice(1)))
.join(''),
);
function fillComponentKey(componentName: string): RegExp[] {
return [new RegExp(`(?<!\\.)\\b${componentName}\\b`)];
}
// Convert a mapping logic
const componentNameMap: Record<string, (string | RegExp)[]> = {};
camelComponentNames.forEach((name) => {
componentNameMap[name] = [...fillComponentKey(name), 'Global:'];
});
componentNameMap.ConfigProvider.push(...fillComponentKey('Wave'));
componentNameMap.Grid.push(...fillComponentKey('Row'));
componentNameMap.Grid.push(...fillComponentKey('Col'));
componentNameMap.Message.push(...fillComponentKey('message'));
componentNameMap.Notification.push(...fillComponentKey('notification'));
// Collect misc. When ComponentName not match will fallback to misc
const miscKeys = [
'ComponentToken',
'Component Token',
'Design Token',
'MISC:',
'杂项:',
2024-12-15 00:15:33 +08:00
'antd',
'@ant-design/cssinjs',
'@ant-design/icons',
'rc-motion',
' IE ',
'reset.css',
'📖',
'🛠',
'📦',
'🌐',
' locale ',
' RTL ',
'<img',
'🇧🇪',
'🇨🇦',
'🇪🇸',
'🇷🇺',
'🇺🇦',
docs: add 5.22.0 changelog (#51560) * docs: add 5.21.7 changelog * docs: add 5.21.7 changelog * chore: update version to 5.22.0 and add changelog entries * fix(TreeSelect): 修复弹层高度不够的问题 * Update CHANGELOG.zh-CN.md Co-authored-by: afc163 <afc163@gmail.com> Signed-off-by: 陈帅 <qixian.cs@outlook.com> * Update CHANGELOG.zh-CN.md Co-authored-by: afc163 <afc163@gmail.com> Signed-off-by: 陈帅 <qixian.cs@outlook.com> * Update CHANGELOG.en-US.md Co-authored-by: afc163 <afc163@gmail.com> Signed-off-by: 陈帅 <qixian.cs@outlook.com> * fix: 修复 Menu title 内容的样式问题,修正葡萄牙语本地化翻译,提高准确性和一致性,优化 uz_UZ 国际化 * chore: 更新 CHANGELOG,修正 Input.OTP 组件 onInput 事件描述的格式 * fix: 修复 Menu title 内容的样式问题,优化葡萄牙语和 uz_UZ 国际化翻译的准确性和一致性 * Update CHANGELOG.zh-CN.md Co-authored-by: afc163 <afc163@gmail.com> Signed-off-by: 陈帅 <qixian.cs@outlook.com> * chore: 更新 CHANGELOG,修正 DatePicker 和 Input.OTP 组件的描述格式 * Update CHANGELOG.zh-CN.md Co-authored-by: thinkasany <480968828@qq.com> Signed-off-by: 陈帅 <qixian.cs@outlook.com> * chore: 更新 CHANGELOG,修正 DatePicker 和 Modal Tour 组件的本地化描述 * chore: 更新 CHANGELOG,修正 DatePicker 和 Modal Tour 组件的描述格式,优化葡萄牙语和 uz_UZ 国际化翻译的准确性和一致性 --------- Signed-off-by: 陈帅 <qixian.cs@outlook.com> Co-authored-by: afc163 <afc163@gmail.com> Co-authored-by: thinkasany <480968828@qq.com>
2024-11-11 23:35:56 +08:00
'🇵🇹',
'🇲🇲',
'🇸🇪',
'🇻🇳',
'🇮🇳',
'🇮🇷',
'🇰🇷',
'🇩🇪',
'🇱🇹',
'🇮🇸',
'🇺🇿',
'🇯🇵',
'🇮🇩',
'🇵🇱',
'🇲🇳',
'🇳🇵',
'🇪🇬',
'🇦🇿',
];
(() => {
2024-02-04 00:39:00 +08:00
const missingChangelog: string[] = [];
const miscChangelog: string[] = [];
// Read & write components changelog
function syncChangelog(sourceFile: string, targetFile: string) {
const content = fs.readFileSync(sourceFile).toString();
// let lastGroup = '';
let lastVersion = '';
let lastReleaseDate = '';
// Split with lines
const lines = content.split(/[\n\r]+/).filter((line) => line.trim());
// Changelog map
const componentChangelog: Record<
string,
{ version: string; changelog: string; refs: string[]; releaseDate: string }[]
> = {};
Object.keys(componentNameMap).forEach((name) => {
componentChangelog[name] = [];
});
for (let i = 0; i < lines.length; i += 1) {
const line = lines[i];
// Skip for v5 release
if (line === '## 5.0.0') {
break;
}
// Get version
if (line.startsWith('## ')) {
lastVersion = line.replace('## ', '');
continue;
}
// Get release date
const matchReleaseDate = line.match(/`(\d{4}-\d{2}-\d{2})`/);
if (matchReleaseDate) {
lastReleaseDate = matchReleaseDate[1];
}
// Start when get version
if (!lastVersion) {
continue;
}
// Group end
if (line.startsWith('- ')) {
// lastGroup = '';
}
// Group check
if (line.startsWith('- ') && lines[i + 1].startsWith(' - ')) {
// lastGroup = line.replace('- ', '');
continue;
}
// Filter not is changelog
if (!line.trim().startsWith('-') && !line.includes('github.')) {
continue;
}
// Collect Components
let matched = false;
const refs: string[] = [];
let changelogLine = line.trim().replace('- ', '');
changelogLine = changelogLine
.replace(/\[([^\]]+)]\(([^)]+)\)/g, (...match) => {
const [, title, ref] = match;
if (/\/(pull|issues)\//.test(ref)) {
refs.push(ref);
}
if (title && (title[0] === '#' || title[0] === '@')) {
return '';
}
return title;
})
.trim();
Object.keys(componentNameMap).forEach((name) => {
const matchKeys = componentNameMap[name];
if (
matchKeys.some((key) => {
if (typeof key === 'string') {
return line.includes(key);
}
return key.test(line);
})
) {
componentChangelog[name].push({
version: lastVersion,
changelog: changelogLine,
refs,
releaseDate: lastReleaseDate,
});
matched = true;
}
});
if (matched) {
continue;
}
// Misc
if (miscKeys.some((key) => line.includes(key))) {
miscChangelog.push(line);
continue;
}
if (!matched) {
console.log('🚨 Miss Component:', line);
missingChangelog.push(line);
}
}
fs.writeFileSync(path.join(output, targetFile), JSON.stringify(componentChangelog), 'utf-8');
}
syncChangelog('CHANGELOG.zh-CN.md', 'components-changelog-cn.json');
syncChangelog('CHANGELOG.en-US.md', 'components-changelog-en.json');
fs.writeFileSync(
path.join(output, 'misc-changelog.json'),
JSON.stringify(miscChangelog),
'utf-8',
);
if (missingChangelog.length) {
console.log('\nMISC key word should be:');
console.log(miscKeys.join(' , '), '\n');
throw new Error(`Component changelog miss match!`);
}
})();