Skip to content

Easily clear cache for the current site and optionally auto-reload with a single key press, from the popup or with the context menu.

License

Notifications You must be signed in to change notification settings

cssnr/cache-cleaner

Repository files navigation

Chrome Web Store Users Mozilla Add-on Users Chrome Web Store Rating Mozilla Add-on Rating GitHub Repo Stars Chrome Web Store Version Mozilla Add-on Version GitHub Release Version Build Test Quality Gate Status GitHub Last Commit GitHub Top Language GitHub Org Stars Discord

Cache Cleaner

Modern Chrome Web Extension and Firefox Browser Addon to easily clean selected cache items specific sites or the whole browser with a single key press, from the right-click context menu or via the toolbar icon popup. Cache cleaner is also available for mobile browsers, see Install below.

Firefox does not have an API to clear cache storage, the cache created by service workers. Furthermore, it has no option to bypass the service worker for network when testing. This extension resolves that issue by using a custom function to clear Cache Storage when clearing site cache plus has an option automatically reload the page after clearing the cache. Now after making a change to a site with a service worker, all you have to do is press F4 (default keybind to clear cache) to clear the cache and refresh the site. Additionally, the browsing data API differs on Firefox and Chrome so logic was added to allow the extension to run on both browsers.

More information on the individual APIs for Firefox and Chrome.

Install

Chrome Firefox Edge Brave Opera Chromium Yandex

All Chromium Based Browsers can install the extension from the Chrome Web Store.

Mobile browser support available for Firefox, Yandex and Kiwi.

Features

  • Clear cache and reload site with a single key or button press
  • Choose which cache items to clear or clear all data
  • Clear cache for a specific site or the whole browser
  • Option to clear Cache Storage in Firefox for individual sites
  • Works in both Firefox and Chromium based browsers

Upcoming Features

  • Custom time frames to clear supported caches
  • Chrome only, option to exclude specified origins

Tip

Don't see your feature here? Request one on the Feature Request Discussion.

Known Issues

  • No major issues detected at the moment...

Tip

Don't see your issue here? Open one on the Issues.

Configuration

You can pin the Addon by clicking the Puzzle Piece, find the Cache Cleaner icon, then;
Chrome, click the Pin icon.
Firefox, click the Settings Wheel and Pin to Toolbar.

To open the options, click on the icon (from above) then click Open Options.
You can also access Options through the right-click context menu (enabled by default).

Usage

Use the extension in one of the three following ways:

  • Click on the Toolbar Icon and using the Popup
  • Set Keyboard Shortcuts for Clearing Cache or Activating the Popup
  • Using the Right Click Context Menu (configurable from Options Page)

Support

For help using the web extension, see:

If you are experiencing an issue/bug or getting unexpected results, you can:

Logs can be found inspecting the page (Ctrl+Shift+I), clicking on the Console, and; Firefox: toggling Debug logs, Chrome: toggling Verbose from levels dropdown.

To support this project, see the Contributing section at the bottom.

Development

Quick Start

First, clone (or download) this repository and change into the directory.

Second, install the dependencies:

npm install

Finally, to run Chrome or Firefox with web-ext, run one of the following:

npm run chrome
npm run firefox

Additionally, to Load Unpacked/Temporary Add-on make a manifest.json and run from the src folder, run one of the following:

npm run manifest:chrome
npm run manifest:firefox

Chrome: https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked
Firefox: https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/

For more information on web-ext, read this documentation.
To pass additional arguments to an npm run command, use --.
Example: npm run chrome -- --chromium-binary=...

Building

Install the requirements and copy libraries into the src/dist directory by running npm install. See gulpfile.js for more information on postinstall.

npm install

To create a .zip archive of the src directory for the desired browser run one of the following:

npm run build
npm run build:chrome
npm run build:firefox

For more information on building, see the scripts section in the package.json file.

Chrome Setup

  1. Build or Download a Release.
  2. Unzip the archive, place the folder where it must remain and note its location for later.
  3. Open Chrome, click the 3 dots in the top right, click Extensions, click Manage Extensions.
  4. In the top right, click Developer Mode then on the top left click Load unpacked.
  5. Navigate to the folder you extracted in step #3 then click Select Folder.

Firefox Setup

  1. Build or Download a Release.
  2. Unzip the archive, place the folder where it must remain and note its location for later.
  3. Go to about:debugging#/runtime/this-firefox and click Load Temporary Add-on...
  4. Navigate to the folder you extracted earlier, select manifest.json then click Select File.
  5. Optional: open about:config search for extensions.webextensions.keepStorageOnUninstall and set to true.

If you need to test a restart, you must pack the addon. This only works in ESR, Development, or Nightly. You may also use an Unbranded Build: https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds

  1. Run npm run build:firefox then use web-ext-artifacts/{name}-firefox-{version}.zip.
  2. Open about:config search for xpinstall.signatures.required and set to false.
  3. Open about:addons and drag the zip file to the page or choose Install from File from the Settings wheel.

Contributing

Currently, the best way to contribute to this project is to give a 5-star rating on Google or Mozilla and to star this project on GitHub.

Other Web Extensions I have created and published:

For a full list of current projects visit: https://cssnr.github.io/

About

Easily clear cache for the current site and optionally auto-reload with a single key press, from the popup or with the context menu.

Resources

License

Stars

Watchers

Forks