Skip to content

Latest commit

 

History

History
299 lines (217 loc) · 11.6 KB

extention_v0.md

File metadata and controls

299 lines (217 loc) · 11.6 KB

Project create from scratch prompt and response

Model: GPT4

You are a chrome extension expert, you’ll guide me step by step to create my own extension and publish to extension marketplace. First what are the steps needed to create an extension? Please write in English language.

Creating a Chrome extension involves several steps. Here's a step-by-step guide to help you create your own extension and publish it to the Chrome Web Store:

  1. Plan your extension: Identify the purpose, features, and target audience for your extension. Sketch out a basic design, and determine the permissions and APIs needed for it to function.

  2. Set up your development environment:

    • Install a code editor, such as Visual Studio Code or Sublime Text.
    • Make sure you have Google Chrome installed on your computer.
  3. Create the extension's files and folders: Create a new folder for your extension and include the following files:

    • manifest.json: The manifest file contains metadata about the extension, such as its name, version, description, permissions, and more.
    • popup.html (optional): If your extension uses a popup, create an HTML file for it.
    • background.js (optional): If your extension requires background processing, create a JavaScript file for it.
    • content.js (optional): If your extension interacts with the content of web pages, create a JavaScript file for it.
    • options.html (optional): If your extension provides configurable options, create an HTML file for it.
    • styles.css (optional): If you want to apply custom styles to your extension's UI, create a CSS file for it.
    • Icons and images: Include any icons or images your extension will use.
  4. Write the manifest file: Fill in the manifest.json file with the required information. Here's a basic example:

    json

    {
      "manifest_version": 2,
      "name": "My Extension",
      "version": "1.0",
      "description": "A sample Chrome extension",
      "icons": {
        "48": "icon48.png",
        "128": "icon128.png"
      },
      "browser_action": {
        "default_icon": "icon48.png",
        "default_popup": "popup.html"
      },
      "permissions": [
        "activeTab"
      ]
    }
  5. Develop the extension's functionality: Write the HTML, JavaScript, and CSS files to implement your extension's features. Use Chrome APIs to interact with the browser and web pages.

  6. Test your extension:

    • Open Chrome and go to chrome://extensions/.
    • Enable "Developer mode" in the top-right corner.
    • Click "Load unpacked" and select your extension's folder.
    • Test your extension and fix any issues that arise.
  7. Prepare for publication:

    • Create a 128x128 pixel icon for the Chrome Web Store listing.
    • Write a detailed description and provide screenshots or a video showcasing your extension's features.
    • Compress your extension folder into a .zip file.
  8. Publish to the Chrome Web Store:

    • Go to the Chrome Web Store Developer Dashboard: https://chrome.google.com/webstore/devconsole
    • Sign in with your Google account or create a new one.
    • Pay the one-time developer fee ($5 at the time of writing) if you haven't already.
    • Click "New Item" and upload your .zip file.
    • Fill in the required information, such as the extension's name, description, icons, and category.
    • Click "Publish" and wait for Google to review and approve your extension.

Congratulations! You've now created and published your own Chrome extension. Remember to regularly update your extension to fix bugs and add new features.

I want to create an extension that detects if there is any element with a "word-streaming" class. If there is one, setup a listener that plays a sound when "word-streaming" class is removed. Please write in English language.

To create a Chrome extension that detects elements with the "word-streaming" class and plays a sound when the class is removed, follow these steps:

  1. Set up the extension files and folders as explained in the previous answer. For this extension, you'll need the following files:

    • manifest.json
    • content.js
    • sound.mp3 (or any audio file format supported by the browser)
  2. Write the manifest file:

    json

    {
      "manifest_version": 2,
      "name": "Word Streaming Notifier",
      "version": "1.0",
      "description": "Plays a sound when 'word-streaming' class is removed from an element",
      "icons": {
        "48": "icon48.png",
        "128": "icon128.png"
      },
      "content_scripts": [
        {
          "matches": ["*://*/*"],
          "js": ["content.js"]
        }
      ],
      "permissions": ["tabs", "storage"],
      "web_accessible_resources": ["sound.mp3"]
    }
  3. Write the content script (content.js):

    javascript

    const audio = new Audio(chrome.runtime.getURL('sound.mp3'));
    
    function checkForWordStreamingClass() {
      return Array.from(document.querySelectorAll('.word-streaming'));
    }
    
    function observeClassChanges(elements) {
      const observer = new MutationObserver((mutations) => {
        mutations.forEach((mutation) => {
          if (mutation.attributeName === 'class') {
            const oldClassList = mutation.oldValue.split(' ');
            const newClassList = mutation.target.className.split(' ');
    
            if (oldClassList.includes('word-streaming') && !newClassList.includes('word-streaming')) {
              audio.play();
            }
          }
        });
      });
    
      elements.forEach((element) => {
        observer.observe(element, { attributes: true, attributeOldValue: true, attributeFilter: ['class'] });
      });
    }
    
    const wordStreamingElements = checkForWordStreamingClass();
    
    if (wordStreamingElements.length > 0) {
      observeClassChanges(wordStreamingElements);
    }
  4. Test and publish the extension as explained in the previous answer.

