feat: add post generator

Author: hckhanh

src/actions/CreateIgnoreFileAction.ts

@@ -3,11 +3,11 @@ import { withCurrentDir, writeContentToFile } from "../process";
 import { Action } from "./Action";
 
 export class CreateIgnoreFileAction extends Action {
-  constructor(private fileName: string) {
+  constructor(private fileName: string, private content = ignoreFiles) {
     super();
   }
 
   async exec(): Promise<void> {
-    await writeContentToFile(withCurrentDir(this.fileName), ignoreFiles);
+    await writeContentToFile(withCurrentDir(this.fileName), this.content);
   }
 }

src/configs.ts

@@ -41,6 +41,12 @@ coverage
 te?mp
 `;
 
+export const postIgnoreFiles = `
+# Editors
+.idea
+.vscode
+`;
+
 export const flowConfigs = `
 [ignore]
 <PROJECT_ROOT>/node_modules/.*

src/generators/GeneratorFactory.ts

@@ -4,6 +4,7 @@ import { GeneratorType, InquirerConfigs } from "../types";
 import { ESLintGenerator } from "./ESLintGenerator";
 import { FlowGenerator } from "./FlowGenerator";
 import { Generator } from "./Generator";
+import { PostGenerator } from "./PostGenerator";
 import { PrettierGenerator } from "./PrettierGenerator";
 import { Yarn2Generator } from "./Yarn2Generator";
 
@@ -39,6 +40,10 @@ export class GeneratorFactory {
       return new FlowGenerator(userConfigs, formatter, packager);
     }
 
+    if (type === "post") {
+      return new PostGenerator(userConfigs, formatter, packager);
+    }
+
     throw new Error(`"${type}" generator not implemented.`);
   }
 }

src/generators/PostGenerator.ts

@@ -0,0 +1,23 @@
+import { Action } from "../actions/Action";
+import { CreateIgnoreFileAction } from "../actions/CreateIgnoreFileAction";
+import { postIgnoreFiles } from "../configs";
+import { Formatter } from "../formatters/Formatter";
+import { Packager } from "../packagers/Packager";
+import { InquirerConfigs } from "../types";
+import { Generator } from "./Generator";
+
+export class PostGenerator extends Generator {
+  generateConfigs(userConfigs: InquirerConfigs): [object, string[]] {
+    return [{}, []];
+  }
+
+  initActions(
+    configs: string,
+    packages: string[],
+    userConfigs: InquirerConfigs,
+    formatter: Formatter,
+    packager: Packager,
+  ): Action[] {
+    return [new CreateIgnoreFileAction(".gitignore", postIgnoreFiles)];
+  }
+}

src/index.ts

@@ -27,6 +27,7 @@ class CreateJavascriptProject extends Command {
     this.parse(CreateJavascriptProject);
     await checkPackageJson();
     const answers = await collectAnswers();
+    answers.configurations.push("post");
 
     if (answers.configurations.includes("flow") || answers.framework !== "none") {
       answers.module = "esm";

src/process.ts

@@ -65,7 +65,7 @@ export async function writeContentToFile(file: string, content: string, flag = "
 
   if (stats) {
     if (stats.isDirectory()) {
-      throw new Error(`Cannot write content to ${file}`);
+      throw new Error(`Cannot write content to a folder (${file})`);
     }
 
     await writeFile(file, `\n${content.trim()}\n`, { flag });

src/types.ts

@@ -8,7 +8,7 @@ export type Environment = "browser" | "node";
 
 export type ConfigsFileFormat = "js" | "json" | "yml";
 
-export type GeneratorType = "yarn2" | "eslint" | "prettier" | "flow";
+export type GeneratorType = "yarn2" | "eslint" | "prettier" | "flow" | "post";
 
 export type PackagerType = "yarn" | "npm";