CONTRIBUTING.md

Contributing

Run tests

• Open the debug viewlet (Ctrl+Shift+D or Cmd+Shift+D on Mac) and from the launch configuration dropdown pick Extension Tests.
• Press F5 to run the tests in a new window with your extension loaded.
• See the output of the test result in the debug console.
• Make changes to src/test/suite/extension.test.ts or create new test files inside the test/suite folder.
  • The provided test runner will only consider files matching the name pattern **.test.ts.
  • You can create folders inside the test folder to structure your tests any way you want.

Registering a plugin:-

1. Register VSWorkbench as a dependency in your package.json file:

  "extensionDependencies": [
    "sufyandahalan.vsworkbench"
  ],

---

---

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this project, please first discuss the changes you wish to make via an issue before making changes.

Please note the Code of Conduct document, please follow it in all your interactions with this project.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through the help-wanted issues.

Getting the code

git clone https://github.com/SufyanDahalan/VSWorkbench.git

Prerequisites

• Git, >= 2.7.2
• NodeJS, >= 14.16.0
• npm, >= 8.11.0

Dependencies

Build

npm run build

Registering a platform specific plugin

import { extensions } from 'vscode';
const VSWorkbench = extensions.getExtension<any>('sufyandahalan.vsworkbench');

VSWorkbench.registerPlugin({TreeViews, Commands})

Please refer to the extension.ts file for more information about the registerPlugin function.