Skip to content

Commit e13582c

Browse files
committed
Add todos to generated readme
1 parent c0797df commit e13582c

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

packages/create-next-stack/src/main/plugins/create-next-stack/add-readme/generate-readme.ts

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const generateReadme = async (
1515
const { args, flags } = inputs
1616

1717
const todos = filterPlugins(inputs)
18-
.map((plugin) => plugin.todos)
18+
.flatMap((plugin) => plugin.todos)
1919
.filter(nonNull)
2020

2121
const runCommand = runCommandMap[flags["package-manager"]]
@@ -38,6 +38,20 @@ export const generateReadme = async (
3838
${runCommand} dev
3939
\`\`\`
4040
41+
${
42+
todos.length > 0
43+
? endent`
44+
## Final Steps
45+
46+
There are a few final steps that we were not able to perform automatically. We have provided a complete list for you below. You should take care of these before you can start developing your project. You can delete each item from the list as you go along.
47+
48+
### To do:
49+
50+
${todos.map((todo) => `- ${todo}`).join("\n")}
51+
`
52+
: ""
53+
}
54+
4155
${
4256
scriptTableRows != null
4357
? endent`

packages/create-next-stack/src/main/plugins/plausible.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,6 @@ export const plausiblePlugin = createPlugin({
7575
],
7676
todos: [
7777
`Set up an account in Plausible Analytics, and add your website in their dashboard.`,
78-
`Update the ${websiteDomainEnvVar} environment variable to your website's domain to connect Plausible Analytics to your app.`,
78+
`Update the \`${websiteDomainEnvVar}\` environment variable to your website's domain to connect Plausible Analytics to your app.`,
7979
],
8080
} as const)

0 commit comments

Comments
 (0)