Templates can now provide help texts

Author: djhi

packages/create-react-admin/src/app.tsx

@@ -1,5 +1,5 @@
-import React, { useReducer } from 'react';
-import { Text } from 'ink';
+import React, { useReducer, useRef } from 'react';
+import { Box, Text } from 'ink';
 import {
     InitialProjectConfiguration,
     ProjectConfiguration,
@@ -71,6 +71,7 @@ export default function App({ name = 'my-admin' }: Props) {
         ...InitialProjectConfiguration,
         name,
     });
+    const helpMessages = useRef([]);
     const installDeps = useInstallDeps();
     const handleSubmit = (value: any) => {
         dispatch({ value });
@@ -86,7 +87,8 @@ export default function App({ name = 'my-admin' }: Props) {
         return <StepResources onSubmit={handleSubmit} />;
     }
     if (state.step === 'generate') {
-        generateProject(state).then(() => {
+        generateProject(state).then(messages => {
+            helpMessages.current = messages;
             dispatch({});
         });
         return <Text>Generating your application...</Text>;
@@ -102,17 +104,24 @@ export default function App({ name = 'my-admin' }: Props) {
     }
     return (
         <>
-            <Text>
-                Your application <Text bold>{state.name}</Text> was successfully
-                generated.
-            </Text>
+            <Box marginBottom={1}>
+                <Text>
+                    Your application <Text bold>{state.name}</Text> was
+                    successfully generated.
+                </Text>
+            </Box>
             <Text>
                 To start working, run <Text bold>cd {state.name}</Text>.
             </Text>
             <Text>
                 Start the app in development mode by running{' '}
                 <Text bold>npm dev</Text>.
             </Text>
+            <Box marginBottom={1}>
+                {helpMessages.current.map(line => (
+                    <Text key={line}>{line}</Text>
+                ))}
+            </Box>
         </>
     );
 }

packages/create-react-admin/src/generateProject.ts

@@ -36,6 +36,33 @@ export const generateProject = async (state: ProjectConfiguration) => {
     generatePackageJson(projectDirectory, state);
     generateEnvFile(projectDirectory, state);
     generateReadme(projectDirectory, state);
+
+    return getHelpMessages(state);
+};
+
+const getHelpMessages = (state: ProjectConfiguration) => {
+    const dataProviderHelpMessages = getTemplateHelpMessages(
+        state.dataProvider
+    );
+    const authProviderHelpMessages = getTemplateHelpMessages(
+        state.authProvider
+    );
+
+    return [dataProviderHelpMessages, authProviderHelpMessages];
+};
+
+const getTemplateHelpMessages = (template: string) => {
+    const helpMessagesPath = path.join(
+        __dirname,
+        '../templates',
+        template,
+        'help.txt'
+    );
+    if (fs.existsSync(helpMessagesPath)) {
+        const helpMessages = fs.readFileSync(helpMessagesPath, 'utf-8');
+        return helpMessages;
+    }
+    return '';
 };
 
 const generateAppFile = (

packages/create-react-admin/templates/local-auth-provider/help.txt

@@ -0,0 +1,3 @@
+You can sign in to the application with the following usernames and password:
+- janedoe / password
+- johndoe / password