`<script setup>` by yyx990803 · Pull Request #227 · vuejs/rfcs
added 3 commits
October 30, 2020 17:17This was referenced
Nov 9, 2020kawamataryo added a commit to kawamataryo/chikamichi that referenced this pull request
Jan 3, 2022diff --git a/README.md b/README.md index 8faad38..882547e 100644 --- a/README.md +++ b/README.md @@ -1,132 +1,21 @@ -# WebExtension Vite Starter +# Fussy history search -A [Vite](https://vitejs.dev/) powered WebExtension ([Chrome](https://developer.chrome.com/docs/extensions/reference/), [FireFox](https://addons.mozilla.org/en-US/developers/), etc.) starter template. - -<p align="center"> -<sub>Popup</sub><br/> -<img width="655" src="https://user-images.githubusercontent.com/11247099/126741643-813b3773-17ff-4281-9737-f319e00feddc.png"><br/> -<sub>Options Page</sub><br/> -<img width="655" src="https://user-images.githubusercontent.com/11247099/126741653-43125b62-6578-4452-83a7-bee19be2eaa2.png"><br/> -<sub>Inject Vue App into the Content Script</sub><br/> -<img src="https://user-images.githubusercontent.com/11247099/130695439-52418cf0-e186-4085-8e19-23fe808a274e.png"> -</p> +A very simple Chrome extension that enables fuzzy search of browsing histories. ## Features -- ⚡️ **Instant HMR** - use **Vite** on dev (no more refresh!) -- 🥝 Vue 3 - Composition API, [`<script setup>` syntax](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0040-script-setup.md) and more! -- 💬 Effortless communications - powered by [`webext-bridge`](https://github.com/antfu/webext-bridge) and [VueUse](https://github.com/antfu/vueuse) storage -- 🍃 [Windi CSS](https://windicss.org/) - on-demand CSS utilities -- 🦾 [TypeScript](https://www.typescriptlang.org/) - type safe -- 📦 [Components auto importing](./src/components) -- 🌟 [Icons](./src/components) - Access to icons from any iconset directly -- 🖥 Content Script - Use Vue even in content script -- 🌍 WebExtension - isomorphic extension for Chrome, Firefox, and others -- 📃 Dynamic `manifest.json` with full type support - -## Pre-packed - -### WebExtension Libraries - -- [`webextension-polyfill`](https://github.com/mozilla/webextension-polyfill) - WebExtension browser API Polyfill with types -- [`webext-bridge`](https://github.com/antfu/webext-bridge) - effortlessly communication between contexts - -### Vite Plugins - -- [`unplugin-auto-import`](https://github.com/antfu/unplugin-auto-import) - Directly use `browser` and Vue Composition API without importing -- [`unplugin-vue-components`](https://github.com/antfu/vite-plugin-components) - components auto import -- [`unplugin-icons`](https://github.com/antfu/unplugin-icons) - icons as components - - [Iconify](https://iconify.design) - use icons from any icon sets [🔍Icônes](https://icones.netlify.app/) -- [`vite-plugin-windicss`](https://github.com/antfu/vite-plugin-windicss) - WindiCSS support - -### Vue Plugins - -- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs - -### UI Frameworks - -- [Windi CSS](https://github.com/windicss/windicss) - next generation utility-first CSS framework - -### Coding Style - -- Use Composition API with [`<script setup>` SFC syntax](vuejs/rfcs#227) -- [ESLint](https://eslint.org/) with [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi - -### Dev tools - -- [TypeScript](https://www.typescriptlang.org/) -- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager -- [esno](https://github.com/antfu/esno) - TypeScript / ESNext node runtime powered by esbuild -- [npm-run-all](https://github.com/mysticatea/npm-run-all) - Run multiple npm-scripts in parallel or sequential -- [web-ext](https://github.com/mozilla/web-ext) - Streamlined experience for developing web extensions - -## Use the Template - -### GitHub Template - -[Create a repo from this template on GitHub](https://github.com/antfu/vitesse-webext/generate). - -### Clone to local - -If you prefer to do it manually with the cleaner git history - -> If you don't have pnpm installed, run: npm install -g pnpm - -```bash -npx degit antfu/vitesse-webext my-webext -cd my-webext -pnpm i -``` - -## Usage - -### Folders - -- `src` - main source. - - `contentScript` - scripts and components to be injected as `content_script` - - `background` - scripts for background. - - `components` - auto-imported Vue components that shared in popup and options page. - - `styles` - styles shared in popup and options page - - `manifest.ts` - manifest for the extension. -- `extension` - extension package root. - - `assets` - static assets. - - `dist` - built files, also serve stub entry for Vite on development. -- `scripts` - development and bundling helper scripts. - -### Development - -```bash -pnpm dev -``` - -Then **load extension in browser with the `extension/` folder**. - -For Firefox developers, you can run the following command instead: - -```bash -pnpm start:firefox -``` - -`web-ext` auto reload the extension when `extension/` files changed. - -> While Vite handles HMR automatically in the most of the case, [Extensions Reloader](https://chrome.google.com/webstore/detail/fimgfedafeadlieiabdeeaodndnlbhid) is still recommanded for cleaner hard reloading. - -### Build - -To build the extension, run - -```bash -pnpm build -``` +- ⚡️ Fuzzy search your browsing history. powered by [Fuse.js](https://fusejs.io/) +- 🔐 All processing is done within the browser. No history data will be sent to the any server. -And then pack files under `extension`, you can upload `extension.crx` or `extension.xpi` to appropriate extension store. +## Demo -## Credits +https://user-images.githubusercontent.com/11070996/147921381-500b1045-c544-4938-bc5f-f88759cc415b.mp4 - +## install -This template is originally made for the [volta.net](https://volta.net) browser extension. +// TODO -## Variations +I am currently in the process of submitting an extension to the public. -This is a variant of [Vitesse](https://github.com/antfu/vitesse), check out the [full variations list](https://github.com/antfu/vitesse#variations). +## Contributing +Contributions are welcome 🎉 We accept contributions via Pull Requests. diff --git a/package.json b/package.json index e9de3f1..6061c11 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "vitesse-webext", - "displayName": "Vitesse WebExt", + "name": "fussy-histoty-search", + "displayName": "Fussy history search", "version": "0.0.1", - "description": "[description]", + "description": "A very simple Chrome extension that enables fuzzy search of browsing histories.", "private": true, "scripts": { "dev": "npm run clear && cross-env NODE_ENV=development run-p dev:*",
This was referenced
Jun 23, 2022cleverfish0v0 pushed a commit to cleverfish0v0/luffycity that referenced this pull request
Apr 17, 2024…S module exports. If you are using a previous version of <script setup>, please consult the updated RFC at vuejs/rfcs#227.
seleningchan pushed a commit to seleningchan/personal-website that referenced this pull request
Nov 18, 2024…p> cannot contain ES module exports. If you are using a previous version of <script setup>, please consult the updated RFC at vuejs/rfcs#227.
sanskar-mk2 added a commit to sanskar-mk2/theme-change that referenced this pull request
Mar 16, 2025This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters