devidw / gearchy Goto Github PK

Internet's first Goggles manager.

License: GNU General Public License v3.0

Dockerfile 0.10% JavaScript 9.53% HTML 0.86% Vue 28.43% TypeScript 54.51% Sass 1.26% Astro 4.13% Stylus 0.08% Svelte 1.11%

brave-goggle brave-search goggles goggles-api goggles-filter gist gist-client gists webapp goggledy

gearchy's Introduction

Gearchy

ℹ️	Gearchy is in beta, if you encounter any issues, please rise an issue.

Gearchy (pronounced like "gearky") has two main goals:

Enhance the overall experience of interacting with Brave Search Goggles
Lower the barrier for new users (especially non-technical users) to join the community

This is done by:

Providing a graphical interface to interact with Goggles, including an interactive Goggle editor which does not require any knowledge of the Goggle’s syntax
Integrating with GitHub Gists as a Goggle hosting provider to permanently store Goggles
Integrating with the Brave Search API to automatically submit Goggles without the need to reenter the Goggle URL on every change made to the Goggle

Graphics by Robert Wolf

gearchy's People

Contributors

Stargazers

Watchers

Forkers

eldk

gearchy's Issues

Make uno and quasar breakpoints equal

storage migrations

quasar boot file
store version number
to migration when key names change in local storage
is there a best way to do this?

gearchy pw field for personal access token

after token change auth not initially working

gearchy other platform integrations beside GitHub

gitlab
https://stackoverflow.com/a/39462342/13765033

Indicate way to add options to instructions

gearchy editor prevent newlines

gearchy editor advanced dev mode

#39 (comment)

gearchy code preview break all lines

Extend details on goggle single view

indicate if public or private

gearchy offer option to replace goggle URLs on clone

Checkbox in the clone dialog to replace data relevant to the source of the clone, which is not relevant to the cloned goggle:

meta data homepage url
meta data issues url

gearchy goggle editor remember tab scroll position on tab change

gearchy move code copy to code preview overlay instead of action bar

gearchy feature custom goggle dependencies

In the goggle editor, the user should be able to define a list of gist URLs that are treated as dependencies (extra tab in the editor?)

This way, goggles could inherit/extend rules from other goggles

The defined dependencies have to be saved into the goggle, most likely some meta comment

And once the gist gets written to GitHub, the dependencies have to be pulled and their instructions (all metadata and comments should be removed) need to be placed inside the goggle

Placement inside the goggle should wrap inside a pair of comments that defines start and end of dependencies

Vendor instructions need to be ignored or striped before the goggle is loaded into the editor

For example, something like:

! name: …

! depends_on: https://…
! depends_on: https://…

! dependency injection start
…
! dependency injection end

…

For implementation of such functionality, perhaps there should be something like a plugin system to be able to extend goggledy to allow custom metadata lines and custom start/end blocks inside goggles

Maybe goggledy should handle an internal list of possible line syntaxes and plugins could register custom syntax definitions like for example a custom metadata line which would detec any ! …: … line

Dependency functionality should not be bundled into goggledy directly, rather as an extra package

The package could ship functionality to:

clear a goggle instance from dependency specific comment and instructions
get and set the dependency URLs and dependency instructions from a goggle instance
fetch and process the dependency URLs and get the instructions cleaned from meta, comments, etc.

These functions would be invoked inside gearchy when the goggle is parsed and stringified

Dependency URLs and content should be managed inside an extra store or the goggle store

Gearchy should also allow the user to trigger an update on the dependencies, this would fetch all dependency sources and place them inside the goggle

Normally only those already in the goggle would be saved to the updated goggle again without updating

Questions on the UI

Hi @devidw,

It's great to see this tool getting together and having a community-based editor for Goggles! So congratz for that.
I was giving it a shot and has some early feedback on the UX, in case that's something you'd like to consider.

On the below:

There are a few buttons but it's not immediately clear what they do, maybe would it make sense to have on each of them a short tooltip when hovering with the mouse to explain what they are about?
When duplicating a Goggle instruction, we end up with two entangled rules (changing the action of one for example will also apply the same change to the other one).

On the below image, if we create a rule then use a newline, then it is seen as two rules (one being empty and resulting in $downrank=6,inurl); maybe would it make sense to ignore empty lines? Or prevent the edition of two instructions at the same time?

On the below image, when creating an empty instruction, then maybe we should not reflect it to the Goggle until the pattern or action is non-empty?

Otherwise we end up with something like this:

Thanks a lot for working on this, it's looking great!