feat(create-graphback): add ability to disable templates

aerogear · Oct 12, 2020 · 57de515 · 57de515
1 parent 1fcee77
commit 57de515
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/packages/create-graphback/src/init/components.ts b/packages/create-graphback/src/init/components.ts
@@ -29,7 +29,7 @@ function checkDirectory(path: string, name: string): void {
 async function chooseTemplate(filter: string = ''): Promise<Template> {
   const regex = new RegExp(`.*${filter}.*`, 'i');
   const displayedTemplates = allTemplates.filter((template: Template) =>
-    regex.test(`${chalk.green(template.name)} ${template.description}`)
+    !template.disabled && regex.test(`${chalk.green(template.name)} ${template.description}`)
   );
   if (!displayedTemplates.length) {
     logInfo(`create-graphback could not find templates matching the given filter: "${filter}".

diff --git a/packages/create-graphback/src/init/starterTemplates.ts b/packages/create-graphback/src/init/starterTemplates.ts
@@ -35,7 +35,7 @@ export const allTemplates: Template[] = [
         branch: 'templates-1.0.0',
         path: '/templates/ts-react-apollo-client',
         mountpath: "client"
-      },{
+      }, {
         uri: 'https://github.com/aerogear/graphback',
         branch: 'templates-1.0.0',
         path: '/templates/ts-apollo-mongodb-backend',
@@ -44,13 +44,18 @@ export const allTemplates: Template[] = [
   {
     name: 'fastify-fullstack-react-mongo-ts',
     description: 'GraphQL Server based on Fastify connecting to MongoDB database and React client using TypeScript',
+    /**
+     * Keeping this template disabled until the following issue is fixed or investigated further:
+     * https://github.com/aerogear/graphback/issues/2174
+     */
+    disabled: true,
     repos: [
       {
         uri: 'https://github.com/aerogear/graphback',
         branch: 'templates-1.0.0',
         path: '/templates/ts-react-apollo-client',
         mountpath: "client"
-      },{
+      }, {
         uri: 'https://github.com/aerogear/graphback',
         branch: 'templates-1.0.0',
         path: '/templates/ts-fastify-mongodb-backend',
@@ -68,6 +73,11 @@ export const allTemplates: Template[] = [
   {
     name: 'fastify-mongo-server-ts',
     description: 'GraphQL Server based on Fastify connecting to MongoDB database using TypeScript',
+    /**
+     * Keeping this template disabled until the following issue is fixed or investigated further:
+     * https://github.com/aerogear/graphback/issues/2174
+     */
+    disabled: true,
     repos: [{
       uri: 'https://github.com/aerogear/graphback',
       branch: 'templates-1.0.0',
@@ -184,7 +194,7 @@ export async function extractTemplate(template: Template, name: string) {
     const file = await downloadRepository(tarInfo);
     repo.mountpath = repo.mountpath || "";
     const output = `${process.cwd()}/${name}/${repo.mountpath}`;
-    if(!existsSync(output)){
+    if (!existsSync(output)) {
       mkdirSync(output);
     }
 

diff --git a/packages/create-graphback/src/init/templateMetadata.ts b/packages/create-graphback/src/init/templateMetadata.ts
@@ -5,6 +5,8 @@ export interface Template {
   name: string
   description: string
   repos: TemplateRepository[]
+  // If disabled, this template will not be available to select in CLI
+  disabled?: boolean
 }
 
 /**