Skip to content

Commit

Permalink
Merge pull request #307 from MLH-Fellowship/vscode-ext
Browse files Browse the repository at this point in the history
Packaged VS Code extension and Added Readme instructions to unpackage extension
  • Loading branch information
gleitz authored Aug 23, 2020
2 parents f78f88d + f5284c5 commit 793b7ef
Show file tree
Hide file tree
Showing 9 changed files with 85 additions and 23 deletions.
18 changes: 5 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,22 +199,14 @@ Or parse it yourself (either work):
Extension Development
---------------------

To simplify the process of integrating howdoi as a code editor extension, edit the files within the ``extension/code-editor-integration`` folder.
To simplify the process of integrating howdoi as a code editor extension, edit the files within the `extension/code-editor-integration folder <https://github.com/gleitz/howdoi/tree/master/extension/code-editor-integration>`_.

To improve upon the Visual Studio Code howdoi extension, edit the files within the ``extension/vscode-ext`` folder and republish the extension.
To improve upon the Visual Studio Code howdoi extension, edit the files within the `extension/vscode-ext folder <https://github.com/gleitz/howdoi/tree/master/extension/vscode-howdoi>`_ and republish the extension.

Code Editor Integration
~~~~~~~~~~~~~~~~~~~~~~~

To begin development for the howdoi code editor integration plug-in, install howdoi on your machine.

Then, install all necessary packages:

::

npm install

Continue to the ``README.md`` within the ``extension/code-editor-integration`` folder for an in depth explanation.
Head over to the `README.md <https://github.com/gleitz/howdoi/blob/master/extension/code-editor-integration/README.md>`_ for an in depth explanation on beginning development for the howdoi code editor integration plug-in.

Visual Studio Code Extension
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -239,10 +231,10 @@ Visual Studio Code Extension Installation
howdoi can now be installed as an extension on Visual Studio Code! There are two ways to install it:

1. On the Visual Studio Code MarketPlace:
- (coming soon)
- Head over to the `MarketPlace <https://marketplace.visualstudio.com/items?itemName=howdoi-org.howdoi>`_ to install the extension.

2. Directly from the packaged extension:
- (coming soon)
- Head over `here <https://github.com/gleitz/howdoi/tree/master/extension/vscode-pkg/README.md>`_ to locally install the howdoi Visual Studio Code package.

Contributing
------------
Expand Down
1 change: 1 addition & 0 deletions extension/code-editor-integration/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Code Editor Integration Development
![Node.js CI](https://img.shields.io/github/workflow/status/gleitz/howdoi/Node.js%20CI?color=78dce8&label=Node.js%20CI&style=plastic)

Simplifies the process of integrating howdoi as a code editor extension.

Expand Down
7 changes: 0 additions & 7 deletions extension/vscode-howdoi/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,2 @@
# Change Log

All notable changes to the "howdoi" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [Unreleased]

- Initial release
21 changes: 21 additions & 0 deletions extension/vscode-howdoi/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Diana Arreola

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Binary file added extension/vscode-howdoi/img/howdoi-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 35 additions & 3 deletions extension/vscode-howdoi/package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
{
"name": "howdoi",
"displayName": "howdoi",
"publisher": "Diana",
"publisher": "howdoi-org",
"description": "Receive instant coding answers via a code editor.",
"version": "0.0.1",
"engines": {
"vscode": "^1.46.0"
},
"categories": [
"Other"
"Other",
"Programming Languages"
],
"author": {
"name": "diana arreola"
},
"icon": "img/howdoi-logo.png",
"galleryBanner": {
"color": "#ab9df2",
"theme": "dark"
},
"activationEvents": [
"onCommand:howdoi.extension"
],
Expand Down Expand Up @@ -51,5 +60,28 @@
"@types/chai": "^4.2.12",
"ncp": "^2.0.0",
"rimraf": "^3.0.2"
}
},
"badges": [
{
"url": "https://img.shields.io/travis/gleitz/howdoi?style=plastic&color=78dce8" ,
"href": "https://travis-ci.org/github/gleitz/howdoi",
"description": "Howdoi Travis CI Build"

},
{
"url": "https://img.shields.io/github/workflow/status/gleitz/howdoi/Node.js%20CI?color=78dce8&label=Node.js%20CI&style=plastic" ,
"href": "https://github.com/gleitz/howdoi/actions?query=workflow%3A%22Node.js+CI%22",
"description": "Github Actions Node.js CI"

}
],
"license": "SEE LICENSE IN LICENSE.txt",
"bugs": {
"url": "https://github.com/gleitz/howdoi/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/gleitz/howdoi.git"
},
"homepage": "https://github.com/gleitz/howdoi/blob/master/extension/vscode-howdoi/README.md"
}
23 changes: 23 additions & 0 deletions extension/vscode-pkg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# howdoi Packaged Visual Studio Code Extension

Locally install the howdoi Visual Studio Code Extension.

## Installation

- Head over [here](https://github.com/gleitz/howdoi#installation) to install howdoi on your machine.

- Open Visual Studio Code and open the Command Palette and run:

Shell Command: Install ‘code’ command in PATH
![Image of Shell Command](https://github.com/gleitz/howdoi/tree/master/extension/vscode-pkg/img/code-command.png)

Restart your terminal.
- Within the `extension/vscode-pkg` folder, run:

code --install-extension howdoi-0.0.1.vsix

- Add the unpackaged files to your VS Code extensions folder (the path of the folder can be found [here](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#your-extension-folder)). If no files were created within the `extension/vscode-pkg`, check if the files are in the extension folder path.

- Look over the README within the unpackaged files for more info on how to run howdoi within VS Code.


Binary file added extension/vscode-pkg/howdoi-0.0.1.vsix
Binary file not shown.
Binary file added extension/vscode-pkg/img/code-command.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 793b7ef

Please sign in to comment.