mirror of
https://github.com/actions/configure-pages.git
synced 2026-03-29 09:24:52 +00:00
Compare commits
44 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5992ce8fd5 | ||
|
|
c8deda3832 | ||
|
|
5d8963e8a5 | ||
|
|
529ba710d5 | ||
|
|
29e9dd5abe | ||
|
|
c450a282d7 | ||
|
|
6567d4c154 | ||
|
|
aba1aa6bab | ||
|
|
6a80311a73 | ||
|
|
380c12d4cc | ||
|
|
c5a3e1159e | ||
|
|
a069fede0c | ||
|
|
2f460cfbe0 | ||
|
|
e5c1ee9f14 | ||
|
|
7fea7010df | ||
|
|
34521f23a5 | ||
|
|
d84b27279d | ||
|
|
5650def507 | ||
|
|
0c2178e929 | ||
|
|
948e60fb96 | ||
|
|
1305a1ba92 | ||
|
|
b94e9adb36 | ||
|
|
fc8c2c4e6e | ||
|
|
e978eba337 | ||
|
|
343cb08233 | ||
|
|
f87a94c875 | ||
|
|
7eb40247a7 | ||
|
|
86f141f32d | ||
|
|
76b6a8292e | ||
|
|
8e221f24db | ||
|
|
d897860efd | ||
|
|
24270f0cca | ||
|
|
0c3c14948a | ||
|
|
b0c19d0de9 | ||
|
|
51323db177 | ||
|
|
3d9811d6e2 | ||
|
|
9c3b6344a2 | ||
|
|
97fb35057c | ||
|
|
c917d1c3cd | ||
|
|
ffa824f004 | ||
|
|
d4a76d1ee1 | ||
|
|
bd8a5da49f | ||
|
|
5cb77813a2 | ||
|
|
2094727a1b |
6
.github/dependabot.yml
vendored
Normal file
6
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: 'github-actions'
|
||||
directory: '/'
|
||||
schedule:
|
||||
interval: 'weekly'
|
||||
2
.github/workflows/draft-release.yml
vendored
2
.github/workflows/draft-release.yml
vendored
@@ -11,7 +11,7 @@ jobs:
|
||||
draft-release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- uses: release-drafter/release-drafter@v5
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
@@ -24,7 +24,7 @@ jobs:
|
||||
steps:
|
||||
- name: Update the ${{ env.TAG_NAME }} tag
|
||||
id: update-major-tag
|
||||
uses: actions/publish-action@v0.1.0
|
||||
uses: actions/publish-action@v0.2.2
|
||||
with:
|
||||
source-tag: ${{ env.TAG_NAME }}
|
||||
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
|
||||
|
||||
@@ -16,8 +16,8 @@ inputs:
|
||||
default: ${{ github.token }}
|
||||
required: true
|
||||
enablement:
|
||||
description: 'Should a Pages site be enabled for the repository if not so already?'
|
||||
default: 'true'
|
||||
description: 'Should a Pages site be enabled for the repository if not so already? This will only work with user-to-server tokens.'
|
||||
default: 'false'
|
||||
required: false
|
||||
outputs:
|
||||
base_url:
|
||||
|
||||
244
dist/index.js
vendored
244
dist/index.js
vendored
@@ -15271,7 +15271,7 @@ Pages's path based routing (and work).
|
||||
|
||||
Supported configuration initializations:
|
||||
|
||||
(1) Default export:
|
||||
(1) Direct default export:
|
||||
|
||||
export default {
|
||||
// configuration object here
|
||||
@@ -15283,19 +15283,69 @@ Supported configuration initializations:
|
||||
// configuration object here
|
||||
}
|
||||
|
||||
(3) Indirect module export:
|
||||
(3) Indirect default export:
|
||||
|
||||
const config = // configuration object here
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
export default config
|
||||
|
||||
(4) Indirect module export:
|
||||
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
module.exports = config
|
||||
|
||||
(5) Direct default export with wrapping call:
|
||||
|
||||
export default defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
|
||||
(6) Direct module export with wrapping call:
|
||||
|
||||
module.exports = defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
|
||||
(7) Indirect default export with wrapping call at the definition:
|
||||
|
||||
const config = defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
export default config
|
||||
|
||||
(8) Indirect default export with wrapping call at the export:
|
||||
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
export default defineConfig(config)
|
||||
|
||||
(9) Indirect module export with wrapping call at the definition:
|
||||
|
||||
const config = defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
module.exports = config
|
||||
|
||||
(10) Indirect module export with wrapping call at the export:
|
||||
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
module.exports = defineConfig(config)
|
||||
*/
|
||||
|
||||
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, allowWrappingCall = false, properties }) {
|
||||
// Save field
|
||||
this.configurationFile = configurationFile
|
||||
this.allowWrappingCall = allowWrappingCall === true
|
||||
this.properties = properties
|
||||
|
||||
// If the configuration file does not exist, initialize it with the blank configuration file
|
||||
@@ -15311,12 +15361,43 @@ class ConfigParser {
|
||||
this.configuration = fs.readFileSync(this.configurationFile, 'utf8')
|
||||
}
|
||||
|
||||
findTopLevelVariableDeclarator(ast, identifierName) {
|
||||
let targetDeclarator
|
||||
ast.body.find(
|
||||
node =>
|
||||
node.type === 'VariableDeclaration' &&
|
||||
node.declarations &&
|
||||
node.declarations.length > 0 &&
|
||||
node.declarations.find(declarator => {
|
||||
if (
|
||||
declarator.type === 'VariableDeclarator' &&
|
||||
declarator.id &&
|
||||
declarator.id.type === 'Identifier' &&
|
||||
declarator.id.name === identifierName
|
||||
) {
|
||||
targetDeclarator = declarator
|
||||
return true
|
||||
}
|
||||
})
|
||||
)
|
||||
return targetDeclarator
|
||||
}
|
||||
|
||||
// Find the configuration object in an AST.
|
||||
// Look for a default export, a direct module export or an indirect module
|
||||
// export (in that order).
|
||||
// Look for, in order:
|
||||
// - a direct default export
|
||||
// - a direct default export with a wrapping call
|
||||
// - an indirect default export
|
||||
// - an indirect default export with a wrapping call at the definition
|
||||
// - an indirect default export with a wrapping call at the export
|
||||
// - a direct module export
|
||||
// - a direct module export with a wrapping call
|
||||
// - an indirect module export
|
||||
// - an indirect module export with a wrapping call at the definition
|
||||
// - an indirect module export with a wrapping call at the export
|
||||
//
|
||||
// Return the configuration object or null.
|
||||
findConfigurationObject(ast) {
|
||||
findConfigurationObject(ast, allowWrappingCall = false) {
|
||||
// Try to find a default export
|
||||
var defaultExport = ast.body.find(node => node.type === 'ExportDefaultDeclaration')
|
||||
|
||||
@@ -15326,21 +15407,61 @@ class ConfigParser {
|
||||
return defaultExport.declaration
|
||||
}
|
||||
|
||||
// Direct default export with a wrapping call
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
defaultExport &&
|
||||
defaultExport.declaration.type === 'CallExpression' &&
|
||||
defaultExport.declaration.arguments.length > 0 &&
|
||||
defaultExport.declaration.arguments[0] &&
|
||||
defaultExport.declaration.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info('Found configuration object in direct default export declaration with a wrapping call')
|
||||
return defaultExport.declaration.arguments[0]
|
||||
}
|
||||
|
||||
// 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) {
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info('Found configuration object in indirect default export declaration')
|
||||
return identifierDefinition.declarations[0].init
|
||||
return identifierInitialization
|
||||
}
|
||||
// Indirect default export with a wrapping call at the definition
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
identifierInitialization &&
|
||||
identifierInitialization.type === 'CallExpression' &&
|
||||
identifierInitialization.arguments.length > 0 &&
|
||||
identifierInitialization.arguments[0] &&
|
||||
identifierInitialization.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info(
|
||||
'Found configuration object in indirect default export declaration with a wrapping call at the definition'
|
||||
)
|
||||
return identifierInitialization.arguments[0]
|
||||
}
|
||||
}
|
||||
|
||||
// Indirect default export with a wrapping call at the export
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
defaultExport &&
|
||||
defaultExport.declaration.type === 'CallExpression' &&
|
||||
defaultExport.declaration.arguments.length > 0 &&
|
||||
defaultExport.declaration.arguments[0] &&
|
||||
defaultExport.declaration.arguments[0].type === 'Identifier'
|
||||
) {
|
||||
const identifierName = defaultExport.declaration.arguments[0].name
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info(
|
||||
'Found configuration object in indirect default export declaration with a wrapping call at the export'
|
||||
)
|
||||
return identifierInitialization
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15363,21 +15484,57 @@ class ConfigParser {
|
||||
return moduleExport.expression.right
|
||||
}
|
||||
|
||||
// Direct default export with a wrapping call
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
moduleExport &&
|
||||
moduleExport.expression.right.type === 'CallExpression' &&
|
||||
moduleExport.expression.right.arguments.length > 0 &&
|
||||
moduleExport.expression.right.arguments[0] &&
|
||||
moduleExport.expression.right.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info('Found configuration object in direct module export with a wrapping call')
|
||||
return moduleExport.expression.right.arguments[0]
|
||||
}
|
||||
|
||||
// Indirect module export
|
||||
else if (moduleExport && moduleExport.expression.right.type === 'Identifier') {
|
||||
const identifierName = moduleExport && moduleExport.expression.right.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) {
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info('Found configuration object in indirect module export')
|
||||
return identifierDefinition.declarations[0].init
|
||||
return identifierInitialization
|
||||
}
|
||||
// Indirect module export with a wrapping call at the definition
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
identifierInitialization &&
|
||||
identifierInitialization.type === 'CallExpression' &&
|
||||
identifierInitialization.arguments.length > 0 &&
|
||||
identifierInitialization.arguments[0] &&
|
||||
identifierInitialization.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info('Found configuration object in indirect module export with a wrapping call at the definition')
|
||||
return identifierInitialization.arguments[0]
|
||||
}
|
||||
}
|
||||
|
||||
// Indirect module export with a wrapping call at the export
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
moduleExport &&
|
||||
moduleExport.expression.right.type === 'CallExpression' &&
|
||||
moduleExport.expression.right.arguments.length > 0 &&
|
||||
moduleExport.expression.right.arguments[0] &&
|
||||
moduleExport.expression.right.arguments[0].type === 'Identifier'
|
||||
) {
|
||||
const identifierName = moduleExport.expression.right.arguments[0].name
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info('Found configuration object in indirect module export declaration with a wrapping call at the export')
|
||||
return identifierInitialization
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15441,7 +15598,7 @@ class ConfigParser {
|
||||
const ast = espree.parse(this.configuration, espreeOptions)
|
||||
|
||||
// Find the configuration object
|
||||
var configurationObject = this.findConfigurationObject(ast)
|
||||
var configurationObject = this.findConfigurationObject(ast, this.allowWrappingCall)
|
||||
if (!configurationObject) {
|
||||
throw 'Could not find a configuration object in the configuration file'
|
||||
}
|
||||
@@ -15555,7 +15712,7 @@ function getRequiredVars() {
|
||||
githubToken: core.getInput('token'),
|
||||
staticSiteGenerator: core.getInput('static_site_generator'),
|
||||
generatorConfigFile: core.getInput('generator_config_file'),
|
||||
enablement: core.getInput('enablement') !== 'false'
|
||||
enablement: core.getInput('enablement') !== 'true'
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15615,6 +15772,8 @@ const core = __nccwpck_require__(2186)
|
||||
const { ConfigParser } = __nccwpck_require__(8395)
|
||||
const removeTrailingSlash = __nccwpck_require__(9255)
|
||||
|
||||
const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
|
||||
|
||||
// Return the settings to be passed to a {ConfigParser} for a given static site generator,
|
||||
// optional configuration file path, and a Pages siteUrl value to inject
|
||||
function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
|
||||
@@ -15647,7 +15806,9 @@ function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, sit
|
||||
|
||||
// Disable server side image optimization too
|
||||
// https://nextjs.org/docs/api-reference/next/image#unoptimized
|
||||
'experimental.images.unoptimized': true
|
||||
'experimental.images.unoptimized': true,
|
||||
// No longer experimental as of Next.js v12.3.0
|
||||
'images.unoptimized': true
|
||||
}
|
||||
}
|
||||
case 'gatsby':
|
||||
@@ -15687,11 +15848,22 @@ function setPagesConfig({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
|
||||
const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl })
|
||||
new ConfigParser(settings).injectAll()
|
||||
} catch (error) {
|
||||
const isSupportedFileExtension = SUPPORTED_FILE_EXTENSIONS.some(ext => generatorConfigFile.endsWith(ext))
|
||||
|
||||
// Logging
|
||||
core.warning(
|
||||
`We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
|
||||
error
|
||||
)
|
||||
if (!isSupportedFileExtension) {
|
||||
core.warning(
|
||||
`Unsupported configuration file extension. Currently supported extensions: ${SUPPORTED_FILE_EXTENSIONS.map(
|
||||
ext => JSON.stringify(ext)
|
||||
).join(', ')}`,
|
||||
error
|
||||
)
|
||||
} else {
|
||||
core.warning(
|
||||
`We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
|
||||
error
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
2
dist/index.js.map
vendored
2
dist/index.js.map
vendored
File diff suppressed because one or more lines are too long
24
package-lock.json
generated
24
package-lock.json
generated
@@ -4339,9 +4339,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/json5": {
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz",
|
||||
"integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==",
|
||||
"version": "2.2.3",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
|
||||
"integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
|
||||
"dev": true,
|
||||
"bin": {
|
||||
"json5": "lib/cli.js"
|
||||
@@ -5437,9 +5437,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/tsconfig-paths/node_modules/json5": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz",
|
||||
"integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==",
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz",
|
||||
"integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"minimist": "^1.2.0"
|
||||
@@ -8962,9 +8962,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"json5": {
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz",
|
||||
"integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==",
|
||||
"version": "2.2.3",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
|
||||
"integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
|
||||
"dev": true
|
||||
},
|
||||
"jsx-ast-utils": {
|
||||
@@ -9759,9 +9759,9 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"json5": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz",
|
||||
"integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==",
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz",
|
||||
"integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"minimist": "^1.2.0"
|
||||
|
||||
@@ -9,7 +9,7 @@ Pages's path based routing (and work).
|
||||
|
||||
Supported configuration initializations:
|
||||
|
||||
(1) Default export:
|
||||
(1) Direct default export:
|
||||
|
||||
export default {
|
||||
// configuration object here
|
||||
@@ -21,19 +21,69 @@ Supported configuration initializations:
|
||||
// configuration object here
|
||||
}
|
||||
|
||||
(3) Indirect module export:
|
||||
(3) Indirect default export:
|
||||
|
||||
const config = // configuration object here
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
export default config
|
||||
|
||||
(4) Indirect module export:
|
||||
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
module.exports = config
|
||||
|
||||
(5) Direct default export with wrapping call:
|
||||
|
||||
export default defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
|
||||
(6) Direct module export with wrapping call:
|
||||
|
||||
module.exports = defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
|
||||
(7) Indirect default export with wrapping call at the definition:
|
||||
|
||||
const config = defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
export default config
|
||||
|
||||
(8) Indirect default export with wrapping call at the export:
|
||||
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
export default defineConfig(config)
|
||||
|
||||
(9) Indirect module export with wrapping call at the definition:
|
||||
|
||||
const config = defineConfig({
|
||||
// configuration object here
|
||||
})
|
||||
module.exports = config
|
||||
|
||||
(10) Indirect module export with wrapping call at the export:
|
||||
|
||||
const config = {
|
||||
// configuration object here
|
||||
}
|
||||
module.exports = defineConfig(config)
|
||||
*/
|
||||
|
||||
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, allowWrappingCall = false, properties }) {
|
||||
// Save field
|
||||
this.configurationFile = configurationFile
|
||||
this.allowWrappingCall = allowWrappingCall === true
|
||||
this.properties = properties
|
||||
|
||||
// If the configuration file does not exist, initialize it with the blank configuration file
|
||||
@@ -49,12 +99,43 @@ class ConfigParser {
|
||||
this.configuration = fs.readFileSync(this.configurationFile, 'utf8')
|
||||
}
|
||||
|
||||
findTopLevelVariableDeclarator(ast, identifierName) {
|
||||
let targetDeclarator
|
||||
ast.body.find(
|
||||
node =>
|
||||
node.type === 'VariableDeclaration' &&
|
||||
node.declarations &&
|
||||
node.declarations.length > 0 &&
|
||||
node.declarations.find(declarator => {
|
||||
if (
|
||||
declarator.type === 'VariableDeclarator' &&
|
||||
declarator.id &&
|
||||
declarator.id.type === 'Identifier' &&
|
||||
declarator.id.name === identifierName
|
||||
) {
|
||||
targetDeclarator = declarator
|
||||
return true
|
||||
}
|
||||
})
|
||||
)
|
||||
return targetDeclarator
|
||||
}
|
||||
|
||||
// Find the configuration object in an AST.
|
||||
// Look for a default export, a direct module export or an indirect module
|
||||
// export (in that order).
|
||||
// Look for, in order:
|
||||
// - a direct default export
|
||||
// - a direct default export with a wrapping call
|
||||
// - an indirect default export
|
||||
// - an indirect default export with a wrapping call at the definition
|
||||
// - an indirect default export with a wrapping call at the export
|
||||
// - a direct module export
|
||||
// - a direct module export with a wrapping call
|
||||
// - an indirect module export
|
||||
// - an indirect module export with a wrapping call at the definition
|
||||
// - an indirect module export with a wrapping call at the export
|
||||
//
|
||||
// Return the configuration object or null.
|
||||
findConfigurationObject(ast) {
|
||||
findConfigurationObject(ast, allowWrappingCall = false) {
|
||||
// Try to find a default export
|
||||
var defaultExport = ast.body.find(node => node.type === 'ExportDefaultDeclaration')
|
||||
|
||||
@@ -64,21 +145,61 @@ class ConfigParser {
|
||||
return defaultExport.declaration
|
||||
}
|
||||
|
||||
// Direct default export with a wrapping call
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
defaultExport &&
|
||||
defaultExport.declaration.type === 'CallExpression' &&
|
||||
defaultExport.declaration.arguments.length > 0 &&
|
||||
defaultExport.declaration.arguments[0] &&
|
||||
defaultExport.declaration.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info('Found configuration object in direct default export declaration with a wrapping call')
|
||||
return defaultExport.declaration.arguments[0]
|
||||
}
|
||||
|
||||
// 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) {
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info('Found configuration object in indirect default export declaration')
|
||||
return identifierDefinition.declarations[0].init
|
||||
return identifierInitialization
|
||||
}
|
||||
// Indirect default export with a wrapping call at the definition
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
identifierInitialization &&
|
||||
identifierInitialization.type === 'CallExpression' &&
|
||||
identifierInitialization.arguments.length > 0 &&
|
||||
identifierInitialization.arguments[0] &&
|
||||
identifierInitialization.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info(
|
||||
'Found configuration object in indirect default export declaration with a wrapping call at the definition'
|
||||
)
|
||||
return identifierInitialization.arguments[0]
|
||||
}
|
||||
}
|
||||
|
||||
// Indirect default export with a wrapping call at the export
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
defaultExport &&
|
||||
defaultExport.declaration.type === 'CallExpression' &&
|
||||
defaultExport.declaration.arguments.length > 0 &&
|
||||
defaultExport.declaration.arguments[0] &&
|
||||
defaultExport.declaration.arguments[0].type === 'Identifier'
|
||||
) {
|
||||
const identifierName = defaultExport.declaration.arguments[0].name
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info(
|
||||
'Found configuration object in indirect default export declaration with a wrapping call at the export'
|
||||
)
|
||||
return identifierInitialization
|
||||
}
|
||||
}
|
||||
|
||||
@@ -101,21 +222,57 @@ class ConfigParser {
|
||||
return moduleExport.expression.right
|
||||
}
|
||||
|
||||
// Direct default export with a wrapping call
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
moduleExport &&
|
||||
moduleExport.expression.right.type === 'CallExpression' &&
|
||||
moduleExport.expression.right.arguments.length > 0 &&
|
||||
moduleExport.expression.right.arguments[0] &&
|
||||
moduleExport.expression.right.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info('Found configuration object in direct module export with a wrapping call')
|
||||
return moduleExport.expression.right.arguments[0]
|
||||
}
|
||||
|
||||
// Indirect module export
|
||||
else if (moduleExport && moduleExport.expression.right.type === 'Identifier') {
|
||||
const identifierName = moduleExport && moduleExport.expression.right.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) {
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info('Found configuration object in indirect module export')
|
||||
return identifierDefinition.declarations[0].init
|
||||
return identifierInitialization
|
||||
}
|
||||
// Indirect module export with a wrapping call at the definition
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
identifierInitialization &&
|
||||
identifierInitialization.type === 'CallExpression' &&
|
||||
identifierInitialization.arguments.length > 0 &&
|
||||
identifierInitialization.arguments[0] &&
|
||||
identifierInitialization.arguments[0].type === 'ObjectExpression'
|
||||
) {
|
||||
core.info('Found configuration object in indirect module export with a wrapping call at the definition')
|
||||
return identifierInitialization.arguments[0]
|
||||
}
|
||||
}
|
||||
|
||||
// Indirect module export with a wrapping call at the export
|
||||
else if (
|
||||
allowWrappingCall &&
|
||||
moduleExport &&
|
||||
moduleExport.expression.right.type === 'CallExpression' &&
|
||||
moduleExport.expression.right.arguments.length > 0 &&
|
||||
moduleExport.expression.right.arguments[0] &&
|
||||
moduleExport.expression.right.arguments[0].type === 'Identifier'
|
||||
) {
|
||||
const identifierName = moduleExport.expression.right.arguments[0].name
|
||||
const identifierDeclarator = this.findTopLevelVariableDeclarator(ast, identifierName)
|
||||
const identifierInitialization = identifierDeclarator && identifierDeclarator.init
|
||||
if (identifierInitialization && identifierInitialization.type === 'ObjectExpression') {
|
||||
core.info('Found configuration object in indirect module export declaration with a wrapping call at the export')
|
||||
return identifierInitialization
|
||||
}
|
||||
}
|
||||
|
||||
@@ -179,7 +336,7 @@ class ConfigParser {
|
||||
const ast = espree.parse(this.configuration, espreeOptions)
|
||||
|
||||
// Find the configuration object
|
||||
var configurationObject = this.findConfigurationObject(ast)
|
||||
var configurationObject = this.findConfigurationObject(ast, this.allowWrappingCall)
|
||||
if (!configurationObject) {
|
||||
throw 'Could not find a configuration object in the configuration file'
|
||||
}
|
||||
|
||||
@@ -10,7 +10,7 @@ const tempFolder = getTempFolder()
|
||||
// Cases to test
|
||||
const cases = [
|
||||
//
|
||||
// Default export
|
||||
// Direct default export
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
@@ -97,11 +97,13 @@ const cases = [
|
||||
source: 'const config = {}; export default config',
|
||||
expected: 'const config = { property: "value"}; export default config'
|
||||
},
|
||||
// with more than 1 declaration chained together
|
||||
{
|
||||
property: 'property',
|
||||
source: 'var config = {}; export default config',
|
||||
expected: 'var config = { property: "value"}; export default config'
|
||||
source: 'var temp = {}, config = {}; export default config',
|
||||
expected: 'var temp = {}, config = { property: "value"}; export default config'
|
||||
},
|
||||
// deeper
|
||||
{
|
||||
property: 'a.b.c',
|
||||
source: 'var config = {}; export default config',
|
||||
@@ -140,11 +142,13 @@ const cases = [
|
||||
source: 'const config = {}; module.exports = config',
|
||||
expected: 'const config = { property: "value"}; module.exports = config'
|
||||
},
|
||||
// with more than 1 declaration chained together
|
||||
{
|
||||
property: 'property',
|
||||
source: 'var config = {}; module.exports = config',
|
||||
expected: 'var config = { property: "value"}; module.exports = config'
|
||||
source: 'var temp = {}, config = {}; module.exports = config',
|
||||
expected: 'var temp = {}, config = { property: "value"}; module.exports = config'
|
||||
},
|
||||
// deeper
|
||||
{
|
||||
property: 'a.b.c',
|
||||
source: 'var config = {}; module.exports = config',
|
||||
@@ -154,6 +158,109 @@ const cases = [
|
||||
property: 'a.b.c',
|
||||
source: 'var config = { a: { b: [], c: "hello" } }; module.exports = config',
|
||||
expected: 'var config = { a: { b: { c: "value"}, c: "hello" } }; module.exports = config'
|
||||
},
|
||||
|
||||
//
|
||||
// Direct default export with wrapping call
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
source: 'import { defineConfig } from "astro/config"; export default defineConfig({ p1: 0 })',
|
||||
expected: 'import { defineConfig } from "astro/config"; export default defineConfig({ property: "value", p1: 0 })',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
|
||||
//
|
||||
// Direct module exports with wrapping call
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
source: 'const { defineConfig } = require("astro/config"); module.exports = defineConfig({ p1: 0 })',
|
||||
expected:
|
||||
'const { defineConfig } = require("astro/config"); module.exports = defineConfig({ property: "value", p1: 0 })',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
|
||||
//
|
||||
// Indirect default export with wrapping call at the definition
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
source: 'import { defineConfig } from "astro/config"; const config = defineConfig({}); export default config',
|
||||
expected:
|
||||
'import { defineConfig } from "astro/config"; const config = defineConfig({ property: "value" }); export default config',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
// with more than 1 declaration chained together
|
||||
{
|
||||
property: 'property',
|
||||
source:
|
||||
'import { defineConfig } from "astro/config"; const temp = {}, config = defineConfig({}); export default config',
|
||||
expected:
|
||||
'import { defineConfig } from "astro/config"; const temp = {}, config = defineConfig({ property: "value" }); export default config',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
|
||||
//
|
||||
// Indirect default export with wrapping call at the export
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
source: 'import { defineConfig } from "astro/config"; const config = {}; export default defineConfig(config)',
|
||||
expected:
|
||||
'import { defineConfig } from "astro/config"; const config = { property: "value" }; export default defineConfig(config)',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
// with more than 1 declaration chained together
|
||||
{
|
||||
property: 'property',
|
||||
source:
|
||||
'import { defineConfig } from "astro/config"; const temp = {}, config = {}; export default defineConfig(config)',
|
||||
expected:
|
||||
'import { defineConfig } from "astro/config"; const temp = {}, config = { property: "value" }; export default defineConfig(config)',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
|
||||
//
|
||||
// Indirect module exports with wrapping call at the definition
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
source:
|
||||
'const { defineConfig } = require("astro/config"); const config = defineConfig({}); module.exports = config',
|
||||
expected:
|
||||
'const { defineConfig } = require("astro/config"); const config = defineConfig({ property: "value"}); module.exports = config',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
// with more than 1 declaration chained together
|
||||
{
|
||||
property: 'property',
|
||||
source:
|
||||
'const { defineConfig } = require("astro/config"); const temp = {}, config = defineConfig({}); module.exports = config',
|
||||
expected:
|
||||
'const { defineConfig } = require("astro/config"); const temp = {}, config = defineConfig({ property: "value"}); module.exports = config',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
|
||||
//
|
||||
// Indirect module exports with wrapping call at the export
|
||||
//
|
||||
{
|
||||
property: 'property',
|
||||
source:
|
||||
'const { defineConfig } = require("astro/config"); const config = {}; module.exports = defineConfig(config)',
|
||||
expected:
|
||||
'const { defineConfig } = require("astro/config"); const config = { property: "value"}; module.exports = defineConfig(config)',
|
||||
allowWrappingCall: true
|
||||
},
|
||||
// with more than 1 declaration chained together
|
||||
{
|
||||
property: 'property',
|
||||
source:
|
||||
'const { defineConfig } = require("astro/config"); const temp = {}, config = {}; module.exports = defineConfig(config)',
|
||||
expected:
|
||||
'const { defineConfig } = require("astro/config"); const temp = {}, config = { property: "value"}; module.exports = defineConfig(config)',
|
||||
allowWrappingCall: true
|
||||
}
|
||||
]
|
||||
|
||||
@@ -168,7 +275,7 @@ describe('config-parser', () => {
|
||||
jest.spyOn(core, 'debug').mockImplementation(jest.fn())
|
||||
})
|
||||
|
||||
cases.forEach(({ property, source, expected }, index) => {
|
||||
cases.forEach(({ property, source, expected, allowWrappingCall = false }, index) => {
|
||||
it(`injects path properly for case #${index}`, () => {
|
||||
// Write the source file
|
||||
const sourceFile = `${tempFolder}/source.js`
|
||||
@@ -180,7 +287,8 @@ describe('config-parser', () => {
|
||||
|
||||
// Update the settings and do the injection
|
||||
new ConfigParser({
|
||||
configurationFile: sourceFile
|
||||
configurationFile: sourceFile,
|
||||
allowWrappingCall
|
||||
}).inject(property, 'value')
|
||||
|
||||
// Compare the files
|
||||
|
||||
@@ -7,7 +7,7 @@ function getRequiredVars() {
|
||||
githubToken: core.getInput('token'),
|
||||
staticSiteGenerator: core.getInput('static_site_generator'),
|
||||
generatorConfigFile: core.getInput('generator_config_file'),
|
||||
enablement: core.getInput('enablement') !== 'false'
|
||||
enablement: core.getInput('enablement') !== 'true'
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// Default Pages configuration for Next
|
||||
const nextConfig = { experimental: { images: { unoptimized: true } }, basePath: '/docs' }
|
||||
const nextConfig = { images: { unoptimized: true }, experimental: { images: { unoptimized: true } }, basePath: '/docs' }
|
||||
module.exports = nextConfig
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/** @type {import('next').NextConfig} */
|
||||
const nextConfig = {
|
||||
images: { unoptimized: true },
|
||||
experimental: { images: { unoptimized: true } },
|
||||
basePath: '/docs',
|
||||
reactStrictMode: true,
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/** @type {import('next').NextConfig} */
|
||||
const nextConfig = {
|
||||
images: { unoptimized: true },
|
||||
experimental: { images: { unoptimized: true } },
|
||||
basePath: '/docs',
|
||||
reactStrictMode: true,
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/** @type {import('next').NextConfig} */
|
||||
const nextConfig = {
|
||||
images: { unoptimized: true },
|
||||
experimental: { images: { unoptimized: true } },
|
||||
basePath: '/docs',
|
||||
reactStrictMode: true,
|
||||
|
||||
@@ -2,6 +2,8 @@ const core = require('@actions/core')
|
||||
const { ConfigParser } = require('./config-parser')
|
||||
const removeTrailingSlash = require('./remove-trailing-slash')
|
||||
|
||||
const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
|
||||
|
||||
// Return the settings to be passed to a {ConfigParser} for a given static site generator,
|
||||
// optional configuration file path, and a Pages siteUrl value to inject
|
||||
function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
|
||||
@@ -34,7 +36,9 @@ function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, sit
|
||||
|
||||
// Disable server side image optimization too
|
||||
// https://nextjs.org/docs/api-reference/next/image#unoptimized
|
||||
'experimental.images.unoptimized': true
|
||||
'experimental.images.unoptimized': true,
|
||||
// No longer experimental as of Next.js v12.3.0
|
||||
'images.unoptimized': true
|
||||
}
|
||||
}
|
||||
case 'gatsby':
|
||||
@@ -74,11 +78,22 @@ function setPagesConfig({ staticSiteGenerator, generatorConfigFile, siteUrl }) {
|
||||
const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, siteUrl })
|
||||
new ConfigParser(settings).injectAll()
|
||||
} catch (error) {
|
||||
const isSupportedFileExtension = SUPPORTED_FILE_EXTENSIONS.some(ext => generatorConfigFile.endsWith(ext))
|
||||
|
||||
// Logging
|
||||
core.warning(
|
||||
`We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
|
||||
error
|
||||
)
|
||||
if (!isSupportedFileExtension) {
|
||||
core.warning(
|
||||
`Unsupported configuration file extension. Currently supported extensions: ${SUPPORTED_FILE_EXTENSIONS.map(
|
||||
ext => JSON.stringify(ext)
|
||||
).join(', ')}`,
|
||||
error
|
||||
)
|
||||
} else {
|
||||
core.warning(
|
||||
`We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${siteUrl}. Please ensure your framework is configured to generate relative links appropriately.`,
|
||||
error
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -11,6 +11,13 @@ const tempFolder = getTempFolder()
|
||||
|
||||
const SUPPORTED_GENERATORS = ['next', 'nuxt', 'gatsby', 'sveltekit']
|
||||
const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
|
||||
const IS_BLANK_CONFIG_FILE_REGEX = new RegExp(
|
||||
'^blank\\.(' + SUPPORTED_FILE_EXTENSIONS.map(ext => ext.slice(1)).join('|') + ')$'
|
||||
)
|
||||
|
||||
function isBlankConfigFileName(fileName) {
|
||||
return IS_BLANK_CONFIG_FILE_REGEX.test(fileName)
|
||||
}
|
||||
|
||||
// Test suite
|
||||
describe('configParser', () => {
|
||||
@@ -44,7 +51,7 @@ describe('configParser', () => {
|
||||
// Copy the source fixture to a temp file
|
||||
const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
|
||||
const fixtureTargetFile = `${tempFolder}/${configurationFile}`
|
||||
if (configurationFile !== 'blank.js') {
|
||||
if (!isBlankConfigFileName(configurationFile)) {
|
||||
fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
|
||||
} else if (fs.existsSync(fixtureTargetFile)) {
|
||||
fs.rmSync(fixtureTargetFile)
|
||||
@@ -77,7 +84,7 @@ describe('configParser', () => {
|
||||
// Copy the source fixture to a temp file
|
||||
const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
|
||||
const fixtureTargetFile = `${tempFolder}/${configurationFile}`
|
||||
if (configurationFile !== 'blank.js') {
|
||||
if (!isBlankConfigFileName(configurationFile)) {
|
||||
fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
|
||||
} else if (fs.existsSync(fixtureTargetFile)) {
|
||||
fs.rmSync(fixtureTargetFile)
|
||||
|
||||
Reference in New Issue
Block a user