Merge branch 'main' into better-docs

.github/workflows/check-dist.yml

@@ -18,6 +18,11 @@ on:
 permissions:
   contents: read
 
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
 jobs:
   check-dist:
     runs-on: ubuntu-latest

.github/workflows/check-formatting.yml

@@ -0,0 +1,34 @@
+name: Checking formatting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.JS
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Verify formatting
+        run: npm run format:check

.github/workflows/draft-release.yml

@@ -4,6 +4,9 @@ on:
     branches:
       - main
 
+permissions:
+  contents: write
+
 jobs:
   draft-release:
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -6,6 +6,14 @@ on:
       - main
   pull_request:
 
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest

.prettierrc.yml

@@ -1,10 +1,10 @@
 # Prettier (formatter) configuration
 ---
-printWidth: 80
+printWidth: 120
 tabWidth: 2
 useTabs: false
 semi: false
 singleQuote: true
 trailingComma: none
-bracketSpacing: false
+bracketSpacing: true
 arrowParens: avoid

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'

dist/index.js

@@ -14559,7 +14559,7 @@ class ConfigParser {
   // Ctor
   // - configurationFile: path to the configuration file
   // - blankConfigurationFile: a blank configuration file to use if non was previously found
-  constructor({configurationFile, blankConfigurationFile, properties}) {
+  constructor({ configurationFile, blankConfigurationFile, properties }) {
     // Save field
     this.configurationFile = configurationFile
     this.properties = properties
@@ -14584,16 +14584,32 @@ class ConfigParser {
   // Return the configuration object or null.
   findConfigurationObject(ast) {
     // Try to find a default export
-    var defaultExport = ast.body.find(
+    var defaultExport = ast.body.find(node => node.type === 'ExportDefaultDeclaration')
-      node =>
+
-        node.type === 'ExportDefaultDeclaration' &&
+    // Direct default export
-        node.declaration.type === 'ObjectExpression'
+    if (defaultExport && defaultExport.declaration.type === 'ObjectExpression') {
-    )
+      core.info('Found configuration object in direct default export declaration')
-    if (defaultExport) {
-      core.info('Found configuration object in default export declaration')
       return defaultExport.declaration
     }
 
+    // Indirect default export
+    else if (defaultExport && defaultExport.declaration.type === 'Identifier') {
+      const identifierName = defaultExport.declaration.name
+      const identifierDefinition = ast.body.find(
+        node =>
+          node.type === 'VariableDeclaration' &&
+          node.declarations.length == 1 &&
+          node.declarations[0].type === 'VariableDeclarator' &&
+          node.declarations[0].id.type === 'Identifier' &&
+          node.declarations[0].id.name === identifierName &&
+          node.declarations[0].init.type === 'ObjectExpression'
+      )
+      if (identifierDefinition) {
+        core.info('Found configuration object in indirect default export declaration')
+        return identifierDefinition.declarations[0].init
+      }
+    }
+
     // Try to find a module export
     var moduleExport = ast.body.find(
       node =>
@@ -14608,19 +14624,13 @@ class ConfigParser {
     )
 
     // Direct module export
-    if (
+    if (moduleExport && moduleExport.expression.right.type === 'ObjectExpression') {
-      moduleExport &&
-      moduleExport.expression.right.type === 'ObjectExpression'
-    ) {
       core.info('Found configuration object in direct module export')
       return moduleExport.expression.right
     }
 
     // Indirect module export
-    else if (
+    else if (moduleExport && moduleExport.expression.right.type === 'Identifier') {
-      moduleExport &&
-      moduleExport.expression.right.type === 'Identifier'
-    ) {
       const identifierName = moduleExport && moduleExport.expression.right.name
       const identifierDefinition = ast.body.find(
         node =>
@@ -14648,9 +14658,7 @@ class ConfigParser {
     // Try to find a property matching a given name
     const property =
       object.type === 'ObjectExpression' &&
-      object.properties.find(
+      object.properties.find(node => node.key.type === 'Identifier' && node.key.name === name)
-        node => node.key.type === 'Identifier' && node.key.name === name
-      )
 
     // Return the property's value (if found) or null
     if (property) {
@@ -14670,9 +14678,7 @@ class ConfigParser {
       return `${properties[startIndex]}: ${JSON.stringify(propertyValue)}`
     } else {
       return (
-        `${properties[startIndex]}: {` +
+        `${properties[startIndex]}: {` + this.getPropertyDeclaration(properties, startIndex + 1, propertyValue) + '}'
-        this.getPropertyDeclaration(properties, startIndex + 1, propertyValue) +
-        '}'
       )
     }
   }
@@ -14711,7 +14717,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])
 
@@ -14750,11 +14756,7 @@ class ConfigParser {
     // Create nested properties in the configuration file
     else {
       // Build the declaration to inject
-      const declaration = this.getPropertyDeclaration(
+      const declaration = this.getPropertyDeclaration(properties, depth, propertyValue)
-        properties,
-        depth,
-        propertyValue
-      )
 
       // The last node identified is an object expression, so do the assignment
       if (lastNode.type === 'ObjectExpression') {
@@ -14801,7 +14803,7 @@ class ConfigParser {
   }
 }
 
-module.exports = {ConfigParser}
+module.exports = { ConfigParser }
 
 
 /***/ }),
@@ -14817,6 +14819,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'
   }
 }
@@ -14833,7 +14836,7 @@ function getContext() {
   return requiredVars
 }
 
-module.exports = {getContext}
+module.exports = { getContext }
 
 
 /***/ }),
@@ -14859,15 +14862,15 @@ module.exports = outputPagesBaseUrl
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
 const core = __nccwpck_require__(2186)
-const {ConfigParser} = __nccwpck_require__(8395)
+const { ConfigParser } = __nccwpck_require__(8395)
 
-// Return the settings to be passed to a {ConfigParser} for a given
+// Return the settings to be passed to a {ConfigParser} for a given static site generator,
-// static site generator and a Pages path value to inject
+// optional configuration file path, and a Pages path value to inject
-function getConfigParserSettings(staticSiteGenerator, path) {
+function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, path }) {
   switch (staticSiteGenerator) {
     case 'nuxt':
       return {
-        configurationFile: './nuxt.config.js',
+        configurationFile: generatorConfigFile || './nuxt.config.js',
         blankConfigurationFile: __nccwpck_require__.ab + "nuxt.js",
         properties: {
           // Configure a base path on the router
@@ -14885,7 +14888,7 @@ function getConfigParserSettings(staticSiteGenerator, path) {
       }
 
       return {
-        configurationFile: './next.config.js',
+        configurationFile: generatorConfigFile || './next.config.js',
         blankConfigurationFile: __nccwpck_require__.ab + "next.js",
         properties: {
           // Configure a base path
@@ -14898,7 +14901,7 @@ function getConfigParserSettings(staticSiteGenerator, path) {
       }
     case 'gatsby':
       return {
-        configurationFile: './gatsby-config.js',
+        configurationFile: generatorConfigFile || './gatsby-config.js',
         blankConfigurationFile: __nccwpck_require__.ab + "gatsby.js",
         properties: {
           // Configure a path prefix
@@ -14911,10 +14914,10 @@ function getConfigParserSettings(staticSiteGenerator, path) {
 }
 
 // Inject Pages configuration in a given static site generator's configuration file
-function setPagesPath({staticSiteGenerator, path}) {
+function setPagesPath({ staticSiteGenerator, generatorConfigFile, path }) {
   try {
     // Parse the configuration file and try to inject the Pages configuration in it
-    const settings = getConfigParserSettings(staticSiteGenerator, path)
+    const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, path })
     new ConfigParser(settings).injectAll()
   } catch (error) {
     // Logging
@@ -14925,7 +14928,7 @@ function setPagesPath({staticSiteGenerator, path}) {
   }
 }
 
-module.exports = {getConfigParserSettings, setPagesPath}
+module.exports = { getConfigParserSettings, setPagesPath }
 
 
 /***/ }),
@@ -16417,13 +16420,13 @@ const outputPagesBaseUrl = __nccwpck_require__(7527)
 
 async function main() {
   try {
-    const { repositoryNwo, githubToken, enablement, staticSiteGenerator } = getContext()
+    const { repositoryNwo, githubToken, enablement, staticSiteGenerator, generatorConfigFile } = getContext()
 
     const pageObject = await findOrCreatePagesSite({ repositoryNwo, githubToken, enablement })
     const siteUrl = new URL(pageObject.html_url)
 
     if (staticSiteGenerator) {
-      setPagesPath({ staticSiteGenerator, path: siteUrl.pathname })
+      setPagesPath({ staticSiteGenerator, generatorConfigFile, path: siteUrl.pathname })
     }
     outputPagesBaseUrl(siteUrl)
   } catch (error) {

package.json

@@ -5,7 +5,9 @@
   "description": "A GitHub Action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as starter workflows.",
   "main": "./dist/index.js",
   "scripts": {
-    "prepare": "ncc build src/index.js -o dist --source-map --license licenses.txt",
+    "format": "prettier --write 'src/**/*.js'",
+    "format:check": "prettier --check 'src/**/*.js'",
+    "prepare": "npm run format && ncc build src/index.js -o dist --source-map --license licenses.txt",
     "test": "jest"
   },
   "repository": {

src/api-client.test.js

@@ -53,9 +53,7 @@ describe('apiClient', () => {
     })
 
     it('handles a 409 response when the page already exists', async () => {
-      jest
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 409 } }))
-        .spyOn(axios, 'post')
-        .mockImplementationOnce(() => Promise.reject({ response: { status: 409 } }))
 
       // Simply assert that no error is raised
       const result = await apiClient.enablePagesSite({
@@ -67,9 +65,7 @@ describe('apiClient', () => {
     })
 
     it('re-raises errors on failure status codes', async () => {
-      jest
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
-        .spyOn(axios, 'post')
-        .mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
 
       let erred = false
       try {
@@ -98,9 +94,7 @@ describe('apiClient', () => {
     })
 
     it('re-raises errors on failure status codes', async () => {
-      jest
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
-        .spyOn(axios, 'get')
-        .mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
 
       let erred = false
       try {
@@ -203,7 +197,8 @@ describe('apiClient', () => {
 
     it('makes second request to get page if create fails because of existence', async () => {
       const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
-      jest.spyOn(axios, 'get')
+      jest
+        .spyOn(axios, 'get')
         .mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
         .mockImplementationOnce(() => Promise.resolve({ status: 200, data: PAGE_OBJECT }))
       jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 409 } }))
@@ -217,5 +212,4 @@ describe('apiClient', () => {
       expect(axios.post).toHaveBeenCalledTimes(1)
     })
   })
-
 })

src/config-parser.js

@@ -31,7 +31,7 @@ class ConfigParser {
   // Ctor
   // - configurationFile: path to the configuration file
   // - blankConfigurationFile: a blank configuration file to use if non was previously found
-  constructor({configurationFile, blankConfigurationFile, properties}) {
+  constructor({ configurationFile, blankConfigurationFile, properties }) {
     // Save field
     this.configurationFile = configurationFile
     this.properties = properties
@@ -56,16 +56,32 @@ class ConfigParser {
   // Return the configuration object or null.
   findConfigurationObject(ast) {
     // Try to find a default export
-    var defaultExport = ast.body.find(
+    var defaultExport = ast.body.find(node => node.type === 'ExportDefaultDeclaration')
-      node =>
+
-        node.type === 'ExportDefaultDeclaration' &&
+    // Direct default export
-        node.declaration.type === 'ObjectExpression'
+    if (defaultExport && defaultExport.declaration.type === 'ObjectExpression') {
-    )
+      core.info('Found configuration object in direct default export declaration')
-    if (defaultExport) {
-      core.info('Found configuration object in default export declaration')
       return defaultExport.declaration
     }
 
+    // Indirect default export
+    else if (defaultExport && defaultExport.declaration.type === 'Identifier') {
+      const identifierName = defaultExport.declaration.name
+      const identifierDefinition = ast.body.find(
+        node =>
+          node.type === 'VariableDeclaration' &&
+          node.declarations.length == 1 &&
+          node.declarations[0].type === 'VariableDeclarator' &&
+          node.declarations[0].id.type === 'Identifier' &&
+          node.declarations[0].id.name === identifierName &&
+          node.declarations[0].init.type === 'ObjectExpression'
+      )
+      if (identifierDefinition) {
+        core.info('Found configuration object in indirect default export declaration')
+        return identifierDefinition.declarations[0].init
+      }
+    }
+
     // Try to find a module export
     var moduleExport = ast.body.find(
       node =>
@@ -80,19 +96,13 @@ class ConfigParser {
     )
 
     // Direct module export
-    if (
+    if (moduleExport && moduleExport.expression.right.type === 'ObjectExpression') {
-      moduleExport &&
-      moduleExport.expression.right.type === 'ObjectExpression'
-    ) {
       core.info('Found configuration object in direct module export')
       return moduleExport.expression.right
     }
 
     // Indirect module export
-    else if (
+    else if (moduleExport && moduleExport.expression.right.type === 'Identifier') {
-      moduleExport &&
-      moduleExport.expression.right.type === 'Identifier'
-    ) {
       const identifierName = moduleExport && moduleExport.expression.right.name
       const identifierDefinition = ast.body.find(
         node =>
@@ -120,9 +130,7 @@ class ConfigParser {
     // Try to find a property matching a given name
     const property =
       object.type === 'ObjectExpression' &&
-      object.properties.find(
+      object.properties.find(node => node.key.type === 'Identifier' && node.key.name === name)
-        node => node.key.type === 'Identifier' && node.key.name === name
-      )
 
     // Return the property's value (if found) or null
     if (property) {
@@ -142,9 +150,7 @@ class ConfigParser {
       return `${properties[startIndex]}: ${JSON.stringify(propertyValue)}`
     } else {
       return (
-        `${properties[startIndex]}: {` +
+        `${properties[startIndex]}: {` + this.getPropertyDeclaration(properties, startIndex + 1, propertyValue) + '}'
-        this.getPropertyDeclaration(properties, startIndex + 1, propertyValue) +
-        '}'
       )
     }
   }
@@ -183,7 +189,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])
 
@@ -222,11 +228,7 @@ class ConfigParser {
     // Create nested properties in the configuration file
     else {
       // Build the declaration to inject
-      const declaration = this.getPropertyDeclaration(
+      const declaration = this.getPropertyDeclaration(properties, depth, propertyValue)
-        properties,
-        depth,
-        propertyValue
-      )
 
       // The last node identified is an object expression, so do the assignment
       if (lastNode.type === 'ObjectExpression') {
@@ -273,4 +275,4 @@ class ConfigParser {
   }
 }
 
-module.exports = {ConfigParser}
+module.exports = { ConfigParser }

src/config-parser.test.js

@@ -1,7 +1,8 @@
 const fs = require('fs')
+const core = require('@actions/core')
 
-const {ConfigParser} = require('./config-parser')
+const { ConfigParser } = require('./config-parser')
-const {getTempFolder, compareFiles} = require('./test-helpers')
+const { getTempFolder, compareFiles } = require('./test-helpers')
 
 // Get the temp folder
 const tempFolder = getTempFolder()
@@ -11,7 +12,6 @@ const cases = [
   //
   // Default export
   //
-
   {
     property: 'property',
     source: `export default {}`,
@@ -89,6 +89,30 @@ const cases = [
     expected: `export default { a2: false, a1: { a2: "value", a3: [12]}}`
   },
 
+  //
+  // Indirect default export
+  //
+  {
+    property: 'property',
+    source: `const config = {}; export default config`,
+    expected: `const config = { property: "value"}; export default config`
+  },
+  {
+    property: 'property',
+    source: `var config = {}; export default config`,
+    expected: `var config = { property: "value"}; export default config`
+  },
+  {
+    property: 'a.b.c',
+    source: `var config = {}; export default config`,
+    expected: `var config = { a: { b: { c: "value"}}}; export default config`
+  },
+  {
+    property: 'a.b.c',
+    source: `var config = { a: { b: [], c: "hello"}}; export default config`,
+    expected: `var config = { a: { b: { c: "value"}, c: "hello"}}; export default config`
+  },
+
   //
   // Direct module exports
   //
@@ -134,15 +158,25 @@ const cases = [
 ]
 
 describe('config-parser', () => {
-  cases.forEach(({property, source, expected}, index) => {
+  beforeEach(() => {
-    it(`Inject path properly for case #${index}`, () => {
+    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(`injects path properly for case #${index}`, () => {
       // Write the source file
       const sourceFile = `${tempFolder}/source.js`
-      fs.writeFileSync(sourceFile, source, {encoding: 'utf8'})
+      fs.writeFileSync(sourceFile, source, { encoding: 'utf8' })
 
       // Write the expected file
       const expectedFile = `${tempFolder}/expected.js`
-      fs.writeFileSync(expectedFile, expected, {encoding: 'utf8'})
+      fs.writeFileSync(expectedFile, expected, { encoding: 'utf8' })
 
       // Update the settings and do the injection
       new ConfigParser({

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'
   }
 }
@@ -22,4 +23,4 @@ function getContext() {
   return requiredVars
 }
 
-module.exports = {getContext}
+module.exports = { getContext }

src/fixtures/gatsby/blank.expected.js

@@ -1,2 +1,2 @@
 // Default Pages configuration for Gatsby
-module.exports = { pathPrefix: "/docs/" }
+module.exports = { pathPrefix: '/docs/' }

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.js

@@ -1,8 +1,8 @@
 module.exports = {
-  pathPrefix: "/docs/",
+  pathPrefix: '/docs/',
   siteMetadata: {
     title: `My Gatsby Site`,
-    siteUrl: `https://www.yourdomain.tld`,
+    siteUrl: `https://www.yourdomain.tld`
   },
-  plugins: [],
+  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.js

@@ -1,7 +1,7 @@
 module.exports = {
   siteMetadata: {
     title: `My Gatsby Site`,
-    siteUrl: `https://www.yourdomain.tld`,
+    siteUrl: `https://www.yourdomain.tld`
   },
-  plugins: [],
+  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/blank.expected.js

@@ -1,6 +1,3 @@
 // Default Pages configuration for Next
-const nextConfig = {
+const nextConfig = { experimental: { images: { unoptimized: true } }, basePath: '/docs' }
-  experimental: {images: {unoptimized: true}},
-  basePath: '/docs'
-}
 module.exports = nextConfig

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.js

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

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.js

@@ -1,7 +1,7 @@
 /** @type {import('next').NextConfig} */
 const nextConfig = {
   reactStrictMode: true,
-  swcMinify: true,
+  swcMinify: true
 }
 
 module.exports = 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.js

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

@@ -1,15 +1,15 @@
-const getAllDynamicRoute = async function() {
+const getAllDynamicRoute = async function () {
   const routes = await (async () => {
-    return ['/posts/hello-world', '/posts/hello-again'];
+    return ['/posts/hello-world', '/posts/hello-again']
-  })();
+  })()
-  return routes;
+  return routes
-};
+}
 
 export default {
   mode: 'universal',
   generate: {
-    async routes () {
+    async routes() {
-      return getAllDynamicRoute();
+      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/blank.expected.js

@@ -1,2 +1,2 @@
 // Default Pages configuration for Nuxt
-export default {target: 'static', router: {base: '/docs/'}}
+export default { target: 'static', router: { base: '/docs/' } }

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.js

@@ -1,7 +1,7 @@
 export default {
   // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
   target: 'static',
-  router: { base: "/docs/" },
+  router: { base: '/docs/' },
   ssr: false,
 
   // Global page headers: https://go.nuxtjs.dev/config-head
@@ -16,31 +16,24 @@ export default {
       { hid: 'description', name: 'description', content: '' },
       { name: 'format-detection', content: 'telephone=no' }
     ],
-    link: [
+    link: [{ rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }]
-      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
-    ]
   },
 
   // Global CSS: https://go.nuxtjs.dev/config-css
-  css: [
+  css: [],
-  ],
 
   // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
-  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: [
+  buildModules: [],
-  ],
 
   // Modules: https://go.nuxtjs.dev/config-modules
-  modules: [
+  modules: [],
-  ],
 
   // Build Configuration: https://go.nuxtjs.dev/config-build
-  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.js

@@ -14,31 +14,24 @@ export default {
       { hid: 'description', name: 'description', content: '' },
       { name: 'format-detection', content: 'telephone=no' }
     ],
-    link: [
+    link: [{ rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }]
-      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
-    ]
   },
 
   // Global CSS: https://go.nuxtjs.dev/config-css
-  css: [
+  css: [],
-  ],
 
   // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
-  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: [
+  buildModules: [],
-  ],
 
   // Modules: https://go.nuxtjs.dev/config-modules
-  modules: [
+  modules: [],
-  ],
 
   // Build Configuration: https://go.nuxtjs.dev/config-build
-  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: {
+  }
+}

src/index.js

@@ -9,13 +9,13 @@ const outputPagesBaseUrl = require('./output-pages-base-url')
 
 async function main() {
   try {
-    const { repositoryNwo, githubToken, enablement, staticSiteGenerator } = getContext()
+    const { repositoryNwo, githubToken, enablement, staticSiteGenerator, generatorConfigFile } = getContext()
 
     const pageObject = await findOrCreatePagesSite({ repositoryNwo, githubToken, enablement })
     const siteUrl = new URL(pageObject.html_url)
 
     if (staticSiteGenerator) {
-      setPagesPath({ staticSiteGenerator, path: siteUrl.pathname })
+      setPagesPath({ staticSiteGenerator, generatorConfigFile, path: siteUrl.pathname })
     }
     outputPagesBaseUrl(siteUrl)
   } catch (error) {

src/output-pages-base-url.test.js

@@ -24,10 +24,7 @@ describe('outputPagesBaseUrl', () => {
     outputPagesBaseUrl(new URL(baseUrl))
 
     expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
-    expect(core.setOutput).toHaveBeenCalledWith(
+    expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://octocat.github.io')
-      'origin',
-      'https://octocat.github.io'
-    )
     expect(core.setOutput).toHaveBeenCalledWith('host', 'octocat.github.io')
     expect(core.setOutput).toHaveBeenCalledWith('base_path', '/')
   })
@@ -38,10 +35,7 @@ describe('outputPagesBaseUrl', () => {
     outputPagesBaseUrl(new URL(baseUrl))
 
     expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
-    expect(core.setOutput).toHaveBeenCalledWith(
+    expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://octocat.github.io')
-      'origin',
-      'https://octocat.github.io'
-    )
     expect(core.setOutput).toHaveBeenCalledWith('host', 'octocat.github.io')
     expect(core.setOutput).toHaveBeenCalledWith('base_path', '/my-repo/')
   })
@@ -52,10 +46,7 @@ describe('outputPagesBaseUrl', () => {
     outputPagesBaseUrl(new URL(baseUrl))
 
     expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
-    expect(core.setOutput).toHaveBeenCalledWith(
+    expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://www.example.com')
-      'origin',
-      'https://www.example.com'
-    )
     expect(core.setOutput).toHaveBeenCalledWith('host', 'www.example.com')
     expect(core.setOutput).toHaveBeenCalledWith('base_path', '/')
   })

src/set-pages-path.js

@@ -1,13 +1,13 @@
 const core = require('@actions/core')
-const {ConfigParser} = require('./config-parser')
+const { ConfigParser } = require('./config-parser')
 
-// Return the settings to be passed to a {ConfigParser} for a given
+// Return the settings to be passed to a {ConfigParser} for a given static site generator,
-// static site generator and a Pages path value to inject
+// optional configuration file path, and a Pages path value to inject
-function getConfigParserSettings(staticSiteGenerator, path) {
+function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, path }) {
   switch (staticSiteGenerator) {
     case 'nuxt':
       return {
-        configurationFile: './nuxt.config.js',
+        configurationFile: generatorConfigFile || './nuxt.config.js',
         blankConfigurationFile: `${__dirname}/blank-configurations/nuxt.js`,
         properties: {
           // Configure a base path on the router
@@ -25,7 +25,7 @@ function getConfigParserSettings(staticSiteGenerator, path) {
       }
 
       return {
-        configurationFile: './next.config.js',
+        configurationFile: generatorConfigFile || './next.config.js',
         blankConfigurationFile: `${__dirname}/blank-configurations/next.js`,
         properties: {
           // Configure a base path
@@ -38,7 +38,7 @@ function getConfigParserSettings(staticSiteGenerator, path) {
       }
     case 'gatsby':
       return {
-        configurationFile: './gatsby-config.js',
+        configurationFile: generatorConfigFile || './gatsby-config.js',
         blankConfigurationFile: `${__dirname}/blank-configurations/gatsby.js`,
         properties: {
           // Configure a path prefix
@@ -51,10 +51,10 @@ function getConfigParserSettings(staticSiteGenerator, path) {
 }
 
 // Inject Pages configuration in a given static site generator's configuration file
-function setPagesPath({staticSiteGenerator, path}) {
+function setPagesPath({ staticSiteGenerator, generatorConfigFile, path }) {
   try {
     // Parse the configuration file and try to inject the Pages configuration in it
-    const settings = getConfigParserSettings(staticSiteGenerator, path)
+    const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, path })
     new ConfigParser(settings).injectAll()
   } catch (error) {
     // Logging
@@ -65,4 +65,4 @@ function setPagesPath({staticSiteGenerator, path}) {
   }
 }
 
-module.exports = {getConfigParserSettings, setPagesPath}
+module.exports = { getConfigParserSettings, setPagesPath }

src/set-pages-path.test.js

@@ -1,53 +1,105 @@
 const fs = require('fs')
 const path = require('path')
+const core = require('@actions/core')
 
-const {getConfigParserSettings} = require('./set-pages-path')
+const { getConfigParserSettings } = require('./set-pages-path')
-const {ConfigParser} = require('./config-parser')
+const { ConfigParser } = require('./config-parser')
-const {getTempFolder, compareFiles} = require('./test-helpers')
+const { getTempFolder, compareFiles } = require('./test-helpers')
 
 // Get the temp folder
 const tempFolder = getTempFolder()
 
+const SUPPORTED_GENERATORS = ['next', 'nuxt', 'gatsby']
+const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
+
 // Test suite
 describe('configParser', () => {
+  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())
+  })
+
   // Iterate over the static site generators
-  ;['next', 'nuxt', 'gatsby'].forEach(staticSiteGenerator => {
+  SUPPORTED_GENERATORS.forEach(staticSiteGenerator => {
     // Folder containing the fixtures for a given static site generator
     const fixtureFolder = `${__dirname}/fixtures/${staticSiteGenerator}`
 
-    // Iterate over the fixtures
+    // Get fixture files, excluding expected results
-    fs.readdirSync(fixtureFolder).forEach(configurationFile => {
+    const configurationFiles = fs.readdirSync(fixtureFolder).filter(filename => !filename.includes('.expected.'))
-      // Ignore expectation
-      if (configurationFile.endsWith('.expected.js')) {
-        return
-      }
 
-      it(`Inject path properly for ${staticSiteGenerator} in ${configurationFile}`, async () => {
+    // Iterate over the fixtures, outputting to default configuration file path
-        // Get settings for the static site generator
+    const defaultFileExtension = '.js'
-        const settings = getConfigParserSettings(staticSiteGenerator, '/docs/')
+    configurationFiles
+      .filter(filename => filename.endsWith(defaultFileExtension))
+      .forEach(configurationFile => {
+        it(`injects path properly for ${staticSiteGenerator} in ${configurationFile} to default configuration file`, async () => {
+          // Copy the source fixture to a temp file
+          const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
+          const fixtureTargetFile = `${tempFolder}/${configurationFile}`
+          if (configurationFile !== 'blank.js') {
+            fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
+          } else if (fs.existsSync(fixtureTargetFile)) {
+            fs.rmSync(fixtureTargetFile)
+          }
 
-        // Copy the source fixture to a temp file
+          // Get settings for the static site generator
-        const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
+          const settings = getConfigParserSettings({ staticSiteGenerator, path: '/docs/' })
-        const fixtureTargetFile = `${tempFolder}/${configurationFile}`
+          // Update the settings
-        if (configurationFile != 'blank.js') {
+          settings.configurationFile = fixtureTargetFile
-          fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
+          // Do the injection
-        } else if (fs.existsSync(fixtureTargetFile)) {
+          new ConfigParser(settings).injectAll()
-          fs.rmSync(fixtureTargetFile)
-        }
 
-        // Update the settings and do the injection
+          // Read the expected file
-        settings.configurationFile = fixtureTargetFile
+          const expectedFile = `${fixtureFolder}/${path.basename(
-        new ConfigParser(settings).injectAll()
+            configurationFile,
+            defaultFileExtension
+          )}.expected${defaultFileExtension}`
 
-        // Read the expected file
+          // Compare the actual and expected files
-        const expectedFile = `${fixtureFolder}/${path.basename(
+          compareFiles(settings.configurationFile, expectedFile)
-          configurationFile,
+        })
-          '.js'
-        )}.expected.js`
-
-        // Compare the actual and expected files
-        compareFiles(settings.configurationFile, expectedFile)
       })
+
+    SUPPORTED_FILE_EXTENSIONS.forEach(fileExtension => {
+      // Iterate over the fixtures, outputting to specified configuration file path
+      configurationFiles
+        .filter(filename => filename.endsWith(fileExtension))
+        .forEach(configurationFile => {
+          it(`injects path properly for ${staticSiteGenerator} in ${configurationFile} to specified *${fileExtension} configuration file`, async () => {
+            // Copy the source fixture to a temp file
+            const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
+            const fixtureTargetFile = `${tempFolder}/${configurationFile}`
+            if (configurationFile !== 'blank.js') {
+              fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
+            } else if (fs.existsSync(fixtureTargetFile)) {
+              fs.rmSync(fixtureTargetFile)
+            }
+
+            // Get settings for the static site generator
+            const settings = getConfigParserSettings({
+              staticSiteGenerator,
+              generatorConfigFile: fixtureTargetFile,
+              path: '/docs/'
+            })
+
+            // Do the injection
+            new ConfigParser(settings).injectAll()
+
+            // Read the expected file
+            const expectedFile = `${fixtureFolder}/${path.basename(
+              configurationFile,
+              fileExtension
+            )}.expected${fileExtension}`
+
+            // Compare the actual and expected files
+            compareFiles(settings.configurationFile, expectedFile)
+          })
+        })
     })
   })
 })

src/test-helpers.js

@@ -6,7 +6,7 @@ const assert = require('assert')
 function getTempFolder() {
   const tmpFolder = `${__dirname}/fixtures/tmp`
   if (!fs.existsSync(tmpFolder)) {
-    fs.mkdirSync(tmpFolder, {recursive: true})
+    fs.mkdirSync(tmpFolder, { recursive: true })
   }
   return tmpFolder
 }
@@ -14,19 +14,21 @@ function getTempFolder() {
 // Read a JavaScript file and return it formatted
 function formatFile(file) {
   const fileContent = fs.readFileSync(file, 'utf8')
-  return prettier.format(fileContent, {
+  return prettier
-    parser: 'espree',
+    .format(fileContent, {
+      parser: 'espree',
 
-    // Prettier options
+      // Prettier options
-    printWidth: 80,
+      printWidth: 120,
-    tabWidth: 2,
+      tabWidth: 2,
-    useTabs: false,
+      useTabs: false,
-    semi: false,
+      semi: false,
-    singleQuote: true,
+      singleQuote: true,
-    trailingComma: 'none',
+      trailingComma: 'none',
-    bracketSpacing: false,
+      bracketSpacing: true,
-    arrowParens: 'avoid'
+      arrowParens: 'avoid'
-  }).trim()
+    })
+    .trim()
 }
 
 // Compare two JavaScript files
@@ -34,4 +36,4 @@ function compareFiles(actualFile, expectedFile) {
   assert.equal(formatFile(actualFile), formatFile(expectedFile))
 }
 
-module.exports = {getTempFolder, formatFile, compareFiles}
+module.exports = { getTempFolder, formatFile, compareFiles }