Add support for specifying the target generator config file

action.yml

@@ -6,7 +6,10 @@ runs:
   main: 'dist/index.js'
 inputs:
   static_site_generator:
-    description: 'Optional static site generator to attempt to configure (nuxt, next or gatsby)'
+    description: 'Optional static site generator to attempt to configure: "nuxt", "next", or "gatsby"'
+    required: false
+  generator_config_file:
+    description: 'Optional file path to static site generator configuration file'
     required: false
   token:
     description: 'GitHub token'

src/config-parser.js

@@ -171,7 +171,7 @@ class ConfigParser {
     var depth = 0
     const properties = propertyName.split('.')
     var lastNode = configurationObject
-    while (1) {
+    while (true) {
       // Find the node for the current property
       var propertyNode = this.findProperty(lastNode, properties[depth])
 

src/config-parser.test.js

@@ -1,4 +1,5 @@
 const fs = require('fs')
+const core = require('@actions/core')
 
 const { ConfigParser } = require('./config-parser')
 const { getTempFolder, compareFiles } = require('./test-helpers')
@@ -134,8 +135,18 @@ const cases = [
 ]
 
 describe('config-parser', () => {
+  beforeEach(() => {
+    jest.restoreAllMocks()
+
+    // Mock error/warning/info/debug to silence their output
+    jest.spyOn(core, 'error').mockImplementation(jest.fn())
+    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
+    jest.spyOn(core, 'info').mockImplementation(jest.fn())
+    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
+  })
+
   cases.forEach(({ property, source, expected }, index) => {
-    it(`Inject path properly for case #${index}`, () => {
+    it(`injects path properly for case #${index}`, () => {
       // Write the source file
       const sourceFile = `${tempFolder}/source.js`
       fs.writeFileSync(sourceFile, source, { encoding: 'utf8' })

src/context.js

@@ -6,6 +6,7 @@ function getRequiredVars() {
     repositoryNwo: process.env.GITHUB_REPOSITORY,
     githubToken: core.getInput('token'),
     staticSiteGenerator: core.getInput('static_site_generator'),
+    generatorConfigFile: core.getInput('generator_config_file'),
     enablement: core.getInput('enablement') !== 'false'
   }
 }

src/fixtures/gatsby/default.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/gatsby/default.expected.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+  pathPrefix: "/docs/",
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/gatsby/default.expected.mjs

@@ -0,0 +1,8 @@
+export default {
+  pathPrefix: "/docs/",
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/gatsby/default.mjs

@@ -0,0 +1,7 @@
+export default {
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/next/default.cjs

@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true,
+}
+
+module.exports = nextConfig

src/fixtures/next/default.expected.cjs

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {images: {unoptimized: true}},
+  basePath: '/docs',
+  reactStrictMode: true,
+  swcMinify: true
+}
+
+module.exports = nextConfig

src/fixtures/next/default.expected.mjs

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {images: {unoptimized: true}},
+  basePath: '/docs',
+  reactStrictMode: true,
+  swcMinify: true
+}
+
+export default nextConfig

src/fixtures/next/default.mjs

@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true,
+}
+
+export default nextConfig

src/fixtures/nuxt/async.cjs

@@ -0,0 +1,15 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+module.exports = {
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/async.expected.cjs

@@ -0,0 +1,17 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+module.exports = {
+  target: 'static',
+  router: {base: '/docs/'},
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/async.expected.mjs

@@ -0,0 +1,17 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+export default {
+  target: 'static',
+  router: {base: '/docs/'},
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/async.mjs

@@ -0,0 +1,15 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+export default {
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/default.cjs

@@ -0,0 +1,44 @@
+module.exports = {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/nuxt/default.expected.cjs

@@ -0,0 +1,46 @@
+module.exports = {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  target: 'static',
+  router: { base: "/docs/" },
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/nuxt/default.expected.mjs

@@ -0,0 +1,46 @@
+export default {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  target: 'static',
+  router: { base: "/docs/" },
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/nuxt/default.mjs

@@ -0,0 +1,44 @@
+export default {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}