Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mjorgegulab/puppeteer-extra-plugin-force-custom-language
Puppeteer-extra plugin to force browser language.
https://github.com/mjorgegulab/puppeteer-extra-plugin-force-custom-language
Last synced: 3 months ago
JSON representation
Puppeteer-extra plugin to force browser language.
- Host: GitHub
- URL: https://github.com/mjorgegulab/puppeteer-extra-plugin-force-custom-language
- Owner: mjorgegulab
- License: mit
- Created: 2022-08-13T14:19:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T22:01:05.000Z (5 months ago)
- Last Synced: 2024-10-06T03:03:37.855Z (4 months ago)
- Language: JavaScript
- Size: 427 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# puppeteer-extra-plugin-force-custom-language
[](https://app.codacy.com/gh/mjorgegulab/puppeteer-extra-plugin-force-custom-language/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://github.com/mjorgegulab/puppeteer-extra-plugin-force-custom-language/actions/workflows/github-code-scanning/codeql) [](https://snyk.io/test/github/mjorgegulab/puppeteer-extra-plugin-force-custom-language)
> A plugin for [puppeteer-extra](https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra) and [playwright-extra](https://github.com/berstend/puppeteer-extra/tree/master/packages/playwright-extra) to force browser language.
## Install
```bash
yarn add puppeteer-extra-plugin-force-custom-language
# - or -
npm install puppeteer-extra-plugin-force-custom-language
```
If this is your first [puppeteer-extra](https://github.com/berstend/puppeteer-extra) plugin here's everything you need:
```bash
yarn add puppeteer puppeteer-extra puppeteer-extra-plugin-force-custom-language
# - or -
npm install puppeteer puppeteer-extra puppeteer-extra-plugin-force-custom-language
```
## Usage
```js
// puppeteer-extra is a drop-in replacement for puppeteer,
// it augments the installed puppeteer with plugin functionality
const puppeteer = require('puppeteer-extra')
// add force language plugin and use defaults (all techniques)
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin())
// puppeteer usage as normal
puppeteer.launch({ headless: true }).then(async browser => {
console.log('Running tests..')
const page = await browser.newPage()
await page.goto('https://www.google.com')
await page.waitForTimeout(5000)
await page.screenshot({ path: 'testresult.png', fullPage: true })
await browser.close()
console.log(`All done, check the screenshot. ✨`)
})
```
## Plugin options
#### Table of Contents
- [puppeteer-extra-plugin-force-custom-language](#puppeteer-extra-plugin-force-custom-language)
- [Install](#install)
- [Usage](#usage)
- [Plugin options](#plugin-options)
- [Table of Contents](#table-of-contents)
- [language](#language)
- [ip](#ip)
- [httpHeaders](#httpheaders)
- [geoLocation](#geolocation)
- [javascript](#javascript)
- [requestInterceptionPriority](#requestinterceptionpriority)
- [Tools](#tools)
- [Contributing](#contributing)
- [License](#license)
## language
**TYPE**: string
**DEFAULT**: en
**DESCRIPTION**: Language code to use.
(Available options: [en, zh, ru, fr, es, de, pt, it, ja])
**USAGE**:
```javascript
const puppeteer = require('puppeteer-extra')
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin({language: 'es'}))
```
---
## ip
**TYPE**: boolean
**DEFAULT**: true
**DESCRIPTION**: Send a fake ip as origin via HTTP headers.
**USAGE**:
```javascript
const puppeteer = require('puppeteer-extra')
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin({ip: true}))
```
---
## httpHeaders
**TYPE**: boolean
**DEFAULT**: true
**DESCRIPTION**: Send a custom `Accept-Language` HTTP header.
**USAGE**:
```javascript
const puppeteer = require('puppeteer-extra')
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin({httpHeaders: true}))
```
---
## geoLocation
**TYPE**: boolean
**DEFAULT**: true
**DESCRIPTION**: Send a custom geographic coordinates.
**USAGE**:
```javascript
const puppeteer = require('puppeteer-extra')
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin({geoLocation: true}))
```
---
## javascript
**TYPE**: boolean
**DEFAULT**: true
**DESCRIPTION**: Set a custom `navigator.language` & `navigator.languages` javascript getters.
**USAGE**:
```javascript
const puppeteer = require('puppeteer-extra')
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin({javascript: true}))
```
---
## requestInterceptionPriority
**TYPE**: number
**DEFAULT**: -1
**DESCRIPTION**: Set the request interceptor priority. [See this](https://pptr.dev/guides/request-interception)
**USAGE**:
```javascript
const puppeteer = require('puppeteer-extra')
const ForceCustomLanguagePlugin = require('puppeteer-extra-plugin-force-custom-language')
puppeteer.use(ForceCustomLanguagePlugin({requestInterceptionPriority: 0}))
```
## Tools
1. **Check IP Assignment** ([tools/checkIPs.js](tools/checkIPs.js))
_with this tool you can check if the ip addresses found in the local.json file are still assigned to their corresponding country. ⬇️_
---
## Contributing
PRs are welcome.
---
## License
Copyright © 2022 - 2022, [thewolfx41] Released under the MIT License.