Allow custom file patterns for file size analysis

.github/workflows/scripts/comments.mjs

@@ -1,6 +1,6 @@
 import { readFile } from 'node:fs/promises'
 
-import { getFileSizes, getStats, modulePaths } from '@govuk-frontend/stats'
+import { getFileSizes, getStats, modulePaths } from '@govuk-frontend/lib'
 import { filesize } from 'filesize'
 
 /**
@@ -79,7 +79,11 @@ export async function commentStats(
 
  // File sizes
  const fileSizeTitle = '### File sizes'
- const fileSizes = await getFileSizes()
+ const distFileSizes = await getFileSizes('dist/**/*(!(*.map))')
+ const packageFileSizes = await getFileSizes(
+ 'packages/govuk-frontend/dist/govuk/*(!(*.map))'
+ )
+ const fileSizes = distFileSizes.concat(packageFileSizes)
  const fileSizeRows = Object.entries(fileSizes).map(([key, value]) => {
  return [key, String(filesize(value.size, { base: 2 }))]
  })

.github/workflows/scripts/package.json

@@ -8,7 +8,7 @@
  },
  "license": "MIT",
  "dependencies": {
- "@govuk-frontend/stats": "*",
+ "@govuk-frontend/lib": "*",
  "filesize": "^10.0.8"
  }
 }

shared/lib/files.js

@@ -1,4 +1,4 @@
-const { readFile } = require('fs/promises')
+const { readFile, stat } = require('fs/promises')
 const { parse, relative, basename } = require('path')
 
 const { paths } = require('@govuk-frontend/config')
@@ -45,6 +45,24 @@ async function getDirectories(directoryPath) {
  return listing.map((directoryPath) => basename(directoryPath)).sort()
 }
 
+/**
+ * Get file sizes
+ *
+ * @returns {Promise<{[key: string]: import('fs').Stats}>} - File names and size
+ */
+async function getFileSizes(directoryPath, ignore) {
+ const filesForAnalysis = await getListing(directoryPath, { ignore })
+
+ const result = {}
+
+ for (const filename of filesForAnalysis) {
+ const stats = await stat(filename)
+ result[filename] = stats
+ }
+
+ return result
+}
+
 /**
  * Directory listing array filter
  * Returns true for files matching every pattern
@@ -84,6 +102,7 @@ async function getYaml(configPath) {
 module.exports = {
  filterPath,
  getDirectories,
+ getFileSizes,
  getListing,
  getYaml,
  mapPathTo

shared/stats/src/index.mjs

@@ -1,7 +1,6 @@
-import { stat } from 'fs/promises'
 import { join, parse } from 'path'
 
-import { paths, pkg } from '@govuk-frontend/config'
+import { paths } from '@govuk-frontend/config'
 import { getComponentNamesFiltered } from '@govuk-frontend/lib/components'
 import { filterPath, getYaml } from '@govuk-frontend/lib/files'
 
@@ -14,17 +13,6 @@ const componentNamesWithJavaScript = await getComponentNamesFiltered(
  { moduleRoot: paths.stats }
 )
 
-/**
- * Target files for file size analysis
- */
-const filesForAnalysis = [
- `dist/govuk-frontend-${pkg.version}.min.js`,
- `dist/govuk-frontend-${pkg.version}.min.css`,
- 'packages/govuk-frontend/dist/govuk/all.mjs',
- 'packages/govuk-frontend/dist/govuk/all.bundle.mjs',
- 'packages/govuk-frontend/dist/govuk/all.bundle.js'
-]
-
 /**
  * Package options
  *
@@ -73,23 +61,6 @@ export async function getStats(modulePath) {
  return { total, modules, moduleCount }
 }
 
-/**
- * Returns file sizes of key files
- *
- * @returns {Promise<{[key: string]: import('fs').Stats}>} - File names and size
- */
-export async function getFileSizes() {
- /** @type { { [key: string]: import('fs').Stats } } */
- const result = {}
-
- for (const filename of filesForAnalysis) {
- const stats = await stat(join(paths.root, filename))
- result[filename] = stats
- }
-
- return result
-}
-
 /**
  * @typedef {{ [modulePath: string]: { rendered: number } }} ModulesList
  */