@backstage-community/plugin-scaffolder-backend-module-regex 2.7.0 → 2.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  ### Dependencies
2
2
 
3
+ ## 2.8.0
4
+
5
+ ### Minor Changes
6
+
7
+ - a64a93a: Backstage version bump to v1.41.1
8
+
9
+ ## 2.7.1
10
+
11
+ ### Patch Changes
12
+
13
+ - d73ba40: Adding regex:replace examples
14
+
3
15
  ## 2.7.0
4
16
 
5
17
  ### Minor Changes
@@ -1,155 +1,47 @@
1
1
  'use strict';
2
2
 
3
3
  var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
4
- var yaml = require('yaml');
5
- var zod = require('zod');
4
+ var replace_example = require('./replace.example.cjs.js');
6
5
 
7
- function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
8
-
9
- var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
10
-
11
- const schemaInput = zod.z.object({
12
- regExps: zod.z.array(
13
- zod.z.object({
14
- pattern: zod.z.string().refine(
15
- // You should not parse a regex (regular language) with a regex (regular language),
16
- // you actually need a context free grammar to parse a regex (regular language).
17
- // Hence, we are using a string comparison here.
18
- (value) => !value.startsWith("/") && !value.endsWith("/"),
19
- {
20
- message: "The RegExp constructor cannot take a string pattern with a leading and trailing forward slash."
21
- }
22
- ).describe(
23
- "The regex pattern to match the value like in String.prototype.replace()"
24
- ),
25
- flags: zod.z.array(
26
- // Prefer array over set here because input values are normally defined in YAML which doesn't support Sets.
27
- zod.z.enum(["g", "m", "i", "y", "u", "s", "d"], {
28
- invalid_type_error: "Invalid flag, possible values are: g, m, i, y, u, s, d"
29
- })
30
- ).optional().describe("The flags for the regex"),
31
- replacement: zod.z.string().describe(
32
- "The replacement value for the regex like in String.prototype.replace()"
33
- ),
34
- values: zod.z.array(
35
- zod.z.object({
36
- key: zod.z.string().describe("The key to access the regex value"),
37
- value: zod.z.string().describe("The input value of the regex")
38
- })
39
- )
40
- })
41
- )
42
- });
43
- const exampleValue = "The quick brown fox jumps over the lazy dog. If the dog reacted, was it really lazy?";
44
6
  const id = "regex:replace";
