Skip to content

Commit ef89b13

Browse files
authored
Merge pull request #1 from PowerShell/master
[ignore] initial readme for Azure Data Studio marketplace (PowerShell#1785)
2 parents 1db2283 + d170c9b commit ef89b13

File tree

2 files changed

+113
-0
lines changed

2 files changed

+113
-0
lines changed

docs/azure_data_studio/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Azure Data Studio Docs
2+
3+
[Azure Data Studio](https://github.com/Microsoft/azuredatastudio) is a VSCode-like IDE primarily targeted at database administrators and is a fork of VSCode. Since it's a fork of VSCode, many extensions "just work" including the PowerShell extension.
4+
5+
This folder contains any docs for PowerShell extension support in Azure Data Studio.
6+
7+
Table of Contents:
8+
9+
* `README.md` - This file. It's purely for information about this folder and shouldn't be used elsewhere.
10+
* `README_FOR_MARKETPLACE.md` - The markdown file that will be shown when you look at the PowerShell extension in the Azure Data Studio marketplace.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# PowerShell Language Support for Azure Data Studio
2+
3+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/df06b9909e7442cebc1132bda0b8c0e3)](https://app.codacy.com/app/TylerLeonhardt/vscode-powershell?utm_source=github.com&utm_medium=referral&utm_content=PowerShell/vscode-powershell&utm_campaign=Badge_Grade_Dashboard)
4+
[![windows build](https://img.shields.io/appveyor/ci/PowerShell/vscode-powershell/master.svg?label=windows+build)](https://ci.appveyor.com/project/PowerShell/vscode-powershell) [![linux/macos build](https://img.shields.io/travis/PowerShell/vscode-powershell/master.svg?label=linux/macos+build)](https://travis-ci.org/PowerShell/vscode-powershell) [![Join the chat at https://gitter.im/PowerShell/vscode-powershell](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5+
6+
This extension provides rich PowerShell language support for [Azure Data Studio](github.com/Microsoft/azuredatastudio).
7+
Now you can write and debug PowerShell scripts using the excellent IDE-like interface
8+
that Azure Data Studio provides.
9+
10+
## Platform support
11+
12+
- **Windows 7 through 10** with Windows PowerShell v3 and higher, and PowerShell Core
13+
- **Linux** with PowerShell Core (all PowerShell-supported distributions)
14+
- **macOS** with PowerShell Core
15+
16+
Read the [FAQ](https://github.com/PowerShell/vscode-powershell/wiki/FAQ) for answers to common questions.
17+
18+
## Features
19+
20+
- Syntax highlighting
21+
- Code snippets
22+
- IntelliSense for cmdlets and more
23+
- Rule-based analysis provided by [PowerShell Script Analyzer](http://github.com/PowerShell/PSScriptAnalyzer)
24+
- Go to Definition of cmdlets and variables
25+
- Find References of cmdlets and variables
26+
- Document and workspace symbol discovery
27+
- Run selected selection of PowerShell code using <kbd>F8</kbd>
28+
- Launch online help for the symbol under the cursor using <kbd>Ctrl</kbd>+<kbd>F1</kbd>
29+
- Basic interactive console support!
30+
31+
## Installing the Extension
32+
33+
You can install the official release of the PowerShell extension by following the steps
34+
in the [Azure Data Studio documentation](docs.microsoft.com/en-us/sql/azure-data-studio/extensions).
35+
In the Extensions pane, search for "PowerShell" extension and install it there. You will
36+
get notified automatically about any future extension updates!
37+
38+
You can also install a VSIX package from our [Releases page](https://github.com/PowerShell/vscode-powershell/releases) and install it through the command line:
39+
40+
```powershell
41+
azuredatastudio --install-extension PowerShell-<version>.vsix
42+
```
43+
44+
## Reporting Problems
45+
46+
If you experience any problems with the PowerShell Extension, see
47+
[the troubleshooting docs](./docs/troubleshooting.md) for information
48+
on diagnosing and reporting issues.
49+
50+
#### Security Note
51+
For any security issues, please see [here](./docs/troubleshooting.md#note-on-security).
52+
53+
## Example Scripts
54+
55+
There are some example scripts in the extension's `examples` folder that you can
56+
use to discover PowerShell editing and debugging functionality. Please
57+
check out the included [README.md](examples/README.md) file to learn more about
58+
how to use them.
59+
60+
This folder can be found at the following path:
61+
62+
```powershell
63+
$HOME/.azuredatastudio/extensions/ms-vscode.PowerShell-<version>/examples
64+
```
65+
66+
or if you're using the preview version of the extension
67+
68+
```powershell
69+
$HOME/.azuredatastudio/extensions/ms-vscode.powershell-preview-<version>/examples
70+
```
71+
72+
To open/view the extension's examples in Visual Studio Code, run the following from your PowerShell command prompt:
73+
74+
```powershell
75+
code (Get-ChildItem $Home\.azuredatastudio\extensions\ms-vscode.PowerShell-*\examples)[-1]
76+
```
77+
78+
## Contributing to the Code
79+
80+
Check out the [development documentation](docs/development.md) for more details
81+
on how to contribute to this extension!
82+
83+
## Maintainers
84+
85+
- [Keith Hill](https://github.com/rkeithhill) - [@r_keith_hill](http://twitter.com/r_keith_hill)
86+
- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](http://twitter.com/tylerleonhardt)
87+
- [Rob Holt](https://github.com/rjmholt)
88+
89+
## License
90+
91+
This extension is [licensed under the MIT License](LICENSE.txt). Please see the
92+
[third-party notices](Third%20Party%20Notices.txt) file for details on the third-party
93+
binaries that we include with releases of this project.
94+
95+
## [Code of Conduct][conduct-md]
96+
97+
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
98+
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
99+
100+
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
101+
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
102+
[conduct-email]: mailto:[email protected]
103+
[conduct-md]: https://github.com/PowerShell/vscode-powershell/blob/master/CODE_OF_CONDUCT.md

0 commit comments

Comments
 (0)