diff --git a/.gitignore b/.gitignore index 0359620a..e562dfd4 100644 --- a/.gitignore +++ b/.gitignore @@ -15,4 +15,5 @@ yarn.lock .DS_Store # License file copied to chocolatey directory -chocolatey/tools/LICENSE.txt \ No newline at end of file +chocolatey/tools/LICENSE.txt +config.wyam.hash diff --git a/config.wyam.dll b/config.wyam.dll new file mode 100644 index 00000000..0839477f Binary files /dev/null and b/config.wyam.dll differ diff --git a/config.wyam.packages.xml b/config.wyam.packages.xml new file mode 100644 index 00000000..bb9ae9bf --- /dev/null +++ b/config.wyam.packages.xml @@ -0,0 +1,181 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/input/_Bottom.cshtml b/docs/input/_Bottom.cshtml index f2f4952d..5939d061 100644 --- a/docs/input/_Bottom.cshtml +++ b/docs/input/_Bottom.cshtml @@ -3,7 +3,7 @@ diff --git a/docs/input/docs/commands/create.md b/docs/input/docs/commands/create.md new file mode 100644 index 00000000..1be49065 --- /dev/null +++ b/docs/input/docs/commands/create.md @@ -0,0 +1,13 @@ +--- +Order: 10 +Title: Create new Chocolatey package +Description: Usage instructions for the create new package command +--- + +Open a folder in VSCode. Failure to do so will cause the extension to throw an error. + +Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Create new Chocolatey Package`. The extension will ask you to give the Package a name. This should match closely with the name of the application you are pacakging. Version in the name is not necessary, and should be avoided as this is handled in the nuspec file with the `` tag. + +The extension then creates a new folder with the name you typed into the extension's prompt and generates template installation, modification, and uninstallation scripts, as well as the nuspec file and some other miscellaneous files. + +The generated files are well-documented inside, and have all the information required inside of them to build a successful package. diff --git a/docs/input/docs/commands/delete.md b/docs/input/docs/commands/delete.md new file mode 100644 index 00000000..b80a16f3 --- /dev/null +++ b/docs/input/docs/commands/delete.md @@ -0,0 +1,9 @@ +--- +Order: 30 +Title: Delete Chocolatey package(s) +Description: Usage instructions for the delete Chocolatey package(s) command +--- + +Sometimes, you no longer need a package, or an older version of a package. `choco delete` makes it easy to remove those unnecessary packages. The extension has this capability built in + +Press `Ctrl+Shift+P` to bring up the Command Pallete and type `Chocolatey: Delete Package`. Select the Chocolatey package nupkg to remove and it will be deleted from disk. diff --git a/docs/input/docs/commands/index.cshtml b/docs/input/docs/commands/index.cshtml new file mode 100644 index 00000000..d37011a6 --- /dev/null +++ b/docs/input/docs/commands/index.cshtml @@ -0,0 +1,7 @@ +--- +Order: 30 +Description: How to use the Chocolatey VSCode Extension +--- +

@Html.Raw(Model.String(DocsKeys.Description))

+ +@Html.Partial("_ChildPages") diff --git a/docs/input/docs/commands/install.md b/docs/input/docs/commands/install.md new file mode 100644 index 00000000..1c08e149 --- /dev/null +++ b/docs/input/docs/commands/install.md @@ -0,0 +1,11 @@ +--- +Order: 50 +Title: Install Template package(s) +Description: Usage instructions for the install Template package(s) command +--- + +Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Install Template packages(s)`* + +* _VSCode must be ran as Administrator for access to C:\ProgramData\chocolatey\lib_ + +This will pull down all the templates for creating different Chocolatey package types. diff --git a/docs/input/docs/commands/pack.md b/docs/input/docs/commands/pack.md new file mode 100644 index 00000000..d2def13a --- /dev/null +++ b/docs/input/docs/commands/pack.md @@ -0,0 +1,11 @@ +--- +Order: 20 +Title: Pack Chocolatey package(s) +Description: Usage instructions for the package Chocolatey package(s) command +--- + +Once you have your package built to your liking and the nuspec file properly filled in (again review the comments in the nuspec file for more information) it is time to Pack the package, which bundles everything into the needed nupkg. + +Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Pack Chocolatey Package(s)`. The extension will ask you for any additional arguments you require for the pack operation. Documentation on those additional arguments and their usage can be found [here]('https://github.com/chocolatey/choco/wiki/CommandsPack'). + +The package operation will bundle everything, and you should see a new file created in the folder named _packagename.nupkg_. diff --git a/docs/input/docs/commands/push.md b/docs/input/docs/commands/push.md new file mode 100644 index 00000000..053c1eea --- /dev/null +++ b/docs/input/docs/commands/push.md @@ -0,0 +1,17 @@ +--- +Order: 40 +Title: Push Chocolatey package(s) +Description: Usage instructions for the push Chocolatey package(s) command +--- + +Pushing a package to the Community Repository requires the use of an API Key. You can head over to the [Community Repository]('https://chocolatey.org/packages') and create an account. Once you have your account, you will see the API listed in your Profile. + +*Add your API key to your local chocolatey installation* + +Run the following command to add your api key for the community repository to your Chocolatey installation: + +`choco apikey -k -s https://push.chocolatey.org/` + +Note that we have covered the Community Repository here. For other sources, information for pushing to them can be found [here]('https://github.com/chocolatey/choco/wiki/CommandsPush'). + +When you are ready to push a package press `Ctrl+Shift+P` to bring up the Command Pallete and type `Chocolatey: Push Package(s)`. This will add your new package to the repository. diff --git a/docs/input/index.cshtml b/docs/input/index.cshtml new file mode 100644 index 00000000..38add267 --- /dev/null +++ b/docs/input/index.cshtml @@ -0,0 +1,17 @@ +--- +Title: Chocolatey Visual Studio Code Extension +NoSidebar: true +NoContainer: true +NoGutter: true +--- + +
+
+

