doc: lint

docs/content/1.guide/guides/0.config.md

@@ -15,7 +15,7 @@ configuration types.
 
 ```ts unlighthouse.config.ts
 /// <reference types="unlighthouse" />
-import {defineConfig} from 'unlighthouse'
+import { defineConfig } from 'unlighthouse'
 
 export default defineConfig({
  // examplebtn-basic

docs/content/1.guide/guides/authentication.md

@@ -8,12 +8,12 @@ To use basic authentication, provide the `auth` option in your configuration fil
 
 ```ts
 // unlighthouse.config.ts
-export default{
+export default {
  auth: {
  username: 'username',
  password: 'password',
  },
-};
+}
 ```
 
 Alternatively, you can provide the `--auth` flag to the CLI.
@@ -28,7 +28,7 @@ If you can authenticate your session using cookies, use the `cookies` option in
 
 ```ts
 // unlighthouse.config.ts
-export default{
+export default {
  cookies: [
  {
  name: 'my-jwt-token',
@@ -41,7 +41,7 @@ export default{
  sameSite: 'Lax',
  },
  ],
-};
+}
 ```
 
 Alternatively, you can provide the `--cookies` flag to the CLI.
@@ -64,11 +64,11 @@ To use custom headers, provide the `extraHeaders` option in your configuration f
 
 ```ts
 // unlighthouse.config.ts
-export default{
+export default {
  extraHeaders: {
  'x-custom-auth': '<token>>',
  },
-};
+}
 ```
 
 Alternatively, you can provide the `--extra-headers` flag to the CLI.
@@ -117,24 +117,24 @@ You can see an example here:
 export default {
  puppeteerOptions: {
  // slow down slightly so input is not missed
- slowMo: 50, 
+ slowMo: 50,
  },
  lighthouseOptions: {
  // allow storage to persist between pages
  disableStorageReset: true,
  },
  hooks: {
  'puppeteer:before-goto': async (page) => {
-  // login to the page
+ // login to the page
  await page.goto('https://example.com/login')
- const emailInput = await page.$('input[type="email"]');
- await emailInput.type('admin@example.com');
- const passwordInput = await page.$('input[type="password"]');
- await passwordInput.type('password');
+ const emailInput = await page.$('input[type="email"]')
+ await emailInput.type('admin@example.com')
+ const passwordInput = await page.$('input[type="password"]')
+ await passwordInput.type('password')
  await Promise.all([
  page.$eval('.login-form', form => form.submit()),
  page.waitForNavigation(),
- ]);
+ ])
  },
  },
 }

docs/content/1.guide/guides/docker.md

@@ -16,7 +16,7 @@ You will need to remove the Chrome sandbox in a Docker environment, this will re
 // unlighthouse.config.ts
 export default {
  puppeteerOptions: {
-  args: ["--no-sandbox", "--disable-setuid-sandbox"],
+ args: ['--no-sandbox', '--disable-setuid-sandbox'],
  },
 }
 ```
@@ -27,14 +27,14 @@ the reports are finished.
 ```ts
 // unlighthouse.config.ts
 export default {
- server: {
- open: false,
- },
- hooks: {
- 'worker-finished': async () => {
- process.exit(0);
- }
+ server: {
+ open: false,
+ },
+ hooks: {
+ 'worker-finished': async () => {
+ process.exit(0)
  }
+ }
 }
 ```
 

docs/content/1.guide/guides/generating-static-reports.md

@@ -90,11 +90,11 @@ jobs:
  - name: Deploy report to Netlify
  uses: nwtgck/actions-netlify@v1.2
  with:
- publish-dir: './.unlighthouse'
+ publish-dir: ./.unlighthouse
  production-branch: main
  production-deploy: true
  github-token: ${{ secrets.GITHUB_TOKEN }}
- deploy-message: "New Release Deploy from GitHub Actions"
+ deploy-message: New Release Deploy from GitHub Actions
  enable-pull-request-comment: false
  enable-commit-comment: true
  overwrites-pull-request-comment: true

docs/content/1.guide/guides/puppeteer.md

@@ -29,15 +29,15 @@ let token
 export default {
  hooks: {
  'puppeteer:before-goto': async (page) => {
- if (!token) {
+ if (!token)
  token = await generateToken()
- }
+
  // set authentication token when we load a new page
- await page.evaluateOnNewDocument(token => {
-  localStorage.clear()
-  localStorage.setItem('token', token)
-  }, token
-  )
+ await page.evaluateOnNewDocument((token) => {
+ localStorage.clear()
+ localStorage.setItem('token', token)
+ }, token
+ )
  },
  },
 }
@@ -49,14 +49,14 @@ export default {
 export default {
  hooks: {
  'puppeteer:before-goto': async (page) => {
- let deleteSelector= ".VPNav";
+ const deleteSelector = '.VPNav'
  page.waitForNavigation().then(async () => {
  await page.waitForTimeout(1000)
  await page.evaluate((sel) => {
- const elements = document.querySelectorAll(sel);
- for(let i=0; i< elements.length; i++){
- elements[i].parentNode.removeChild(elements[i]);
- }
+ const elements = document.querySelectorAll(sel)
+ for (let i = 0; i < elements.length; i++)
+ elements[i].parentNode.removeChild(elements[i])
+
  }, deleteSelector)
  })
  }

docs/content/1.guide/recipes/client.md

@@ -13,7 +13,7 @@ See the [glossary guide](/api/glossary/#columns) for the columns to understand t
 ```ts
 export default {
  hooks: {
- 'resolved-config'(config) {
+ 'resolved-config': function (config) {
  // replace FCP column with server response time
  config.client.columns.performance[2] = {
  cols: 1,

docs/content/1.guide/recipes/improving-accuracy.md

@@ -24,7 +24,7 @@ performance scores as the extra workload will affect performance metrics.
 ```ts
 export default {
  puppeteerClusterOptions: {
-  // only run 1 worker at a time 
+ // only run 1 worker at a time
  maxConcurrency: 1
  }
 }

docs/content/2.integrations/0.cli.md

@@ -71,7 +71,6 @@ See the [Configuration](#configuration) section for more details and the guides.
 If you want to configure Unlighthouse, you can create a `unlighthouse.config.ts` file in your cwd.
 
 ```ts unlighthouse.config.ts
-
 export default {
  site: 'example.com',
  debug: true,

docs/content/2.integrations/1.ci.md

@@ -63,10 +63,10 @@ export default {
  site: 'https://example.com',
  ci: {
  budget: {
- performance: 50,
- accessibility: 100,
+ 'performance': 50,
+ 'accessibility': 100,
  'best-practices': 90,
- seo: 90,
+ 'seo': 90,
  }
  }
 }
@@ -130,7 +130,6 @@ Configuring the CLI can be done either through the CI arguments or through a con
 If you want to configure Unlighthouse, you can create a `unlighthouse.config.ts` file in your cwd.
 
 ```ts unlighthouse.config.ts
-
 export default {
  site: 'example.com',
  debug: true,

docs/content/2.integrations/4.vite.md

@@ -76,9 +76,9 @@ export default defineConfig({
  onRoutesGenerated(routes) {
  // tell Unlighthouse about the routes
  const unlighthouse = useUnlighthouse()
- if (unlighthouse?.hooks) {
+ if (unlighthouse?.hooks)
  hooks.callHook('route-definitions-provided', routes)
- }
+
  }
  }),
  ]

docs/content/3.api/glossary.md

@@ -48,7 +48,7 @@ export interface Provider {
  * The collection of route definitions belonging to the provider. These can be inferred but aren't 100% correct,
  * frameworks that can provide these should do so.
  */
- routeDefinitions?: RouteDefinition[]|(() => RouteDefinition[]|Promise<RouteDefinition[]>)
+ routeDefinitions?: RouteDefinition[] | (() => RouteDefinition[] | Promise<RouteDefinition[]>)
 }
 ```
 
@@ -201,12 +201,12 @@ See [cluster.task(fn)](https://github.com/thomasdondorf/puppeteer-cluster) for m
 /**
  * Tasks that Unlighthouse will run, used to track their status.
  */
-export type UnlighthouseTask = 'inspectHtmlTask'|'runLighthouseTask'
+export type UnlighthouseTask = 'inspectHtmlTask' | 'runLighthouseTask'
 
 /**
  * Each task ran by unlighthouse (extractHtmlPayload, runLighthouseTask) has a specific status which we can expose.
  */
-export type UnlighthouseTaskStatus = 'waiting'|'in-progress'|'completed'|'failed'
+export type UnlighthouseTaskStatus = 'waiting' | 'in-progress' | 'completed' | 'failed'
 ```
 
 ## Client

docs/content/3.api/index.md

@@ -19,10 +19,10 @@ Functions exposed from the `@unlighthouse/core` package.
  // config
  { configFile: 'mysite.config.ts' },
  // provider
- { 
-  name: 'custom',
-  // some custom implementation to find the route definitions
-  routeDefinitions: () => generateRouteDefinitions(),
+ {
+ name: 'custom',
+ // some custom implementation to find the route definitions
+ routeDefinitions: () => generateRouteDefinitions(),
  }
  )
  ```
@@ -53,6 +53,7 @@ Functions exposed from the `@unlighthouse/core` package.
 
  ```ts
  import { generateClient } from '@unlighthouse/core'
+ 
  // ...
  logger.info('Generating static client.')
  await generateClient({ static: true })
@@ -68,6 +69,7 @@ Functions exposed from the `@unlighthouse/core` package.
 
  ```ts
  import { useUnlighthouse } from '@unlighthouse/core'
+ 
  // access the lighthouse context, pick out the worker
  const { worker } = useUnlighthouse()
  // force whichever route matches home.md to be re-scanned
@@ -83,6 +85,7 @@ Functions exposed from the `@unlighthouse/core` package.
 
  ```ts
  import { useLogger } from '@unlighthouse/core'
+ 
  // you need to instantiate the logger to get the instance
  const logger = useLogger()
  // force whichever route matches home.md to be re-scanned
@@ -105,6 +108,7 @@ running Unlighthouse with the `cli` provider will use this package.
 
  ```ts
  import { createServer } from '@unlighthouse/server'
+ 
  // ...
  const { server, app } = await createServer()
  // server is an instance of listhen, app is an instance of h3
@@ -147,7 +151,7 @@ Unlighthouse provides hooks using [hookable](https://github.com/unjs/hookable) w
 Hooks can be accessed on the `hooks` property of the context and will always return a `Promise<void>|void`.
 
 ```ts
-export type HookResult = Promise<void>|void
+export type HookResult = Promise<void> | void
 ```
 
 ```ts
@@ -156,7 +160,7 @@ import { useUnlighthouse } from '@unlighthouse/core'
 const { hooks } = useUnlighthouse()
 
 hooks.hook('task-complete', (path, response) => {
-  console.log('task is finished at path', path)
+ console.log('task is finished at path', path)
 })
 ```