https://github.com/gajananpp/puppeteer-ide-extension

Standalone puppeteer playground in browser's developer tools.
https://github.com/gajananpp/puppeteer-ide-extension

automation chrome-devtools-protocol chrome-extension ide puppeteer

Last synced: 3 months ago
JSON representation

Standalone puppeteer playground in browser's developer tools.

• Host: GitHub
• URL: https://github.com/gajananpp/puppeteer-ide-extension
• Owner: gajananpp
• License: mit
• Created: 2021-12-12T19:20:15.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-13T10:25:49.000Z (about 1 year ago)
• Last Synced: 2024-08-02T16:11:20.418Z (6 months ago)
• Topics: automation, chrome-devtools-protocol, chrome-extension, ide, puppeteer
• Language: TypeScript
• Homepage:
• Size: 9.06 MB
• Stars: 198
• Watchers: 4
• Forks: 20
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-chrome-devtools - Puppeteer IDE - Standalone Puppeteer playground in browser's developer tools. (DevTools Extensions / Automation)

README

        


# Puppeteer IDE Extension

![lint](https://github.com/gajananpp/puppeteer-ide-extension/actions/workflows/lint.yml/badge.svg) 

![build](https://github.com/gajananpp/puppeteer-ide-extension/actions/workflows/build.yml/badge.svg) 

A standalone extension to write and execute puppeteer scripts from browser's developer tools.

[Installation](#installation) •

[Usage](#usage) •

[Screenshots](#screenshots) •

[Build From Source](#build-from-source) •

[Privacy](#privacy) •

[Todo](#todo) •

[FAQs](#faqs)





## Installation

This extension is published on chrome web store.

[![Add from Chrome web store](assets/chrome-web-store-btn.png)](https://chrome.google.com/webstore/detail/puppeteer-ide/ilehdekjacappgghkgmmlbhgbnlkgoid)

## Usage

This extension will add an extra tab named "Puppeteer IDE" in browser's developer tools from where you can write and execute puppeteer scripts.

Use [page](https://pptr.dev/#?product=Puppeteer&version=v13.0.0&show=api-class-page) instance variable directly for the tab in which developer tools is opened. 

On clicking `Execute` button, the script will be executed on the inspected tab.

The script will be auto saved as it is being edited.

## Screenshots

Using `$0` :-

![Using $0 to get selector](assets/screenshots/$0-usage.gif)

Dark theme :- 

![Dark theme](assets/screenshots/screen-1.png)

Light theme :- 

![Light theme](assets/screenshots/screen-2.png)

## Build From Source

To build extension from source :-

```

git clone https://github.com/gajananpp/puppeteer-ide-extension

cd puppeteer-ide-extension

npm install

npm run dist

```

This will output extension in dist folder which you can load in your browser by following this [steps](https://developer.chrome.com/docs/extensions/mv3/getstarted/#:~:text=The%20directory%20holding%20the%20manifest%20file%20can%20be%20added%20as%20an%20extension%20in%20developer%20mode%20in%20its%20current%20state.).

## Privacy

This extension is standalone. **It doesn't make any external api calls**. You can inspect network of page/extension and source code in this repo.

## Todo

- [x] Add multi tab/script support.

- [x] Add theme switch.

- [x] Print unhandled errors in console tab of inspected window.

- [x] Suggesting xPath of currently selected element when `$0` typed in editor.

- [ ] Binding keyboard shortcut with script for execution without devtools opened.

- [ ] Adjustable delay in execution.

- [ ] Show used/available chrome storage space.

## FAQs

**Q: Does this extension have any external dependency ?**




No. This extension internally uses [chrome.debugger](https://developer.chrome.com/docs/extensions/reference/debugger/) api and is standalone, so there is no requirement of starting browser with remote debugging cli flag or having nodejs or any other service running. 




**Q: On which browsers can this extension be installed ?**




This extension only works with chrome and other chromium based browsers like edge, brave etc.




**Q: Execution stops abruptly when page navigates ?**




Some other extensions may cause this issue, especially 3rd party extensions which are added by desktop applications. One particular extension is `Adobe Acrobat` which is added by Adobe's desktop application.

You can disable this extension and try again executing.




**Q: From where can this extension be installed ?**




This extension is published on chrome web store. Click on below button to view it in chrome web store.

[![Add from Chrome web store](assets/chrome-web-store-btn.png)](https://chrome.google.com/webstore/detail/puppeteer-ide/ilehdekjacappgghkgmmlbhgbnlkgoid)




**Q: How can be puppeteer script executed in extension ?**




Check out [puppeteer-extension-transport](https://github.com/gajananpp/puppeteer-extension-transport) package.