create-gasket-app 7.0.0-next.60 → 7.0.0-next.61

package/lib/index.d.ts

@@ -37,7 +37,7 @@ export interface PluginInfo extends ModuleInfo {}
 
 export interface ConfigBuilder<Config> {
   /**
-   * fields object 
+   * fields object
    */
   fields: { [key: string]: any };
 
@@ -148,6 +148,35 @@ export interface Files {
   add(...args: string[]): void;
 }
 
+export interface Readme {
+  /** Markdown content to be injected into the app readme */
+  markdown: string[];
+
+  /** Links to be added to the footer */
+  links: string[];
+
+  /** Add a markdown heading */
+  heading(content: string, level?: number): Readme;
+
+  /** Add a markdown sub-heading */
+  subHeading(content: string): Readme;
+
+  /** Add markdown content */
+  content(markdown: string);
+
+  /** Add a markdown list */
+  list(items: string[]): Readme;
+
+  /** Add a markdown link - printed in footer */
+  link(content: string, href: string): Readme;
+
+  /** Add a markdown code block */
+  codeBlock(content: string, syntax?: string): Readme;
+
+  /** Add markdown file */
+  markdownFile(path: string): Promise<Readme>;
+}
+
 export interface CreateContext {
   /** Short name of the app */
   appName: string;
@@ -235,6 +264,9 @@ export interface CreateContext {
 
   /** Use to add files and templates to generate */
   files: Files;
+
+  /** Use to add content to the README.md */
+  readme: Readme;
 }
 
 export interface ActionWrapperParams {

package/lib/scaffold/actions/create-hooks.js

@@ -1,6 +1,7 @@
 import action from '../action-wrapper.js';
 import { ConfigBuilder } from '../config-builder.js';
 import { Files } from '../files.js';
+import Readme from '../readme.js';
 
 /**
  * Executes the `create` hook for all registered plugins.
@@ -14,8 +15,9 @@ async function createHooks({ gasket, context }) {
   const { plugins = [], warnings } = context;
 
   const files = new Files();
+  const readme = new Readme();
   const gasketConfig = ConfigBuilder.create({}, { orderBy: ['plugins'], warnings, plugins });
-  Object.assign(context, { files, gasketConfig });
+  Object.assign(context, { files, readme, gasketConfig });
 
   await gasket.execApply('create', async function applyCreate(plugin, handler) {
     await handler(context.runWith(plugin));

package/lib/scaffold/actions/generate-files.js

@@ -109,7 +109,10 @@ async function performGenerate(context, descriptors) {
   handlebars.registerHelper('jspretty', (data) => {
     return JSON.stringify(data).replace(/"/g, '\'');
   });
-  handlebars.registerHelper('eq', (a, b) => a === b)
+  handlebars.registerHelper('eq', (a, b) => a === b);
+  handlebars.registerHelper('markdownCompile', (data) => {
+    return handlebars.compile(data)(context);
+  });
 
   debug('descriptors', JSON.stringify(descriptors, null, 2));
 

package/lib/scaffold/create-context.js

@@ -170,7 +170,8 @@ export function makeCreateContext(argv = [], options = {}) {
     presets: [],
     presetConfig: {
       plugins: []
-    }
+    },
+    readme: []
   });
 
   readConfig(context, { config, configFile });

package/lib/scaffold/readme.js

@@ -0,0 +1,51 @@
+import { readFile } from 'fs/promises';
+
+/** @type {import('../index').Readme} */
+export default class Readme {
+  constructor() {
+    this.markdown = [];
+    this.links = [];
+  }
+
+  addNewLine() {
+    this.markdown.push('');
+    return this;
+  }
+
+  heading(content, level = 2) {
+    this.markdown.push(`${'#'.repeat(level)} ${content}`);
+    return this.addNewLine();
+  }
+
+  subHeading(content) {
+    return this.heading(content, 3);
+  }
+
+  content(content) {
+    this.markdown.push(content);
+    return this.addNewLine();
+  }
+
+  list(items) {
+    this.markdown.push(...items.map(item => `- ${item}`));
+    return this.addNewLine();
+  }
+
+  link(content, href) {
+    this.links.push(`[${content}]: ${href}`);
+    return this;
+  }
+
+  codeBlock(content, syntax = '') {
+    this.markdown.push(`\`\`\`${syntax}`);
+    this.markdown.push(content);
+    this.markdown.push('```');
+    return this.addNewLine();
+  }
+
+  async markdownFile(path) {
+    const content = await readFile(path, 'utf8');
+    this.markdown.push(content);
+    return this.addNewLine();
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gasket-app",
-  "version": "7.0.0-next.60",
+  "version": "7.0.0-next.61",
   "description": "starter pack for creating a gasket app",
   "type": "module",
   "bin": {
@@ -33,14 +33,14 @@
   },
   "homepage": "https://github.com/godaddy/gasket/tree/main/packages/create-gasket-app",
   "dependencies": {
-    "@gasket/core": "7.0.0-next.60",
-    "@gasket/plugin-command": "7.0.0-next.60",
-    "@gasket/plugin-docs": "7.0.0-next.60",
-    "@gasket/plugin-docusaurus": "7.0.0-next.60",
-    "@gasket/plugin-git": "7.0.0-next.60",
-    "@gasket/plugin-logger": "7.0.0-next.60",
-    "@gasket/plugin-metadata": "7.0.0-next.60",
-    "@gasket/utils": "7.0.0-next.60",
+    "@gasket/core": "7.0.0-next.61",
+    "@gasket/plugin-command": "7.0.0-next.61",
+    "@gasket/plugin-docs": "7.0.0-next.61",
+    "@gasket/plugin-docusaurus": "7.0.0-next.61",
+    "@gasket/plugin-git": "7.0.0-next.61",
+    "@gasket/plugin-logger": "7.0.0-next.61",
+    "@gasket/plugin-metadata": "7.0.0-next.61",
+    "@gasket/utils": "7.0.0-next.61",
     "commander": "^12.0.0",
     "deepmerge": "^4.3.1",
     "glob": "^8.1.0",
@@ -83,5 +83,5 @@
   "jest": {
     "transform": {}
   },
-  "gitHead": "ea9feae6cd291d4361c06e09659e50dbec19bcea"
+  "gitHead": "6bfc613e64088429e95e89211008b1c9ab530ca7"
 }