Note: this document is intended as a draft, it will be updated soon
- Nodejs ^8.x
- Visual Studio Code
- GPG Tool
- Contributing guidelines
First you will have to install node_modules through npm
npm install
To compile to the source code, you have to execute the build task through visual studio code.
First you need to invoke to quick command (on MacOS ⌘P
, while on Linux/windows is ctrl+p
)
then type task build
and wait until VSC will have finished the task.
To test the theme, you will have to go to the debug section, select the Launch Extension from debug and execute it.
Material Theme commands are located inside the extensions/commands
directory. They are split by folders so you can find a single specific index.ts
file inside a command
folder. This is a patter choice: so you can add related command helpers inside that folder.
The main file must return a function
. The function
can be async
or sync
.
We want to make this clear, so the async
declaration must be present even if you want to use then()
for chaining inside the function
.
export default async (): Promise<boolean> => {
...
export default (): boolean => {
...
We encourage you to split up your command in other small modules so they can be tested more easily and outside of the context.
You must register the new command to execute it when it's called by the user.
Firstly add the command to our commands extensions/commands/index.ts
export {default as awesomeCommand} from './awesome-command';
Commands are registered within the extensions/material.theme.config.ts
file.
Just add a new registration after the others that will run your command:
Commands.registerCommand('materialTheme.awesomeCommand', () => ThemeCommands.awesomeCommand());
When you are ready to test your new command you must add its declaration within the package.json
. The command must be prefixed with materialTheme.
prefix.
As the others your command will look like this:
Level: contribute.commands -> Array
{
"command": "materialTheme.awesomeCommand",
"title": "Awesome Title For Command",
"category": "🎨 Material Theme"
}
Now you can re-build the theme and just run the debug, you will see your command in the command list of VSCode just searching for its title.
Thank you to all the people who have already contributed to vsc-material-theme!