Chocolatey Visual Studio Code Extension

+

+ This extension brings support for Chocolatey to Visual Studio Code.
+

+ Learn more + Commands +
+
diff --git a/docs/input/index.md b/docs/input/index.md deleted file mode 100644 index 85699e2b..00000000 --- a/docs/input/index.md +++ /dev/null @@ -1,62 +0,0 @@ -# Chocolatey Visual Studio Code Documentation - -## Requirements - -This extension expects Chocolatey to be installed. -All other VSCode extension dependencies will be installed alongside this extension - -## Getting Started - -### Available Commands - -- Chocolatey: Install Template package(s) -- Chocolatey: Create new Chocolatey Package -- Chocolatey: Pack Chocolatey package(s) -- Chocolatey: Push Chocolatey packages(s) -- Chocolatey: Delete Chocolatey package(s) - -### Installing Templates - -Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Install Template packages(s)`* - -* _VSCode must be ran as Administrator for access to C:\ProgramData\chocolatey\lib_ - -This will pull down all the templates for creating different Chocolatey package types. - -### Creating a new Chocolatey Package - -Open a folder in VSCode. Failure to do so will cause the extension to throw an error. - -Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Create new Chocolatey Package`. The extension will ask you to give the Package a name. This should match closely with the name of the application you are pacakging. Version in the name is not necessary, and should be avoided as this is handled in the nuspec file with the `` tag. - -The extension then creates a new folder with the name you typed into the extension's prompt and generates template installation, modification, and uninstallation scripts, as well as the nuspec file and some other miscellaneous files. - -The generated files are well-documented inside, and have all the information required inside of them to build a successful package. - -### Packing a Chocolatey Package - -Once you have your package built to your liking and the nuspec file properly filled in (again review the comments in the nuspec file for more information) it is time to Pack the package, which bundles everything into the needed nupkg. - -Press `Ctrl+Shift+P` to bring up the Command Pallete. Type `Chocolatey: Pack Chocolatey Package(s)`. The extension will ask you for any additional arguments you require for the pack operation. Documentation on those additional arguments and their usage can be found [here]('https://github.com/chocolatey/choco/wiki/CommandsPack'). - -The package operation will bundle everything, and you should see a new file created in the folder named _packagename.nupkg_. - -### Pushing a Chocolatey Package - -Pushing a package to the Community Repository requires the use of an API Key. You can head over to the [Community Repository]('https://chocolatey.org/packages') and create an account. Once you have your account, you will see the API listed in your Profile. - -*Add your API key to your local chocolatey installation* - -Run the following command to add your api key for the community repository to your Chocolatey installation: - -`choco apikey -k -s https://push.chocolatey.org/` - -Note that we have covered the Community Repository here. For other sources, information for pushing to them can be found [here]('https://github.com/chocolatey/choco/wiki/CommandsPush'). - -When you are ready to push a package press `Ctrl+Shift+P` to bring up the Command Pallete and type `Chocolatey: Push Package(s)`. This will add your new package to the repository. - -### Deleting a Package - -Sometimes, you no longer need a package, or an older version of a package. `choco delete` makes it easy to remove those unnecessary packages. The extension has this capability built in - -Press `Ctrl+Shift+P` to bring up the Command Pallete and type `Chocolatey: Delete Package`. Select the Chocolatey package nupkg to remove and it will be deleted from disk.