wip

Author: jacekradko

packages/upgrade/scripts/generate-guide.js

@@ -23,11 +23,11 @@ const cli = meow(
  $ pnpm run generate-guide --version=core-3 --sdk=react > react-guide.md
 `,
  {
- importMeta: import.meta,
  flags: {
- version: { type: 'string', isRequired: true },
- sdk: { type: 'string', isRequired: true },
+ sdk: { isRequired: true, type: 'string' },
+ version: { isRequired: true, type: 'string' },
  },
+ importMeta: import.meta,
  },
 );
 
@@ -101,8 +101,8 @@ function getCategoryHeading(category) {
  breaking: 'Breaking Changes',
  deprecation: 'Deprecations',
  'deprecation-removal': 'Deprecation Removals',
- warning: 'Warnings',
  version: 'Version',
+ warning: 'Warnings',
  };
  if (headings[category]) {
  return headings[category];
@@ -111,6 +111,32 @@ function getCategoryHeading(category) {
  return category.replace(/[-_]+/g, ' ').replace(/\b\w/g, char => char.toUpperCase());
 }
 
+function normalizeSdk(sdk) {
+ return sdk.replace(/^@clerk\//, '');
+}
+
+function renderAccordionCategory(lines, category, categoryChanges) {
+ const sortedChanges = [...categoryChanges].sort((a, b) => a.title.localeCompare(b.title));
+ const titles = sortedChanges.map(change => JSON.stringify(change.title));
+
+ lines.push(`## ${getCategoryHeading(category)}`);
+ lines.push('');
+ lines.push(`<Accordion titles={[${titles.join(', ')}]}>`);
+ lines.push('');
+
+ for (const change of sortedChanges) {
+ lines.push(' <AccordionPanel>');
+ lines.push('');
+ lines.push(change.content);
+ lines.push('');
+ lines.push(' </AccordionPanel>');
+ lines.push('');
+ }
+
+ lines.push('</Accordion>');
+ lines.push('');
+}
+
 function generateMarkdown(sdk, versionConfig, changes) {
  const lines = [];
  const versionName = versionConfig.name || versionConfig.id;
@@ -134,6 +160,11 @@ function generateMarkdown(sdk, versionConfig, changes) {
  }
 
  seenCategories.add(category);
+ if (category === 'breaking') {
+ renderAccordionCategory(lines, category, categoryChanges);
+ continue;
+ }
+
  lines.push(`## ${getCategoryHeading(category)}`);
  lines.push('');
 
@@ -151,6 +182,11 @@ function generateMarkdown(sdk, versionConfig, changes) {
  continue;
  }
 
+ if (category === 'breaking') {
+ renderAccordionCategory(lines, category, categoryChanges);
+ continue;
+ }
+
  lines.push(`## ${getCategoryHeading(category)}`);
  lines.push('');
 
@@ -166,17 +202,18 @@ function generateMarkdown(sdk, versionConfig, changes) {
 }
 
 async function main() {
- const { version, sdk } = cli.flags;
+ const { sdk, version } = cli.flags;
+ const normalizedSdk = normalizeSdk(sdk);
 
  const versionConfig = await loadVersionConfig(version);
- const changes = loadChanges(version, sdk);
+ const changes = loadChanges(version, normalizedSdk);
 
  if (changes.length === 0) {
- console.error(`No changes found for ${sdk} in ${version}`);
+ console.error(`No changes found for ${normalizedSdk} in ${version}`);
  process.exit(1);
  }
 
- const markdown = generateMarkdown(sdk, versionConfig, changes);
+ const markdown = generateMarkdown(normalizedSdk, versionConfig, changes);
  console.log(markdown);
 }