README

Visual Studio Code extension package containing useful extensions for developing Portal.

Included In The Package

• Docker
• Highlight Dodgy Characters
• markdownlint
• Prettier

Creating The Extension Package (.vsix File)

1. Run the following command in Terminal

   npm install vsce
   
   # Creates the .vsix file (used for installation/publishing)
   vsce package
   

Installing The Extension Package

Using Published Extension Package

1. Simply install it via the VSCode Extensions Marketplace as you would any other extensions.

Using .vsix File

1. Click Extensions.
2. Click the ... at the top right corner of the Extensions panel.
3. Select Install from VSIX...
4. Select the .vsix file.
5. Click Install.

Modifying The Extensions Package

The extensionPack property within the package.json file dictates which extensions are included within the package.

Adding Extensions To The Package

1. Open the source directory in VSCode.

2. Click the Extensions icon in the left-hand side toolbar.

3. Search for the extension that you wish to add to the package.

4. Click the extension to bring up the Extension Information window.

5. Copy the Extension ID next to the Extension Name (e.g. davidanson.vscode-markdownlint).

6. In the package.json file

   • Paste the Extension ID into the extensionPack property.

Removing Extensions From The Package

1. Open the source directory in VSCode.

2. In the package.json file

   • Delete the Extension ID of the extension you wish to remove from the extensionPack property.

(Optional) Publishing The Extensions Package

1. Visit the VSCode Extensions Marketplace.
2. Sign in to your account.
   • You will be automatically redirected to the Create Publisher page.
3. Fill in the form to create a publisher.
4. Go to the package.json file.
5. Change the publisher property to the ID of the newly created publisher.
6. Click New extension.
7. Select Visual Studio Code in the dropdown box.
8. Upload the .vsix file.
9. Click Upload.