https://github.com/tjx666/view-github-repository

Open npm package GitHub repository straight from VScode
https://github.com/tjx666/view-github-repository

github repository vscode vscode-extension

Last synced: 4 months ago
JSON representation

Open npm package GitHub repository straight from VScode

• Host: GitHub
• URL: https://github.com/tjx666/view-github-repository
• Owner: tjx666
• License: mit
• Created: 2019-12-03T14:25:23.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-20T01:35:30.000Z (over 2 years ago)
• Last Synced: 2024-10-04T16:43:41.759Z (4 months ago)
• Topics: github, repository, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=YuTengjing.view-github-repository
• Size: 3.87 MB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# View GitHub Repository

Open npm package GitHub repository straight from VSCode.

[![Version](https://vsmarketplacebadge.apphb.com/version-short/yutengjing.view-github-repository.svg)](https://marketplace.visualstudio.com/items?itemName=yutengjing.view-github-repository) [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/yutengjing.view-github-repository.svg)](https://marketplace.visualstudio.com/items?itemName=yutengjing.view-github-repository) [![Downloads](https://vsmarketplacebadge.apphb.com/downloads-short/yutengjing.view-github-repository.svg)](https://marketplace.visualstudio.com/items?itemName=yutengjing.view-github-repository) [![Rating Star](https://vsmarketplacebadge.apphb.com/rating-star/yutengjing.view-github-repository.svg)](https://marketplace.visualstudio.com/items?itemName=yutengjing.view-github-repository) [![Trending Monthly](https://vsmarketplacebadge.apphb.com/trending-monthly/yutengjing.view-github-repository.svg)](https://marketplace.visualstudio.com/items?itemName=yutengjing.view-github-repository) [![Percentage of issues still open](https://isitmaintained.com/badge/open/tjx666/view-github-repository.svg)](http://isitmaintained.com/project/tjx666/view-github-repository')

[![Build Status](https://travis-ci.org/tjx666/view-github-repository.svg?branch=master)](https://travis-ci.org/tjx666/view-github-repository) [![Known Vulnerabilities](https://snyk.io/test/github/tjx666/view-github-repository/badge.svg?targetFile=package.json)](https://snyk.io/test/github/tjx666/view-github-repository?targetFile=package.json)



## Features

This extension provides two commands:

1. `view github repository`

2. `view github repository (package.json)`

## Usage

1. navigate to the file where you import/require the npm packages. Support the following three forms of import statement:

   ```javascript

   const path = require('path');

   import webpack from 'webpack';

   export * from 'lodash';

   ```

2. use the shortcut ctrl + shift + p(Windows) or ⌘ + shift + p(macOS) to expand command panel, select one of commands you need listed above.

![view github repository of active editor](https://github.com/tjx666/view-github-repository/blob/master/images/usage.gif?raw=true)

## Details

### view github repository

With this command, you can open the github repository of npm packages which imported/required in current active editor.

Support languages:

- javascript(.js)

- javascriptreact(.jsx)

- vue(.vue)

- typescript(.ts)

- typescriptreact(.tsx)

If you select a node builtIn module, the extension will open the nodejs official document of selected module.

If current active editor's fileName is just `package.json`, this extension will list all the dependencies and devDependencies modules.

### view github repository (package.json)

This command will load all the module names from package.json exists in workspace root path.

### TODO

- [ ] import statement is multiple lines

- [ ] module alias

## 🧡 Backers

Thanks to `JiangShiqi` for designing the extension's logo.