ci: move scripts to a cli (#237)

Author: Barbapapazes

.github/workflows/ci.yml

@@ -80,3 +80,27 @@ jobs:
 
       - name: Build project
         run: pnpm run build
+
+  check:
+    name: Check Content
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - run: corepack enable
+      - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4
+        with:
+          node-version: 20.5
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Check puzzle parts
+        run: pnpm run cli check puzzle
+
+      - name: Check logos
+        run: pnpm run cli check logos
+
+      - name: Check Package Redirects
+        run: pnpm run cli check packages-redirects

.github/workflows/generate-monthly-updates.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
-      - run: pnpm jiti scripts/releases-article.ts
+      - run: pnpm run cli generate releases-article
 
       - name: Commit
         run: |
@@ -61,7 +61,7 @@ jobs:
                 title: 'content: create monthly updates',
                 head: 'monthly-updates',
                 base: 'main',
-                body: `- [ ] format the article by creating paragraphs\n\nThis PR is automatically generated by a script._`,
+                body: `- [ ] format the article by creating paragraphs`,
                 labels: ['content'],
               })
             }

.github/workflows/update-packages.yml

@@ -28,6 +28,6 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
-      - run: pnpm jiti scripts/update-packages.ts
+      - run: pnpm run cli github sync-packages
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

bin/commands/check.ts

@@ -0,0 +1,12 @@
+import { defineCommand } from 'citty'
+
+export const check = defineCommand({
+  meta: {
+    name: 'check',
+  },
+  subCommands: {
+    'puzzle': () => import('./check/puzzle').then(m => m.puzzle),
+    'logos': () => import('./check/logos').then(m => m.logos),
+    'packages-redirects': () => import('./check/packages-redirects').then(m => m.packagesRedirects),
+  },
+})

bin/commands/check/logos.ts

@@ -0,0 +1,33 @@
+import { exit } from 'node:process'
+import { defineCommand } from 'citty'
+import { consola } from 'consola'
+import { getPackages } from '../../utils/content'
+import { getLogos } from '../../utils/public'
+import { formatTree } from '../../utils/format'
+
+export const logos = defineCommand({
+  meta: {
+    name: 'Logos',
+  },
+  run() {
+    const packages = getPackages()
+    const logos = getLogos()
+
+    // Check if each package have a logo
+    const packagesWithoutLogo = packages.filter(name => !logos.includes(name))
+
+    if (packagesWithoutLogo.length)
+      consola.error(`A logo is needed:\n${formatTree(packagesWithoutLogo)}`)
+
+    // Check if each logo have a package
+    const logosWithoutPackage = logos.filter(name => !packages.includes(name))
+
+    if (logosWithoutPackage.length)
+      consola.error(`A package is needed:\n${formatTree(logosWithoutPackage)}`)
+
+    if (packagesWithoutLogo.length || logosWithoutPackage.length)
+      return exit(1)
+
+    return exit(0)
+  },
+})

bin/commands/check/packages-redirects.ts

@@ -0,0 +1,35 @@
+import { exit } from 'node:process'
+import { defineCommand } from 'citty'
+import { getPackages } from '../../utils/content'
+import { getPackagesRedirectsPath } from '../../utils/config'
+import { formatTree } from '../../utils/format'
+
+export const packagesRedirects = defineCommand({
+  meta: {
+    name: 'Packages Redirects',
+    description: 'Check that all packages have a redirect rule',
+  },
+  async run() {
+    const packages = getPackages()
+    const redirects = await import(getPackagesRedirectsPath()).then(m => m.default)
+
+    const redirectsKeys = Object.keys(redirects).map(name => name.replace('/', ''))
+
+    // Check if each package have a redirect rule
+    const missingRedirects = packages.filter(name => !redirectsKeys.includes(name))
+
+    if (missingRedirects.length)
+      console.error(`Missing redirects:\n${formatTree(missingRedirects)}`)
+
+    // Check if each redirect rule have a package
+    const missingPackages = redirectsKeys.filter(name => !packages.includes(name))
+
+    if (missingPackages.length)
+      console.error(`Missing packages:\n${formatTree(missingPackages)}`)
+
+    if (missingRedirects.length || missingPackages.length)
+      return exit(1)
+
+    return exit(0)
+  },
+})

bin/commands/check/puzzle.ts