45
- const examples = [
46
- {
47
- description: "Create a regex to capture the first word of a string",
48
- example: yaml__default.default.stringify({
49
- steps: [
50
- {
51
- id: "regexValues",
52
- action: id,
53
- name: "Regex Values",
54
- input: {
55
- regExps: [
56
- {
57
- pattern: "^(\\S+).*$",
58
- replacement: "$1",
59
- values: [
60
- { key: "eg1", value: "Hello world!" },
61
- { key: "eg2", value: "Test world!" }
62
- ]
63
- }
64
- ]
65
- }
66
- }
67
- ]
68
- })
69
- },
70
- {
71
- description: "Create a regex to replace a word in a string",
72
- example: yaml__default.default.stringify({
73
- steps: [
74
- {
75
- id: "regexValues",
76
- action: id,
77
- name: "Regex Values",
78
- input: {
79
- regExps: [
80
- {
81
- pattern: "dog",
82
- replacement: "monkey",
83
- values: [
84
- {
85
- key: "eg1",
86
- value: exampleValue
87
- }
88
- ]
89
- },
90
- {
91
- pattern: "Dog",
92
- replacement: "ferret",
93
- flags: ["i"],
94
- values: [
95
- {
96
- key: "eg2",
97
- value: exampleValue
98
- }
99
- ]
100
- }
101
- ]
102
- }
103
- }
104
- ]
105
- })
106
- },
107
- {
108
- description: "Create a regex to replace a word globally in a string",
109
- example: yaml__default.default.stringify({
110
- steps: [
111
- {
112
- id: "regexValues",
113
- action: id,
114
- name: "Regex Values",
115
- input: {
116
- regExps: [
117
- {
118
- pattern: "dog",
119
- replacement: "monkey",
120
- flags: ["g"],
121
- values: [
122
- {
123
- key: "eg1",
124
- value: exampleValue
125
- }
126
- ]
127
- },
128
- {
129
- pattern: "Dog",
130
- replacement: "ferret",
131
- flags: ["gi"],
132
- values: [
133
- {
134
- key: "eg2",
135
- value: exampleValue
136
- }
137
- ]
138
- }
139
- ]
140
- }
141
- }
142
- ]
143
- })
144
- }
145
- ];
146
7
  const createReplaceAction = () => {
147
8
  return pluginScaffolderNode.createTemplateAction({
148
9
  id,
149
10
  description: "Replaces strings that match a regular expression pattern with a specified replacement string",
150
- examples,
11
+ examples: replace_example.examples,
151
12
  schema: {
152
- input: schemaInput
13
+ input: {
14
+ regExps: (z) => z.array(
15
+ z.object({
16
+ pattern: z.string().refine(
17
+ // You should not parse a regex (regular language) with a regex (regular language),
18
+ // you actually need a context free grammar to parse a regex (regular language).
19
+ // Hence, we are using a string comparison here.
20
+ (value) => !value.startsWith("/") && !value.endsWith("/"),
21
+ {
22
+ message: "The RegExp constructor cannot take a string pattern with a leading and trailing forward slash."
23
+ }
24
+ ).describe(
25
+ "The regex pattern to match the value like in String.prototype.replace()"
26
+ ),
27
+ flags: z.array(
28
+ // Prefer array over set here because input values are normally defined in YAML which doesn't support Sets.
29
+ z.enum(["g", "m", "i", "y", "u", "s", "d"], {
30
+ invalid_type_error: "Invalid flag, possible values are: g, m, i, y, u, s, d"
31
+ })
32
+ ).optional().describe("The flags for the regex"),
33
+ replacement: z.string().describe(
34
+ "The replacement value for the regex like in String.prototype.replace()"
35
+ ),
36
+ values: z.array(
37
+ z.object({
38
+ key: z.string().describe("The key to access the regex value"),
39
+ value: z.string().describe("The input value of the regex")
40
+ })
41
+ )
42
+ })
43
+ )
44
+ }
153
45
  },
154
46
  async handler(ctx) {
155
47
  const input = ctx.input;
@@ -1 +1 @@
1
- {"version":3,"file":"replace.cjs.js","sources":["../../../src/actions/regex/replace.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\n\nimport yaml from 'yaml';\nimport { z } from 'zod';\n\nconst schemaInput = z.object({\n regExps: z.array(\n z.object({\n pattern: z\n .string()\n .refine(\n // You should not parse a regex (regular language) with a regex (regular language),\n // you actually need a context free grammar to parse a regex (regular language).\n // Hence, we are using a string comparison here.\n value => !value.startsWith('/') && !value.endsWith('/'),\n {\n message:\n 'The RegExp constructor cannot take a string pattern with a leading and trailing forward slash.',\n },\n )\n .describe(\n 'The regex pattern to match the value like in String.prototype.replace()',\n ),\n flags: z\n .array(\n // Prefer array over set here because input values are normally defined in YAML which doesn't support Sets.\n z.enum(['g', 'm', 'i', 'y', 'u', 's', 'd'], {\n invalid_type_error:\n 'Invalid flag, possible values are: g, m, i, y, u, s, d',\n }),\n )\n .optional()\n .describe('The flags for the regex'),\n replacement: z\n .string()\n .describe(\n 'The replacement value for the regex like in String.prototype.replace()',\n ),\n values: z.array(\n z.object({\n key: z.string().describe('The key to access the regex value'),\n value: z.string().describe('The input value of the regex'),\n }),\n ),\n }),\n ),\n});\n\nconst exampleValue =\n 'The quick brown fox jumps over the lazy dog. If the dog reacted, was it really lazy?';\n\nconst id = 'regex:replace';\n\nconst examples = [\n {\n description: 'Create a regex to capture the first word of a string',\n example: yaml.stringify({\n steps: [\n {\n id: 'regexValues',\n action: id,\n name: 'Regex Values',\n input: {\n regExps: [\n {\n pattern: '^(\\\\S+).*$',\n replacement: '$1',\n values: [\n { key: 'eg1', value: 'Hello world!' },\n { key: 'eg2', value: 'Test world!' },\n ],\n },\n ],\n },\n },\n ],\n }),\n },\n {\n description: 'Create a regex to replace a word in a string',\n example: yaml.stringify({\n steps: [\n {\n id: 'regexValues',\n action: id,\n name: 'Regex Values',\n input: {\n regExps: [\n {\n pattern: 'dog',\n replacement: 'monkey',\n values: [\n {\n key: 'eg1',\n value: exampleValue,\n },\n ],\n },\n {\n pattern: 'Dog',\n replacement: 'ferret',\n flags: ['i'],\n values: [\n {\n key: 'eg2',\n value: exampleValue,\n },\n ],\n },\n ],\n },\n },\n ],\n }),\n },\n {\n description: 'Create a regex to replace a word globally in a string',\n example: yaml.stringify({\n steps: [\n {\n id: 'regexValues',\n action: id,\n name: 'Regex Values',\n input: {\n regExps: [\n {\n pattern: 'dog',\n replacement: 'monkey',\n flags: ['g'],\n values: [\n {\n key: 'eg1',\n value: exampleValue,\n },\n ],\n },\n {\n pattern: 'Dog',\n replacement: 'ferret',\n flags: ['gi'],\n values: [\n {\n key: 'eg2',\n value: exampleValue,\n },\n ],\n },\n ],\n },\n },\n ],\n }),\n },\n];\n\n/**\n * @public\n */\nexport const createReplaceAction = () => {\n return createTemplateAction({\n id,\n description:\n 'Replaces strings that match a regular expression pattern with a specified replacement string',\n examples,\n schema: {\n input: schemaInput,\n },\n\n async handler(ctx) {\n const input = ctx.input;\n\n const values: Record<string, string> = {};\n\n for (const {\n pattern,\n flags: flagsInput,\n replacement,\n values: valuesInput,\n } of input.regExps) {\n // remove duplicates from the flags input array\n const flags = flagsInput\n ? Array.from(new Set(flagsInput)).join('')\n : '';\n const regex = new RegExp(pattern, flags);\n\n for (const { key, value } of valuesInput) {\n const match = value.replace(regex, replacement);\n\n if (values.hasOwnProperty(key)) {\n throw new Error(\n `The key '${key}' is used more than once in the input.`,\n );\n }\n\n values[key] = match;\n }\n }\n\n ctx.output('values', values);\n },\n });\n};\n"],"names":["z","yaml","createTemplateAction"],"mappings":";;;;;;;;;;AAoBA,MAAM,WAAA,GAAcA,MAAE,MAAO,CAAA;AAAA,EAC3B,SAASA,KAAE,CAAA,KAAA;AAAA,IACTA,MAAE,MAAO,CAAA;AAAA,MACP,OAAA,EAASA,KACN,CAAA,MAAA,EACA,CAAA,MAAA;AAAA;AAAA;AAAA;AAAA,QAIC,CAAA,KAAA,KAAS,CAAC,KAAM,CAAA,UAAA,CAAW,GAAG,CAAK,IAAA,CAAC,KAAM,CAAA,QAAA,CAAS,GAAG,CAAA;AAAA,QACtD;AAAA,UACE,OACE,EAAA;AAAA;AACJ,OAED,CAAA,QAAA;AAAA,QACC;AAAA,OACF;AAAA,MACF,OAAOA,KACJ,CAAA,KAAA;AAAA;AAAA,QAECA,KAAA,CAAE,IAAK,CAAA,CAAC,GAAK,EAAA,GAAA,EAAK,KAAK,GAAK,EAAA,GAAA,EAAK,GAAK,EAAA,GAAG,CAAG,EAAA;AAAA,UAC1C,kBACE,EAAA;AAAA,SACH;AAAA,OAEF,CAAA,QAAA,EACA,CAAA,QAAA,CAAS,yBAAyB,CAAA;AAAA,MACrC,WAAA,EAAaA,KACV,CAAA,MAAA,EACA,CAAA,QAAA;AAAA,QACC;AAAA,OACF;AAAA,MACF,QAAQA,KAAE,CAAA,KAAA;AAAA,QACRA,MAAE,MAAO,CAAA;AAAA,UACP,GAAK,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,SAAS,mCAAmC,CAAA;AAAA,UAC5D,KAAO,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,SAAS,8BAA8B;AAAA,SAC1D;AAAA;AACH,KACD;AAAA;AAEL,CAAC,CAAA;AAED,MAAM,YACJ,GAAA,sFAAA;AAEF,MAAM,EAAK,GAAA,eAAA;AAEX,MAAM,QAAW,GAAA;AAAA,EACf;AAAA,IACE,WAAa,EAAA,sDAAA;AAAA,IACb,OAAA,EAASC,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,aAAA;AAAA,UACJ,MAAQ,EAAA,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA;AAAA,cACP;AAAA,gBACE,OAAS,EAAA,YAAA;AAAA,gBACT,WAAa,EAAA,IAAA;AAAA,gBACb,MAAQ,EAAA;AAAA,kBACN,EAAE,GAAA,EAAK,KAAO,EAAA,KAAA,EAAO,cAAe,EAAA;AAAA,kBACpC,EAAE,GAAA,EAAK,KAAO,EAAA,KAAA,EAAO,aAAc;AAAA;AACrC;AACF;AACF;AACF;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,8CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,aAAA;AAAA,UACJ,MAAQ,EAAA,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA;AAAA,cACP;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,KAAA,EAAO,CAAC,GAAG,CAAA;AAAA,gBACX,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF;AACF;AACF;AACF;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,uDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,aAAA;AAAA,UACJ,MAAQ,EAAA,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA;AAAA,cACP;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,KAAA,EAAO,CAAC,GAAG,CAAA;AAAA,gBACX,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,KAAA,EAAO,CAAC,IAAI,CAAA;AAAA,gBACZ,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF;AACF;AACF;AACF;AACF;AACF,KACD;AAAA;AAEL,CAAA;AAKO,MAAM,sBAAsB,MAAM;AACvC,EAAA,OAAOC,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,8FAAA;AAAA,IACF,QAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,KACT;AAAA,IAEA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,QAAQ,GAAI,CAAA,KAAA;AAElB,MAAA,MAAM,SAAiC,EAAC;AAExC,MAAW,KAAA,MAAA;AAAA,QACT,OAAA;AAAA,QACA,KAAO,EAAA,UAAA;AAAA,QACP,WAAA;AAAA,QACA,MAAQ,EAAA;AAAA,OACV,IAAK,MAAM,OAAS,EAAA;AAElB,QAAM,MAAA,KAAA,GAAQ,UACV,GAAA,KAAA,CAAM,IAAK,CAAA,IAAI,GAAI,CAAA,UAAU,CAAC,CAAA,CAAE,IAAK,CAAA,EAAE,CACvC,GAAA,EAAA;AACJ,QAAA,MAAM,KAAQ,GAAA,IAAI,MAAO,CAAA,OAAA,EAAS,KAAK,CAAA;AAEvC,QAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAM,EAAA,IAAK,WAAa,EAAA;AACxC,UAAA,MAAM,KAAQ,GAAA,KAAA,CAAM,OAAQ,CAAA,KAAA,EAAO,WAAW,CAAA;AAE9C,UAAI,IAAA,MAAA,CAAO,cAAe,CAAA,GAAG,CAAG,EAAA;AAC9B,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,YAAY,GAAG,CAAA,sCAAA;AAAA,aACjB;AAAA;AAGF,UAAA,MAAA,CAAO,GAAG,CAAI,GAAA,KAAA;AAAA;AAChB;AAGF,MAAI,GAAA,CAAA,MAAA,CAAO,UAAU,MAAM,CAAA;AAAA;AAC7B,GACD,CAAA;AACH;;;;"}
1
+ {"version":3,"file":"replace.cjs.js","sources":["../../../src/actions/regex/replace.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\n\nimport { examples } from './replace.example';\n\nconst id = 'regex:replace';\n\n/**\n * @public\n */\nexport const createReplaceAction = () => {\n return createTemplateAction({\n id,\n description:\n 'Replaces strings that match a regular expression pattern with a specified replacement string',\n examples,\n schema: {\n input: {\n regExps: z =>\n z.array(\n z.object({\n pattern: z\n .string()\n .refine(\n // You should not parse a regex (regular language) with a regex (regular language),\n // you actually need a context free grammar to parse a regex (regular language).\n // Hence, we are using a string comparison here.\n value => !value.startsWith('/') && !value.endsWith('/'),\n {\n message:\n 'The RegExp constructor cannot take a string pattern with a leading and trailing forward slash.',\n },\n )\n .describe(\n 'The regex pattern to match the value like in String.prototype.replace()',\n ),\n flags: z\n .array(\n // Prefer array over set here because input values are normally defined in YAML which doesn't support Sets.\n z.enum(['g', 'm', 'i', 'y', 'u', 's', 'd'], {\n invalid_type_error:\n 'Invalid flag, possible values are: g, m, i, y, u, s, d',\n }),\n )\n .optional()\n .describe('The flags for the regex'),\n replacement: z\n .string()\n .describe(\n 'The replacement value for the regex like in String.prototype.replace()',\n ),\n values: z.array(\n z.object({\n key: z.string().describe('The key to access the regex value'),\n value: z.string().describe('The input value of the regex'),\n }),\n ),\n }),\n ),\n },\n },\n\n async handler(ctx) {\n const input = ctx.input;\n\n const values: Record<string, string> = {};\n\n for (const {\n pattern,\n flags: flagsInput,\n replacement,\n values: valuesInput,\n } of input.regExps) {\n // remove duplicates from the flags input array\n const flags = flagsInput\n ? Array.from(new Set(flagsInput)).join('')\n : '';\n const regex = new RegExp(pattern, flags);\n\n for (const { key, value } of valuesInput) {\n const match = value.replace(regex, replacement);\n\n if (values.hasOwnProperty(key)) {\n throw new Error(\n `The key '${key}' is used more than once in the input.`,\n );\n }\n\n values[key] = match;\n }\n }\n\n ctx.output('values', values);\n },\n });\n};\n"],"names":["createTemplateAction","examples"],"mappings":";;;;;AAmBA,MAAM,EAAK,GAAA,eAAA;AAKJ,MAAM,sBAAsB,MAAM;AACvC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,8FAAA;AAAA,cACFC,wBAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,OAAA,EAAS,OACP,CAAE,CAAA,KAAA;AAAA,UACA,EAAE,MAAO,CAAA;AAAA,YACP,OAAA,EAAS,CACN,CAAA,MAAA,EACA,CAAA,MAAA;AAAA;AAAA;AAAA;AAAA,cAIC,CAAA,KAAA,KAAS,CAAC,KAAM,CAAA,UAAA,CAAW,GAAG,CAAK,IAAA,CAAC,KAAM,CAAA,QAAA,CAAS,GAAG,CAAA;AAAA,cACtD;AAAA,gBACE,OACE,EAAA;AAAA;AACJ,aAED,CAAA,QAAA;AAAA,cACC;AAAA,aACF;AAAA,YACF,OAAO,CACJ,CAAA,KAAA;AAAA;AAAA,cAEC,CAAA,CAAE,IAAK,CAAA,CAAC,GAAK,EAAA,GAAA,EAAK,KAAK,GAAK,EAAA,GAAA,EAAK,GAAK,EAAA,GAAG,CAAG,EAAA;AAAA,gBAC1C,kBACE,EAAA;AAAA,eACH;AAAA,aAEF,CAAA,QAAA,EACA,CAAA,QAAA,CAAS,yBAAyB,CAAA;AAAA,YACrC,WAAA,EAAa,CACV,CAAA,MAAA,EACA,CAAA,QAAA;AAAA,cACC;AAAA,aACF;AAAA,YACF,QAAQ,CAAE,CAAA,KAAA;AAAA,cACR,EAAE,MAAO,CAAA;AAAA,gBACP,GAAK,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,mCAAmC,CAAA;AAAA,gBAC5D,KAAO,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,8BAA8B;AAAA,eAC1D;AAAA;AACH,WACD;AAAA;AACH;AACJ,KACF;AAAA,IAEA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,QAAQ,GAAI,CAAA,KAAA;AAElB,MAAA,MAAM,SAAiC,EAAC;AAExC,MAAW,KAAA,MAAA;AAAA,QACT,OAAA;AAAA,QACA,KAAO,EAAA,UAAA;AAAA,QACP,WAAA;AAAA,QACA,MAAQ,EAAA;AAAA,OACV,IAAK,MAAM,OAAS,EAAA;AAElB,QAAM,MAAA,KAAA,GAAQ,UACV,GAAA,KAAA,CAAM,IAAK,CAAA,IAAI,GAAI,CAAA,UAAU,CAAC,CAAA,CAAE,IAAK,CAAA,EAAE,CACvC,GAAA,EAAA;AACJ,QAAA,MAAM,KAAQ,GAAA,IAAI,MAAO,CAAA,OAAA,EAAS,KAAK,CAAA;AAEvC,QAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAM,EAAA,IAAK,WAAa,EAAA;AACxC,UAAA,MAAM,KAAQ,GAAA,KAAA,CAAM,OAAQ,CAAA,KAAA,EAAO,WAAW,CAAA;AAE9C,UAAI,IAAA,MAAA,CAAO,cAAe,CAAA,GAAG,CAAG,EAAA;AAC9B,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,YAAY,GAAG,CAAA,sCAAA;AAAA,aACjB;AAAA;AAGF,UAAA,MAAA,CAAO,GAAG,CAAI,GAAA,KAAA;AAAA;AAChB;AAGF,MAAI,GAAA,CAAA,MAAA,CAAO,UAAU,MAAM,CAAA;AAAA;AAC7B,GACD,CAAA;AACH;;;;"}
@@ -0,0 +1,114 @@
1
+ 'use strict';
2
+
3
+ var yaml = require('yaml');
4
+
5
+ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
6
+
7
+ var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
8
+
9
+ const exampleValue = "The quick brown fox jumps over the lazy dog. If the dog reacted, was it really lazy?";
10
+ const id = "regex:replace";
11
+ const examples = [
12
+ {
13
+ description: "Create a regex to capture the first word of a string",
14
+ example: yaml__default.default.stringify({
15
+ steps: [
16
+ {
17
+ id: "regexValues",
18
+ action: id,
19
+ name: "Regex Values",
20
+ input: {
21
+ regExps: [
22
+ {
23
+ pattern: "^(\\S+).*$",
24
+ replacement: "$1",
25
+ values: [
26
+ { key: "eg1", value: "Hello world!" },
27
+ { key: "eg2", value: "Test world!" }
28
+ ]
29
+ }
30
+ ]
31
+ }
32
+ }
33
+ ]
34
+ })
35
+ },
36
+ {
37
+ description: "Create a regex to replace a word in a string",
38
+ example: yaml__default.default.stringify({
39
+ steps: [
40
+ {
41
+ id: "regexValues",
42
+ action: id,
43
+ name: "Regex Values",
44
+ input: {
45
+ regExps: [
46
+ {
47
+ pattern: "dog",
48
+ replacement: "monkey",
49
+ values: [
50
+ {
51
+ key: "eg1",
52
+ value: exampleValue
53
+ }
54
+ ]
55
+ },
56
+ {
57
+ pattern: "Dog",
58
+ replacement: "ferret",
59
+ flags: ["i"],
60
+ values: [
61
+ {
62
+ key: "eg2",
63
+ value: exampleValue
64
+ }
65
+ ]
66
+ }
67
+ ]
68
+ }
69
+ }
70
+ ]
71
+ })
72
+ },
73
+ {
74
+ description: "Create a regex to replace a word globally in a string",
75
+ example: yaml__default.default.stringify({
76
+ steps: [
77
+ {
78
+ id: "regexValues",
79
+ action: id,
80
+ name: "Regex Values",
81
+ input: {
82
+ regExps: [
83
+ {
84
+ pattern: "dog",
85
+ replacement: "monkey",
86
+ flags: ["g"],
87
+ values: [
88
+ {
89
+ key: "eg1",
90
+ value: exampleValue
91
+ }
92
+ ]
93
+ },
94
+ {
95
+ pattern: "Dog",
96
+ replacement: "ferret",
97
+ flags: ["gi"],
98
+ values: [
99
+ {
100
+ key: "eg2",
101
+ value: exampleValue
102
+ }
103
+ ]
104
+ }
105
+ ]
106
+ }
107
+ }
108
+ ]
109
+ })
110
+ }
111
+ ];
112
+
113
+ exports.examples = examples;
114
+ //# sourceMappingURL=replace.example.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"replace.example.cjs.js","sources":["../../../src/actions/regex/replace.example.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { TemplateExample } from '@backstage/plugin-scaffolder-node';\n\nimport yaml from 'yaml';\n\nconst exampleValue =\n 'The quick brown fox jumps over the lazy dog. If the dog reacted, was it really lazy?';\n\nconst id = 'regex:replace';\n\nexport const examples: TemplateExample[] = [\n {\n description: 'Create a regex to capture the first word of a string',\n example: yaml.stringify({\n steps: [\n {\n id: 'regexValues',\n action: id,\n name: 'Regex Values',\n input: {\n regExps: [\n {\n pattern: '^(\\\\S+).*$',\n replacement: '$1',\n values: [\n { key: 'eg1', value: 'Hello world!' },\n { key: 'eg2', value: 'Test world!' },\n ],\n },\n ],\n },\n },\n ],\n }),\n },\n {\n description: 'Create a regex to replace a word in a string',\n example: yaml.stringify({\n steps: [\n {\n id: 'regexValues',\n action: id,\n name: 'Regex Values',\n input: {\n regExps: [\n {\n pattern: 'dog',\n replacement: 'monkey',\n values: [\n {\n key: 'eg1',\n value: exampleValue,\n },\n ],\n },\n {\n pattern: 'Dog',\n replacement: 'ferret',\n flags: ['i'],\n values: [\n {\n key: 'eg2',\n value: exampleValue,\n },\n ],\n },\n ],\n },\n },\n ],\n }),\n },\n {\n description: 'Create a regex to replace a word globally in a string',\n example: yaml.stringify({\n steps: [\n {\n id: 'regexValues',\n action: id,\n name: 'Regex Values',\n input: {\n regExps: [\n {\n pattern: 'dog',\n replacement: 'monkey',\n flags: ['g'],\n values: [\n {\n key: 'eg1',\n value: exampleValue,\n },\n ],\n },\n {\n pattern: 'Dog',\n replacement: 'ferret',\n flags: ['gi'],\n values: [\n {\n key: 'eg2',\n value: exampleValue,\n },\n ],\n },\n ],\n },\n },\n ],\n }),\n },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAoBA,MAAM,YACJ,GAAA,sFAAA;AAEF,MAAM,EAAK,GAAA,eAAA;AAEJ,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,sDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,aAAA;AAAA,UACJ,MAAQ,EAAA,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA;AAAA,cACP;AAAA,gBACE,OAAS,EAAA,YAAA;AAAA,gBACT,WAAa,EAAA,IAAA;AAAA,gBACb,MAAQ,EAAA;AAAA,kBACN,EAAE,GAAA,EAAK,KAAO,EAAA,KAAA,EAAO,cAAe,EAAA;AAAA,kBACpC,EAAE,GAAA,EAAK,KAAO,EAAA,KAAA,EAAO,aAAc;AAAA;AACrC;AACF;AACF;AACF;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,8CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,aAAA;AAAA,UACJ,MAAQ,EAAA,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA;AAAA,cACP;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,KAAA,EAAO,CAAC,GAAG,CAAA;AAAA,gBACX,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF;AACF;AACF;AACF;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,uDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,aAAA;AAAA,UACJ,MAAQ,EAAA,EAAA;AAAA,UACR,IAAM,EAAA,cAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA;AAAA,cACP;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,KAAA,EAAO,CAAC,GAAG,CAAA;AAAA,gBACX,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA,KAAA;AAAA,gBACT,WAAa,EAAA,QAAA;AAAA,gBACb,KAAA,EAAO,CAAC,IAAI,CAAA;AAAA,gBACZ,MAAQ,EAAA;AAAA,kBACN;AAAA,oBACE,GAAK,EAAA,KAAA;AAAA,oBACL,KAAO,EAAA;AAAA;AACT;AACF;AACF;AACF;AACF;AACF;AACF,KACD;AAAA;AAEL;;;;"}
package/dist/index.d.ts CHANGED
@@ -12,9 +12,11 @@ declare const createReplaceAction: () => _backstage_plugin_scaffolder_node.Templ
12
12
  }[];
13
13
  pattern: string;
14
14
  replacement: string;
15
- flags?: ("g" | "m" | "i" | "y" | "u" | "s" | "d")[] | undefined;
15
+ flags?: ("i" | "g" | "m" | "y" | "u" | "s" | "d")[] | undefined;
16
16
  }[];
17
- }, any, "v1">;
17
+ }, {
18
+ [x: string]: any;
19
+ }, "v2">;
18
20
 
19
21
  /**
20
22
  * @public
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-scaffolder-backend-module-regex",
3
3
  "description": "The regex custom actions",
4
- "version": "2.7.0",
4
+ "version": "2.8.0",
5
5
  "main": "./dist/index.cjs.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -46,14 +46,13 @@
46
46
  "prettier:fix": "prettier --ignore-unknown --write ."
47
47
  },
48
48
  "dependencies": {
49
- "@backstage/backend-plugin-api": "^1.3.1",
50
- "@backstage/plugin-scaffolder-node": "^0.8.2",
51
- "yaml": "^2.3.3",
52
- "zod": "^3.22.4"
49
+ "@backstage/backend-plugin-api": "^1.4.1",
50
+ "@backstage/plugin-scaffolder-node": "^0.10.0",
51
+ "yaml": "^2.3.3"
53
52
  },
54
53
  "devDependencies": {
55
- "@backstage/cli": "^0.32.1",
56
- "@backstage/plugin-scaffolder-node-test-utils": "^0.2.2"
54
+ "@backstage/cli": "^0.33.1",
55
+ "@backstage/plugin-scaffolder-node-test-utils": "^0.3.1"
57
56
  },
58
57
  "files": [
59
58
  "dist",