feat: ✨ add puppeteer options

.npmignore

@@ -11,4 +11,5 @@ eslint.config.js
 LICENSE
 tsconfig.json
 bin
-output.json
+output.json
+server

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helptheweb/scanner",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "service to scan websites and get accessibility violations",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

src/generateReport.ts

@@ -1,16 +1,11 @@
 import { AxePuppeteer } from '@axe-core/puppeteer';
-import puppeteer from 'puppeteer';
-
-import locateChrome from 'locate-chrome';
+import puppeteer, { type LaunchOptions } from 'puppeteer';
 
 // Launches Puppeteer and runs the Axe Reporter for a SINGLE URL
-export const generateReport = async (url: string): Promise<any> => {
-
-  const executablePath: string = await new Promise(resolve => locateChrome((arg: any) => resolve(arg))) || '';
+export const generateReport = async (url: string, puppeteerLaunchOptions?: LaunchOptions): Promise<any> => {
 
   const browser = await puppeteer.launch({
-    executablePath,
-    args: ['--no-sandbox', '--disable-setuid-sandbox'],
+    ...puppeteerLaunchOptions
   });
   const page = await browser.newPage();
 
@@ -23,13 +18,10 @@ export const generateReport = async (url: string): Promise<any> => {
 }
 
 // If the supplied URL is an array of URLs, parse through it
-export const generateMultipleReports = async (urls: string[]): Promise<any[]> => {
-
-  const executablePath: string = await new Promise(resolve => locateChrome((arg: any) => resolve(arg))) || '';
+export const generateMultipleReports = async (urls: string[], puppeteerLaunchOptions?: LaunchOptions): Promise<any[]> => {
 
   const browser = await puppeteer.launch({
-    executablePath,
-    args: ['--no-sandbox', '--disable-setuid-sandbox'],
+    ...puppeteerLaunchOptions
   });
   const page = await browser.newPage();
   let combinedResults = [];

src/index.ts

@@ -3,21 +3,22 @@ import { generateReport, generateMultipleReports } from './generateReport';
 import { displayResults } from './displayResults';
 import { getUrlsFromSitemap } from './getUrlsFromSitemap';
 import type { ReportInterface } from './types';
+import { type LaunchOptions } from 'puppeteer';
 
-export const scanner = async (url: string): Promise<ReportInterface[]> => {
+export const scanner = async (url: string, puppeteerLaunchOptions?: LaunchOptions): Promise<ReportInterface[]> => {
 
   let output: ReportInterface[] = [];
 
   if (url && URL.canParse(url)) {
     if (url.includes('.xml')) {
       const fullSitemap: string[] = await getUrlsFromSitemap(url);
-      const reports = await generateMultipleReports(fullSitemap);
+      const reports = await generateMultipleReports(fullSitemap, puppeteerLaunchOptions);
       for (let report of reports) {
         const formattedResults: ReportInterface = displayResults(report);
         output.push(formattedResults);
       }
     } else {
-      const report = await generateReport(url);
+      const report = await generateReport(url, puppeteerLaunchOptions);
       const formattedResults: ReportInterface = displayResults(report);
       output.push(formattedResults);
     }