@backstage/create-app 0.4.27-next.0 → 0.4.27
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 +343 -0
- package/dist/index.cjs.js +95 -97
- package/dist/index.cjs.js.map +1 -1
- package/package.json +3 -3
- package/templates/default-app/.dockerignore +2 -2
- package/templates/default-app/app-config.local.yaml +1 -0
- package/templates/default-app/app-config.production.yaml +15 -0
- package/templates/default-app/app-config.yaml.hbs +23 -47
- package/templates/default-app/examples/entities.yaml +41 -0
- package/templates/default-app/examples/org.yaml +17 -0
- package/templates/default-app/examples/template/content/catalog-info.yaml +8 -0
- package/templates/default-app/examples/template/content/index.js +1 -0
- package/templates/default-app/examples/template/content/package.json +5 -0
- package/templates/default-app/examples/template/template.yaml +74 -0
- package/templates/default-app/package.json.hbs +1 -1
- package/templates/default-app/packages/app/package.json.hbs +2 -0
- package/templates/default-app/packages/app/src/App.tsx +7 -1
- package/templates/default-app/packages/app/src/components/search/SearchPage.tsx +4 -1
- package/templates/default-app/packages/backend/package.json.hbs +3 -10
- package/templates/default-app/packages/backend/src/plugins/auth.ts +22 -1
- package/templates/default-app/packages/backend/src/plugins/search.ts.hbs +3 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,348 @@
|
|
|
1
1
|
# @backstage/create-app
|
|
2
2
|
|
|
3
|
+
## 0.4.27
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 73480846dd: Simplified the search collator scheduling by removing the need for the `luxon` dependency.
|
|
8
|
+
|
|
9
|
+
For existing installations the scheduling can be simplified by removing the `luxon` dependency and using the human friendly duration object instead.
|
|
10
|
+
Please note that this only applies if luxon is not used elsewhere in your installation.
|
|
11
|
+
|
|
12
|
+
`packages/backend/package.json`
|
|
13
|
+
|
|
14
|
+
```diff
|
|
15
|
+
"express": "^4.17.1",
|
|
16
|
+
"express-promise-router": "^4.1.0",
|
|
17
|
+
- "luxon": "^2.0.2",
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
`packages/backend/src/plugins/search.ts`
|
|
21
|
+
|
|
22
|
+
```diff
|
|
23
|
+
import { Router } from 'express';
|
|
24
|
+
-import { Duration } from 'luxon';
|
|
25
|
+
|
|
26
|
+
// omitted other code
|
|
27
|
+
|
|
28
|
+
const schedule = env.scheduler.createScheduledTaskRunner({
|
|
29
|
+
- frequency: Duration.fromObject({ minutes: 10 }),
|
|
30
|
+
- timeout: Duration.fromObject({ minutes: 15 }),
|
|
31
|
+
+ frequency: { minutes: 10 },
|
|
32
|
+
+ timeout: { minutes: 15 },
|
|
33
|
+
// A 3 second delay gives the backend server a chance to initialize before
|
|
34
|
+
// any collators are executed, which may attempt requests against the API.
|
|
35
|
+
- initialDelay: Duration.fromObject({ seconds: 3 }),
|
|
36
|
+
+ initialDelay: { seconds: 3 },
|
|
37
|
+
});
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- 7cda923c16: Tweaked the `.dockerignore` file so that it's easier to add additional backend packages if desired.
|
|
41
|
+
|
|
42
|
+
To apply this change to an existing app, make the following change to `.dockerignore`:
|
|
43
|
+
|
|
44
|
+
```diff
|
|
45
|
+
cypress
|
|
46
|
+
microsite
|
|
47
|
+
node_modules
|
|
48
|
+
-packages
|
|
49
|
+
-!packages/backend/dist
|
|
50
|
+
+packages/*/src
|
|
51
|
+
+packages/*/node_modules
|
|
52
|
+
plugins
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
- 3983940a21: Optimized the command order in `packages/backend/Dockerfile` as well as added the `--no-install-recommends` to the `apt-get install` and tweaked the installed packages.
|
|
56
|
+
|
|
57
|
+
To apply this change to an existing app, update your `packages/backend/Dockerfile` to match the documented `Dockerfile` at https://backstage.io/docs/deployment/docker#host-build.
|
|
58
|
+
|
|
59
|
+
- 28bbf5aff6: Added some instruction comments to the generated config files, to clarify the
|
|
60
|
+
usage of `backend.baseUrl` and `backend.listen.host`. Importantly, it also per
|
|
61
|
+
default now listens on all IPv4 interfaces, to make it easier to take the step
|
|
62
|
+
over to production. If you want to do the same, update your
|
|
63
|
+
`app-config.production.yaml` as follows:
|
|
64
|
+
|
|
65
|
+
```diff
|
|
66
|
+
backend:
|
|
67
|
+
listen:
|
|
68
|
+
port: 7007
|
|
69
|
+
+ host: 0.0.0.0
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Also, updated the builtin backend Dockerfile to honor the
|
|
73
|
+
`app-config.production.yaml` file. If you want to do the same, change
|
|
74
|
+
`packages/backend/Dockerfile` as follows:
|
|
75
|
+
|
|
76
|
+
```diff
|
|
77
|
+
-COPY packages/backend/dist/bundle.tar.gz app-config.yaml ./
|
|
78
|
+
+COPY packages/backend/dist/bundle.tar.gz app-config*.yaml ./
|
|
79
|
+
RUN tar xzf bundle.tar.gz && rm bundle.tar.gz
|
|
80
|
+
|
|
81
|
+
-CMD ["node", "packages/backend", "--config", "app-config.yaml"]
|
|
82
|
+
+CMD ["node", "packages/backend", "--config", "app-config.yaml", "--config", "app-config.production.yaml"]
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
If you look carefully, this adds a glob match on app-config files. For those
|
|
86
|
+
that try out the build flows locally, you also want to make sure that the docker
|
|
87
|
+
daemon does NOT pick up any local/private config files that might contain
|
|
88
|
+
secrets. You should therefore also update your local `.dockerignore` file at the
|
|
89
|
+
same time:
|
|
90
|
+
|
|
91
|
+
```diff
|
|
92
|
+
+*.local.yaml
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
- 7b253072c6: Tweaked template to provide an example and guidance for how to configure sign-in in `packages/backend/src/plugins/auth.ts`. There is no need to add this to existing apps, but for more information about sign-in configuration, see https://backstage.io/docs/auth/identity-resolver.
|
|
96
|
+
- cfc0f19699: Updated dependency `fs-extra` to `10.1.0`.
|
|
97
|
+
- f55414f895: Added sample catalog data to the template under a top-level `examples` directory. This includes some simple entities, org data, and a template. You can find the sample data at https://github.com/backstage/backstage/tree/master/packages/create-app/templates/default-app/examples.
|
|
98
|
+
- 344ea56acc: Bump `commander` to version 9.1.0
|
|
99
|
+
- 00fa0dada0: Removed the database choice from the `create-app` command.
|
|
100
|
+
|
|
101
|
+
This reduces the step from development to production by always installing the dependencies and templating the production configuration in `app-config.production.yaml`.
|
|
102
|
+
|
|
103
|
+
Added `app-config.local.yaml` to allow for local configuration overrides.
|
|
104
|
+
To replicate this behavior in an existing installation simply `touch app-config.local.yaml` in the project root and apply your local configuration.
|
|
105
|
+
|
|
106
|
+
`better-sqlite3` has been moved to devDependencies, for existing installations using postgres in production and SQLite in development it's recommended to move SQLite into the devDependencies section to avoid unnecessary dependencies during builds.
|
|
107
|
+
|
|
108
|
+
in `packages/backend/package.json`
|
|
109
|
+
|
|
110
|
+
```diff
|
|
111
|
+
"dependencies": {
|
|
112
|
+
...
|
|
113
|
+
"pg": "^8.3.0",
|
|
114
|
+
- "better-sqlite3": "^7.5.0",
|
|
115
|
+
"winston": "^3.2.1"
|
|
116
|
+
},
|
|
117
|
+
"devDependencies": {
|
|
118
|
+
...
|
|
119
|
+
"@types/luxon": "^2.0.4",
|
|
120
|
+
+ "better-sqlite3": "^7.5.0"
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
- 10d86dedc0: Integrates TechDocs add-ons with the app package so add-ons are configured when creating an app using the Backstage CLI. To apply these changes to an existing application do the following:
|
|
125
|
+
|
|
126
|
+
1. Add the `@backstage/plugin-techdocs-react` and `@backstage/plugin-techdocs-module-addons-contrib` packages to your app's dependencies;
|
|
127
|
+
2. And then register the `<ReportIssue/ >` Addon in your `packages/app/src/App.tsx` file, there where you define a route to `<TechDocsReaderPage />`:
|
|
128
|
+
|
|
129
|
+
```diff
|
|
130
|
+
import {
|
|
131
|
+
DefaultTechDocsHome,
|
|
132
|
+
TechDocsIndexPage,
|
|
133
|
+
TechDocsReaderPage,
|
|
134
|
+
} from '@backstage/plugin-techdocs';
|
|
135
|
+
+ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
|
|
136
|
+
+ import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
|
|
137
|
+
|
|
138
|
+
// ...
|
|
139
|
+
|
|
140
|
+
const AppRoutes = () => {
|
|
141
|
+
<FlatRoutes>
|
|
142
|
+
// ... other plugin routes
|
|
143
|
+
<Route path="/docs" element={<TechDocsIndexPage />}>
|
|
144
|
+
<DefaultTechDocsHome />
|
|
145
|
+
</Route>
|
|
146
|
+
<Route
|
|
147
|
+
path="/docs/:namespace/:kind/:name/*"
|
|
148
|
+
element={<TechDocsReaderPage />}
|
|
149
|
+
>
|
|
150
|
+
+ <TechDocsAddons>
|
|
151
|
+
+ <ReportIssue />
|
|
152
|
+
+ </TechDocsAddons>
|
|
153
|
+
</Route>
|
|
154
|
+
</FlatRoutes>;
|
|
155
|
+
};
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
- 806427545f: Added a link to the `${GITHUB_TOKEN}` to document how to generate a token
|
|
159
|
+
- 3a74e203a8: Implement highlighting matching terms in search results. To enable this for an existing app, make the following changes:
|
|
160
|
+
|
|
161
|
+
```diff
|
|
162
|
+
// packages/app/src/components/search/SearchPage.tsx
|
|
163
|
+
...
|
|
164
|
+
- {results.map(({ type, document }) => {
|
|
165
|
+
+ {results.map(({ type, document, highlight }) => {
|
|
166
|
+
switch (type) {
|
|
167
|
+
case 'software-catalog':
|
|
168
|
+
return (
|
|
169
|
+
<CatalogSearchResultListItem
|
|
170
|
+
key={document.location}
|
|
171
|
+
result={document}
|
|
172
|
+
+ highlight={highlight}
|
|
173
|
+
/>
|
|
174
|
+
);
|
|
175
|
+
case 'techdocs':
|
|
176
|
+
return (
|
|
177
|
+
<TechDocsSearchResultListItem
|
|
178
|
+
key={document.location}
|
|
179
|
+
result={document}
|
|
180
|
+
+ highlight={highlight}
|
|
181
|
+
/>
|
|
182
|
+
);
|
|
183
|
+
default:
|
|
184
|
+
return (
|
|
185
|
+
<DefaultResultListItem
|
|
186
|
+
key={document.location}
|
|
187
|
+
result={document}
|
|
188
|
+
+ highlight={highlight}
|
|
189
|
+
/>
|
|
190
|
+
);
|
|
191
|
+
}
|
|
192
|
+
})}
|
|
193
|
+
...
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
- d41f19ca2a: Bumped the `typescript` version in the template to `~4.6.4`.
|
|
197
|
+
|
|
198
|
+
To apply this change to an existing app, make the following change to the root `package.json`:
|
|
199
|
+
|
|
200
|
+
```diff
|
|
201
|
+
dependencies: {
|
|
202
|
+
...
|
|
203
|
+
- "typescript": "~4.5.4"
|
|
204
|
+
+ "typescript": "~4.6.4"
|
|
205
|
+
},
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
- Updated dependencies
|
|
209
|
+
- @backstage/cli-common@0.1.9
|
|
210
|
+
|
|
211
|
+
## 0.4.27-next.2
|
|
212
|
+
|
|
213
|
+
### Patch Changes
|
|
214
|
+
|
|
215
|
+
- 73480846dd: Simplified the search collator scheduling by removing the need for the `luxon` dependency.
|
|
216
|
+
|
|
217
|
+
For existing installations the scheduling can be simplified by removing the `luxon` dependency and using the human friendly duration object instead.
|
|
218
|
+
Please note that this only applies if luxon is not used elsewhere in your installation.
|
|
219
|
+
|
|
220
|
+
`packages/backend/package.json`
|
|
221
|
+
|
|
222
|
+
```diff
|
|
223
|
+
"express": "^4.17.1",
|
|
224
|
+
"express-promise-router": "^4.1.0",
|
|
225
|
+
- "luxon": "^2.0.2",
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
`packages/backend/src/plugins/search.ts`
|
|
229
|
+
|
|
230
|
+
```diff
|
|
231
|
+
import { Router } from 'express';
|
|
232
|
+
-import { Duration } from 'luxon';
|
|
233
|
+
|
|
234
|
+
// omitted other code
|
|
235
|
+
|
|
236
|
+
const schedule = env.scheduler.createScheduledTaskRunner({
|
|
237
|
+
- frequency: Duration.fromObject({ minutes: 10 }),
|
|
238
|
+
- timeout: Duration.fromObject({ minutes: 15 }),
|
|
239
|
+
+ frequency: { minutes: 10 },
|
|
240
|
+
+ timeout: { minutes: 15 },
|
|
241
|
+
// A 3 second delay gives the backend server a chance to initialize before
|
|
242
|
+
// any collators are executed, which may attempt requests against the API.
|
|
243
|
+
- initialDelay: Duration.fromObject({ seconds: 3 }),
|
|
244
|
+
+ initialDelay: { seconds: 3 },
|
|
245
|
+
});
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
- 7cda923c16: Tweaked the `.dockerignore` file so that it's easier to add additional backend packages if desired.
|
|
249
|
+
|
|
250
|
+
To apply this change to an existing app, make the following change to `.dockerignore`:
|
|
251
|
+
|
|
252
|
+
```diff
|
|
253
|
+
cypress
|
|
254
|
+
microsite
|
|
255
|
+
node_modules
|
|
256
|
+
-packages
|
|
257
|
+
-!packages/backend/dist
|
|
258
|
+
+packages/*/src
|
|
259
|
+
+packages/*/node_modules
|
|
260
|
+
plugins
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
- f55414f895: Added sample catalog data to the template under a top-level `examples` directory. This includes some simple entities, org data, and a template. You can find the sample data at https://github.com/backstage/backstage/tree/master/packages/create-app/templates/default-app/examples.
|
|
264
|
+
- 3a74e203a8: Implement highlighting matching terms in search results. To enable this for an existing app, make the following changes:
|
|
265
|
+
|
|
266
|
+
```diff
|
|
267
|
+
// packages/app/src/components/search/SearchPage.tsx
|
|
268
|
+
...
|
|
269
|
+
- {results.map(({ type, document }) => {
|
|
270
|
+
+ {results.map(({ type, document, highlight }) => {
|
|
271
|
+
switch (type) {
|
|
272
|
+
case 'software-catalog':
|
|
273
|
+
return (
|
|
274
|
+
<CatalogSearchResultListItem
|
|
275
|
+
key={document.location}
|
|
276
|
+
result={document}
|
|
277
|
+
+ highlight={highlight}
|
|
278
|
+
/>
|
|
279
|
+
);
|
|
280
|
+
case 'techdocs':
|
|
281
|
+
return (
|
|
282
|
+
<TechDocsSearchResultListItem
|
|
283
|
+
key={document.location}
|
|
284
|
+
result={document}
|
|
285
|
+
+ highlight={highlight}
|
|
286
|
+
/>
|
|
287
|
+
);
|
|
288
|
+
default:
|
|
289
|
+
return (
|
|
290
|
+
<DefaultResultListItem
|
|
291
|
+
key={document.location}
|
|
292
|
+
result={document}
|
|
293
|
+
+ highlight={highlight}
|
|
294
|
+
/>
|
|
295
|
+
);
|
|
296
|
+
}
|
|
297
|
+
})}
|
|
298
|
+
...
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
- Updated dependencies
|
|
302
|
+
- @backstage/cli-common@0.1.9-next.0
|
|
303
|
+
|
|
304
|
+
## 0.4.27-next.1
|
|
305
|
+
|
|
306
|
+
### Patch Changes
|
|
307
|
+
|
|
308
|
+
- 7b253072c6: Tweaked template to provide an example and guidance for how to configure sign-in in `packages/backend/src/plugins/auth.ts`. There is no need to add this to existing apps, but for more information about sign-in configuration, see https://backstage.io/docs/auth/identity-resolver.
|
|
309
|
+
- 00fa0dada0: Removed the database choice from the `create-app` command.
|
|
310
|
+
|
|
311
|
+
This reduces the step from development to production by always installing the dependencies and templating the production configuration in `app-config.production.yaml`.
|
|
312
|
+
|
|
313
|
+
Added `app-config.local.yaml` to allow for local configuration overrides.
|
|
314
|
+
To replicate this behavior in an existing installation simply `touch app-config.local.yaml` in the project root and apply your local configuration.
|
|
315
|
+
|
|
316
|
+
`better-sqlite3` has been moved to devDependencies, for existing installations using postgres in production and SQLite in development it's recommended to move SQLite into the devDependencies section to avoid unnecessary dependencies during builds.
|
|
317
|
+
|
|
318
|
+
in `packages/backend/package.json`
|
|
319
|
+
|
|
320
|
+
```diff
|
|
321
|
+
"dependencies": {
|
|
322
|
+
...
|
|
323
|
+
"pg": "^8.3.0",
|
|
324
|
+
- "better-sqlite3": "^7.5.0",
|
|
325
|
+
"winston": "^3.2.1"
|
|
326
|
+
},
|
|
327
|
+
"devDependencies": {
|
|
328
|
+
...
|
|
329
|
+
"@types/luxon": "^2.0.4",
|
|
330
|
+
+ "better-sqlite3": "^7.5.0"
|
|
331
|
+
}
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
- d41f19ca2a: Bumped the `typescript` version in the template to `~4.6.4`.
|
|
335
|
+
|
|
336
|
+
To apply this change to an existing app, make the following change to the root `package.json`:
|
|
337
|
+
|
|
338
|
+
```diff
|
|
339
|
+
dependencies: {
|
|
340
|
+
...
|
|
341
|
+
- "typescript": "~4.5.4"
|
|
342
|
+
+ "typescript": "~4.6.4"
|
|
343
|
+
},
|
|
344
|
+
```
|
|
345
|
+
|
|
3
346
|
## 0.4.27-next.0
|
|
4
347
|
|
|
5
348
|
### Patch Changes
|
package/dist/index.cjs.js
CHANGED
|
@@ -57,144 +57,150 @@ ${chalk__default["default"].red(`${error}`)}
|
|
|
57
57
|
}
|
|
58
58
|
}
|
|
59
59
|
|
|
60
|
-
var version$
|
|
60
|
+
var version$L = "0.4.27";
|
|
61
61
|
|
|
62
|
-
var version$
|
|
62
|
+
var version$K = "1.2.0";
|
|
63
63
|
|
|
64
|
-
var version$
|
|
64
|
+
var version$J = "1.0.2";
|
|
65
65
|
|
|
66
|
-
var version$
|
|
66
|
+
var version$I = "0.13.3";
|
|
67
67
|
|
|
68
|
-
var version$
|
|
68
|
+
var version$H = "0.3.1";
|
|
69
69
|
|
|
70
|
-
var version$
|
|
70
|
+
var version$G = "1.0.2";
|
|
71
|
+
|
|
72
|
+
var version$F = "1.0.2";
|
|
73
|
+
|
|
74
|
+
var version$E = "0.17.1";
|
|
71
75
|
|
|
72
76
|
var version$D = "1.0.1";
|
|
73
77
|
|
|
74
|
-
var version$C = "
|
|
78
|
+
var version$C = "1.0.2";
|
|
75
79
|
|
|
76
|
-
var version$B = "
|
|
80
|
+
var version$B = "0.9.4";
|
|
77
81
|
|
|
78
|
-
var version$A = "1.0.
|
|
82
|
+
var version$A = "1.0.2";
|
|
79
83
|
|
|
80
|
-
var version$z = "0.
|
|
84
|
+
var version$z = "1.0.0";
|
|
81
85
|
|
|
82
|
-
var version$y = "1.0
|
|
86
|
+
var version$y = "1.1.0";
|
|
83
87
|
|
|
84
|
-
var version$x = "1.
|
|
88
|
+
var version$x = "1.1.0";
|
|
85
89
|
|
|
86
|
-
var version$w = "
|
|
90
|
+
var version$w = "0.2.15";
|
|
87
91
|
|
|
88
|
-
var version$v = "
|
|
92
|
+
var version$v = "0.8.5";
|
|
89
93
|
|
|
90
|
-
var version$u = "0.
|
|
94
|
+
var version$u = "0.3.32";
|
|
91
95
|
|
|
92
|
-
var version$t = "0.
|
|
96
|
+
var version$t = "0.14.0";
|
|
93
97
|
|
|
94
|
-
var version$s = "
|
|
98
|
+
var version$s = "1.2.0";
|
|
95
99
|
|
|
96
|
-
var version$r = "
|
|
100
|
+
var version$r = "1.0.2";
|
|
97
101
|
|
|
98
|
-
var version$q = "1.
|
|
102
|
+
var version$q = "1.1.0";
|
|
99
103
|
|
|
100
|
-
var version$p = "1.
|
|
104
|
+
var version$p = "1.1.2";
|
|
101
105
|
|
|
102
|
-
var version$o = "
|
|
106
|
+
var version$o = "0.2.17";
|
|
103
107
|
|
|
104
|
-
var version$n = "
|
|
108
|
+
var version$n = "0.8.8";
|
|
105
109
|
|
|
106
|
-
var version$m = "0.
|
|
110
|
+
var version$m = "0.3.5";
|
|
107
111
|
|
|
108
|
-
var version$l = "0.
|
|
112
|
+
var version$l = "0.3.36";
|
|
109
113
|
|
|
110
|
-
var version$k = "0.
|
|
114
|
+
var version$k = "0.5.5";
|
|
111
115
|
|
|
112
|
-
var version$j = "0.3.
|
|
116
|
+
var version$j = "0.3.5";
|
|
113
117
|
|
|
114
|
-
var version$i = "0.5.5
|
|
118
|
+
var version$i = "0.5.5";
|
|
115
119
|
|
|
116
|
-
var version$h = "0.
|
|
120
|
+
var version$h = "0.6.1";
|
|
117
121
|
|
|
118
|
-
var version$g = "0.
|
|
122
|
+
var version$g = "0.4.1";
|
|
119
123
|
|
|
120
|
-
var version$f = "0.6.
|
|
124
|
+
var version$f = "0.6.1";
|
|
121
125
|
|
|
122
|
-
var version$e = "0.
|
|
126
|
+
var version$e = "0.2.26";
|
|
123
127
|
|
|
124
|
-
var version$d = "0.
|
|
128
|
+
var version$d = "0.1.29";
|
|
125
129
|
|
|
126
|
-
var version$c = "
|
|
130
|
+
var version$c = "1.2.0";
|
|
127
131
|
|
|
128
|
-
var version$b = "
|
|
132
|
+
var version$b = "1.2.0";
|
|
129
133
|
|
|
130
|
-
var version$a = "
|
|
134
|
+
var version$a = "0.8.1";
|
|
131
135
|
|
|
132
|
-
var version$9 = "
|
|
136
|
+
var version$9 = "0.2.0";
|
|
133
137
|
|
|
134
|
-
var version$8 = "0.
|
|
138
|
+
var version$8 = "0.5.2";
|
|
135
139
|
|
|
136
|
-
var version$7 = "0.
|
|
140
|
+
var version$7 = "0.3.3";
|
|
137
141
|
|
|
138
|
-
var version$6 = "0.
|
|
142
|
+
var version$6 = "0.6.1";
|
|
139
143
|
|
|
140
|
-
var version$5 = "0.
|
|
144
|
+
var version$5 = "0.5.12";
|
|
141
145
|
|
|
142
|
-
var version$4 = "
|
|
146
|
+
var version$4 = "1.1.1";
|
|
143
147
|
|
|
144
|
-
var version$3 = "0.
|
|
148
|
+
var version$3 = "1.0.0";
|
|
145
149
|
|
|
146
|
-
var version$2 = "1.
|
|
150
|
+
var version$2 = "1.0.0";
|
|
147
151
|
|
|
148
|
-
var version$1 = "1.1.1
|
|
152
|
+
var version$1 = "1.1.1";
|
|
149
153
|
|
|
150
|
-
var version = "0.4.
|
|
154
|
+
var version = "0.4.4";
|
|
151
155
|
|
|
152
156
|
const packageVersions = {
|
|
153
|
-
root: version$
|
|
154
|
-
"@backstage/app-defaults": version$
|
|
155
|
-
"@backstage/backend-common": version$
|
|
156
|
-
"@backstage/backend-tasks": version$
|
|
157
|
-
"@backstage/catalog-client": version$
|
|
158
|
-
"@backstage/catalog-model": version$
|
|
159
|
-
"@backstage/cli": version$
|
|
160
|
-
"@backstage/config": version$
|
|
161
|
-
"@backstage/core-app-api": version$
|
|
162
|
-
"@backstage/core-components": version$
|
|
163
|
-
"@backstage/core-plugin-api": version$
|
|
164
|
-
"@backstage/errors": version$
|
|
165
|
-
"@backstage/integration-react": version$
|
|
166
|
-
"@backstage/plugin-api-docs": version$
|
|
167
|
-
"@backstage/plugin-app-backend": version$
|
|
168
|
-
"@backstage/plugin-auth-backend": version$
|
|
169
|
-
"@backstage/plugin-catalog": version$
|
|
170
|
-
"@backstage/plugin-catalog-common": version$
|
|
171
|
-
"@backstage/plugin-catalog-react": version$
|
|
172
|
-
"@backstage/plugin-catalog-backend": version$
|
|
173
|
-
"@backstage/plugin-catalog-graph": version$
|
|
174
|
-
"@backstage/plugin-catalog-import": version$
|
|
175
|
-
"@backstage/plugin-circleci": version$
|
|
176
|
-
"@backstage/plugin-explore": version$
|
|
177
|
-
"@backstage/plugin-github-actions": version$
|
|
178
|
-
"@backstage/plugin-lighthouse": version$
|
|
179
|
-
"@backstage/plugin-org": version$
|
|
180
|
-
"@backstage/plugin-permission-common": version$
|
|
181
|
-
"@backstage/plugin-permission-node": version$
|
|
182
|
-
"@backstage/plugin-permission-react": version$
|
|
183
|
-
"@backstage/plugin-proxy-backend": version$
|
|
184
|
-
"@backstage/plugin-rollbar-backend": version$
|
|
185
|
-
"@backstage/plugin-scaffolder": version$
|
|
186
|
-
"@backstage/plugin-scaffolder-backend": version$
|
|
187
|
-
"@backstage/plugin-search": version$
|
|
188
|
-
"@backstage/plugin-search-react": version$
|
|
189
|
-
"@backstage/plugin-search-backend": version$
|
|
190
|
-
"@backstage/plugin-search-backend-module-pg": version$
|
|
191
|
-
"@backstage/plugin-search-backend-node": version$
|
|
192
|
-
"@backstage/plugin-tech-radar": version$
|
|
193
|
-
"@backstage/plugin-techdocs": version$
|
|
157
|
+
root: version$K,
|
|
158
|
+
"@backstage/app-defaults": version$J,
|
|
159
|
+
"@backstage/backend-common": version$I,
|
|
160
|
+
"@backstage/backend-tasks": version$H,
|
|
161
|
+
"@backstage/catalog-client": version$G,
|
|
162
|
+
"@backstage/catalog-model": version$F,
|
|
163
|
+
"@backstage/cli": version$E,
|
|
164
|
+
"@backstage/config": version$D,
|
|
165
|
+
"@backstage/core-app-api": version$C,
|
|
166
|
+
"@backstage/core-components": version$B,
|
|
167
|
+
"@backstage/core-plugin-api": version$A,
|
|
168
|
+
"@backstage/errors": version$z,
|
|
169
|
+
"@backstage/integration-react": version$y,
|
|
170
|
+
"@backstage/plugin-api-docs": version$v,
|
|
171
|
+
"@backstage/plugin-app-backend": version$u,
|
|
172
|
+
"@backstage/plugin-auth-backend": version$t,
|
|
173
|
+
"@backstage/plugin-catalog": version$s,
|
|
174
|
+
"@backstage/plugin-catalog-common": version$r,
|
|
175
|
+
"@backstage/plugin-catalog-react": version$q,
|
|
176
|
+
"@backstage/plugin-catalog-backend": version$p,
|
|
177
|
+
"@backstage/plugin-catalog-graph": version$o,
|
|
178
|
+
"@backstage/plugin-catalog-import": version$n,
|
|
179
|
+
"@backstage/plugin-circleci": version$m,
|
|
180
|
+
"@backstage/plugin-explore": version$l,
|
|
181
|
+
"@backstage/plugin-github-actions": version$k,
|
|
182
|
+
"@backstage/plugin-lighthouse": version$j,
|
|
183
|
+
"@backstage/plugin-org": version$i,
|
|
184
|
+
"@backstage/plugin-permission-common": version$h,
|
|
185
|
+
"@backstage/plugin-permission-node": version$f,
|
|
186
|
+
"@backstage/plugin-permission-react": version$g,
|
|
187
|
+
"@backstage/plugin-proxy-backend": version$e,
|
|
188
|
+
"@backstage/plugin-rollbar-backend": version$d,
|
|
189
|
+
"@backstage/plugin-scaffolder": version$c,
|
|
190
|
+
"@backstage/plugin-scaffolder-backend": version$b,
|
|
191
|
+
"@backstage/plugin-search": version$a,
|
|
192
|
+
"@backstage/plugin-search-react": version$9,
|
|
193
|
+
"@backstage/plugin-search-backend": version$8,
|
|
194
|
+
"@backstage/plugin-search-backend-module-pg": version$7,
|
|
195
|
+
"@backstage/plugin-search-backend-node": version$6,
|
|
196
|
+
"@backstage/plugin-tech-radar": version$5,
|
|
197
|
+
"@backstage/plugin-techdocs": version$4,
|
|
198
|
+
"@backstage/plugin-techdocs-react": version$3,
|
|
199
|
+
"@backstage/plugin-techdocs-module-addons-contrib": version$2,
|
|
194
200
|
"@backstage/plugin-techdocs-backend": version$1,
|
|
195
201
|
"@backstage/plugin-user-settings": version,
|
|
196
|
-
"@backstage/test-utils": version$
|
|
197
|
-
"@backstage/theme": version$
|
|
202
|
+
"@backstage/test-utils": version$x,
|
|
203
|
+
"@backstage/theme": version$w
|
|
198
204
|
};
|
|
199
205
|
|
|
200
206
|
const TASK_NAME_MAX_LENGTH = 14;
|
|
@@ -338,16 +344,8 @@ var createApp = async (opts) => {
|
|
|
338
344
|
}
|
|
339
345
|
return true;
|
|
340
346
|
}
|
|
341
|
-
},
|
|
342
|
-
{
|
|
343
|
-
type: "list",
|
|
344
|
-
name: "dbType",
|
|
345
|
-
message: chalk__default["default"].blue("Select database for the backend [required]"),
|
|
346
|
-
choices: ["SQLite", "PostgreSQL"]
|
|
347
347
|
}
|
|
348
348
|
]);
|
|
349
|
-
answers.dbTypePG = answers.dbType === "PostgreSQL";
|
|
350
|
-
answers.dbTypeSqlite = answers.dbType === "SQLite";
|
|
351
349
|
const templateDir = paths.resolveOwn("templates/default-app");
|
|
352
350
|
const tempDir = path.resolve(os__default["default"].tmpdir(), answers.name);
|
|
353
351
|
const appDir = opts.path ? path.resolve(paths.targetDir, opts.path) : path.resolve(paths.targetDir, answers.name);
|
|
@@ -391,7 +389,7 @@ var createApp = async (opts) => {
|
|
|
391
389
|
};
|
|
392
390
|
|
|
393
391
|
const main = (argv) => {
|
|
394
|
-
commander.program.name("backstage-create-app").version(version$
|
|
392
|
+
commander.program.name("backstage-create-app").version(version$L).description("Creates a new app in a new directory or specified path").option("--path [directory]", "Location to store the app defaulting to a new folder with the app name").option("--skip-install", "Skip the install and builds steps after creating the app").action((cmd) => createApp(cmd));
|
|
395
393
|
commander.program.parse(argv);
|
|
396
394
|
};
|
|
397
395
|
process.on("unhandledRejection", (rejection) => {
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/lib/errors.ts","../src/lib/versions.ts","../src/lib/tasks.ts","../src/createApp.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2020 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 chalk from 'chalk';\n\nexport class CustomError extends Error {\n get name(): string {\n return this.constructor.name;\n }\n}\n\nexport class ExitCodeError extends CustomError {\n readonly code: number;\n\n constructor(code: number, command?: string) {\n if (command) {\n super(`Command '${command}' exited with code ${code}`);\n } else {\n super(`Child exited with code ${code}`);\n }\n this.code = code;\n }\n}\n\nexport function exitWithError(error: Error): never {\n if (error instanceof ExitCodeError) {\n process.stderr.write(`\\n${chalk.red(error.message)}\\n\\n`);\n process.exit(error.code);\n } else {\n process.stderr.write(`\\n${chalk.red(`${error}`)}\\n\\n`);\n process.exit(1);\n }\n}\n","/*\n * Copyright 2020 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\n/* eslint-disable monorepo/no-relative-import */\n\n/*\nThis is a list of all packages used by the template. If dependencies are added or removed,\nthis list should be updated as well.\n\nThe list, and the accompanying peerDependencies entries, are here to ensure correct versioning\nand bumping of this package. Without this list the version would not be bumped unless we\nmanually trigger a release.\n\nThis does not create an actual dependency on these packages and does not bring in any code.\nRelative imports are used rather than package imports to make sure the packages aren't externalized.\nRollup will extract the value of the version field in each package at build time without\nleaving any imports in place.\n*/\n\nimport { version as root } from '../../../../package.json';\n\nimport { version as appDefaults } from '../../../app-defaults/package.json';\nimport { version as backendCommon } from '../../../backend-common/package.json';\nimport { version as backendTasks } from '../../../backend-tasks/package.json';\nimport { version as catalogClient } from '../../../catalog-client/package.json';\nimport { version as catalogModel } from '../../../catalog-model/package.json';\nimport { version as cli } from '../../../cli/package.json';\nimport { version as config } from '../../../config/package.json';\nimport { version as coreAppApi } from '../../../core-app-api/package.json';\nimport { version as coreComponents } from '../../../core-components/package.json';\nimport { version as corePluginApi } from '../../../core-plugin-api/package.json';\nimport { version as errors } from '../../../errors/package.json';\nimport { version as integrationReact } from '../../../integration-react/package.json';\nimport { version as testUtils } from '../../../test-utils/package.json';\nimport { version as theme } from '../../../theme/package.json';\n\nimport { version as pluginApiDocs } from '../../../../plugins/api-docs/package.json';\nimport { version as pluginAppBackend } from '../../../../plugins/app-backend/package.json';\nimport { version as pluginAuthBackend } from '../../../../plugins/auth-backend/package.json';\nimport { version as pluginCatalog } from '../../../../plugins/catalog/package.json';\nimport { version as pluginCatalogCommon } from '../../../../plugins/catalog-common/package.json';\nimport { version as pluginCatalogReact } from '../../../../plugins/catalog-react/package.json';\nimport { version as pluginCatalogBackend } from '../../../../plugins/catalog-backend/package.json';\nimport { version as pluginCatalogGraph } from '../../../../plugins/catalog-graph/package.json';\nimport { version as pluginCatalogImport } from '../../../../plugins/catalog-import/package.json';\nimport { version as pluginCircleci } from '../../../../plugins/circleci/package.json';\nimport { version as pluginExplore } from '../../../../plugins/explore/package.json';\nimport { version as pluginGithubActions } from '../../../../plugins/github-actions/package.json';\nimport { version as pluginLighthouse } from '../../../../plugins/lighthouse/package.json';\nimport { version as pluginOrg } from '../../../../plugins/org/package.json';\nimport { version as pluginPermissionCommon } from '../../../../plugins/permission-common/package.json';\nimport { version as pluginPermissionReact } from '../../../../plugins/permission-react/package.json';\nimport { version as pluginPermissionNode } from '../../../../plugins/permission-node/package.json';\nimport { version as pluginProxyBackend } from '../../../../plugins/proxy-backend/package.json';\nimport { version as pluginRollbarBackend } from '../../../../plugins/rollbar-backend/package.json';\nimport { version as pluginScaffolder } from '../../../../plugins/scaffolder/package.json';\nimport { version as pluginScaffolderBackend } from '../../../../plugins/scaffolder-backend/package.json';\nimport { version as pluginSearch } from '../../../../plugins/search/package.json';\nimport { version as pluginSearchReact } from '../../../../plugins/search-react/package.json';\nimport { version as pluginSearchBackend } from '../../../../plugins/search-backend/package.json';\nimport { version as pluginSearchBackendModulePg } from '../../../../plugins/search-backend-module-pg/package.json';\nimport { version as pluginSearchBackendNode } from '../../../../plugins/search-backend-node/package.json';\nimport { version as pluginTechRadar } from '../../../../plugins/tech-radar/package.json';\nimport { version as pluginTechdocs } from '../../../../plugins/techdocs/package.json';\nimport { version as pluginTechdocsBackend } from '../../../../plugins/techdocs-backend/package.json';\nimport { version as pluginUserSettings } from '../../../../plugins/user-settings/package.json';\n\nexport const packageVersions = {\n root,\n '@backstage/app-defaults': appDefaults,\n '@backstage/backend-common': backendCommon,\n '@backstage/backend-tasks': backendTasks,\n '@backstage/catalog-client': catalogClient,\n '@backstage/catalog-model': catalogModel,\n '@backstage/cli': cli,\n '@backstage/config': config,\n '@backstage/core-app-api': coreAppApi,\n '@backstage/core-components': coreComponents,\n '@backstage/core-plugin-api': corePluginApi,\n '@backstage/errors': errors,\n '@backstage/integration-react': integrationReact,\n '@backstage/plugin-api-docs': pluginApiDocs,\n '@backstage/plugin-app-backend': pluginAppBackend,\n '@backstage/plugin-auth-backend': pluginAuthBackend,\n '@backstage/plugin-catalog': pluginCatalog,\n '@backstage/plugin-catalog-common': pluginCatalogCommon,\n '@backstage/plugin-catalog-react': pluginCatalogReact,\n '@backstage/plugin-catalog-backend': pluginCatalogBackend,\n '@backstage/plugin-catalog-graph': pluginCatalogGraph,\n '@backstage/plugin-catalog-import': pluginCatalogImport,\n '@backstage/plugin-circleci': pluginCircleci,\n '@backstage/plugin-explore': pluginExplore,\n '@backstage/plugin-github-actions': pluginGithubActions,\n '@backstage/plugin-lighthouse': pluginLighthouse,\n '@backstage/plugin-org': pluginOrg,\n '@backstage/plugin-permission-common': pluginPermissionCommon,\n '@backstage/plugin-permission-node': pluginPermissionNode,\n '@backstage/plugin-permission-react': pluginPermissionReact,\n '@backstage/plugin-proxy-backend': pluginProxyBackend,\n '@backstage/plugin-rollbar-backend': pluginRollbarBackend,\n '@backstage/plugin-scaffolder': pluginScaffolder,\n '@backstage/plugin-scaffolder-backend': pluginScaffolderBackend,\n '@backstage/plugin-search': pluginSearch,\n '@backstage/plugin-search-react': pluginSearchReact,\n '@backstage/plugin-search-backend': pluginSearchBackend,\n '@backstage/plugin-search-backend-module-pg': pluginSearchBackendModulePg,\n '@backstage/plugin-search-backend-node': pluginSearchBackendNode,\n '@backstage/plugin-tech-radar': pluginTechRadar,\n '@backstage/plugin-techdocs': pluginTechdocs,\n '@backstage/plugin-techdocs-backend': pluginTechdocsBackend,\n '@backstage/plugin-user-settings': pluginUserSettings,\n '@backstage/test-utils': testUtils,\n '@backstage/theme': theme,\n};\n","/*\n * Copyright 2020 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 chalk from 'chalk';\nimport fs from 'fs-extra';\nimport handlebars from 'handlebars';\nimport ora from 'ora';\nimport recursive from 'recursive-readdir';\nimport {\n basename,\n dirname,\n resolve as resolvePath,\n relative as relativePath,\n} from 'path';\nimport { exec as execCb } from 'child_process';\nimport { packageVersions } from './versions';\nimport { promisify } from 'util';\n\nconst TASK_NAME_MAX_LENGTH = 14;\nconst exec = promisify(execCb);\n\nexport class Task {\n static log(name: string = '') {\n process.stdout.write(`${chalk.green(name)}\\n`);\n }\n\n static error(message: string = '') {\n process.stdout.write(`\\n${chalk.red(message)}\\n\\n`);\n }\n\n static section(name: string) {\n const title = chalk.green(`${name}:`);\n process.stdout.write(`\\n ${title}\\n`);\n }\n\n static exit(code: number = 0) {\n process.exit(code);\n }\n\n static async forItem(\n task: string,\n item: string,\n taskFunc: () => Promise<void>,\n ): Promise<void> {\n const paddedTask = chalk.green(task.padEnd(TASK_NAME_MAX_LENGTH));\n\n const spinner = ora({\n prefixText: chalk.green(` ${paddedTask}${chalk.cyan(item)}`),\n spinner: 'arc',\n color: 'green',\n }).start();\n\n try {\n await taskFunc();\n spinner.succeed();\n } catch (error) {\n spinner.fail();\n throw error;\n }\n }\n}\n\n/**\n * Generate a templated backstage project\n *\n * @param templateDir - location containing template files\n * @param destinationDir - location to save templated project\n * @param context - template parameters\n */\nexport async function templatingTask(\n templateDir: string,\n destinationDir: string,\n context: any,\n) {\n const files = await recursive(templateDir).catch(error => {\n throw new Error(`Failed to read template directory: ${error.message}`);\n });\n\n for (const file of files) {\n const destinationFile = resolvePath(\n destinationDir,\n relativePath(templateDir, file),\n );\n await fs.ensureDir(dirname(destinationFile));\n\n if (file.endsWith('.hbs')) {\n await Task.forItem('templating', basename(file), async () => {\n const destination = destinationFile.replace(/\\.hbs$/, '');\n\n const template = await fs.readFile(file);\n const compiled = handlebars.compile(template.toString());\n const contents = compiled(\n { name: basename(destination), ...context },\n {\n helpers: {\n version(name: keyof typeof packageVersions) {\n if (name in packageVersions) {\n return packageVersions[name];\n }\n throw new Error(`No version available for package ${name}`);\n },\n },\n },\n );\n\n await fs.writeFile(destination, contents).catch(error => {\n throw new Error(\n `Failed to create file: ${destination}: ${error.message}`,\n );\n });\n });\n } else {\n await Task.forItem('copying', basename(file), async () => {\n await fs.copyFile(file, destinationFile).catch(error => {\n const destination = destinationFile;\n throw new Error(\n `Failed to copy file to ${destination} : ${error.message}`,\n );\n });\n });\n }\n }\n}\n\n/**\n * Verify that application target does not already exist\n *\n * @param rootDir - The directory to create application folder `name`\n * @param name - The specified name of the application\n * @Throws Error - If directory with name of `destination` already exists\n */\nexport async function checkAppExistsTask(rootDir: string, name: string) {\n await Task.forItem('checking', name, async () => {\n const destination = resolvePath(rootDir, name);\n\n if (await fs.pathExists(destination)) {\n const existing = chalk.cyan(destination.replace(`${rootDir}/`, ''));\n throw new Error(\n `A directory with the same name already exists: ${existing}\\nPlease try again with a different app name`,\n );\n }\n });\n}\n\n/**\n * Verify that application `path` exists, otherwise create the directory\n *\n * @param path - target to create directory\n * @throws if `path` is a file, or `fs.mkdir` fails\n */\nexport async function checkPathExistsTask(path: string) {\n await Task.forItem('checking', path, async () => {\n try {\n await fs.mkdirs(path);\n } catch (error) {\n // will fail if a file already exists at given `path`\n throw new Error(`Failed to create app directory: ${error.message}`);\n }\n });\n}\n\n/**\n * Create a folder to store templated files\n *\n * @param tempDir - target temporary directory\n * @throws if `fs.mkdir` fails\n */\nexport async function createTemporaryAppFolderTask(tempDir: string) {\n await Task.forItem('creating', 'temporary directory', async () => {\n try {\n await fs.mkdir(tempDir);\n } catch (error) {\n throw new Error(`Failed to create temporary app directory, ${error}`);\n }\n });\n}\n\n/**\n * Run `yarn install` and `run tsc` in application directory\n *\n * @param appDir - location of application to build\n */\nexport async function buildAppTask(appDir: string) {\n const runCmd = async (cmd: string) => {\n await Task.forItem('executing', cmd, async () => {\n process.chdir(appDir);\n await exec(cmd).catch(error => {\n process.stdout.write(error.stderr);\n process.stdout.write(error.stdout);\n throw new Error(`Could not execute command ${chalk.cyan(cmd)}`);\n });\n });\n };\n\n await runCmd('yarn install');\n await runCmd('yarn tsc');\n}\n\n/**\n * Move temporary directory to destination application folder\n *\n * @param tempDir - source path to copy files from\n * @param destination - target path to copy files\n * @param id - item ID\n * @throws if `fs.move` fails\n */\nexport async function moveAppTask(\n tempDir: string,\n destination: string,\n id: string,\n) {\n await Task.forItem('moving', id, async () => {\n await fs\n .move(tempDir, destination)\n .catch(error => {\n throw new Error(\n `Failed to move app from ${tempDir} to ${destination}: ${error.message}`,\n );\n })\n .finally(() => {\n // remove temporary files on both success and failure\n fs.removeSync(tempDir);\n });\n });\n}\n","/*\n * Copyright 2020 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 chalk from 'chalk';\nimport { OptionValues } from 'commander';\nimport inquirer, { Answers } from 'inquirer';\nimport { resolve as resolvePath } from 'path';\nimport { findPaths } from '@backstage/cli-common';\nimport os from 'os';\nimport {\n Task,\n buildAppTask,\n checkAppExistsTask,\n checkPathExistsTask,\n createTemporaryAppFolderTask,\n moveAppTask,\n templatingTask,\n} from './lib/tasks';\n\nexport default async (opts: OptionValues): Promise<void> => {\n /* eslint-disable-next-line no-restricted-syntax */\n const paths = findPaths(__dirname);\n\n const answers: Answers = await inquirer.prompt([\n {\n type: 'input',\n name: 'name',\n message: chalk.blue('Enter a name for the app [required]'),\n validate: (value: any) => {\n if (!value) {\n return chalk.red('Please enter a name for the app');\n } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n return chalk.red(\n 'App name must be lowercase and contain only letters, digits, and dashes.',\n );\n }\n return true;\n },\n },\n {\n type: 'list',\n name: 'dbType',\n message: chalk.blue('Select database for the backend [required]'),\n choices: ['SQLite', 'PostgreSQL'],\n },\n ]);\n answers.dbTypePG = answers.dbType === 'PostgreSQL';\n answers.dbTypeSqlite = answers.dbType === 'SQLite';\n\n const templateDir = paths.resolveOwn('templates/default-app');\n const tempDir = resolvePath(os.tmpdir(), answers.name);\n\n // Use `--path` argument as application directory when specified, otherwise\n // create a directory using `answers.name`\n const appDir = opts.path\n ? resolvePath(paths.targetDir, opts.path)\n : resolvePath(paths.targetDir, answers.name);\n\n Task.log();\n Task.log('Creating the app...');\n\n try {\n if (opts.path) {\n // Template directly to specified path\n\n Task.section('Checking that supplied path exists');\n await checkPathExistsTask(appDir);\n\n Task.section('Preparing files');\n await templatingTask(templateDir, opts.path, answers);\n } else {\n // Template to temporary location, and then move files\n\n Task.section('Checking if the directory is available');\n await checkAppExistsTask(paths.targetDir, answers.name);\n\n Task.section('Creating a temporary app directory');\n await createTemporaryAppFolderTask(tempDir);\n\n Task.section('Preparing files');\n await templatingTask(templateDir, tempDir, answers);\n\n Task.section('Moving to final location');\n await moveAppTask(tempDir, appDir, answers.name);\n }\n\n if (!opts.skipInstall) {\n Task.section('Building the app');\n await buildAppTask(appDir);\n }\n\n Task.log();\n Task.log(\n chalk.green(`🥇 Successfully created ${chalk.cyan(answers.name)}`),\n );\n Task.log();\n Task.section('All set! Now you might want to');\n Task.log(` Run the app: ${chalk.cyan(`cd ${answers.name} && yarn dev`)}`);\n Task.log(\n ' Set up the software catalog: https://backstage.io/docs/features/software-catalog/configuration',\n );\n Task.log(' Add authentication: https://backstage.io/docs/auth/');\n Task.log();\n Task.exit();\n } catch (error) {\n Task.error(String(error));\n\n Task.log('It seems that something went wrong when creating the app 🤔');\n\n Task.error('🔥 Failed to create app!');\n Task.exit(1);\n }\n};\n","/*\n * Copyright 2020 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\n/**\n * A CLI that helps you create your own Backstage app\n *\n * @packageDocumentation\n */\n\nimport { program } from 'commander';\nimport { exitWithError } from './lib/errors';\nimport { version } from '../package.json';\nimport createApp from './createApp';\n\nconst main = (argv: string[]) => {\n program\n .name('backstage-create-app')\n .version(version)\n .description('Creates a new app in a new directory or specified path')\n .option(\n '--path [directory]',\n 'Location to store the app defaulting to a new folder with the app name',\n )\n .option(\n '--skip-install',\n 'Skip the install and builds steps after creating the app',\n )\n .action(cmd => createApp(cmd));\n\n program.parse(argv);\n};\n\nprocess.on('unhandledRejection', rejection => {\n if (rejection instanceof Error) {\n exitWithError(rejection);\n } else {\n exitWithError(new Error(`Unknown rejection: '${rejection}'`));\n }\n});\n\nmain(process.argv);\n"],"names":["chalk","root","appDefaults","backendCommon","backendTasks","catalogClient","catalogModel","cli","config","coreAppApi","coreComponents","corePluginApi","errors","integrationReact","pluginApiDocs","pluginAppBackend","pluginAuthBackend","pluginCatalog","pluginCatalogCommon","pluginCatalogReact","pluginCatalogBackend","pluginCatalogGraph","pluginCatalogImport","pluginCircleci","pluginExplore","pluginGithubActions","pluginLighthouse","pluginOrg","pluginPermissionCommon","pluginPermissionNode","pluginPermissionReact","pluginProxyBackend","pluginRollbarBackend","pluginScaffolder","pluginScaffolderBackend","pluginSearch","pluginSearchReact","pluginSearchBackend","pluginSearchBackendModulePg","pluginSearchBackendNode","pluginTechRadar","pluginTechdocs","pluginTechdocsBackend","pluginUserSettings","testUtils","theme","promisify","execCb","ora","recursive","resolvePath","relativePath","fs","dirname","basename","handlebars","findPaths","inquirer","os","program","version"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACO,MAAM,WAAW,SAAS,KAAK,CAAC;AACvC,EAAE,IAAI,IAAI,GAAG;AACb,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;AACjC,GAAG;AACH,CAAC;AACM,MAAM,aAAa,SAAS,WAAW,CAAC;AAC/C,EAAE,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE;AAC7B,IAAI,IAAI,OAAO,GAAG,CAAC,GAAG,IAAI,KAAK;AAC/B,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AACrB,KAAK,CAAC;AACN,IAAI,IAAI,OAAO,EAAE;AACjB,MAAM,OAAO,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/D,KAAK,MAAM;AACX,MAAM,OAAO,CAAC,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACrB,GAAG;AACH,CAAC;AACM,SAAS,aAAa,CAAC,KAAK,EAAE;AACrC,EAAE,IAAI,KAAK,YAAY,aAAa,EAAE;AACtC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,EAAEA,yBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3B;AACA,CAAC,CAAC,CAAC;AACH,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC7B,GAAG,MAAM;AACT,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,EAAEA,yBAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACxB;AACA,CAAC,CAAC,CAAC;AACH,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,GAAG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACYO,MAAM,eAAe,GAAG;AAC/B,QAAEC,SAAI;AACN,EAAE,yBAAyB,EAAEC,SAAW;AACxC,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,0BAA0B,EAAEC,SAAY;AAC1C,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,0BAA0B,EAAEC,SAAY;AAC1C,EAAE,gBAAgB,EAAEC,SAAG;AACvB,EAAE,mBAAmB,EAAEC,SAAM;AAC7B,EAAE,yBAAyB,EAAEC,SAAU;AACvC,EAAE,4BAA4B,EAAEC,SAAc;AAC9C,EAAE,4BAA4B,EAAEC,SAAa;AAC7C,EAAE,mBAAmB,EAAEC,SAAM;AAC7B,EAAE,8BAA8B,EAAEC,SAAgB;AAClD,EAAE,4BAA4B,EAAEC,SAAa;AAC7C,EAAE,+BAA+B,EAAEC,SAAgB;AACnD,EAAE,gCAAgC,EAAEC,SAAiB;AACrD,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,iCAAiC,EAAEC,SAAkB;AACvD,EAAE,mCAAmC,EAAEC,SAAoB;AAC3D,EAAE,iCAAiC,EAAEC,SAAkB;AACvD,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,4BAA4B,EAAEC,SAAc;AAC9C,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,8BAA8B,EAAEC,SAAgB;AAClD,EAAE,uBAAuB,EAAEC,SAAS;AACpC,EAAE,qCAAqC,EAAEC,SAAsB;AAC/D,EAAE,mCAAmC,EAAEC,SAAoB;AAC3D,EAAE,oCAAoC,EAAEC,SAAqB;AAC7D,EAAE,iCAAiC,EAAEC,SAAkB;AACvD,EAAE,mCAAmC,EAAEC,SAAoB;AAC3D,EAAE,8BAA8B,EAAEC,SAAgB;AAClD,EAAE,sCAAsC,EAAEC,SAAuB;AACjE,EAAE,0BAA0B,EAAEC,SAAY;AAC1C,EAAE,gCAAgC,EAAEC,SAAiB;AACrD,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,4CAA4C,EAAEC,SAA2B;AAC3E,EAAE,uCAAuC,EAAEC,SAAuB;AAClE,EAAE,8BAA8B,EAAEC,SAAe;AACjD,EAAE,4BAA4B,EAAEC,SAAc;AAC9C,EAAE,oCAAoC,EAAEC,SAAqB;AAC7D,EAAE,iCAAiC,EAAEC,OAAkB;AACvD,EAAE,uBAAuB,EAAEC,SAAS;AACpC,EAAE,kBAAkB,EAAEC,SAAK;AAC3B,CAAC;;AC7ED,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,IAAI,GAAGC,cAAS,CAACC,kBAAM,CAAC,CAAC;AACxB,MAAM,IAAI,CAAC;AAClB,EAAE,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE;AACxB,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE/C,yBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AACH,GAAG;AACH,EAAE,OAAO,KAAK,CAAC,OAAO,GAAG,EAAE,EAAE;AAC7B,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,EAAEA,yBAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACrB;AACA,CAAC,CAAC,CAAC;AACH,GAAG;AACH,EAAE,OAAO,OAAO,CAAC,IAAI,EAAE;AACvB,IAAI,MAAM,KAAK,GAAGA,yBAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1C,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC,EAAE,KAAK,CAAC;AACT,CAAC,CAAC,CAAC;AACH,GAAG;AACH,EAAE,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE;AACxB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvB,GAAG;AACH,EAAE,aAAa,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;AAC7C,IAAI,MAAM,UAAU,GAAGA,yBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;AACtE,IAAI,MAAM,OAAO,GAAGgD,uBAAG,CAAC;AACxB,MAAM,UAAU,EAAEhD,yBAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,EAAEA,yBAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACnE,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,KAAK,EAAE,OAAO;AACpB,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;AACf,IAAI,IAAI;AACR,MAAM,MAAM,QAAQ,EAAE,CAAC;AACvB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;AACxB,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;AACrB,MAAM,MAAM,KAAK,CAAC;AAClB,KAAK;AACL,GAAG;AACH,CAAC;AACM,eAAe,cAAc,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE;AAC3E,EAAE,MAAM,KAAK,GAAG,MAAMiD,6BAAS,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AAC9D,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,mCAAmC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3E,GAAG,CAAC,CAAC;AACL,EAAE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AAC5B,IAAI,MAAM,eAAe,GAAGC,YAAW,CAAC,cAAc,EAAEC,aAAY,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;AACzF,IAAI,MAAMC,sBAAE,CAAC,SAAS,CAACC,YAAO,CAAC,eAAe,CAAC,CAAC,CAAC;AACjD,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC/B,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAEC,aAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;AACnE,QAAQ,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAClE,QAAQ,MAAM,QAAQ,GAAG,MAAMF,sBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACjD,QAAQ,MAAM,QAAQ,GAAGG,8BAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;AACjE,QAAQ,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,IAAI,EAAED,aAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE;AAC/E,UAAU,OAAO,EAAE;AACnB,YAAY,OAAO,CAAC,IAAI,EAAE;AAC1B,cAAc,IAAI,IAAI,IAAI,eAAe,EAAE;AAC3C,gBAAgB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC7C,eAAe;AACf,cAAc,MAAM,IAAI,KAAK,CAAC,CAAC,iCAAiC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC1E,aAAa;AACb,WAAW;AACX,SAAS,CAAC,CAAC;AACX,QAAQ,MAAMF,sBAAE,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACnE,UAAU,MAAM,IAAI,KAAK,CAAC,CAAC,uBAAuB,EAAE,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACrF,SAAS,CAAC,CAAC;AACX,OAAO,CAAC,CAAC;AACT,KAAK,MAAM;AACX,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAEE,aAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;AAChE,QAAQ,MAAMF,sBAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AAClE,UAAU,MAAM,WAAW,GAAG,eAAe,CAAC;AAC9C,UAAU,MAAM,IAAI,KAAK,CAAC,CAAC,uBAAuB,EAAE,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACtF,SAAS,CAAC,CAAC;AACX,OAAO,CAAC,CAAC;AACT,KAAK;AACL,GAAG;AACH,CAAC;AACM,eAAe,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE;AACxD,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY;AACnD,IAAI,MAAM,WAAW,GAAGF,YAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACnD,IAAI,IAAI,MAAME,sBAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;AAC1C,MAAM,MAAM,QAAQ,GAAGpD,yBAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1E,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,+CAA+C,EAAE,QAAQ,CAAC;AACjF,0CAA0C,CAAC,CAAC,CAAC;AAC7C,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,eAAe,mBAAmB,CAAC,IAAI,EAAE;AAChD,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY;AACnD,IAAI,IAAI;AACR,MAAM,MAAMoD,sBAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5B,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,gCAAgC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC1E,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,eAAe,4BAA4B,CAAC,OAAO,EAAE;AAC5D,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,qBAAqB,EAAE,YAAY;AACpE,IAAI,IAAI;AACR,MAAM,MAAMA,sBAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC9B,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5E,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,eAAe,YAAY,CAAC,MAAM,EAAE;AAC3C,EAAE,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK;AAChC,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,EAAE,YAAY;AACrD,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC5B,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACvC,QAAQ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3C,QAAQ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3C,QAAQ,MAAM,IAAI,KAAK,CAAC,CAAC,0BAA0B,EAAEpD,yBAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACxE,OAAO,CAAC,CAAC;AACT,KAAK,CAAC,CAAC;AACP,GAAG,CAAC;AACJ,EAAE,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC;AAC/B,EAAE,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3B,CAAC;AACM,eAAe,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE;AAC5D,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,YAAY;AAC/C,IAAI,MAAMoD,sBAAE,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACzD,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,wBAAwB,EAAE,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAChG,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM;AACrB,MAAMA,sBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAC7B,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;AC5HA,gBAAe,OAAO,IAAI,KAAK;AAC/B,EAAE,MAAM,KAAK,GAAGI,mBAAS,CAAC,SAAS,CAAC,CAAC;AACrC,EAAE,MAAM,OAAO,GAAG,MAAMC,4BAAQ,CAAC,MAAM,CAAC;AACxC,IAAI;AACJ,MAAM,IAAI,EAAE,OAAO;AACnB,MAAM,IAAI,EAAE,MAAM;AAClB,MAAM,OAAO,EAAEzD,yBAAK,CAAC,IAAI,CAAC,qCAAqC,CAAC;AAChE,MAAM,QAAQ,EAAE,CAAC,KAAK,KAAK;AAC3B,QAAQ,IAAI,CAAC,KAAK,EAAE;AACpB,UAAU,OAAOA,yBAAK,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;AAC9D,SAAS,MAAM,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;AAC5D,UAAU,OAAOA,yBAAK,CAAC,GAAG,CAAC,0EAA0E,CAAC,CAAC;AACvG,SAAS;AACT,QAAQ,OAAO,IAAI,CAAC;AACpB,OAAO;AACP,KAAK;AACL,IAAI;AACJ,MAAM,IAAI,EAAE,MAAM;AAClB,MAAM,IAAI,EAAE,QAAQ;AACpB,MAAM,OAAO,EAAEA,yBAAK,CAAC,IAAI,CAAC,4CAA4C,CAAC;AACvE,MAAM,OAAO,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC;AACvC,KAAK;AACL,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,KAAK,YAAY,CAAC;AACrD,EAAE,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC;AACrD,EAAE,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAChE,EAAE,MAAM,OAAO,GAAGkD,YAAW,CAACQ,sBAAE,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AACzD,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,GAAGR,YAAW,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,GAAGA,YAAW,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAClH,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;AACb,EAAE,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;AAClC,EAAE,IAAI;AACN,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;AACnB,MAAM,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;AACzD,MAAM,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;AACxC,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACtC,MAAM,MAAM,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5D,KAAK,MAAM;AACX,MAAM,IAAI,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC;AAC7D,MAAM,MAAM,kBAAkB,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9D,MAAM,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;AACzD,MAAM,MAAM,4BAA4B,CAAC,OAAO,CAAC,CAAC;AAClD,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACtC,MAAM,MAAM,cAAc,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC/C,MAAM,MAAM,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AACvD,KAAK;AACL,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;AAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACvC,MAAM,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;AACjC,KAAK;AACL,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AACf,IAAI,IAAI,CAAC,GAAG,CAAClD,yBAAK,CAAC,KAAK,CAAC,CAAC,gCAAgC,EAAEA,yBAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzF,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AACf,IAAI,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;AACnD,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,eAAe,EAAEA,yBAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/E,IAAI,IAAI,CAAC,GAAG,CAAC,kGAAkG,CAAC,CAAC;AACjH,IAAI,IAAI,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;AACtE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AACf,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;AAChB,GAAG,CAAC,OAAO,KAAK,EAAE;AAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,oEAAoE,CAAC,CAAC;AACnF,IAAI,IAAI,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACnD,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,GAAG;AACH,CAAC;;AC3ED,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK;AACvB,EAAE2D,iBAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAACC,SAAO,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CAAC,MAAM,CAAC,oBAAoB,EAAE,wEAAwE,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1V,EAAED,iBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AACF,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,SAAS,KAAK;AAChD,EAAE,IAAI,SAAS,YAAY,KAAK,EAAE;AAClC,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AAC7B,GAAG,MAAM;AACT,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,GAAG;AACH,CAAC,CAAC,CAAC;AACH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/lib/errors.ts","../src/lib/versions.ts","../src/lib/tasks.ts","../src/createApp.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2020 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 chalk from 'chalk';\n\nexport class CustomError extends Error {\n get name(): string {\n return this.constructor.name;\n }\n}\n\nexport class ExitCodeError extends CustomError {\n readonly code: number;\n\n constructor(code: number, command?: string) {\n if (command) {\n super(`Command '${command}' exited with code ${code}`);\n } else {\n super(`Child exited with code ${code}`);\n }\n this.code = code;\n }\n}\n\nexport function exitWithError(error: Error): never {\n if (error instanceof ExitCodeError) {\n process.stderr.write(`\\n${chalk.red(error.message)}\\n\\n`);\n process.exit(error.code);\n } else {\n process.stderr.write(`\\n${chalk.red(`${error}`)}\\n\\n`);\n process.exit(1);\n }\n}\n","/*\n * Copyright 2020 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\n/* eslint-disable monorepo/no-relative-import */\n\n/*\nThis is a list of all packages used by the template. If dependencies are added or removed,\nthis list should be updated as well.\n\nThe list, and the accompanying peerDependencies entries, are here to ensure correct versioning\nand bumping of this package. Without this list the version would not be bumped unless we\nmanually trigger a release.\n\nThis does not create an actual dependency on these packages and does not bring in any code.\nRelative imports are used rather than package imports to make sure the packages aren't externalized.\nRollup will extract the value of the version field in each package at build time without\nleaving any imports in place.\n*/\n\nimport { version as root } from '../../../../package.json';\n\nimport { version as appDefaults } from '../../../app-defaults/package.json';\nimport { version as backendCommon } from '../../../backend-common/package.json';\nimport { version as backendTasks } from '../../../backend-tasks/package.json';\nimport { version as catalogClient } from '../../../catalog-client/package.json';\nimport { version as catalogModel } from '../../../catalog-model/package.json';\nimport { version as cli } from '../../../cli/package.json';\nimport { version as config } from '../../../config/package.json';\nimport { version as coreAppApi } from '../../../core-app-api/package.json';\nimport { version as coreComponents } from '../../../core-components/package.json';\nimport { version as corePluginApi } from '../../../core-plugin-api/package.json';\nimport { version as errors } from '../../../errors/package.json';\nimport { version as integrationReact } from '../../../integration-react/package.json';\nimport { version as testUtils } from '../../../test-utils/package.json';\nimport { version as theme } from '../../../theme/package.json';\n\nimport { version as pluginApiDocs } from '../../../../plugins/api-docs/package.json';\nimport { version as pluginAppBackend } from '../../../../plugins/app-backend/package.json';\nimport { version as pluginAuthBackend } from '../../../../plugins/auth-backend/package.json';\nimport { version as pluginCatalog } from '../../../../plugins/catalog/package.json';\nimport { version as pluginCatalogCommon } from '../../../../plugins/catalog-common/package.json';\nimport { version as pluginCatalogReact } from '../../../../plugins/catalog-react/package.json';\nimport { version as pluginCatalogBackend } from '../../../../plugins/catalog-backend/package.json';\nimport { version as pluginCatalogGraph } from '../../../../plugins/catalog-graph/package.json';\nimport { version as pluginCatalogImport } from '../../../../plugins/catalog-import/package.json';\nimport { version as pluginCircleci } from '../../../../plugins/circleci/package.json';\nimport { version as pluginExplore } from '../../../../plugins/explore/package.json';\nimport { version as pluginGithubActions } from '../../../../plugins/github-actions/package.json';\nimport { version as pluginLighthouse } from '../../../../plugins/lighthouse/package.json';\nimport { version as pluginOrg } from '../../../../plugins/org/package.json';\nimport { version as pluginPermissionCommon } from '../../../../plugins/permission-common/package.json';\nimport { version as pluginPermissionReact } from '../../../../plugins/permission-react/package.json';\nimport { version as pluginPermissionNode } from '../../../../plugins/permission-node/package.json';\nimport { version as pluginProxyBackend } from '../../../../plugins/proxy-backend/package.json';\nimport { version as pluginRollbarBackend } from '../../../../plugins/rollbar-backend/package.json';\nimport { version as pluginScaffolder } from '../../../../plugins/scaffolder/package.json';\nimport { version as pluginScaffolderBackend } from '../../../../plugins/scaffolder-backend/package.json';\nimport { version as pluginSearch } from '../../../../plugins/search/package.json';\nimport { version as pluginSearchReact } from '../../../../plugins/search-react/package.json';\nimport { version as pluginSearchBackend } from '../../../../plugins/search-backend/package.json';\nimport { version as pluginSearchBackendModulePg } from '../../../../plugins/search-backend-module-pg/package.json';\nimport { version as pluginSearchBackendNode } from '../../../../plugins/search-backend-node/package.json';\nimport { version as pluginTechRadar } from '../../../../plugins/tech-radar/package.json';\nimport { version as pluginTechdocs } from '../../../../plugins/techdocs/package.json';\nimport { version as pluginTechdocsReact } from '../../../../plugins/techdocs-react/package.json';\nimport { version as pluginTechdocsModuleAddonsContrib } from '../../../../plugins/techdocs-module-addons-contrib/package.json';\nimport { version as pluginTechdocsBackend } from '../../../../plugins/techdocs-backend/package.json';\nimport { version as pluginUserSettings } from '../../../../plugins/user-settings/package.json';\n\nexport const packageVersions = {\n root,\n '@backstage/app-defaults': appDefaults,\n '@backstage/backend-common': backendCommon,\n '@backstage/backend-tasks': backendTasks,\n '@backstage/catalog-client': catalogClient,\n '@backstage/catalog-model': catalogModel,\n '@backstage/cli': cli,\n '@backstage/config': config,\n '@backstage/core-app-api': coreAppApi,\n '@backstage/core-components': coreComponents,\n '@backstage/core-plugin-api': corePluginApi,\n '@backstage/errors': errors,\n '@backstage/integration-react': integrationReact,\n '@backstage/plugin-api-docs': pluginApiDocs,\n '@backstage/plugin-app-backend': pluginAppBackend,\n '@backstage/plugin-auth-backend': pluginAuthBackend,\n '@backstage/plugin-catalog': pluginCatalog,\n '@backstage/plugin-catalog-common': pluginCatalogCommon,\n '@backstage/plugin-catalog-react': pluginCatalogReact,\n '@backstage/plugin-catalog-backend': pluginCatalogBackend,\n '@backstage/plugin-catalog-graph': pluginCatalogGraph,\n '@backstage/plugin-catalog-import': pluginCatalogImport,\n '@backstage/plugin-circleci': pluginCircleci,\n '@backstage/plugin-explore': pluginExplore,\n '@backstage/plugin-github-actions': pluginGithubActions,\n '@backstage/plugin-lighthouse': pluginLighthouse,\n '@backstage/plugin-org': pluginOrg,\n '@backstage/plugin-permission-common': pluginPermissionCommon,\n '@backstage/plugin-permission-node': pluginPermissionNode,\n '@backstage/plugin-permission-react': pluginPermissionReact,\n '@backstage/plugin-proxy-backend': pluginProxyBackend,\n '@backstage/plugin-rollbar-backend': pluginRollbarBackend,\n '@backstage/plugin-scaffolder': pluginScaffolder,\n '@backstage/plugin-scaffolder-backend': pluginScaffolderBackend,\n '@backstage/plugin-search': pluginSearch,\n '@backstage/plugin-search-react': pluginSearchReact,\n '@backstage/plugin-search-backend': pluginSearchBackend,\n '@backstage/plugin-search-backend-module-pg': pluginSearchBackendModulePg,\n '@backstage/plugin-search-backend-node': pluginSearchBackendNode,\n '@backstage/plugin-tech-radar': pluginTechRadar,\n '@backstage/plugin-techdocs': pluginTechdocs,\n '@backstage/plugin-techdocs-react': pluginTechdocsReact,\n '@backstage/plugin-techdocs-module-addons-contrib':\n pluginTechdocsModuleAddonsContrib,\n '@backstage/plugin-techdocs-backend': pluginTechdocsBackend,\n '@backstage/plugin-user-settings': pluginUserSettings,\n '@backstage/test-utils': testUtils,\n '@backstage/theme': theme,\n};\n","/*\n * Copyright 2020 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 chalk from 'chalk';\nimport fs from 'fs-extra';\nimport handlebars from 'handlebars';\nimport ora from 'ora';\nimport recursive from 'recursive-readdir';\nimport {\n basename,\n dirname,\n resolve as resolvePath,\n relative as relativePath,\n} from 'path';\nimport { exec as execCb } from 'child_process';\nimport { packageVersions } from './versions';\nimport { promisify } from 'util';\n\nconst TASK_NAME_MAX_LENGTH = 14;\nconst exec = promisify(execCb);\n\nexport class Task {\n static log(name: string = '') {\n process.stdout.write(`${chalk.green(name)}\\n`);\n }\n\n static error(message: string = '') {\n process.stdout.write(`\\n${chalk.red(message)}\\n\\n`);\n }\n\n static section(name: string) {\n const title = chalk.green(`${name}:`);\n process.stdout.write(`\\n ${title}\\n`);\n }\n\n static exit(code: number = 0) {\n process.exit(code);\n }\n\n static async forItem(\n task: string,\n item: string,\n taskFunc: () => Promise<void>,\n ): Promise<void> {\n const paddedTask = chalk.green(task.padEnd(TASK_NAME_MAX_LENGTH));\n\n const spinner = ora({\n prefixText: chalk.green(` ${paddedTask}${chalk.cyan(item)}`),\n spinner: 'arc',\n color: 'green',\n }).start();\n\n try {\n await taskFunc();\n spinner.succeed();\n } catch (error) {\n spinner.fail();\n throw error;\n }\n }\n}\n\n/**\n * Generate a templated backstage project\n *\n * @param templateDir - location containing template files\n * @param destinationDir - location to save templated project\n * @param context - template parameters\n */\nexport async function templatingTask(\n templateDir: string,\n destinationDir: string,\n context: any,\n) {\n const files = await recursive(templateDir).catch(error => {\n throw new Error(`Failed to read template directory: ${error.message}`);\n });\n\n for (const file of files) {\n const destinationFile = resolvePath(\n destinationDir,\n relativePath(templateDir, file),\n );\n await fs.ensureDir(dirname(destinationFile));\n\n if (file.endsWith('.hbs')) {\n await Task.forItem('templating', basename(file), async () => {\n const destination = destinationFile.replace(/\\.hbs$/, '');\n\n const template = await fs.readFile(file);\n const compiled = handlebars.compile(template.toString());\n const contents = compiled(\n { name: basename(destination), ...context },\n {\n helpers: {\n version(name: keyof typeof packageVersions) {\n if (name in packageVersions) {\n return packageVersions[name];\n }\n throw new Error(`No version available for package ${name}`);\n },\n },\n },\n );\n\n await fs.writeFile(destination, contents).catch(error => {\n throw new Error(\n `Failed to create file: ${destination}: ${error.message}`,\n );\n });\n });\n } else {\n await Task.forItem('copying', basename(file), async () => {\n await fs.copyFile(file, destinationFile).catch(error => {\n const destination = destinationFile;\n throw new Error(\n `Failed to copy file to ${destination} : ${error.message}`,\n );\n });\n });\n }\n }\n}\n\n/**\n * Verify that application target does not already exist\n *\n * @param rootDir - The directory to create application folder `name`\n * @param name - The specified name of the application\n * @Throws Error - If directory with name of `destination` already exists\n */\nexport async function checkAppExistsTask(rootDir: string, name: string) {\n await Task.forItem('checking', name, async () => {\n const destination = resolvePath(rootDir, name);\n\n if (await fs.pathExists(destination)) {\n const existing = chalk.cyan(destination.replace(`${rootDir}/`, ''));\n throw new Error(\n `A directory with the same name already exists: ${existing}\\nPlease try again with a different app name`,\n );\n }\n });\n}\n\n/**\n * Verify that application `path` exists, otherwise create the directory\n *\n * @param path - target to create directory\n * @throws if `path` is a file, or `fs.mkdir` fails\n */\nexport async function checkPathExistsTask(path: string) {\n await Task.forItem('checking', path, async () => {\n try {\n await fs.mkdirs(path);\n } catch (error) {\n // will fail if a file already exists at given `path`\n throw new Error(`Failed to create app directory: ${error.message}`);\n }\n });\n}\n\n/**\n * Create a folder to store templated files\n *\n * @param tempDir - target temporary directory\n * @throws if `fs.mkdir` fails\n */\nexport async function createTemporaryAppFolderTask(tempDir: string) {\n await Task.forItem('creating', 'temporary directory', async () => {\n try {\n await fs.mkdir(tempDir);\n } catch (error) {\n throw new Error(`Failed to create temporary app directory, ${error}`);\n }\n });\n}\n\n/**\n * Run `yarn install` and `run tsc` in application directory\n *\n * @param appDir - location of application to build\n */\nexport async function buildAppTask(appDir: string) {\n const runCmd = async (cmd: string) => {\n await Task.forItem('executing', cmd, async () => {\n process.chdir(appDir);\n await exec(cmd).catch(error => {\n process.stdout.write(error.stderr);\n process.stdout.write(error.stdout);\n throw new Error(`Could not execute command ${chalk.cyan(cmd)}`);\n });\n });\n };\n\n await runCmd('yarn install');\n await runCmd('yarn tsc');\n}\n\n/**\n * Move temporary directory to destination application folder\n *\n * @param tempDir - source path to copy files from\n * @param destination - target path to copy files\n * @param id - item ID\n * @throws if `fs.move` fails\n */\nexport async function moveAppTask(\n tempDir: string,\n destination: string,\n id: string,\n) {\n await Task.forItem('moving', id, async () => {\n await fs\n .move(tempDir, destination)\n .catch(error => {\n throw new Error(\n `Failed to move app from ${tempDir} to ${destination}: ${error.message}`,\n );\n })\n .finally(() => {\n // remove temporary files on both success and failure\n fs.removeSync(tempDir);\n });\n });\n}\n","/*\n * Copyright 2020 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 chalk from 'chalk';\nimport { OptionValues } from 'commander';\nimport inquirer, { Answers } from 'inquirer';\nimport { resolve as resolvePath } from 'path';\nimport { findPaths } from '@backstage/cli-common';\nimport os from 'os';\nimport {\n Task,\n buildAppTask,\n checkAppExistsTask,\n checkPathExistsTask,\n createTemporaryAppFolderTask,\n moveAppTask,\n templatingTask,\n} from './lib/tasks';\n\nexport default async (opts: OptionValues): Promise<void> => {\n /* eslint-disable-next-line no-restricted-syntax */\n const paths = findPaths(__dirname);\n\n const answers: Answers = await inquirer.prompt([\n {\n type: 'input',\n name: 'name',\n message: chalk.blue('Enter a name for the app [required]'),\n validate: (value: any) => {\n if (!value) {\n return chalk.red('Please enter a name for the app');\n } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n return chalk.red(\n 'App name must be lowercase and contain only letters, digits, and dashes.',\n );\n }\n return true;\n },\n },\n ]);\n\n const templateDir = paths.resolveOwn('templates/default-app');\n const tempDir = resolvePath(os.tmpdir(), answers.name);\n\n // Use `--path` argument as application directory when specified, otherwise\n // create a directory using `answers.name`\n const appDir = opts.path\n ? resolvePath(paths.targetDir, opts.path)\n : resolvePath(paths.targetDir, answers.name);\n\n Task.log();\n Task.log('Creating the app...');\n\n try {\n if (opts.path) {\n // Template directly to specified path\n\n Task.section('Checking that supplied path exists');\n await checkPathExistsTask(appDir);\n\n Task.section('Preparing files');\n await templatingTask(templateDir, opts.path, answers);\n } else {\n // Template to temporary location, and then move files\n\n Task.section('Checking if the directory is available');\n await checkAppExistsTask(paths.targetDir, answers.name);\n\n Task.section('Creating a temporary app directory');\n await createTemporaryAppFolderTask(tempDir);\n\n Task.section('Preparing files');\n await templatingTask(templateDir, tempDir, answers);\n\n Task.section('Moving to final location');\n await moveAppTask(tempDir, appDir, answers.name);\n }\n\n if (!opts.skipInstall) {\n Task.section('Building the app');\n await buildAppTask(appDir);\n }\n\n Task.log();\n Task.log(\n chalk.green(`🥇 Successfully created ${chalk.cyan(answers.name)}`),\n );\n Task.log();\n Task.section('All set! Now you might want to');\n Task.log(` Run the app: ${chalk.cyan(`cd ${answers.name} && yarn dev`)}`);\n Task.log(\n ' Set up the software catalog: https://backstage.io/docs/features/software-catalog/configuration',\n );\n Task.log(' Add authentication: https://backstage.io/docs/auth/');\n Task.log();\n Task.exit();\n } catch (error) {\n Task.error(String(error));\n\n Task.log('It seems that something went wrong when creating the app 🤔');\n\n Task.error('🔥 Failed to create app!');\n Task.exit(1);\n }\n};\n","/*\n * Copyright 2020 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\n/**\n * A CLI that helps you create your own Backstage app\n *\n * @packageDocumentation\n */\n\nimport { program } from 'commander';\nimport { exitWithError } from './lib/errors';\nimport { version } from '../package.json';\nimport createApp from './createApp';\n\nconst main = (argv: string[]) => {\n program\n .name('backstage-create-app')\n .version(version)\n .description('Creates a new app in a new directory or specified path')\n .option(\n '--path [directory]',\n 'Location to store the app defaulting to a new folder with the app name',\n )\n .option(\n '--skip-install',\n 'Skip the install and builds steps after creating the app',\n )\n .action(cmd => createApp(cmd));\n\n program.parse(argv);\n};\n\nprocess.on('unhandledRejection', rejection => {\n if (rejection instanceof Error) {\n exitWithError(rejection);\n } else {\n exitWithError(new Error(`Unknown rejection: '${rejection}'`));\n }\n});\n\nmain(process.argv);\n"],"names":["chalk","root","appDefaults","backendCommon","backendTasks","catalogClient","catalogModel","cli","config","coreAppApi","coreComponents","corePluginApi","errors","integrationReact","pluginApiDocs","pluginAppBackend","pluginAuthBackend","pluginCatalog","pluginCatalogCommon","pluginCatalogReact","pluginCatalogBackend","pluginCatalogGraph","pluginCatalogImport","pluginCircleci","pluginExplore","pluginGithubActions","pluginLighthouse","pluginOrg","pluginPermissionCommon","pluginPermissionNode","pluginPermissionReact","pluginProxyBackend","pluginRollbarBackend","pluginScaffolder","pluginScaffolderBackend","pluginSearch","pluginSearchReact","pluginSearchBackend","pluginSearchBackendModulePg","pluginSearchBackendNode","pluginTechRadar","pluginTechdocs","pluginTechdocsReact","pluginTechdocsModuleAddonsContrib","pluginTechdocsBackend","pluginUserSettings","testUtils","theme","promisify","execCb","ora","recursive","resolvePath","relativePath","fs","dirname","basename","handlebars","findPaths","inquirer","os","program","version"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACO,MAAM,WAAW,SAAS,KAAK,CAAC;AACvC,EAAE,IAAI,IAAI,GAAG;AACb,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;AACjC,GAAG;AACH,CAAC;AACM,MAAM,aAAa,SAAS,WAAW,CAAC;AAC/C,EAAE,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE;AAC7B,IAAI,IAAI,OAAO,GAAG,CAAC,GAAG,IAAI,KAAK;AAC/B,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AACrB,KAAK,CAAC;AACN,IAAI,IAAI,OAAO,EAAE;AACjB,MAAM,OAAO,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/D,KAAK,MAAM;AACX,MAAM,OAAO,CAAC,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACrB,GAAG;AACH,CAAC;AACM,SAAS,aAAa,CAAC,KAAK,EAAE;AACrC,EAAE,IAAI,KAAK,YAAY,aAAa,EAAE;AACtC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,EAAEA,yBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3B;AACA,CAAC,CAAC,CAAC;AACH,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC7B,GAAG,MAAM;AACT,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,EAAEA,yBAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACxB;AACA,CAAC,CAAC,CAAC;AACH,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,GAAG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACcO,MAAM,eAAe,GAAG;AAC/B,QAAEC,SAAI;AACN,EAAE,yBAAyB,EAAEC,SAAW;AACxC,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,0BAA0B,EAAEC,SAAY;AAC1C,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,0BAA0B,EAAEC,SAAY;AAC1C,EAAE,gBAAgB,EAAEC,SAAG;AACvB,EAAE,mBAAmB,EAAEC,SAAM;AAC7B,EAAE,yBAAyB,EAAEC,SAAU;AACvC,EAAE,4BAA4B,EAAEC,SAAc;AAC9C,EAAE,4BAA4B,EAAEC,SAAa;AAC7C,EAAE,mBAAmB,EAAEC,SAAM;AAC7B,EAAE,8BAA8B,EAAEC,SAAgB;AAClD,EAAE,4BAA4B,EAAEC,SAAa;AAC7C,EAAE,+BAA+B,EAAEC,SAAgB;AACnD,EAAE,gCAAgC,EAAEC,SAAiB;AACrD,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,iCAAiC,EAAEC,SAAkB;AACvD,EAAE,mCAAmC,EAAEC,SAAoB;AAC3D,EAAE,iCAAiC,EAAEC,SAAkB;AACvD,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,4BAA4B,EAAEC,SAAc;AAC9C,EAAE,2BAA2B,EAAEC,SAAa;AAC5C,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,8BAA8B,EAAEC,SAAgB;AAClD,EAAE,uBAAuB,EAAEC,SAAS;AACpC,EAAE,qCAAqC,EAAEC,SAAsB;AAC/D,EAAE,mCAAmC,EAAEC,SAAoB;AAC3D,EAAE,oCAAoC,EAAEC,SAAqB;AAC7D,EAAE,iCAAiC,EAAEC,SAAkB;AACvD,EAAE,mCAAmC,EAAEC,SAAoB;AAC3D,EAAE,8BAA8B,EAAEC,SAAgB;AAClD,EAAE,sCAAsC,EAAEC,SAAuB;AACjE,EAAE,0BAA0B,EAAEC,SAAY;AAC1C,EAAE,gCAAgC,EAAEC,SAAiB;AACrD,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,4CAA4C,EAAEC,SAA2B;AAC3E,EAAE,uCAAuC,EAAEC,SAAuB;AAClE,EAAE,8BAA8B,EAAEC,SAAe;AACjD,EAAE,4BAA4B,EAAEC,SAAc;AAC9C,EAAE,kCAAkC,EAAEC,SAAmB;AACzD,EAAE,kDAAkD,EAAEC,SAAiC;AACvF,EAAE,oCAAoC,EAAEC,SAAqB;AAC7D,EAAE,iCAAiC,EAAEC,OAAkB;AACvD,EAAE,uBAAuB,EAAEC,SAAS;AACpC,EAAE,kBAAkB,EAAEC,SAAK;AAC3B,CAAC;;ACjFD,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,IAAI,GAAGC,cAAS,CAACC,kBAAM,CAAC,CAAC;AACxB,MAAM,IAAI,CAAC;AAClB,EAAE,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE;AACxB,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAEjD,yBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AACH,GAAG;AACH,EAAE,OAAO,KAAK,CAAC,OAAO,GAAG,EAAE,EAAE;AAC7B,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,EAAEA,yBAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACrB;AACA,CAAC,CAAC,CAAC;AACH,GAAG;AACH,EAAE,OAAO,OAAO,CAAC,IAAI,EAAE;AACvB,IAAI,MAAM,KAAK,GAAGA,yBAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1C,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC,EAAE,KAAK,CAAC;AACT,CAAC,CAAC,CAAC;AACH,GAAG;AACH,EAAE,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE;AACxB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvB,GAAG;AACH,EAAE,aAAa,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;AAC7C,IAAI,MAAM,UAAU,GAAGA,yBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;AACtE,IAAI,MAAM,OAAO,GAAGkD,uBAAG,CAAC;AACxB,MAAM,UAAU,EAAElD,yBAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,EAAEA,yBAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACnE,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,KAAK,EAAE,OAAO;AACpB,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;AACf,IAAI,IAAI;AACR,MAAM,MAAM,QAAQ,EAAE,CAAC;AACvB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;AACxB,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;AACrB,MAAM,MAAM,KAAK,CAAC;AAClB,KAAK;AACL,GAAG;AACH,CAAC;AACM,eAAe,cAAc,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE;AAC3E,EAAE,MAAM,KAAK,GAAG,MAAMmD,6BAAS,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AAC9D,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,mCAAmC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3E,GAAG,CAAC,CAAC;AACL,EAAE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AAC5B,IAAI,MAAM,eAAe,GAAGC,YAAW,CAAC,cAAc,EAAEC,aAAY,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;AACzF,IAAI,MAAMC,sBAAE,CAAC,SAAS,CAACC,YAAO,CAAC,eAAe,CAAC,CAAC,CAAC;AACjD,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC/B,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAEC,aAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;AACnE,QAAQ,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAClE,QAAQ,MAAM,QAAQ,GAAG,MAAMF,sBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACjD,QAAQ,MAAM,QAAQ,GAAGG,8BAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;AACjE,QAAQ,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,IAAI,EAAED,aAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE;AAC/E,UAAU,OAAO,EAAE;AACnB,YAAY,OAAO,CAAC,IAAI,EAAE;AAC1B,cAAc,IAAI,IAAI,IAAI,eAAe,EAAE;AAC3C,gBAAgB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC7C,eAAe;AACf,cAAc,MAAM,IAAI,KAAK,CAAC,CAAC,iCAAiC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC1E,aAAa;AACb,WAAW;AACX,SAAS,CAAC,CAAC;AACX,QAAQ,MAAMF,sBAAE,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACnE,UAAU,MAAM,IAAI,KAAK,CAAC,CAAC,uBAAuB,EAAE,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACrF,SAAS,CAAC,CAAC;AACX,OAAO,CAAC,CAAC;AACT,KAAK,MAAM;AACX,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAEE,aAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;AAChE,QAAQ,MAAMF,sBAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AAClE,UAAU,MAAM,WAAW,GAAG,eAAe,CAAC;AAC9C,UAAU,MAAM,IAAI,KAAK,CAAC,CAAC,uBAAuB,EAAE,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACtF,SAAS,CAAC,CAAC;AACX,OAAO,CAAC,CAAC;AACT,KAAK;AACL,GAAG;AACH,CAAC;AACM,eAAe,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE;AACxD,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY;AACnD,IAAI,MAAM,WAAW,GAAGF,YAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACnD,IAAI,IAAI,MAAME,sBAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;AAC1C,MAAM,MAAM,QAAQ,GAAGtD,yBAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1E,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,+CAA+C,EAAE,QAAQ,CAAC;AACjF,0CAA0C,CAAC,CAAC,CAAC;AAC7C,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,eAAe,mBAAmB,CAAC,IAAI,EAAE;AAChD,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY;AACnD,IAAI,IAAI;AACR,MAAM,MAAMsD,sBAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5B,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,gCAAgC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC1E,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,eAAe,4BAA4B,CAAC,OAAO,EAAE;AAC5D,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,qBAAqB,EAAE,YAAY;AACpE,IAAI,IAAI;AACR,MAAM,MAAMA,sBAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC9B,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5E,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,eAAe,YAAY,CAAC,MAAM,EAAE;AAC3C,EAAE,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK;AAChC,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,EAAE,YAAY;AACrD,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC5B,MAAM,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACvC,QAAQ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3C,QAAQ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3C,QAAQ,MAAM,IAAI,KAAK,CAAC,CAAC,0BAA0B,EAAEtD,yBAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACxE,OAAO,CAAC,CAAC;AACT,KAAK,CAAC,CAAC;AACP,GAAG,CAAC;AACJ,EAAE,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC;AAC/B,EAAE,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3B,CAAC;AACM,eAAe,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE;AAC5D,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,YAAY;AAC/C,IAAI,MAAMsD,sBAAE,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACzD,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,wBAAwB,EAAE,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAChG,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM;AACrB,MAAMA,sBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAC7B,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;AC5HA,gBAAe,OAAO,IAAI,KAAK;AAC/B,EAAE,MAAM,KAAK,GAAGI,mBAAS,CAAC,SAAS,CAAC,CAAC;AACrC,EAAE,MAAM,OAAO,GAAG,MAAMC,4BAAQ,CAAC,MAAM,CAAC;AACxC,IAAI;AACJ,MAAM,IAAI,EAAE,OAAO;AACnB,MAAM,IAAI,EAAE,MAAM;AAClB,MAAM,OAAO,EAAE3D,yBAAK,CAAC,IAAI,CAAC,qCAAqC,CAAC;AAChE,MAAM,QAAQ,EAAE,CAAC,KAAK,KAAK;AAC3B,QAAQ,IAAI,CAAC,KAAK,EAAE;AACpB,UAAU,OAAOA,yBAAK,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;AAC9D,SAAS,MAAM,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;AAC5D,UAAU,OAAOA,yBAAK,CAAC,GAAG,CAAC,0EAA0E,CAAC,CAAC;AACvG,SAAS;AACT,QAAQ,OAAO,IAAI,CAAC;AACpB,OAAO;AACP,KAAK;AACL,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAChE,EAAE,MAAM,OAAO,GAAGoD,YAAW,CAACQ,sBAAE,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AACzD,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,GAAGR,YAAW,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,GAAGA,YAAW,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAClH,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;AACb,EAAE,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;AAClC,EAAE,IAAI;AACN,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;AACnB,MAAM,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;AACzD,MAAM,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;AACxC,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACtC,MAAM,MAAM,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5D,KAAK,MAAM;AACX,MAAM,IAAI,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC;AAC7D,MAAM,MAAM,kBAAkB,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9D,MAAM,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;AACzD,MAAM,MAAM,4BAA4B,CAAC,OAAO,CAAC,CAAC;AAClD,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;AACtC,MAAM,MAAM,cAAc,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC/C,MAAM,MAAM,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AACvD,KAAK;AACL,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;AAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACvC,MAAM,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;AACjC,KAAK;AACL,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AACf,IAAI,IAAI,CAAC,GAAG,CAACpD,yBAAK,CAAC,KAAK,CAAC,CAAC,gCAAgC,EAAEA,yBAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACzF,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AACf,IAAI,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;AACnD,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,eAAe,EAAEA,yBAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/E,IAAI,IAAI,CAAC,GAAG,CAAC,kGAAkG,CAAC,CAAC;AACjH,IAAI,IAAI,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;AACtE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AACf,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;AAChB,GAAG,CAAC,OAAO,KAAK,EAAE;AAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,oEAAoE,CAAC,CAAC;AACnF,IAAI,IAAI,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACnD,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjB,GAAG;AACH,CAAC;;ACnED,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK;AACvB,EAAE6D,iBAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAACC,SAAO,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CAAC,MAAM,CAAC,oBAAoB,EAAE,wEAAwE,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1V,EAAED,iBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AACF,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,SAAS,KAAK;AAChD,EAAE,IAAI,SAAS,YAAY,KAAK,EAAE;AAClC,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;AAC7B,GAAG,MAAM;AACT,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,GAAG;AACH,CAAC,CAAC,CAAC;AACH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;;"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/create-app",
|
|
3
3
|
"description": "A CLI that helps you create your own Backstage app",
|
|
4
|
-
"version": "0.4.27
|
|
4
|
+
"version": "0.4.27",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|
|
7
7
|
"access": "public"
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"start": "nodemon --"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@backstage/cli-common": "^0.1.
|
|
36
|
+
"@backstage/cli-common": "^0.1.9",
|
|
37
37
|
"chalk": "^4.0.0",
|
|
38
38
|
"commander": "^9.1.0",
|
|
39
39
|
"fs-extra": "10.1.0",
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"dist",
|
|
61
61
|
"templates"
|
|
62
62
|
],
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "96323f280ba32ee526c5b151cda42260aee927c9"
|
|
64
64
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Backstage override configuration for your local development environment
|
|
@@ -17,3 +17,18 @@ backend:
|
|
|
17
17
|
# backend will bind on the interface that corresponds to the backend.baseUrl
|
|
18
18
|
# hostname.
|
|
19
19
|
host: 0.0.0.0
|
|
20
|
+
|
|
21
|
+
# config options: https://node-postgres.com/api/client
|
|
22
|
+
database:
|
|
23
|
+
client: pg
|
|
24
|
+
connection:
|
|
25
|
+
host: ${POSTGRES_HOST}
|
|
26
|
+
port: ${POSTGRES_PORT}
|
|
27
|
+
user: ${POSTGRES_USER}
|
|
28
|
+
password: ${POSTGRES_PASSWORD}
|
|
29
|
+
# https://node-postgres.com/features/ssl
|
|
30
|
+
# you can set the sslmode configuration option via the `PGSSLMODE` environment variable
|
|
31
|
+
# see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
|
|
32
|
+
# ssl:
|
|
33
|
+
# ca: # if you have a CA file and want to verify it you can uncomment this section
|
|
34
|
+
# $file: <file-path>/ca/server.crt
|
|
@@ -26,27 +26,11 @@ backend:
|
|
|
26
26
|
origin: http://localhost:3000
|
|
27
27
|
methods: [GET, POST, PUT, DELETE]
|
|
28
28
|
credentials: true
|
|
29
|
-
|
|
29
|
+
# This is for local developement only, it is not recommended to use this in production
|
|
30
|
+
# The production database configuration is stored in app-config.production.yaml
|
|
30
31
|
database:
|
|
31
32
|
client: better-sqlite3
|
|
32
33
|
connection: ':memory:'
|
|
33
|
-
{{/if}}
|
|
34
|
-
{{#if dbTypePG}}
|
|
35
|
-
# config options: https://node-postgres.com/api/client
|
|
36
|
-
database:
|
|
37
|
-
client: pg
|
|
38
|
-
connection:
|
|
39
|
-
host: ${POSTGRES_HOST}
|
|
40
|
-
port: ${POSTGRES_PORT}
|
|
41
|
-
user: ${POSTGRES_USER}
|
|
42
|
-
password: ${POSTGRES_PASSWORD}
|
|
43
|
-
# https://node-postgres.com/features/ssl
|
|
44
|
-
# you can set the sslmode configuration option via the `PGSSLMODE` environment variable
|
|
45
|
-
# see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
|
|
46
|
-
# ssl:
|
|
47
|
-
# ca: # if you have a CA file and want to verify it you can uncomment this section
|
|
48
|
-
# $file: <file-path>/ca/server.crt
|
|
49
|
-
{{/if}}
|
|
50
34
|
cache:
|
|
51
35
|
store: memory
|
|
52
36
|
# workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
|
|
@@ -92,36 +76,28 @@ catalog:
|
|
|
92
76
|
rules:
|
|
93
77
|
- allow: [Component, System, API, Resource, Location]
|
|
94
78
|
locations:
|
|
95
|
-
#
|
|
96
|
-
- type:
|
|
97
|
-
target:
|
|
98
|
-
|
|
99
|
-
# Backstage example systems
|
|
100
|
-
- type: url
|
|
101
|
-
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-systems.yaml
|
|
102
|
-
|
|
103
|
-
# Backstage example APIs
|
|
104
|
-
- type: url
|
|
105
|
-
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
|
|
79
|
+
# Local example data, file locations are relative to the backend process, typically `packages/backend`
|
|
80
|
+
- type: file
|
|
81
|
+
target: ../../examples/entities.yaml
|
|
106
82
|
|
|
107
|
-
#
|
|
108
|
-
- type:
|
|
109
|
-
target:
|
|
110
|
-
|
|
111
|
-
# Backstage example organization groups
|
|
112
|
-
- type: url
|
|
113
|
-
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/org.yaml
|
|
114
|
-
|
|
115
|
-
# Backstage example templates
|
|
116
|
-
- type: url
|
|
117
|
-
target: https://github.com/backstage/software-templates/blob/main/scaffolder-templates/react-ssr-template/template.yaml
|
|
83
|
+
# Local example template
|
|
84
|
+
- type: file
|
|
85
|
+
target: ../../examples/template/template.yaml
|
|
118
86
|
rules:
|
|
119
87
|
- allow: [Template]
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
- type: url
|
|
125
|
-
target: https://github.com/backstage/software-templates/blob/main/scaffolder-templates/docs-template/template.yaml
|
|
88
|
+
|
|
89
|
+
# Local example organizational data
|
|
90
|
+
- type: file
|
|
91
|
+
target: ../../examples/org.yaml
|
|
126
92
|
rules:
|
|
127
|
-
- allow: [
|
|
93
|
+
- allow: [User, Group]
|
|
94
|
+
|
|
95
|
+
## Uncomment these lines to add more example data
|
|
96
|
+
# - type: url
|
|
97
|
+
# target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all.yaml
|
|
98
|
+
|
|
99
|
+
## Uncomment these lines to add an example org
|
|
100
|
+
# - type: url
|
|
101
|
+
# target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
|
|
102
|
+
# rules:
|
|
103
|
+
# - allow: [User, Group]
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-system
|
|
3
|
+
apiVersion: backstage.io/v1alpha1
|
|
4
|
+
kind: System
|
|
5
|
+
metadata:
|
|
6
|
+
name: examples
|
|
7
|
+
spec:
|
|
8
|
+
owner: guests
|
|
9
|
+
---
|
|
10
|
+
# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component
|
|
11
|
+
apiVersion: backstage.io/v1alpha1
|
|
12
|
+
kind: Component
|
|
13
|
+
metadata:
|
|
14
|
+
name: example-website
|
|
15
|
+
spec:
|
|
16
|
+
type: website
|
|
17
|
+
lifecycle: experimental
|
|
18
|
+
owner: guests
|
|
19
|
+
system: examples
|
|
20
|
+
providesApis: [example-grpc-api]
|
|
21
|
+
---
|
|
22
|
+
# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-api
|
|
23
|
+
apiVersion: backstage.io/v1alpha1
|
|
24
|
+
kind: API
|
|
25
|
+
metadata:
|
|
26
|
+
name: example-grpc-api
|
|
27
|
+
spec:
|
|
28
|
+
type: grpc
|
|
29
|
+
lifecycle: experimental
|
|
30
|
+
owner: guests
|
|
31
|
+
system: examples
|
|
32
|
+
definition: |
|
|
33
|
+
syntax = "proto3";
|
|
34
|
+
|
|
35
|
+
service Exampler {
|
|
36
|
+
rpc Example (ExampleMessage) returns (ExampleMessage) {};
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
message ExampleMessage {
|
|
40
|
+
string example = 1;
|
|
41
|
+
};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-user
|
|
3
|
+
apiVersion: backstage.io/v1alpha1
|
|
4
|
+
kind: User
|
|
5
|
+
metadata:
|
|
6
|
+
name: guest
|
|
7
|
+
spec:
|
|
8
|
+
memberOf: [guests]
|
|
9
|
+
---
|
|
10
|
+
# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-group
|
|
11
|
+
apiVersion: backstage.io/v1alpha1
|
|
12
|
+
kind: Group
|
|
13
|
+
metadata:
|
|
14
|
+
name: guests
|
|
15
|
+
spec:
|
|
16
|
+
type: team
|
|
17
|
+
children: []
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
console.log('Hello from ${{ values.name }}!');
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
apiVersion: scaffolder.backstage.io/v1beta3
|
|
2
|
+
# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-template
|
|
3
|
+
kind: Template
|
|
4
|
+
metadata:
|
|
5
|
+
name: example-nodejs-template
|
|
6
|
+
title: Example Node.js Template
|
|
7
|
+
description: An example template for the scaffolder that creates a simple Node.js service
|
|
8
|
+
spec:
|
|
9
|
+
owner: user:guest
|
|
10
|
+
type: service
|
|
11
|
+
|
|
12
|
+
# These parameters are used to generate the input form in the frontend, and are
|
|
13
|
+
# used to gather input data for the execution of the template.
|
|
14
|
+
parameters:
|
|
15
|
+
- title: Fill in some steps
|
|
16
|
+
required:
|
|
17
|
+
- name
|
|
18
|
+
properties:
|
|
19
|
+
name:
|
|
20
|
+
title: Name
|
|
21
|
+
type: string
|
|
22
|
+
description: Unique name of the component
|
|
23
|
+
ui:autofocus: true
|
|
24
|
+
ui:options:
|
|
25
|
+
rows: 5
|
|
26
|
+
- title: Choose a location
|
|
27
|
+
required:
|
|
28
|
+
- repoUrl
|
|
29
|
+
properties:
|
|
30
|
+
repoUrl:
|
|
31
|
+
title: Repository Location
|
|
32
|
+
type: string
|
|
33
|
+
ui:field: RepoUrlPicker
|
|
34
|
+
ui:options:
|
|
35
|
+
allowedHosts:
|
|
36
|
+
- github.com
|
|
37
|
+
|
|
38
|
+
# These steps are executed in the scaffolder backend, using data that we gathered
|
|
39
|
+
# via the parameters above.
|
|
40
|
+
steps:
|
|
41
|
+
# Each step executes an action, in this case one templates files into the working directory.
|
|
42
|
+
- id: fetch-base
|
|
43
|
+
name: Fetch Base
|
|
44
|
+
action: fetch:template
|
|
45
|
+
input:
|
|
46
|
+
url: ./content
|
|
47
|
+
values:
|
|
48
|
+
name: ${{ parameters.name }}
|
|
49
|
+
|
|
50
|
+
# This step publishes the contents of the working directory to GitHub.
|
|
51
|
+
- id: publish
|
|
52
|
+
name: Publish
|
|
53
|
+
action: publish:github
|
|
54
|
+
input:
|
|
55
|
+
allowedHosts: ['github.com']
|
|
56
|
+
description: This is ${{ parameters.name }}
|
|
57
|
+
repoUrl: ${{ parameters.repoUrl }}
|
|
58
|
+
|
|
59
|
+
# The final step is to register our new component in the catalog.
|
|
60
|
+
- id: register
|
|
61
|
+
name: Register
|
|
62
|
+
action: catalog:register
|
|
63
|
+
input:
|
|
64
|
+
repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
|
|
65
|
+
catalogInfoPath: '/catalog-info.yaml'
|
|
66
|
+
|
|
67
|
+
# Outputs are displayed to the user after a successful execution of the template.
|
|
68
|
+
output:
|
|
69
|
+
links:
|
|
70
|
+
- title: Repository
|
|
71
|
+
url: ${{ steps.publish.output.remoteUrl }}
|
|
72
|
+
- title: Open in catalog
|
|
73
|
+
icon: catalog
|
|
74
|
+
entityRef: ${{ steps.register.output.entityRef }}
|
|
@@ -28,6 +28,8 @@
|
|
|
28
28
|
"@backstage/plugin-search-react": "^{{version '@backstage/plugin-search-react'}}",
|
|
29
29
|
"@backstage/plugin-tech-radar": "^{{version '@backstage/plugin-tech-radar'}}",
|
|
30
30
|
"@backstage/plugin-techdocs": "^{{version '@backstage/plugin-techdocs'}}",
|
|
31
|
+
"@backstage/plugin-techdocs-react": "^{{version '@backstage/plugin-techdocs-react'}}",
|
|
32
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "^{{version '@backstage/plugin-techdocs-module-addons-contrib'}}",
|
|
31
33
|
"@backstage/plugin-user-settings": "^{{version '@backstage/plugin-user-settings'}}",
|
|
32
34
|
"@backstage/theme": "^{{version '@backstage/theme'}}",
|
|
33
35
|
"@material-ui/core": "^4.12.2",
|
|
@@ -19,6 +19,8 @@ import {
|
|
|
19
19
|
techdocsPlugin,
|
|
20
20
|
TechDocsReaderPage,
|
|
21
21
|
} from '@backstage/plugin-techdocs';
|
|
22
|
+
import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
|
|
23
|
+
import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
|
|
22
24
|
import { UserSettingsPage } from '@backstage/plugin-user-settings';
|
|
23
25
|
import { apis } from './apis';
|
|
24
26
|
import { entityPage } from './components/catalog/EntityPage';
|
|
@@ -68,7 +70,11 @@ const routes = (
|
|
|
68
70
|
<Route
|
|
69
71
|
path="/docs/:namespace/:kind/:name/*"
|
|
70
72
|
element={<TechDocsReaderPage />}
|
|
71
|
-
|
|
73
|
+
>
|
|
74
|
+
<TechDocsAddons>
|
|
75
|
+
<ReportIssue />
|
|
76
|
+
</TechDocsAddons>
|
|
77
|
+
</Route>
|
|
72
78
|
<Route path="/create" element={<ScaffolderPage />} />
|
|
73
79
|
<Route path="/api-docs" element={<ApiExplorerPage />} />
|
|
74
80
|
<Route
|
|
@@ -112,13 +112,14 @@ const SearchPage = () => {
|
|
|
112
112
|
<SearchResult>
|
|
113
113
|
{({ results }) => (
|
|
114
114
|
<List>
|
|
115
|
-
{results.map(({ type, document }) => {
|
|
115
|
+
{results.map(({ type, document, highlight }) => {
|
|
116
116
|
switch (type) {
|
|
117
117
|
case 'software-catalog':
|
|
118
118
|
return (
|
|
119
119
|
<CatalogSearchResultListItem
|
|
120
120
|
key={document.location}
|
|
121
121
|
result={document}
|
|
122
|
+
highlight={highlight}
|
|
122
123
|
/>
|
|
123
124
|
);
|
|
124
125
|
case 'techdocs':
|
|
@@ -126,6 +127,7 @@ const SearchPage = () => {
|
|
|
126
127
|
<TechDocsSearchResultListItem
|
|
127
128
|
key={document.location}
|
|
128
129
|
result={document}
|
|
130
|
+
highlight={highlight}
|
|
129
131
|
/>
|
|
130
132
|
);
|
|
131
133
|
default:
|
|
@@ -133,6 +135,7 @@ const SearchPage = () => {
|
|
|
133
135
|
<DefaultResultListItem
|
|
134
136
|
key={document.location}
|
|
135
137
|
result={document}
|
|
138
|
+
highlight={highlight}
|
|
136
139
|
/>
|
|
137
140
|
);
|
|
138
141
|
}
|
|
@@ -30,29 +30,22 @@
|
|
|
30
30
|
"@backstage/plugin-proxy-backend": "^{{version '@backstage/plugin-proxy-backend'}}",
|
|
31
31
|
"@backstage/plugin-scaffolder-backend": "^{{version '@backstage/plugin-scaffolder-backend'}}",
|
|
32
32
|
"@backstage/plugin-search-backend": "^{{version '@backstage/plugin-search-backend'}}",
|
|
33
|
-
{{#if dbTypePG}}
|
|
34
33
|
"@backstage/plugin-search-backend-module-pg": "^{{version '@backstage/plugin-search-backend-module-pg'}}",
|
|
35
|
-
{{/if}}
|
|
36
34
|
"@backstage/plugin-search-backend-node": "^{{version '@backstage/plugin-search-backend-node'}}",
|
|
37
35
|
"@backstage/plugin-techdocs-backend": "^{{version '@backstage/plugin-techdocs-backend'}}",
|
|
38
36
|
"dockerode": "^3.3.1",
|
|
39
37
|
"express": "^4.17.1",
|
|
40
38
|
"express-promise-router": "^4.1.0",
|
|
41
|
-
"luxon": "^2.0.2",
|
|
42
|
-
{{#if dbTypePG}}
|
|
43
39
|
"pg": "^8.3.0",
|
|
44
|
-
{{/if}}
|
|
45
|
-
{{#if dbTypeSqlite}}
|
|
46
|
-
"better-sqlite3": "^7.5.0",
|
|
47
|
-
{{/if}}
|
|
48
40
|
"winston": "^3.2.1"
|
|
49
41
|
},
|
|
50
42
|
"devDependencies": {
|
|
51
43
|
"@backstage/cli": "^{{version '@backstage/cli'}}",
|
|
52
44
|
"@types/dockerode": "^3.3.0",
|
|
53
|
-
"@types/express": "^4.17.6",
|
|
54
45
|
"@types/express-serve-static-core": "^4.17.5",
|
|
55
|
-
"@types/
|
|
46
|
+
"@types/express": "^4.17.6",
|
|
47
|
+
"@types/luxon": "^2.0.4",
|
|
48
|
+
"better-sqlite3": "^7.5.0"
|
|
56
49
|
},
|
|
57
50
|
"files": [
|
|
58
51
|
"dist"
|
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
createRouter,
|
|
3
|
+
providers,
|
|
4
|
+
defaultAuthProviderFactories,
|
|
5
|
+
} from '@backstage/plugin-auth-backend';
|
|
2
6
|
import { Router } from 'express';
|
|
3
7
|
import { PluginEnvironment } from '../types';
|
|
4
8
|
|
|
@@ -11,5 +15,22 @@ export default async function createPlugin(
|
|
|
11
15
|
database: env.database,
|
|
12
16
|
discovery: env.discovery,
|
|
13
17
|
tokenManager: env.tokenManager,
|
|
18
|
+
providerFactories: {
|
|
19
|
+
...defaultAuthProviderFactories,
|
|
20
|
+
|
|
21
|
+
// This overrides the default GitHub auth provider with a custom one.
|
|
22
|
+
// Since the options are empty it will behave just like the default
|
|
23
|
+
// provider, but if you uncomment the `signIn` section you will enable
|
|
24
|
+
// sign-in via GitHub. This particular configuration uses a resolver
|
|
25
|
+
// that matches the username to the user entity name. See the auth
|
|
26
|
+
// documentation for more details on how to enable and customize sign-in:
|
|
27
|
+
//
|
|
28
|
+
// https://backstage.io/docs/auth/identity-resolver
|
|
29
|
+
github: providers.github.create({
|
|
30
|
+
// signIn: {
|
|
31
|
+
// resolver: providers.github.resolvers.usernameMatchingUserEntityName(),
|
|
32
|
+
// },
|
|
33
|
+
}),
|
|
34
|
+
},
|
|
14
35
|
});
|
|
15
36
|
}
|
|
@@ -4,40 +4,29 @@ import {
|
|
|
4
4
|
IndexBuilder,
|
|
5
5
|
LunrSearchEngine,
|
|
6
6
|
} from '@backstage/plugin-search-backend-node';
|
|
7
|
-
{{#if dbTypePG}}
|
|
8
|
-
import { PgSearchEngine } from '@backstage/plugin-search-backend-module-pg';
|
|
9
|
-
{{/if}}
|
|
10
7
|
import { PluginEnvironment } from '../types';
|
|
11
8
|
import { DefaultCatalogCollatorFactory } from '@backstage/plugin-catalog-backend';
|
|
12
9
|
import { DefaultTechDocsCollatorFactory } from '@backstage/plugin-techdocs-backend';
|
|
13
10
|
import { Router } from 'express';
|
|
14
|
-
import { Duration } from 'luxon';
|
|
15
11
|
|
|
16
12
|
export default async function createPlugin(
|
|
17
13
|
env: PluginEnvironment,
|
|
18
14
|
): Promise<Router> {
|
|
19
15
|
// Initialize a connection to a search engine.
|
|
20
|
-
{{#if dbTypeSqlite}}
|
|
21
16
|
const searchEngine = new LunrSearchEngine({
|
|
22
17
|
logger: env.logger,
|
|
23
18
|
});
|
|
24
|
-
{{/if}}
|
|
25
|
-
{{#if dbTypePG}}
|
|
26
|
-
const searchEngine = (await PgSearchEngine.supported(env.database))
|
|
27
|
-
? await PgSearchEngine.from({ database: env.database })
|
|
28
|
-
: new LunrSearchEngine({ logger: env.logger });
|
|
29
|
-
{{/if}}
|
|
30
19
|
const indexBuilder = new IndexBuilder({
|
|
31
20
|
logger: env.logger,
|
|
32
21
|
searchEngine,
|
|
33
22
|
});
|
|
34
23
|
|
|
35
24
|
const schedule = env.scheduler.createScheduledTaskRunner({
|
|
36
|
-
frequency:
|
|
37
|
-
timeout:
|
|
25
|
+
frequency: { minutes: 10 },
|
|
26
|
+
timeout: { minutes: 15 },
|
|
38
27
|
// A 3 second delay gives the backend server a chance to initialize before
|
|
39
28
|
// any collators are executed, which may attempt requests against the API.
|
|
40
|
-
initialDelay:
|
|
29
|
+
initialDelay: { seconds: 3 },
|
|
41
30
|
});
|
|
42
31
|
|
|
43
32
|
// Collators are responsible for gathering documents known to plugins. This
|