From 111dcaeb9ab2761437278b52296410218fd0311e Mon Sep 17 00:00:00 2001
From: Bret Hubbard <hubbard.bret@gmail.com>
Date: Wed, 15 Dec 2021 12:38:03 -0700
Subject: [PATCH] scaffolder: add DescriptionField override to support markdown

Signed-off-by: Bret Hubbard <hubbard.bret@gmail.com>
---
 .../FieldOverrides/DescriptionField.tsx       | 22 +++++++++++++++++++
 .../MultistepJsonForm/FieldOverrides/index.ts | 16 ++++++++++++++
 .../MultistepJsonForm/MultistepJsonForm.tsx   |  3 ++-
 3 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/DescriptionField.tsx
 create mode 100644 plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/index.ts

diff --git a/plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/DescriptionField.tsx b/plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/DescriptionField.tsx
new file mode 100644
index 0000000000..6d116cc52b
--- /dev/null
+++ b/plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/DescriptionField.tsx
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+import { MarkdownContent } from '@backstage/core-components';
+import { FieldProps } from '@rjsf/core';
+
+export const DescriptionField = ({ description }: FieldProps) =>
+  description && <MarkdownContent content={description} />;
diff --git a/plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/index.ts b/plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/index.ts
new file mode 100644
index 0000000000..d6d0bf3499
--- /dev/null
+++ b/plugins/scaffolder/src/components/MultistepJsonForm/FieldOverrides/index.ts
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { DescriptionField } from './DescriptionField';
diff --git a/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx b/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx
index 738e1f894a..a9c8eaec1d 100644
--- a/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx
+++ b/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx
@@ -30,6 +30,7 @@ import { Theme as MuiTheme } from '@rjsf/material-ui';
 import React, { useState } from 'react';
 import { transformSchemaToProps } from './schema';
 import { Content, StructuredMetadataTable } from '@backstage/core-components';
+import * as fieldOverrides from './FieldOverrides';
 
 const Form = withTheme(MuiTheme);
 type Step = {
@@ -152,7 +153,7 @@ export const MultistepJsonForm = ({
               <StepContent key={title}>
                 <Form
                   showErrorList={false}
-                  fields={fields}
+                  fields={{ ...fieldOverrides, ...fields }}
                   widgets={widgets}
                   noHtml5Validate
                   formData={formData}