Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pd4d10/octohint
The missing IntelliSense hint for GitHub and GitLab
https://github.com/pd4d10/octohint
browser-extension chrome-extension github github-extension gitlab intellisense
Last synced: 22 days ago
JSON representation
The missing IntelliSense hint for GitHub and GitLab
- Host: GitHub
- URL: https://github.com/pd4d10/octohint
- Owner: pd4d10
- License: mit
- Created: 2017-01-19T02:40:27.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T18:47:45.000Z (about 2 months ago)
- Last Synced: 2024-09-30T03:04:27.358Z (about 1 month ago)
- Topics: browser-extension, chrome-extension, github, github-extension, gitlab, intellisense
- Language: TypeScript
- Homepage: https://chrome.google.com/webstore/detail/octohint/hbkpjkfdheainjkkebeoofkpgddnnbpk
- Size: 3.63 MB
- Stars: 962
- Watchers: 17
- Forks: 35
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - pd4d10/octohint - The missing IntelliSense hint for GitHub and GitLab (TypeScript)
README
# Octohint
[![chrome web store](https://img.shields.io/chrome-web-store/v/hbkpjkfdheainjkkebeoofkpgddnnbpk.svg)](https://chrome.google.com/webstore/detail/hbkpjkfdheainjkkebeoofkpgddnnbpk)
[![users](https://img.shields.io/chrome-web-store/d/hbkpjkfdheainjkkebeoofkpgddnnbpk.svg)](https://chrome.google.com/webstore/detail/hbkpjkfdheainjkkebeoofkpgddnnbpk)
[![rating](https://img.shields.io/chrome-web-store/stars/hbkpjkfdheainjkkebeoofkpgddnnbpk.svg)](https://chrome.google.com/webstore/detail/hbkpjkfdheainjkkebeoofkpgddnnbpk)## Introduction
Octohint is a browser extension which adds IntelliSense hint to GitHub and GitLab.
[Introduction at Medium](https://medium.com/@pd4d10/introducing-octohint-e1a3e4b80c47)
## Installation
### Chrome
Install it from [Chrome Web Store](https://chrome.google.com/webstore/detail/octohint/hbkpjkfdheainjkkebeoofkpgddnnbpk)
### Firefox
Currently you could build it from source, see web extension section of [contributing docs](CONTRIBUTING.md). Or [try this one](https://github.com/pd4d10/octohint/issues/24#issuecomment-450467200).
You can use the "On your own" signing option on [Mozilla addon site](https://addons.mozilla.org/en-US/developers/addon/submit/distribution) to create a signed add-on for your self, and install it.
Alternatively, you can follow [this guide](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) to install it temporarly from local directory, note that add-on installed this way is temporary add-on, and will be removed every time you restart the Firefox.Make sure your version of Firefox supports web extensions.
### Opera
Use this extension: [Install Chrome Extensions](https://addons.opera.com/en/extensions/details/download-chrome-extension-9/) to install Octohint from Chrome Web Store
## Features
With Octohint installed, when you view code at GitHub (For example [this demo](https://github.com/pd4d10/octohint/blob/master/assets/demo.ts)), you'll get features as follows:
- Mouse Hover: Show information of current token
- Left Click: Show all references of current token
- [⌘] + Click: Go to definition of current token (For Windows and Linux user, use [Ctrl] instead)## Supported languages
Octohint supports all languages. There are two strategies:
- IntelliSense hint: TypeScript, JavaScript, CSS, LESS, SCSS
- Simple token matching: All other languagesIt is because browser only runs JavaScript. But with help of WebAssembly, maybe we could bring other languages' IntelliSense analysis to browser! It's still in research
## Supported platforms
Support GitHub and GitLab. Since GitLab CE has many versions, I'm not sure it works correctly on every version. If you find some bugs you could [submit an issue](https://github.com/pd4d10/octohint/issues/new).
Bitbucket's code viewer UI has changed greatly, so there is still lots of work to do.
## Get your private site works
If GitHub/GitLab/Bitbucket you are using is hosted on different site, go to chrome://extensions, click options of Octohint, then add [match patterns](https://developer.chrome.com/extensions/match_patterns) of your site, like `https://www.example.com/*`.
## Privacy policy
Octohint is a pure client thing. All code analysis are performed at your browser, which means your code and actions log like click, mousemove will never be sent to any server.
Feel free to use it at your private GitHub/GitLab/Bitbucket.
## Related tools
- [Octoview](https://github.com/pd4d10/octoview): The missing preview feature for GitHub
## License
MIT