Repository files navigation

VSCode plugin to quickly open files on Github and other providers. View Git blame information, copy permalinks and more. See the "commands" section of the README for more details.

Open theonline marketplace listing for Githubinator and click "Install". Follow the prompts to open VSCode and install Githubinator.

In VSCode, typeCMD+P and enterext install chdsbd.githubinator. Or search for and installchdsbd.githubinator via the extensions tab.

Download the extension package from thelatest Github release and runcode --install-extension githubinator-*.vsix

Withvsce installed from NPM (yarn global add vsce), clonethis repo and runvsce package. Install the resulting package withcode --install-extension githubinator-*.vsix

The "main" branch is configured viagithubinator.mainBranches (see "Extension Settings" below).

• Local Git repository. You must have a git repository configured with a remote. ("origin" is default but this can be changed in settings).

• githubinator.contextMenu: Enable access to Githubinator commands from the context menu ("enabled"|"submenu"|"disabled"). (default:"enabled")
• githubinator.mainBranches: Branch names to use asmain repository branch. (default:["main", "master", "trunk", "develop", "dev"])
• githubinator.remote: The default remote branch for a repository. (default:"origin")
• githubinator.providers.github.remote: Remote name to look for when identifying a Github origin. (default:"origin")
• githubinator.providers.github.hostnames: Hostnames for identifying a Github origin and building a URL. (default:["github.com"])
• githubinator.providers.gitlab.remote: Remote name to look for when identifying a Gitlab origin. (default:"origin")
• githubinator.providers.gitlab.hostnames: Hostnames for identifying a Gitlab origin and building a url. (default:["gitlab.com"])
• githubinator.providers.bitbucket.remote: Remote name to look for when identifying a Bitbucket origin. (default:"origin")
• githubinator.providers.bitbucket.hostnames: Hostnames for identifying a Bitbucket origin and building a url. (default:["bitbucket.org"])

This plugin is based on theSublime Plugin by ehamiter with the same name.

* changeable in settings between permalink and branch

# install dependenciesmake install# lint (tslint and formatting)make lint# format codemake format# check formattingmake format-ci# run testsmaketest# run linting and testingmake test-ci

• PressF5 to open a new window with your extension loaded.
• Run your command from the command palette by pressing (Ctrl+Shift+P orCmd+Shift+P on Mac) and typingHello World.
• Set breakpoints in your code insidesrc/extension.ts to debug your extension.
• Find output from your extension in the debug console.

• You can relaunch the extension from the debug toolbar after changing code insrc/extension.ts.
• You can also reload (Ctrl+R orCmd+R on Mac) the VS Code window with your extension to load your changes.

• Open the debug viewlet (Ctrl+Shift+D orCmd+Shift+D on Mac) and from the launch configuration dropdown pickExtension Tests.
• PressF5 to run the tests in a new window with your extension loaded.
• See the output of the test result in the debug console.
• Make changes totest/extension.test.ts or create new test files inside thetest folder.
  • By convention, the test runner will only consider files matching the name pattern**.test.ts.
  • You can create folders inside thetest folder to structure your tests any way you want.

vsce packagevsce login chdsbdvsce publish<version>

Based on theGit Logo byJason Long, licensed under theCreative Commons Attribution 3.0 Unported License..