refactor: split reading angular version out to separate helper function

Author: pieh

src/helpers/getAngularVersion.js

@@ -0,0 +1,22 @@
+const { readJSON } = require('fs-extra')
+
+/**
+ * Get Angular version from package.json.
+ * @param {string} root
+ * @returns {Promise<string | undefined>}
+ */
+const getAngularVersion = async function (root) {
+  let packagePath
+  try {
+    // eslint-disable-next-line n/no-missing-require
+    packagePath = require.resolve('@angular/core/package.json', { paths: [root] })
+  } catch {
+    // module not found
+    return
+  }
+
+  const { version } = await readJSON(packagePath)
+  return version
+}
+
+module.exports = getAngularVersion

src/helpers/validateAngularVersion.js

@@ -1,23 +1,16 @@
-const { readJSON } = require('fs-extra')
 const { satisfies } = require('semver')
 
 /**
  * Ensure site is using Angular v17+.
- * @param {string} root
- * @returns {Promise<boolean>}
+ * @param {string | undefined} version
+ * @returns {boolean}
  */
-const validateAngularVersion = async function (root) {
-  let packagePath
-  try {
-    // eslint-disable-next-line n/no-missing-require
-    packagePath = require.resolve('@angular/core/package.json', { paths: [root] })
-  } catch {
-    // module not found
+const validateAngularVersion = function (version) {
+  if (!version) {
     console.warn('This site does not seem to be using Angular.')
     return false
   }
 
-  const { version } = await readJSON(packagePath)
   if (!satisfies(version, '>=17.0.0-rc', { includePrerelease: true })) {
     console.warn(`This site does not seem to be using Angular 17 or later. Found: ${version}.`)
     return false

src/index.js

@@ -2,6 +2,7 @@ const ensureNoCompetingPlugin = require('./helpers/ensureNoCompetingPlugin')
 const fixOutputDir = require('./helpers/fixOutputDir')
 const getAngularJson = require('./helpers/getAngularJson')
 const getAngularRoot = require('./helpers/getAngularRoot')
+const getAngularVersion = require('./helpers/getAngularVersion')
 const { setUpEdgeFunction } = require('./helpers/setUpEdgeFunction')
 const validateAngularVersion = require('./helpers/validateAngularVersion')
 
@@ -11,7 +12,8 @@ module.exports = {
   async onPreBuild({ netlifyConfig, utils, constants }) {
     const { failBuild, failPlugin } = utils.build
     const siteRoot = getAngularRoot({ failBuild, netlifyConfig })
-    isValidAngularProject = await validateAngularVersion(siteRoot)
+    const angularVersion = await getAngularVersion(siteRoot)
+    isValidAngularProject = validateAngularVersion(angularVersion)
     if (!isValidAngularProject) {
       console.warn('Skipping build plugin.')
       return

tests/integration.test.mjs

@@ -6,6 +6,7 @@ import { fileURLToPath } from 'node:url'
 
 import build from '@netlify/build'
 
+import getAngularVersion from '../src/helpers/getAngularVersion.js'
 import validateAngularVersion from '../src/helpers/validateAngularVersion.js'
 
 test('project without angular config file fails the plugin execution but does not error', async () => {
@@ -95,21 +96,21 @@ test('Angular 19 using App Engine (Developer Preview)', async () => {
 })
 
 test('checks version for angular 19', async () => {
-  const result = await validateAngularVersion('tests/fixtures/angular-19-common-engine')
+  const result = validateAngularVersion(await getAngularVersion('tests/fixtures/angular-19-common-engine'))
   assert.strictEqual(result, true)
 })
 
 test('checks version for angular 18', async () => {
-  const result = await validateAngularVersion('tests/fixtures/application-builder')
+  const result = validateAngularVersion(await getAngularVersion('tests/fixtures/application-builder'))
   assert.strictEqual(result, true)
 })
 
 test('checks version for angular 17', async () => {
-  const result = await validateAngularVersion('tests/fixtures/angular-17')
+  const result = validateAngularVersion(await getAngularVersion('tests/fixtures/angular-17'))
   assert.strictEqual(result, true)
 })
 
 test('fails angular version validation when angular dependencies are missing', async () => {
-  const result = await validateAngularVersion('missing-angular-deps')
+  const result = validateAngularVersion(await getAngularVersion('missing-angular-deps'))
   assert.strictEqual(result, false)
 })