paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

validate plugin and module ids

Browse Source 
Signed-off-by: Juan Pablo Garcia Ripa <sarabadu@gmail.com>
This commit is contained in:
Juan Pablo Garcia Ripa
2025-07-09 21:33:23 +02:00
parent 4ad63b8d9f
commit 5766fc71c6
9 changed files with 109 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/backend-system/architecture/08-naming-patterns.md
+8 -8
View File
@@ -11,10 +11,10 @@ As a rule, all names should be camel case, with the exceptions of plugin and mod
### Plugins
| Description | Pattern | Examples |
| ----------- | ----------------- | ------------------------------------- |
| export | `<camelId>Plugin` | `catalogPlugin`, `userSettingsPlugin` |
| ID | `'<kebab-id>'` | `'catalog'`, `'user-settings'` |
| Description | Pattern | Examples | Notes |
| ----------- | ----------------- | ------------------------------------- | --------------------------------------------------------------------- |
| export | `<camelId>Plugin` | `catalogPlugin`, `userSettingsPlugin` | |
| ID | `'<kebab-id>'` | `'catalog'`, `'user-settings'` | letters, digits, dashes, and underscores only, starting with a letter |
Example:
@@ -27,10 +27,10 @@ export const userSettingsPlugin = createBackendPlugin({
### Modules
| Description | Pattern | Examples |
| ----------- | ---------------------------- | ----------------------------------- |
| export | `<pluginId>Module<ModuleId>` | `catalogModuleGithubEntityProvider` |
| ID | `'<module-id>'` | `'github-entity-provider'` |
| Description | Pattern | Examples | Notes |
| ----------- | ---------------------------- | ----------------------------------- | --------------------------------------------------------------------- |
| export | `<pluginId>Module<ModuleId>` | `catalogModuleGithubEntityProvider` | |
| ID | `'<module-id>'` | `'github-entity-provider'` | letters, digits, dashes, and underscores only, starting with a letter |
Example: