Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "Docs"
on:
workflow_dispatch:
push:
branches: [master]
branches: [master, main]
paths:
- ".github/workflows/docs.yaml"
- ".vitepress/**"
Expand All @@ -21,12 +21,12 @@ concurrency:
jobs:
build:
name: "Build"
if: ${{ !contains(github.event.head_commit.message, '#nodeploy') || github.actor != 'dependabot[bot]' }}
if: ${{ !contains(github.event.head_commit.message, '#nodeploy') }}
uses: cssnr/workflows/.github/workflows/npm-build.yaml@master
permissions:
contents: read
with:
#install: "npm ci --legacy-peer-deps"
install: "npm ci --ignore-scripts"
build: "npm run docs:deploy"
path: "docs/.vitepress/dist"
pages: true
Expand Down Expand Up @@ -86,4 +86,4 @@ jobs:
uses: sarisia/actions-status-discord@v1
with:
webhook: ${{ secrets.DISCORD_WEBHOOK }}
description: ${{ github.event.repository.html_url }}/actions/runs/${{ github.run_id }}
description: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
2 changes: 1 addition & 1 deletion .github/workflows/draft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "Draft Release"
on:
workflow_dispatch:
push:
branches: [master]
branches: [master, main]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/issue.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@ jobs:
Provide initial triage and troubleshooting steps, then gather any additional information needed to proceed.
Respond using your general knowledge of Web Extensions and the following knowledge files:
url: https://cssnr.github.io/cache-cleaner/llms.txt
path: |
AGENTS.md
8 changes: 4 additions & 4 deletions .github/workflows/preview.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "Preview"
on:
workflow_dispatch:
push:
branches-ignore: [master, legacy]
branches-ignore: [master, main, legacy]
paths:
- ".github/workflows/preview.yaml"
- ".vitepress/**"
Expand All @@ -17,12 +17,12 @@ concurrency:
jobs:
build:
name: "Build"
if: ${{ !contains(github.event.head_commit.message, '#nodev') }}
if: ${{ !contains(github.event.head_commit.message, '#nopreview') }}
uses: cssnr/workflows/.github/workflows/npm-build.yaml@master
permissions:
contents: read
with:
#install: "npm ci --legacy-peer-deps"
install: "npm ci --ignore-scripts"
build: "npm run docs:deploy"
path: "docs/.vitepress/dist"
secrets: inherit
Expand Down Expand Up @@ -61,7 +61,7 @@ jobs:

- name: "Install"
id: install
run: npm ci
run: npm ci --ignore-scripts

- name: "eslint"
if: ${{ !cancelled() }}
Expand Down
28 changes: 22 additions & 6 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,32 @@
# Cache Cleaner — Agent Guide
# Agent Guide — Cache Cleaner

Before answering any question that involves facts about ANYTHING, you MUST output at least one Read, WebFetch, or WebSearch tool call.
If your first output is text instead of a tool call, you have failed.

Project - This is a Web Extension for Chrome and Firefox using the WXT Framework, TypeScript, and Vue3.
The documentation uses VitePress.

Application - The primary purpose is to allow the user to clear site or browser cache.
The user can select which items are cleared when clearing the cache, or clear everything.

## Project Structure

- `src` - Source directory for the web extension, WXT Framework.
- `docs` - Source directory for the documentation, VitePress framework.

## Commands

ALWAYS use the `npm run *` command

| Command | What it does |
| -------------------- | ------------------------------ |
| `npm run build` | `wxt build` |
| `npm run build:ff` | build Firefox only (faster) |
| `npm run docs` | `vitepress dev docs` |
| `npm run docs:build` | `vitepress build docs` |
| `npm run lint` | `npx eslint src docs` |
| `npm run prettier` | ALWAYS RUN AFTER EDITING FILES |

## Terminology

### Cache Items
Expand Down Expand Up @@ -38,8 +59,3 @@ The extension allows users to interface via the following APIs.
- Right-Click Context Menu - All cache options + Toggle UI
- Side Panel UI - Browser + All Site cache only + Toggle UI
- Popout - Browser + All Site cache only

## Project Structure

- `src` - Source directory for the web extension, WXT Framework.
- `docs` - Source directory for the documentation, VitePress framework.
3 changes: 1 addition & 2 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# TODO

- Update [menus.ts](src/entrypoints/background/menus.ts) to use `page` and not `all`.
- Increase size/padding on site/browser buttons in the popup.
- Add a custom debug logger and replace console.log calls.
- Implement [logger.ts](src/utils/logger.ts).
5 changes: 4 additions & 1 deletion docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@
--vp-button-alt-bg: var(--vp-c-default-1);
}

/* NOTE: This is a "fix" for the search modal content shift */
@supports (scrollbar-gutter: stable) {
/* Note: local search is: 768px */
@media (min-width: 769px) {
html {
scrollbar-gutter: stable;
}
html:has(:fullscreen) {
scrollbar-gutter: auto;
}
}
}

Expand Down
3 changes: 2 additions & 1 deletion docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ export default {
...DefaultTheme,

...chat(DefaultTheme, {
filePath: 'llms.txt',
api: import.meta.env.VITE_AI_API,
headers: import.meta.env.VITE_AI_AUTH
? { Authorization: import.meta.env.VITE_AI_AUTH }
: undefined,
filePath: 'llms.txt',
showReasoning: true,
}),

enhanceApp({ app }) {
Expand Down
Loading
Loading