Merge pull request #13 from actions/prettier

Prettier formatting

.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

.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

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
@@ -14585,9 +14585,7 @@ class ConfigParser {
   findConfigurationObject(ast) {
     // Try to find a default export
     var defaultExport = ast.body.find(
-      node =>
+      node => node.type === 'ExportDefaultDeclaration' && node.declaration.type === 'ObjectExpression'
-        node.type === 'ExportDefaultDeclaration' &&
-        node.declaration.type === 'ObjectExpression'
     )
     if (defaultExport) {
       core.info('Found configuration object in default export declaration')
@@ -14608,19 +14606,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 +14640,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 +14660,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) +
-        '}'
       )
     }
   }
@@ -14750,11 +14738,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 +14785,7 @@ class ConfigParser {
   }
 }
 
-module.exports = {ConfigParser}
+module.exports = { ConfigParser }
 
 
 /***/ }),
@@ -14833,7 +14817,7 @@ function getContext() {
   return requiredVars
 }
 
-module.exports = {getContext}
+module.exports = { getContext }
 
 
 /***/ }),
@@ -14859,7 +14843,7 @@ 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
 // static site generator and a Pages path value to inject
@@ -14911,7 +14895,7 @@ function getConfigParserSettings(staticSiteGenerator, path) {
 }
 
 // Inject Pages configuration in a given static site generator's configuration file
-function setPagesPath({staticSiteGenerator, path}) {
+function setPagesPath({ staticSiteGenerator, path }) {
   try {
     // Parse the configuration file and try to inject the Pages configuration in it
     const settings = getConfigParserSettings(staticSiteGenerator, path)
@@ -14925,7 +14909,7 @@ function setPagesPath({staticSiteGenerator, path}) {
   }
 }
 
-module.exports = {getConfigParserSettings, setPagesPath}
+module.exports = { getConfigParserSettings, setPagesPath }
 
 
 /***/ }),

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
@@ -57,9 +57,7 @@ class ConfigParser {
   findConfigurationObject(ast) {
     // Try to find a default export
     var defaultExport = ast.body.find(
-      node =>
+      node => node.type === 'ExportDefaultDeclaration' && node.declaration.type === 'ObjectExpression'
-        node.type === 'ExportDefaultDeclaration' &&
-        node.declaration.type === 'ObjectExpression'
     )
     if (defaultExport) {
       core.info('Found configuration object in default export declaration')
@@ -80,19 +78,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 +112,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 +132,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) +
-        '}'
       )
     }
   }
@@ -222,11 +210,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 +257,4 @@ class ConfigParser {
   }
 }
 
-module.exports = {ConfigParser}
+module.exports = { ConfigParser }

src/config-parser.test.js

@@ -1,7 +1,7 @@
 const fs = require('fs')
 
-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()
@@ -134,15 +134,15 @@ const cases = [
 ]
 
 describe('config-parser', () => {
-  cases.forEach(({property, source, expected}, index) => {
+  cases.forEach(({ property, source, expected }, index) => {
     it(`Inject 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

@@ -22,4 +22,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/blank.js

@@ -1 +1 @@
-// This file is not read by the test suite
+// This file is not read by the test suite

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

@@ -1 +1 @@
-// This file is not read by the test suite
+// This file is not read by the test suite

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

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

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

@@ -1 +1 @@
-// This file is not read by the test suite
+// This file is not read by the test suite

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.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/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,5 +1,5 @@
 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
 // static site generator and a Pages path value to inject
@@ -51,7 +51,7 @@ function getConfigParserSettings(staticSiteGenerator, path) {
 }
 
 // Inject Pages configuration in a given static site generator's configuration file
-function setPagesPath({staticSiteGenerator, path}) {
+function setPagesPath({ staticSiteGenerator, path }) {
   try {
     // Parse the configuration file and try to inject the Pages configuration in it
     const settings = getConfigParserSettings(staticSiteGenerator, path)
@@ -65,4 +65,4 @@ function setPagesPath({staticSiteGenerator, path}) {
   }
 }
 
-module.exports = {getConfigParserSettings, setPagesPath}
+module.exports = { getConfigParserSettings, setPagesPath }

src/set-pages-path.test.js

@@ -1,9 +1,9 @@
 const fs = require('fs')
 const path = require('path')
 
-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()
@@ -40,10 +40,7 @@ describe('configParser', () => {
         new ConfigParser(settings).injectAll()
 
         // Read the expected file
-        const expectedFile = `${fixtureFolder}/${path.basename(
+        const expectedFile = `${fixtureFolder}/${path.basename(configurationFile, '.js')}.expected.js`
-          configurationFile,
-          '.js'
-        )}.expected.js`
 
         // 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 }