@@ -0,0 +1,43 @@
+import { exit } from 'node:process'
+import { defineCommand } from 'citty'
+import { consola } from 'consola'
+import { getPackages } from '../../utils/content'
+import { getPuzzleParts } from '../../utils/public'
+import { formatTree } from '../../utils/format'
+
+export const puzzle = defineCommand({
+  meta: {
+    name: 'puzzle',
+  },
+  run: () => {
+    const packages = getPackages()
+    const puzzleParts = getPuzzleParts()
+
+    // Check if each package have a puzzle part (light and dark)
+    const packagesWithoutLightPuzzlePart = packages.filter(name => !puzzleParts.light.includes(name))
+
+    if (packagesWithoutLightPuzzlePart.length)
+      consola.error(`A light puzzle part is needed:\n${formatTree(packagesWithoutLightPuzzlePart)}`)
+
+    const packagesWithoutDarkPuzzlePart = packages.filter(name => !puzzleParts.dark.includes(name))
+
+    if (packagesWithoutDarkPuzzlePart.length)
+      consola.error(`A dark puzzle part is needed:\n${formatTree(packagesWithoutDarkPuzzlePart)}`)
+
+    // Check if each puzzle part (light and dark) have a package
+    const lightPuzzlePartsWithoutPackage = puzzleParts.light.filter(name => !packages.includes(name))
+
+    if (lightPuzzlePartsWithoutPackage.length)
+      consola.error(`A package (from light) is needed:\n${formatTree(lightPuzzlePartsWithoutPackage)}`)
+
+    const darkPuzzlePartsWithoutPackage = puzzleParts.dark.filter(name => !packages.includes(name))
+
+    if (darkPuzzlePartsWithoutPackage.length)
+      consola.error(`A package (from dark) is needed:\n${formatTree(darkPuzzlePartsWithoutPackage)}`)
+
+    if (packagesWithoutLightPuzzlePart.length || packagesWithoutDarkPuzzlePart.length || lightPuzzlePartsWithoutPackage.length || darkPuzzlePartsWithoutPackage.length)
+      return exit(1)
+
+    return exit(0)
+  },
+})

bin/commands/generate.ts

@@ -0,0 +1,10 @@
+import { defineCommand } from 'citty'
+
+export const generate = defineCommand({
+  meta: {
+    name: 'Generate',
+  },
+  subCommands: {
+    'releases-article': () => import('./generate/releases-article').then(m => m.releasesArticle),
+  },
+})

scripts/releases-article.ts bin/commands/generate/releases-article.tsscripts/releases-article.ts renamed to bin/commands/generate/releases-article.ts

