Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Prettier to the codebase. #5825

Merged
merged 4 commits into from May 7, 2020
Merged

Add Prettier to the codebase. #5825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8111d9c
prettier
jackfranklin May 7, 2020
5577ec8
Configure ESLint and Prettier
jackfranklin May 7, 2020
2560adf
Run Prettier on all files
jackfranklin May 7, 2020
7c2b01f
Move ts-ignore back
jackfranklin May 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 6 additions & 41 deletions .eslintrc.js
View file
Open in desktop
Expand Up @@ -13,33 +13,29 @@ module.exports = {
"unicorn"
],

"extends": [
"plugin:prettier/recommended"
],

"rules": {
// Error if files are not formatted with Prettier correctly.
"prettier/prettier": 2,
// syntax preferences
"quotes": [2, "single", {
"avoidEscape": true,
"allowTemplateLiterals": true
}],
"semi": 2,
"no-extra-semi": 2,
"comma-style": [2, "last"],
"wrap-iife": [2, "inside"],
"spaced-comment": [2, "always", {
"markers": ["*"]
}],
"eqeqeq": [2],
"arrow-body-style": [2, "as-needed"],
"accessor-pairs": [2, {
"getWithoutSet": false,
"setWithoutGet": false
}],
"brace-style": [2, "1tbs", {"allowSingleLine": true}],
"curly": [2, "multi-or-nest", "consistent"],
"object-curly-spacing": [2, "never"],
"new-parens": 2,
"func-call-spacing": 2,
"arrow-parens": [2, "as-needed"],
"prefer-const": 2,
"quote-props": [2, "consistent"],

// anti-patterns
"no-var": 2,
Expand Down Expand Up @@ -68,37 +64,6 @@ module.exports = {
"require-yield": 2,
"template-curly-spacing": [2, "never"],

// spacing details
"space-infix-ops": 2,
"space-in-parens": [2, "never"],
"space-before-function-paren": [2, "never"],
"no-whitespace-before-property": 2,
"keyword-spacing": [2, {
"overrides": {
"if": {"after": true},
"else": {"after": true},
"for": {"after": true},
"while": {"after": true},
"do": {"after": true},
"switch": {"after": true},
"return": {"after": true}
}
}],
"arrow-spacing": [2, {
"after": true,
"before": true
}],

// file whitespace
"no-multiple-empty-lines": [2, {"max": 2}],
"no-mixed-spaces-and-tabs": 2,
"no-trailing-spaces": 2,
"linebreak-style": [ process.platform === "win32" ? 0 : 2, "unix" ],
"indent": [2, 2, { "SwitchCase": 1, "CallExpression": {"arguments": 2}, "MemberExpression": 2 }],
"key-spacing": [2, {
"beforeColon": false
}],

// ensure we don't have any it.only or describe.only in prod
"mocha/no-exclusive-tests": "error",

Expand Down
13 changes: 5 additions & 8 deletions examples/block-images.js
View file
Open in desktop
Expand Up @@ -18,19 +18,16 @@

const puppeteer = require('puppeteer');

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.setRequestInterception(true);
page.on('request', request => {
if (request.resourceType() === 'image')
request.abort();
else
request.continue();
page.on('request', (request) => {
if (request.resourceType() === 'image') request.abort();
else request.continue();
});
await page.goto('https://news.google.com/news/');
await page.screenshot({path: 'news.png', fullPage: true});
await page.screenshot({ path: 'news.png', fullPage: true });

await browser.close();
})();

6 changes: 3 additions & 3 deletions examples/cross-browser.js
View file
Open in desktop
Expand Up @@ -25,7 +25,7 @@ const firefoxOptions = {
dumpio: true,
};

(async() => {
(async () => {
const browser = await puppeteer.launch(firefoxOptions);

const page = await browser.newPage();
Expand All @@ -35,9 +35,9 @@ const firefoxOptions = {

// Extract articles from the page.
const resultsSelector = '.storylink';
const links = await page.evaluate(resultsSelector => {
const links = await page.evaluate((resultsSelector) => {
const anchors = Array.from(document.querySelectorAll(resultsSelector));
return anchors.map(anchor => {
return anchors.map((anchor) => {
const title = anchor.textContent.trim();
return `${title} - ${anchor.href}`;
});
Expand Down
14 changes: 8 additions & 6 deletions examples/custom-event.js
View file
Open in desktop
Expand Up @@ -18,12 +18,12 @@

const puppeteer = require('puppeteer');

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();

// Define a window.onCustomEvent function on the page.
await page.exposeFunction('onCustomEvent', e => {
await page.exposeFunction('onCustomEvent', (e) => {
console.log(`${e.type} fired`, e.detail || '');
});

Expand All @@ -33,16 +33,18 @@ const puppeteer = require('puppeteer');
* @return {!Promise}
*/
function listenFor(type) {
return page.evaluateOnNewDocument(type => {
document.addEventListener(type, e => {
window.onCustomEvent({type, detail: e.detail});
return page.evaluateOnNewDocument((type) => {
document.addEventListener(type, (e) => {
window.onCustomEvent({ type, detail: e.detail });
});
}, type);
}

await listenFor('app-ready'); // Listen for "app-ready" custom event on page load.

await page.goto('https://www.chromestatus.com/features', {waitUntil: 'networkidle0'});
await page.goto('https://www.chromestatus.com/features', {
waitUntil: 'networkidle0',
});

await browser.close();
})();
8 changes: 4 additions & 4 deletions examples/detect-sniff.js
View file
Open in desktop
Expand Up @@ -22,22 +22,22 @@ function sniffDetector() {
const userAgent = window.navigator.userAgent;
const platform = window.navigator.platform;

window.navigator.__defineGetter__('userAgent', function() {
window.navigator.__defineGetter__('userAgent', function () {
window.navigator.sniffed = true;
return userAgent;
});

window.navigator.__defineGetter__('platform', function() {
window.navigator.__defineGetter__('platform', function () {
window.navigator.sniffed = true;
return platform;
});
}

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.evaluateOnNewDocument(sniffDetector);
await page.goto('https://www.google.com', {waitUntil: 'networkidle2'});
await page.goto('https://www.google.com', { waitUntil: 'networkidle2' });
console.log('Sniffed: ' + (await page.evaluate(() => !!navigator.sniffed)));

await browser.close();
Expand Down
8 changes: 5 additions & 3 deletions examples/pdf.js
View file
Open in desktop
Expand Up @@ -18,15 +18,17 @@

const puppeteer = require('puppeteer');

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('https://news.ycombinator.com', {waitUntil: 'networkidle2'});
await page.goto('https://news.ycombinator.com', {
waitUntil: 'networkidle2',
});
// page.pdf() is currently supported only in headless mode.
// @see https://bugs.chromium.org/p/chromium/issues/detail?id=753118
await page.pdf({
path: 'hn.pdf',
format: 'letter'
format: 'letter',
});

await browser.close();
Expand Down
4 changes: 2 additions & 2 deletions examples/proxy.js
View file
Open in desktop
Expand Up @@ -18,7 +18,7 @@

const puppeteer = require('puppeteer');

(async() => {
(async () => {
const browser = await puppeteer.launch({
// Launch chromium using a proxy server on port 9876.
// More on proxying:
Expand All @@ -27,7 +27,7 @@ const puppeteer = require('puppeteer');
'--proxy-server=127.0.0.1:9876',
// Use proxy for localhost URLs
'--proxy-bypass-list=<-loopback>',
]
],
});
const page = await browser.newPage();
await page.goto('https://google.com');
Expand Down
4 changes: 2 additions & 2 deletions examples/screenshot-fullpage.js
View file
Open in desktop
Expand Up @@ -19,11 +19,11 @@
const puppeteer = require('puppeteer');
const devices = require('puppeteer/DeviceDescriptors');

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.emulate(devices['iPhone 6']);
await page.goto('https://www.nytimes.com/');
await page.screenshot({path: 'full.png', fullPage: true});
await page.screenshot({ path: 'full.png', fullPage: true });
await browser.close();
})();
4 changes: 2 additions & 2 deletions examples/screenshot.js
View file
Open in desktop
Expand Up @@ -18,10 +18,10 @@

const puppeteer = require('puppeteer');

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('http://example.com');
await page.screenshot({path: 'example.png'});
await page.screenshot({ path: 'example.png' });
await browser.close();
})();
6 changes: 3 additions & 3 deletions examples/search.js
View file
Open in desktop
Expand Up @@ -23,7 +23,7 @@

const puppeteer = require('puppeteer');

(async() => {
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();

Expand All @@ -42,9 +42,9 @@ const puppeteer = require('puppeteer');
await page.waitForSelector(resultsSelector);

// Extract the results from the page.
const links = await page.evaluate(resultsSelector => {
const links = await page.evaluate((resultsSelector) => {
const anchors = Array.from(document.querySelectorAll(resultsSelector));
return anchors.map(anchor => {
return anchors.map((anchor) => {
const title = anchor.textContent.split('|')[0].trim();
return `${title} - ${anchor.href}`;
});
Expand Down
19 changes: 14 additions & 5 deletions index.js
View file
Open in desktop
Expand Up @@ -14,9 +14,9 @@
* limitations under the License.
*/

const {helper} = require('./lib/helper');
const { helper } = require('./lib/helper');
const api = require('./lib/api');
const {Page} = require('./lib/Page');
const { Page } = require('./lib/Page');
for (const className in api) {
if (typeof api[className] === 'function')
helper.installAsyncStackHooks(api[className]);
Expand All @@ -25,16 +25,25 @@ for (const className in api) {
// Expose alias for deprecated method.
Page.prototype.emulateMedia = Page.prototype.emulateMediaType;

const {Puppeteer} = require('./lib/Puppeteer');
const { Puppeteer } = require('./lib/Puppeteer');
const packageJson = require('./package.json');
let preferredRevision = packageJson.puppeteer.chromium_revision;
const isPuppeteerCore = packageJson.name === 'puppeteer-core';
// puppeteer-core ignores environment variables
const product = isPuppeteerCore ? undefined : process.env.PUPPETEER_PRODUCT || process.env.npm_config_puppeteer_product || process.env.npm_package_config_puppeteer_product;
const product = isPuppeteerCore
? undefined
: process.env.PUPPETEER_PRODUCT ||
process.env.npm_config_puppeteer_product ||
process.env.npm_package_config_puppeteer_product;
if (!isPuppeteerCore && product === 'firefox')
preferredRevision = packageJson.puppeteer.firefox_revision;

const puppeteer = new Puppeteer(__dirname, preferredRevision, isPuppeteerCore, product);
const puppeteer = new Puppeteer(
__dirname,
preferredRevision,
isPuppeteerCore,
product
);

// The introspection in `Helper.installAsyncStackHooks` references `Puppeteer._launcher`
// before the Puppeteer ctor is called, such that an invalid Launcher is selected at import,
Expand Down