Merge pull request #845 from CobyPear/DB-6235-update-starter-readmes

DB-6235: Update starter kit READMEs

.changeset/famous-singers-perform.md

@@ -0,0 +1,5 @@
+---
+'create-pantheon-decoupled-kit': patch
+---
+
+[next-wp][next-drupal][gatsby-wp] Update READMEs

packages/create-pantheon-decoupled-kit/esbuild.js

@@ -8,9 +8,12 @@ const buildOptions = {
 	entryPoints: [
 		'./src/bin.ts',
 		// compile tagged templates to js
-		...(await glob('./src/templates/**/*.{css,jsx,tsx,ts,js,json,env.*}.ts', {
-			dot: true,
-		})),
+		...(await glob(
+			'./src/templates/**/*.{css,jsx,tsx,ts,js,json,md,env.*}.ts',
+			{
+				dot: true,
+			},
+		)),
 	],
 	bundle: true,
 	platform: 'node',

packages/create-pantheon-decoupled-kit/src/index.ts

@@ -7,6 +7,7 @@ import {
 	isDrupalCms,
 	isString,
 	isWpCms,
+	Input,
 } from './types';
 import { actionRunner, getHandlebarsInstance, helpMenu } from './utils/index';
 
@@ -188,7 +189,7 @@ To see this list at any time, use the --help command.`;
 	const actionsResult = await actionRunner({
 		actions,
 		templateData,
-		data: args,
+		data: args as Input,
 		handlebars: hbs,
 	});
 	args?.silent || console.log(chalk.blueBright(actionsResult));

packages/create-pantheon-decoupled-kit/src/templates/gatsby-wp/README.md.ts

@@ -0,0 +1,38 @@
+import type { TemplateFn } from '@cli/types';
+import {
+	commands,
+	createPantheonDecoupledKitNpmPackage,
+	gettingStarted,
+	graphqlPostRequest,
+	healthCheck,
+	lando,
+	readmeHeader,
+	wordpressKitNpmPackage,
+} from '@partials/shared/readme/sharedReadme';
+
+const starterName = 'Gatsby WordPress';
+
+const md: TemplateFn = () => /* md */ `${readmeHeader(starterName)}
+
+${gettingStarted(starterName)}
+
+## \`@pantheon-systems\` npm Packages
+
+${wordpressKitNpmPackage()}
+
+${createPantheonDecoupledKitNpmPackage()}
+
+${healthCheck('gatsby-wp')}
+
+## Local development
+
+${lando('wordpress')}
+
+${commands(true)}
+
+## Miscellaneous
+
+${graphqlPostRequest()}
+`;
+
+export default md;

packages/create-pantheon-decoupled-kit/src/templates/next-drupal/README.md.ts

@@ -0,0 +1,33 @@
+import type { TemplateFn } from '@cli/types';
+import {
+	commands,
+	createPantheonDecoupledKitNpmPackage,
+	drupalKitNpmPackage,
+	gettingStarted,
+	healthCheck,
+	lando,
+	readmeHeader,
+} from '@partials/shared/readme/sharedReadme';
+
+const starterName = 'Next Drupal';
+
+const md: TemplateFn = () => /* md */ `${readmeHeader(starterName)}
+
+${gettingStarted(starterName)}
+
+## \`@pantheon-systems\` npm Packages
+
+${drupalKitNpmPackage()}
+
+${createPantheonDecoupledKitNpmPackage()}
+
+${healthCheck('next-drupal')}
+
+## Local development
+
+${lando('drupal')}
+
+${commands(false)}
+`;
+
+export default md;