Skip to content

Commit

Permalink
Merge branch 'master' into lsp-refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
TwitchBronBron authored Aug 21, 2024
2 parents 539656e + 88cf386 commit d763dbe
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ builder.addPlugin(myPlugin);
builder.run(/*...*/);
```

## Creating a plugin
### Naming conventions
While there are no restrictions on plugin names, it helps others to find your plugin on npm when you follow these naming conventions:

- **Unscoped**: If your npm package name won’t be scoped (doesn’t begin with `@`), then the plugin name should begin with `bsc-plugin-`, such as `bsc-plugin-auto-findnode`.
- **Scoped**: If your npm package name will be scoped, then the plugin name should be in the format of `@<scope>/bsc-plugin-<plugin-name>` such as `@rokucommunity/bsc-plugin-auto-findnode` or even `@<scope>/bsc-plugin` such as `@maestro/bsc-plugin`.

## Compiler events

Full compiler lifecycle:
Expand Down Expand Up @@ -448,4 +455,4 @@ export default function plugin() {
}
} as CompilerPlugin;
}
```
```

0 comments on commit d763dbe

Please sign in to comment.