Skip to content

Commit abb6399

Browse files
dzsquareddzsquared
committed
getting closer to release, working script cleaned up a bit and readme nearly complete
1 parent fc0046a commit abb6399

8 files changed

Lines changed: 304 additions & 140 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Change Log
2-
All notable changes to the "sosblitz" extension will be documented in this file.
2+
All notable changes to the "First Responder Kit" extension will be documented in this file.
33

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

6-
## [Unreleased]
6+
## 0.1.0
77
- Initial release

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 DrewSK
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 20 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,68 +5,43 @@ If you want to build your extension, run:
55
npm run compile
66
```
77

8-
# sosblitz README
8+
# SQL Operations Studio - First Responder Kit Extension
99

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

12-
## Features
12+
## Installation
13+
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...`
1314

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

16-
For example if there is an image subfolder under your extension project workspace:
17+
### Import
18+
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>`
1719

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

20-
> 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.
21+
![Import a Script](images/frk_import.gif)
2122

22-
## Requirements
23+
### Run
24+
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>`
2325

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

26-
## Extension Settings
27-
28-
Include if your extension adds any SQL Operations Studio settings through the `contributes.configuration` extension point.
28+
## Requirements
2929

30-
For example:
30+
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.
3131

32-
This extension contributes the following settings:
3332

34-
* `myExtension.enable`: enable/disable this extension
35-
* `myExtension.thing`: set to `blah` to do something
33+
-----------------------------------------------------------------------------------------------------------
3634

3735
## Known Issues
3836

39-
Calling out known issues can help limit users opening duplicate issues against your extension.
40-
41-
## Release Notes
42-
43-
Users appreciate release notes as you update your extension.
44-
45-
### 1.0.0
37+
None yet.
4638

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

49-
### 1.0.1
50-
51-
Fixed issue #.
52-
53-
### 1.1.0
54-
55-
Added features X, Y, and Z.
56-
57-
-----------------------------------------------------------------------------------------------------------
58-
59-
## Working with Markdown
60-
61-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
62-
63-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
64-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
65-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
42+
## Release Notes
6643

67-
### For more information
6844

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

72-
**Enjoy!**
47+
- Initial release.

‎images/frk_import.gif‎

82.9 KB
Loading

‎images/frk_run.gif‎

65 KB
Loading

‎package.json‎

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "sosblitz",
3-
"displayName": "sosblitz",
2+
"name": "firstresponderkit",
3+
"displayName": "First Responder Kit",
44
"description": "Current Versions of the sp_blitz Scripts",
5-
"version": "0.0.1",
5+
"version": "0.1.0",
66
"publisher": "drewsk",
77
"engines": {
88
"vscode": "^1.25.0",
@@ -13,18 +13,53 @@
1313
],
1414
"activationEvents": [
1515
"onCommand:extension.sp_blitz",
16-
"onCommand:extension.showCurrentConnection"
16+
"onCommand:extension.run_sp_blitz",
17+
"onCommand:extension.sp_blitzwho",
18+
"onCommand:extension.sp_blitzindex",
19+
"onCommand:extension.run_sp_blitzindex",
20+
"onCommand:extension.sp_blitzcache",
21+
"onCommand:extension.run_sp_blitzcache",
22+
"onCommand:extension.sp_blitzfirst",
23+
"onCommand:extension.run_sp_blitzfirst"
1724
],
1825
"main": "./out/extension",
1926
"contributes": {
2027
"commands": [
2128
{
2229
"command": "extension.sp_blitz",
23-
"title": "Import sp_blitz"
30+
"title": "First Responder Kit: Import sp_blitz"
2431
},
2532
{
26-
"command": "extension.showCurrentConnection",
27-
"title": "Show Current Connection"
33+
"command": "extension.run_sp_blitz",
34+
"title": "First Responder Kit: Run sp_blitz"
35+
},
36+
{
37+
"command": "extension.sp_blitzindex",
38+
"title": "First Responder Kit: Import sp_blitzindex"
39+
},
40+
{
41+
"command": "extension.run_sp_blitzindex",
42+
"title": "First Responder Kit: Run sp_blitzindex"
43+
},
44+
{
45+
"command": "extension.sp_blitzwho",
46+
"title": "First Responder Kit: Import sp_blitzwho"
47+
},
48+
{
49+
"command": "extension.sp_blitzfirst",
50+
"title": "First Responder Kit: Import sp_blitzfirst"
51+
},
52+
{
53+
"command": "extension.run_sp_blitzfirst",
54+
"title": "First Responder Kit: Run sp_blitzfirst"
55+
},
56+
{
57+
"command": "extension.sp_blitzcache",
58+
"title": "First Responder Kit: Import sp_blitzcache"
59+
},
60+
{
61+
"command": "extension.run_sp_blitzcache",
62+
"title": "First Responder Kit: Run sp_blitzcache"
2863
}
2964
]
3065
},

‎resources.txt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
http://www.chrisstead.com/archives/1082/visual-studio-code-extensions-editing-the-document/
2+
3+
https://code.visualstudio.com/docs/extensionAPI/vscode-api#_commands
4+
5+
https://stackoverflow.com/questions/45046552/texteditoredit-replace-is-async-how-to-execute-code-when-it-is-finished
6+
7+
https://stackoverflow.com/questions/45748476/http-request-in-typescript
8+
9+
https://github.com/egamma/vscode-extension-async/blob/master/src/extension.ts
10+
11+
https://github.com/patbenatar/vscode-advanced-new-file/blob/master/src/extension.ts

0 commit comments

Comments
 (0)