@janus-idp/backstage-scaffolder-backend-module-regex-dynamic v1.4.5
Regex actions for Backstage
This plugin provides Backstage template actions for RegExp.
The following actions are currently supported in this plugin:
Prerequisites
- A Backstage project
Installation
Run the following command to install the action package in your Backstage project:
yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-regex
Installing the action on the legacy backend
Register the regex actions by modifying the packages/backend/src/plugins/scaffolder.ts
file from your project with the following changes:
/* highlight-add-next-line */
import { createReplaceAction } from '@janus-idp/backstage-scaffolder-backend-module-regex';
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
// ...
/* highlight-add-next-line */
const actions = [...builtInActions, createReplaceAction()];
return await createRouter({
actions,
logger: env.logger,
config: env.config,
database: env.database,
reader: env.reader,
catalogClient,
identity: env.identity,
});
}
Installing the action on the new backend
Add the following to your packages/backend/src/index.ts
file:
const backend = createBackend();
// Add the following line
backend.add(
import('@janus-idp/backstage-scaffolder-backend-module-regex/alpha'),
);
backend.start();
Usage
Action : regex:replace
Parameter Name | Type | Required | Description |
---|---|---|---|
regExps[].pattern | string | Yes | The regex pattern to match the value like in String.prototype.replace() |
regExps[].flags | string[] | No | The flags for the regex, possible values are: g , m , i , y , u , s , d |
regExps[].replacement | string | Yes | The replacement value for the regex like in String.prototype.replace() |
regExps[].values[].key | string | Yes | The key to access the regex value |
regExps[].values[].value | string | Yes | The input value of the regex |
Warning
The
regExps[].pattern
string cannot have a leading or trailing forward slashThe
regExps[].values[].key
values must all be unique since the key is used forvalues.<key>
to access the return value
Output
Name | Type | Description |
---|---|---|
values.<key> | string | A new string, with one, some, or all matches of the pattern replaced by the specified replacement. |
7 days ago
7 days ago
9 days ago
9 days ago
14 days ago
24 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
5 months ago