Skip to content

Commit

Permalink
getting closer to release, working script cleaned up a bit and readme…
Browse files Browse the repository at this point in the history
… nearly complete
  • Loading branch information
dzsquared committed Jul 25, 2018
1 parent fc0046a commit abb6399
Show file tree
Hide file tree
Showing 8 changed files with 304 additions and 140 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Change Log
All notable changes to the "sosblitz" extension will be documented in this file.
All notable changes to the "First Responder Kit" extension will be documented in this file.

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

## [Unreleased]
## 0.1.0
- Initial release
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 DrewSK

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.
65 changes: 20 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,68 +5,43 @@ If you want to build your extension, run:
npm run compile
```

# sosblitz README
# SQL Operations Studio - First Responder Kit Extension

This is the README for your extension "sosblitz". After writing up a brief description, we recommend including the following sections.
This extension provides immediate access to the current First Responder Kit scripts and introductory execution suggestions. (All credit due to http://firstresponderkit.org/)

## Features
## Installation
The current release is available to download as a .vsix file and can be installed by opening the command palette (`ctrl/command+shift+p`) and selecting `Extensions: Install from VSIX...`

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
## Features

For example if there is an image subfolder under your extension project workspace:
### Import
Import a script from the First Responder Kit to a new editor by opening the command palette (`ctrl/command+shift+p`) and selecting an option under `First Responder Kit: Import <some script>`

\!\[feature X\]\(images/feature-x.png\)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
![Import a Script](images/frk_import.gif)

## Requirements
### Run
Already have the current scripts loaded to the database? Great! Take the shortcut to execution by opening the command palette (`ctrl/command+shift+p`) and selecting an option under `First Responder Kit: Run <some script>`

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
![Execute](images/frk_run.gif)

## Extension Settings

Include if your extension adds any SQL Operations Studio settings through the `contributes.configuration` extension point.
## Requirements

For example:
Internet connectivity is required for any of the "Import" commands, which connect to GitHub to fetch recent versions of the scripts. A GitHub account is NOT required.

This extension contributes the following settings:

* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something
-----------------------------------------------------------------------------------------------------------

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0
None yet.

Initial release of ...
## Unknown Issues
Can be raised here: https://github.com/dzsquared/sqlops-firstresponderkit/issues

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

-----------------------------------------------------------------------------------------------------------

## Working with Markdown

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
## Release Notes

### For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
### 0.1.0

**Enjoy!**
- Initial release.
Binary file added images/frk_import.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/frk_run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 42 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "sosblitz",
"displayName": "sosblitz",
"name": "firstresponderkit",
"displayName": "First Responder Kit",
"description": "Current Versions of the sp_blitz Scripts",
"version": "0.0.1",
"version": "0.1.0",
"publisher": "drewsk",
"engines": {
"vscode": "^1.25.0",
Expand All @@ -13,18 +13,53 @@
],
"activationEvents": [
"onCommand:extension.sp_blitz",
"onCommand:extension.showCurrentConnection"
"onCommand:extension.run_sp_blitz",
"onCommand:extension.sp_blitzwho",
"onCommand:extension.sp_blitzindex",
"onCommand:extension.run_sp_blitzindex",
"onCommand:extension.sp_blitzcache",
"onCommand:extension.run_sp_blitzcache",
"onCommand:extension.sp_blitzfirst",
"onCommand:extension.run_sp_blitzfirst"
],
"main": "./out/extension",
"contributes": {
"commands": [
{
"command": "extension.sp_blitz",
"title": "Import sp_blitz"
"title": "First Responder Kit: Import sp_blitz"
},
{
"command": "extension.showCurrentConnection",
"title": "Show Current Connection"
"command": "extension.run_sp_blitz",
"title": "First Responder Kit: Run sp_blitz"
},
{
"command": "extension.sp_blitzindex",
"title": "First Responder Kit: Import sp_blitzindex"
},
{
"command": "extension.run_sp_blitzindex",
"title": "First Responder Kit: Run sp_blitzindex"
},
{
"command": "extension.sp_blitzwho",
"title": "First Responder Kit: Import sp_blitzwho"
},
{
"command": "extension.sp_blitzfirst",
"title": "First Responder Kit: Import sp_blitzfirst"
},
{
"command": "extension.run_sp_blitzfirst",
"title": "First Responder Kit: Run sp_blitzfirst"
},
{
"command": "extension.sp_blitzcache",
"title": "First Responder Kit: Import sp_blitzcache"
},
{
"command": "extension.run_sp_blitzcache",
"title": "First Responder Kit: Run sp_blitzcache"
}
]
},
Expand Down
11 changes: 11 additions & 0 deletions resources.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
http://www.chrisstead.com/archives/1082/visual-studio-code-extensions-editing-the-document/

https://code.visualstudio.com/docs/extensionAPI/vscode-api#_commands

https://stackoverflow.com/questions/45046552/texteditoredit-replace-is-async-how-to-execute-code-when-it-is-finished

https://stackoverflow.com/questions/45748476/http-request-in-typescript

https://github.com/egamma/vscode-extension-async/blob/master/src/extension.ts

https://github.com/patbenatar/vscode-advanced-new-file/blob/master/src/extension.ts
Loading

0 comments on commit abb6399

Please sign in to comment.