dangerfile.js

const { danger, markdown } = require('danger');

function addDeployPreviewUrls() {
  /**
   * The incoming docsPath from danger does not start with `/`
   * e.g. ['docs/data/data-grid/editing/editing.md']
   */
  function formatFileToLink(docsPath) {
    const url = docsPath.replace('docs/data', 'x').replace(/\/[^/]+\.md$/, '/');

    return url
      .replace('data-grid/', 'react-data-grid/')
      .replace('date-pickers/', 'react-date-pickers/')
      .replace('charts/', 'react-charts/')
      .replace('tree-view/', 'react-tree-view/')
      .replace(/\/[^/]+\.md$/, '/');
  }

  const netlifyPreview = `https://deploy-preview-${danger.github.pr.number}--material-ui-x.netlify.app/`;

  const files = [...danger.git.created_files, ...danger.git.modified_files];

  // limit to the first 5 docs
  const docs = files
    .filter((file) => file.startsWith('docs/data') && file.endsWith('.md'))
    .slice(0, 5);

  markdown(`**Deploy preview:** <a href="${netlifyPreview}">${netlifyPreview}</a>`);

  if (docs.length) {
    markdown(`

**Updated pages:**

${docs
  .map((docsPath) => {
    const formattedUrl = formatFileToLink(docsPath);
    return `- [${docsPath}](${netlifyPreview}${formattedUrl})`;
  })
  .join('\n')}
`);
  }
}

function addL10nHelpMessage() {
  const isAddingLocale = danger.git.created_files.some((file) => file.includes('/src/locales/'));
  const isUpdatingLocale = danger.git.modified_files.some((file) => file.includes('/src/locales/'));

  if (!isAddingLocale && !isUpdatingLocale) {
    return;
  }
  markdown(
    [
      '## Localization writing tips :writing_hand:',
      '',
      'Seems you are updating localization :earth_africa: files.',
      '',
      'Thank you for contributing to the localization! :tada: To make your PR perfect, here is a list of elements to check: :heavy_check_mark:',
      '- [ ] Verify if the PR title respects the release format. Here are two examples (depending if you update or add a locale file)',
      '  > [l10n] Improve Swedish (sv-SE) locale',
      '  > [l10n] Add Danish (da-DK) locale',
      '- [ ] Update the documentation of supported locales by running `pnpm l10n`',
      ...(isAddingLocale
        ? [
            '- [ ] Verify that you have added an export line in `src/locales/index.ts` for the new locale.',
            '- [ ] Run `pnpm docs:api` which should add your new translation to the list of exported interfaces.',
          ]
        : []),
      '- [ ] Clean files with `pnpm prettier`.',
      '',
    ].join('\n'),
  );
}

async function run() {
  addL10nHelpMessage();
  addDeployPreviewUrls();
}

run().catch((error) => {
  console.error(error);
  process.exit(1);
});