@@ -1,73 +1,91 @@
-import { exit } from 'node:process'
-import fs from 'node:fs'
-import { consola } from 'consola'
-import { fetchReleases, fetchRepos } from './utils/github'
-import type { GithubRelease } from './types'
-
-/**
- * This script is used to fetch all releases from UnJS packages to create a draft for an article to publish on our blog.
- */
-async function main() {
-  const repos = await fetchRepos()
-
-  const releases = await fetchReleases(repos)
-
-  const today = new Date()
-  const currentYear = today.getFullYear()
-  const currentMonth = today.getMonth() + 1
-  // Filter releases to only keep the ones from the current year and month
-  const releasesFromCurrentMonth = releases.reduce((acc, releases) => {
-    const filtered = releases.releases.filter((release) => {
-      const releaseDate = new Date(release.publishedAt)
-      const releaseYear = releaseDate.getFullYear()
-      const releaseMonth = releaseDate.getMonth() + 1
-
-      return releaseYear === currentYear && releaseMonth === currentMonth && release.prerelease === false && release.draft === false
-    })
-
-    if (filtered.length > 0) {
-      acc.push({
-        ...releases,
-        releases: filtered,
-      })
-    }
-
-    return acc
-  }, [] as { name: string, releases: GithubRelease[] }[]).sort((a, b) => a.name.localeCompare(b.name))
-
-  const numberOfReleases = releasesFromCurrentMonth.reduce((acc, releases) => acc + releases.releases.length, 0)
-
-  // Create the article (draft)
-  const currentMonthName = today.toLocaleString('default', { month: 'long' })
-  const currentDay = today.getDate()
-  const filename = `${currentYear}-${currentMonth}-${currentDay}-${currentMonthName.toLocaleLowerCase()}-monthly-updates.md`
-  const title = `Monthly updates (${currentMonthName} ${currentYear})`
+import { writeFileSync } from 'node:fs'
+import { defineCommand } from 'citty'
+import { fetchReleases, fetchRepos } from '../../utils/github'
+import { getCurrentMonth, getCurrentYear } from '../../utils/date'
+import { getBlogPath } from '../../utils/content'
+import type { GithubRelease } from '../../types'
+
+export const releasesArticle = defineCommand({
+  meta: {
+    name: 'releases-article',
+    description: 'Generate an article with all releases of the current month',
+  },
+  async run() {
+    const blogPath = getBlogPath()
+
+    const currentMonth = getCurrentMonth()
+    const currentYear = getCurrentYear()
+
+    /**
+     * Retrieve correct data
+     */
+
+    const repos = await fetchRepos()
+    const releases = await fetchReleases(repos)
+
+    const currentReleases = releases.reduce((acc, _releases) => {
+      const filtered = getMonthReleases(_releases.releases, currentYear, currentMonth)
+
+      if (filtered.length) {
+        acc.push({
+          ..._releases,
+          releases: filtered,
+        })
+      }
 
-  const article = /* md */`---
+      return acc
+    }, [] as { name: string, releases: GithubRelease[] }[]).sort((a, b) => a.name.localeCompare(b.name))
+
+    const numberOfReleases = currentReleases.reduce((acc, releases) => acc + releases.releases.length, 0)
+
+    /**
+     * Create the article
+     */
+    const today = new Date()
+    const currentMonthName = today.toLocaleString('default', { month: 'long' })
+    const currentDay = today.getDate()
+    const filename = `${currentYear}-${currentMonth.toLocaleString('en-US', {
+    minimumIntegerDigits: 2,
+    useGrouping: false,
+  })}-${currentDay.toLocaleString('en-US', {
+    minimumIntegerDigits: 2,
+    useGrouping: false,
+  })}-${currentMonthName.toLocaleLowerCase()}-monthly-updates.md`
+    const title = `Monthly updates (${currentMonthName} ${currentYear})`
+    const article = /* md */`---
 title: ${title}
 description: ${numberOfReleases} releases this month! What's new in the UnJS ecosystem?
-image:
-  src:
-  alt:
 authors:
   - name:
     picture:
     twitter:
 category:
   - releases
 packages:
-  - ${releasesFromCurrentMonth.map(releases => releases.name).join('\n  - ')}
+  - ${currentReleases.map(releases => releases.name).join('\n  - ')}
 publishedAt: ${today.toISOString()}
 modifiedAt: ${today.toISOString()}
-layout: blog-post
 ---
 
-${releasesFromCurrentMonth.map(releases => `## ${releases.name}\n\nThis month, we release ${releases.releases.length} new ${releases.releases.length > 1 ? 'releases' : 'release'} (${logReleasesTypes(releases.releases)}):\n\n${releases.releases.map(release => `- [${release.tag}](https://github.com/unjs/${releases.name}/releases/tag/${release.tag})`).join('\n')}\n\n${formatReleasesMarkdown(releases.releases)}`).join('\n\n')}`
+${currentReleases.map(releases => `## ${releases.name}\n\nThis month, we release ${releases.releases.length} new ${releases.releases.length > 1 ? 'releases' : 'release'} (${logReleasesTypes(releases.releases)}):\n\n${releases.releases.map(release => `- [${release.tag}](https://github.com/unjs/${releases.name}/releases/tag/${release.tag})`).join('\n')}\n\n${formatReleasesMarkdown(releases.releases)}`).join('\n\n')}`
 
-  fs.writeFileSync(`./content/5.blog/${filename}`, article)
-}
+    // An article is a list of repo where each repo have a list releases and then, the changelog of each release.
+    writeFileSync(`${blogPath}/${filename}`, article)
+  },
+})
 
-main().then(() => exit(0)).catch(consola.error)
+/**
+ * Extract releases from a specific month and year
+ */
+function getMonthReleases(releases: GithubRelease[], year: number, month: number): GithubRelease[] {
+  return releases.filter((release) => {
+    const releaseDate = new Date(release.publishedAt)
+    const releaseYear = releaseDate.getFullYear()
+    const releaseMonth = releaseDate.getMonth() + 1
+
+    return releaseYear === year && releaseMonth === month && release.prerelease === false && release.draft === false
+  })
+}
 
 function logReleasesTypes(releases: GithubRelease[]): string {
   const majorReleases = releases.filter(release => release.tag.endsWith('.0.0'))
@@ -154,7 +172,7 @@ function formatLine(line: string): string {
  * Standardize title using h3, removing emoji like 🚀 and lowercase
  */
 function formatTitle(line: string): string {
-  return `### ${line.replace(/#+\s*/, '').replace(/[🚀🚨🐞🩹📖]/u, '').toLowerCase().trim()}`
+  return `### ${line.replace(/#+\s*/, '').replace(/[🚀🚨🐞🩹📖💅🌊]/u, '').toLowerCase().trim()}`
 }
 
 /**

bin/commands/github.ts

@@ -0,0 +1,11 @@
+import { defineCommand } from 'citty'
+
+export const github = defineCommand({
+  meta: {
+    name: 'github',
+    description: 'Command that will impact GitHub',
+  },
+  subCommands: {
+    'sync-packages': () => import('./github/sync-packages').then(m => m.syncPackages),
+  },
+})