sitespeed.io/release/feed.js

import { Feed } from 'feed';
import { readdirSync, statSync, readFileSync, writeFileSync } from 'node:fs';
import path from 'node:path';
import parseChangelog from 'changelog-parser';
import { marked } from 'marked';

const allFeeds = [];

const images = {
  'sitespeed.io': 'https://www.sitespeed.io/img/logos/sitespeed.io.png',
  browsertime: 'https://www.sitespeed.io/img/logos/browsertime.png',
  'coach-core': 'https://www.sitespeed.io/img/logos/coach.png',
  pagexray: 'https://www.sitespeed.io/img/logos/pagexray.png',
  server: '',
  testrunner: '',
  throttle: '',
  coach: 'https://www.sitespeed.io/img/logos/coach.png',
  'chrome-har': '',
  'chrome-trace': '',
  compare: 'https://www.sitespeed.io/img/logos/compare.png',
  humble: ''
};

const getSortedFiles = dir => {
  const files = readdirSync(dir);

  return files
    .map(fileName => ({
      fileName: fileName,
      name: path.parse(fileName).name,
      time: statSync(`${dir}/${fileName}`).mtime.getTime(),
      version: readFileSync(`${dir}/${fileName}`, 'utf8').trim()
    }))
    .sort((a, b) => b.time - a.time);
};

function getFeed(tool, time) {
  return new Feed({
    title: `${tool} release feed`,
    description: `New releases and changelog feed of ${tool}`,
    id: `${tool}-release-feed`,
    link: 'https://www.sitespeed.io',
    language: 'en', // optional, used only in RSS 2.0, possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
    image: images[tool],
    favicon: 'http://www.sitespeed.io/favicon.ico',
    copyright: 'All rights reserved 2022, Peter Hedenskog and team',
    updated: new Date(time),
    feedLinks: {
      atom:
        tool === 'sitespeed.io'
          ? `https://www.sitespeed.io/feed/atom.xml`
          : `https://www.sitespeed.io/feed/${tool}.atom`,
      rss:
        tool === 'sitespeed.io'
          ? `https://www.sitespeed.io/feed/rss.xml`
          : `https://www.sitespeed.io/feed/${tool}.rss`
    },
    author: {
      name: 'Peter Hedenskog',
      email: 'peter@soulgalore.com',
      link: 'https://www.peterhedenskog.com'
    }
  });
}

function addItemToFeed(feed, item, tool) {
  feed.addItem({
    title: `${tool} ${item.version}`,
    id: `https://github.com/sitespeedio/${tool}/blob/main/CHANGELOG.md#${item.version}`,
    link: `https://github.com/sitespeedio/${tool}/blob/main/CHANGELOG.md#${item.version}`,
    description: getResultAsHTML(item),
    author: [
      {
        name: 'Sitespeed.io',
        link: 'https://www.sitespeed.io'
      }
    ],
    date: new Date(item.date),
    image: images[tool]
  });
}

function getResultAsHTML(result) {
  let allData = '';
  if (result.parsed) {
    if (result.parsed.Added) {
      allData += `<h3>Added</h3>\n`;
      for (let added of result.parsed.Added) {
        allData += ' ' + marked.parse(added);
      }
    }
    if (result.parsed.Fixed) {
      allData += `<h3>Fixed</h3>\n`;
      for (let fixed of result.parsed.Fixed) {
        allData += ' ' + marked.parse(fixed);
      }
    }

    if (result.parsed.Changed) {
      allData += `<h3>Changed</h3>\n`;
      for (let changed of result.parsed.Changed) {
        allData += ' ' + marked.parse(changed);
      }
    }

    if (result.parsed['Breaking changes']) {
      allData += `<h3>Breaking changes</h3>\n`;
      for (let breaking of result.parsed['Breaking changes']) {
        allData += ' ' + marked.parse(breaking);
      }
    }

    if (result.parsed['Deprecated']) {
      allData += `<h3>Deprecated</h3>\n`;
      for (let deprecated of result.parsed['Deprecated']) {
        allData += ' ' + marked.parse(deprecated);
      }
    }

    if (result.parsed['Removed']) {
      allData += `<h3>Removed</h3>\n`;
      for (let removed of result.parsed['Removed']) {
        allData += ' ' + marked.parse(removed);
      }
    }

    if (result.parsed['Security']) {
      allData += `<h3>Security</h3>\n`;
      for (let security of result.parsed['Security']) {
        allData += ' ' + marked.parse(security);
      }
    }

    return allData;
  }
}

const getContent = async tool => {
  const content = [];
  let changelog =
    tool === 'sitespeed.io' ? './CHANGELOG.md' : '../' + tool + '/CHANGELOG.md';
  if (tool === 'server' || tool === 'testrunner') {
    changelog = `../onlinetest/${tool}/CHANGELOG.md`;
  }
  const result = await parseChangelog({
    filePath: changelog,
    removeMarkdown: false
  });

  for (let index = 0; index < 10; index++) {
    // It's not unreleased
    if (result.versions[index] && result.versions[index].date !== null) {
      content.push(result.versions[index]);
      allFeeds.push({ tool, item: result.versions[index] });
    }
  }
  return content;
};
async function generateFeed() {
  const versionDir = './docs/_includes/version/';
  const sortedVersionFiles = getSortedFiles(versionDir);

  for (let tool of sortedVersionFiles) {
    const feed = getFeed(tool.name, tool.time);
    feed.addCategory('Web Performance');
    const items = await getContent(tool.name);
    for (let item of items) {
      addItemToFeed(feed, item, tool.name);
    }

    const documentPath = './docs/';

    writeFileSync(
      path.join(documentPath, 'feed', `${tool.name}.rss`),
      feed.rss2()
    );
    writeFileSync(
      path.join(documentPath, 'feed', `${tool.name}.atom`),
      feed.atom1()
    );
  }

  allFeeds.sort(function (a, b) {
    return new Date(b.item.date) - new Date(a.item.date);
  });

  const allFeed = getFeed('sitespeed.io', allFeeds[0].item.date);
  for (let item of allFeeds) {
    addItemToFeed(allFeed, item.item, item.tool);
  }

  const documentPath = './docs/';

  writeFileSync(path.join(documentPath, 'feed', `rss.xml`), allFeed.rss2());
  writeFileSync(path.join(documentPath, 'feed', `atom.xml`), allFeed.atom1());
}

await generateFeed();