This extension will now listen for elements with the "word-streaming" class and play a sound when the class is removed. Make sure to replace icon48.png, icon128.png, and sound.mp3 with your actual files.

Where should I upload my mp3 file? Please write in English language.

You should place your sound.mp3 file in the root folder of your Chrome extension, alongside the other files like manifest.json and content.js.

When the extension is loaded in the browser, the sound.mp3 file will be accessible through the chrome.runtime.getURL() function as shown in the content.js example:

javascript

const audio = new Audio(chrome.runtime.getURL('sound.mp3'));

This allows the extension to play the sound file when needed. Remember to include the sound.mp3 file when you package your extension for uploading to the Chrome Web Store.

The page renders dynamically, how do I continuously detect the class change? also the class name should be "result-streaming" Please write in English language.

To continuously detect the class change for dynamically rendered pages, you can use a MutationObserver to watch for changes in the DOM. Here's the updated code for the content script (content.js) with the correct class name "result-streaming":

javascript

const audio = new Audio(chrome.runtime.getURL('sound.mp3'));

function checkForResultStreamingClass() {
  return Array.from(document.querySelectorAll('.result-streaming'));
}

function observeClassChanges(elements) {
  const observer = new MutationObserver((mutations) => {
    mutations.forEach((mutation) => {
      if (mutation.attributeName === 'class') {
        const oldClassList = mutation.oldValue.split(' ');
        const newClassList = mutation.target.className.split(' ');

        if (oldClassList.includes('result-streaming') && !newClassList.includes('result-streaming')) {
          audio.play();
        }
      }
    });
  });

  elements.forEach((element) => {
    observer.observe(element, { attributes: true, attributeOldValue: true, attributeFilter: ['class'] });
  });
}

function observeDOMChanges() {
  const bodyObserver = new MutationObserver((mutations) => {
    mutations.forEach((mutation) => {
      if (mutation.type === 'childList') {
        const newResultStreamingElements = checkForResultStreamingClass();
        if (newResultStreamingElements.length > 0) {
          observeClassChanges(newResultStreamingElements);
        }
      }
    });
  });

  bodyObserver.observe(document.body, { childList: true, subtree: true });
}

const resultStreamingElements = checkForResultStreamingClass();

if (resultStreamingElements.length > 0) {
  observeClassChanges(resultStreamingElements);
}

observeDOMChanges();

This script will now not only observe the class changes of existing elements with the "result-streaming" class but also watch for new elements added to the DOM. If a new element with the "result-streaming" class is detected, it will start observing its class changes as well.

Can you walk me through the code? Please write in English language.

Certainly! I'll explain each part of the updated content.js code.

  1. Loading the audio file:

javascript

const audio = new Audio(chrome.runtime.getURL('sound.mp3'));

Here, we create an Audio object using the sound.mp3 file from the extension's folder. chrome.runtime.getURL() is used to get the URL of the audio file within the extension.

  1. Function to find elements with "result-streaming" class:

javascript

function checkForResultStreamingClass() {
  return Array.from(document.querySelectorAll('.result-streaming'));
}

This function searches the document for elements with the "result-streaming" class and returns an array containing those elements.

  1. Function to observe class changes for given elements:

javascript

function observeClassChanges(elements) {
  // ...
}

This function takes an array of elements and sets up a MutationObserver to watch for changes in the class attribute of each element. If an element loses the "result-streaming" class, the audio will play.

  1. Function to observe DOM changes:

javascript

function observeDOMChanges() {
  // ...
}

This function sets up a MutationObserver to watch for changes in the DOM, specifically for the addition or removal of elements. If new elements with the "result-streaming" class are added to the DOM, the observeClassChanges function will be called to watch for class changes in those elements.

  1. Initial check for elements with "result-streaming" class:

javascript

const resultStreamingElements = checkForResultStreamingClass();

if (resultStreamingElements.length > 0) {
  observeClassChanges(resultStreamingElements);
}

At the beginning of the script execution, we check if there are any elements with the "result-streaming" class already in the document. If there are, we start observing their class changes with the observeClassChanges function.

  1. Start observing DOM changes:

javascript

observeDOMChanges();

Finally, we call the observeDOMChanges function to watch for DOM changes, including the addition of new elements with the "result-streaming" class.

In summary, this script does the following:

  • Loads the audio file for playback.
  • Searches for elements with the "result-streaming" class and observes their class changes.
  • Watches for DOM changes to detect the addition of new elements with the "result-streaming" class.
  • Plays the audio when an element loses the "result-streaming" class.