@outwalk/create-firefly 0.1.0

package/README.md

@@ -0,0 +1,58 @@
+# @outwalk/create-firefly
+
+A scaffolding tool for creating Firefly projects.
+
+![Actions](https://github.com/OutwalkStudios/firefly/workflows/build/badge.svg)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/OutwalkStudios/firefly/blob/main/LICENSE)
+[![Follow Us](https://img.shields.io/badge/follow-on%20twitter-4AA1EC.svg)](https://twitter.com/OutwalkStudios)
+
+---
+
+## Usage
+
+Create a Firefly project by running the following command and then follow the prompts.
+
+```
+npm create @outwalk/firefly
+```
+
+You can also specify settings via command line options.
+
+```
+npm create @outwalk/firefly my-app --language typescript
+```
+
+### Command Line Options.
+
+The first argument passed to the command will be used as the project name/directory, Other settings can be configured using the following command line options:
+
+```
+# Specify the language
+-l, --language
+
+# Specify the platform
+-p, --platform
+
+# Specify the database
+-d, --database
+
+# Prevent automatic dependency installation
+--skip-install
+
+# Prevent initilizing a new git repository
+--skip-git
+
+# Ignore any warnings (dangerous)
+--force
+```
+---
+
+## Reporting Issues
+
+If you are having trouble getting something to work with Firefly or run into any problems, you can create a new [issue](https://github.com/OutwalkStudios/firefly/issues).
+
+---
+
+## License
+
+Firefly is licensed under the terms of the [**MIT**](https://github.com/OutwalkStudios/firefly/blob/main/LICENSE) license.

package/dist/index.js

@@ -0,0 +1,243 @@
+'use strict';
+
+var yargs = require('yargs-parser');
+var prompts = require('prompts');
+var chalk = require('chalk');
+var path = require('path');
+var fs = require('fs');
+var child_process = require('child_process');
+
+class TemplateBuilder {
+  constructor(src, dest) {
+    this.src = src;
+    this.dest = dest;
+    this.values = {};
+  }
+  inject(marker, value) {
+    this.values[marker] = value;
+    return this;
+  }
+  snippet(marker, snippet) {
+    this.values[marker] = fs.readFileSync(snippet, "utf8");
+    return this;
+  }
+  build() {
+    TemplateBuilder.createDirectory(this.dest);
+    TemplateBuilder.copyTemplate(this.src, this.dest, this.values);
+    return this;
+  }
+  /* create a directory */
+  static createDirectory(directory) {
+    if (!fs.existsSync(directory)) {
+      fs.mkdirSync(directory, { recursive: true });
+    }
+  }
+  /* deletes a directory and all subdirectories and files */
+  static deleteDirectory(directory) {
+    if (fs.existsSync(directory)) {
+      const files = fs.readdirSync(directory);
+      for (let file of files) {
+        const filepath = path.join(directory, file);
+        if (fs.statSync(filepath).isDirectory()) {
+          TemplateBuilder.deleteDirectory(filepath);
+        } else {
+          fs.unlinkSync(filepath);
+        }
+      }
+      fs.rmdirSync(directory);
+    }
+  }
+  /* copy a template and apply dynamic values to template markers */
+  static copyTemplate(src, dest, values) {
+    const filesToCreate = fs.readdirSync(src);
+    const render = (content) => {
+      const keys = Object.keys(values);
+      for (let key of keys) {
+        content = content.replace(new RegExp(`{{${key}}}`, "g"), values[key]);
+      }
+      return content;
+    };
+    for (let file of filesToCreate) {
+      const originalPath = path.join(src, file);
+      if (file.endsWith(".template")) {
+        file = file.replace(/.template$/, "");
+      }
+      const newPath = path.join(dest, file);
+      const stats = fs.statSync(originalPath);
+      if (stats.isFile()) {
+        if (path.extname(originalPath) == ".template") {
+          fs.writeFileSync(newPath, render(fs.readFileSync(originalPath, "utf8")));
+        } else {
+          fs.writeFileSync(newPath, fs.readFileSync(originalPath));
+        }
+      } else if (stats.isDirectory()) {
+        TemplateBuilder.createDirectory(newPath);
+        TemplateBuilder.copyTemplate(originalPath, newPath, values);
+      }
+    }
+  }
+}
+
+const firefly$1 = chalk.hex("#ADFF2F");
+function installDependencies(dependencies, directory) {
+  return new Promise((resolve, reject) => {
+    console.log(`${firefly$1("[firefly]")} - installing dependencies...`);
+    const command = /^win/.test(process.platform) ? "npm.cmd" : "npm";
+    const spawnProcess = (command2, args) => {
+      const { status, error } = child_process.spawnSync(command2, args, { cwd: directory, stdio: "ignore" });
+      if (status != 0)
+        throw new Error("failed to install project dependencies.");
+      if (error)
+        throw error;
+    };
+    try {
+      spawnProcess(command, ["install", "--save"].concat(dependencies));
+      resolve();
+    } catch (error) {
+      reject(error);
+    }
+  });
+}
+function intitializeGitRepository(directory) {
+  return new Promise((resolve, reject) => {
+    console.log(`${firefly$1("[firefly]")} - initializing git repository...`);
+    try {
+      child_process.exec("git init", { cwd: directory });
+      resolve();
+    } catch {
+      reject(new Error("failed to initialize the git repository."));
+    }
+  });
+}
+
+const firefly = chalk.hex("#ADFF2F");
+const args = yargs(process.argv.slice(2));
+prompts.override({
+  name: args._[0],
+  language: args.l ?? args.language,
+  platform: args.p ?? args.platform,
+  database: args.d ?? args.database
+});
+const questions = [
+  {
+    type: "text",
+    name: "name",
+    message: "Project name:",
+    validate: (name) => name != name.toLowerCase() ? "your project name must be lowercase." : true
+  },
+  {
+    type: "select",
+    name: "language",
+    message: "Select a language:",
+    choices: [
+      { title: "JavaScript", value: "javascript" },
+      { title: "TypeScript", value: "typescript" }
+    ]
+  },
+  {
+    type: "select",
+    name: "platform",
+    message: "Select a platform:",
+    choices: [
+      { title: "Express", value: "express" },
+      { title: "Custom", value: "custom-platform" }
+    ]
+  },
+  {
+    type: "select",
+    name: "database",
+    message: "Select a database:",
+    choices: [
+      { title: "Mongoose", value: "mongoose" },
+      { title: "Custom", value: "custom-database" },
+      { title: "None", value: "none" }
+    ]
+  }
+];
+(async () => {
+  const config = await prompts(questions, { onCancel: () => process.exit() });
+  const skipInstall = args["skip-install"];
+  const skipGit = args["skip-git"];
+  const force = args["force"];
+  const settings = { useCurrentDirectory: false };
+  const dependencies = ["@outwalk/firefly"];
+  if (!["none", "custom-platform"].includes(config.platform)) {
+    dependencies.push(config.platform);
+  }
+  if (!["none", "custom-database"].includes(config.database)) {
+    dependencies.push(config.database);
+  }
+  if (config.name == ".") {
+    if (!force && fs.readdirSync(config.name).length > 0) {
+      const response = await prompts({
+        type: "confirm",
+        name: "continue",
+        message: "The current directory is not empty. Continue?",
+        initial: true
+      });
+      if (!response.continue)
+        return;
+    }
+    config.name = path.basename(process.cwd());
+    settings.useCurrentDirectory = true;
+  }
+  if (fs.existsSync(config.name)) {
+    if (force && !settings.useCurrentDirectory) {
+      TemplateBuilder.deleteDirectory(config.name);
+    } else {
+      console.error(`${chalk.red("[firefly]")} - ${config.name} already exists.`);
+      return;
+    }
+  }
+  console.log(`
+${firefly("[firefly]")} - creating ${config.name}...`);
+  const templatePath = path.join(__dirname, "../templates/", config.language);
+  const snippetPath = path.join(__dirname, "../templates/snippets");
+  const projectPath = !settings.useCurrentDirectory ? config.name : ".";
+  try {
+    const template = new TemplateBuilder(templatePath, projectPath);
+    template.inject("project-name", config.name);
+    template.inject("options", config.database != "none" ? "{ platform, database }" : "{ platform }");
+    if (config.platform.startsWith("custom")) {
+      template.snippet("import-platform", path.join(snippetPath, config.platform, config.language, "import-platform.template"));
+      template.snippet("define-platform", path.join(snippetPath, config.platform, config.language, "define-platform.template"));
+    } else {
+      template.snippet("import-platform", path.join(snippetPath, config.platform, "import-platform.template"));
+      template.snippet("define-platform", path.join(snippetPath, config.platform, "define-platform.template"));
+    }
+    if (config.database.startsWith("custom")) {
+      template.snippet("import-database", path.join(snippetPath, config.database, config.language, "import-database.template"));
+      template.snippet("define-database", path.join(snippetPath, config.database, config.language, "define-database.template"));
+    } else if (config.database != "none") {
+      template.snippet("import-database", path.join(snippetPath, config.database, "import-database.template"));
+      template.snippet("define-database", path.join(snippetPath, config.database, "define-database.template"));
+    } else {
+      template.inject("import-database", "");
+      template.inject("define-database", "");
+    }
+    template.build();
+  } catch (error) {
+    console.error(`${chalk.red("[firefly]")} - ${error.message}`);
+    return;
+  }
+  try {
+    if (!skipInstall)
+      await installDependencies(dependencies, projectPath);
+    if (!skipGit)
+      await intitializeGitRepository(projectPath);
+  } catch (error) {
+    console.error(`${chalk.red("[firefly]")} - ${error.message}`);
+    if (!settings.useCurrentDirectory)
+      TemplateBuilder.deleteDirectory(config.name);
+    return;
+  }
+  console.log("\n----------------------------------");
+  console.log("Get started with your new project!\n");
+  if (!settings.useCurrentDirectory) {
+    console.log(firefly(` > cd ./${path.relative(process.cwd(), config.name)} `));
+  }
+  if (skipInstall)
+    console.log(firefly(" > npm install"));
+  console.log(firefly(" > npm run dev"));
+  console.log("----------------------------------");
+})();

package/package.json

@@ -0,0 +1,57 @@
+{
+    "name": "@outwalk/create-firefly",
+    "version": "0.1.0",
+    "description": "Firefly - a modern scalable web framework.",
+    "main": "dist/index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "bin": {
+        "create-firefly": "dist/index.js"
+    },
+    "scripts": {
+        "build": "rollup -c",
+        "lint": "eslint src",
+        "prepublishOnly": "npm run lint && npm run build"
+    },
+    "keywords": [
+        "outwalk",
+        "express",
+        "decorators",
+        "mvc"
+    ],
+    "files": [
+        "dist",
+        "templates"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/OutwalkStudios/firefly.git",
+        "directory": "packages/create-firefly"
+    },
+    "bugs": {
+        "url": "https://github.com/OutwalkStudios/firefly/issues"
+    },
+    "homepage": "https://github.com/OutwalkStudios/firefly#readme",
+    "author": "Outwalk Studios <support@outwalkstudios.com> (https://www.outwalkstudios.com/)",
+    "license": "MIT",
+    "dependencies": {
+        "chalk": "^4.1.2",
+        "prompts": "^2.4.2",
+        "yargs-parser": "^21.1.1"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.1.1",
+        "@rollup/plugin-commonjs": "^25.0.7",
+        "@rollup/plugin-json": "^6.1.0",
+        "@rollup/plugin-node-resolve": "^15.2.3",
+        "esbuild": "^0.20.2",
+        "eslint": "^9.1.1",
+        "globals": "^15.0.0",
+        "rollup": "^4.16.4",
+        "rollup-plugin-esbuild": "^6.1.1"
+    }
+}

package/templates/javascript/.gitignore.template

@@ -0,0 +1,49 @@
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+.env.test
+
+# rollup.js default build output
+dist/
+
+# Temporary folders
+tmp/
+temp/

package/templates/javascript/jsconfig.json.template

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "experimentalDecorators": true,
+        "baseUrl": "./src",
+        "paths": {
+            "@/*": [
+                "./*"
+            ]
+        }
+    }
+}

package/templates/javascript/package.json.template

@@ -0,0 +1,14 @@
+{
+  "name": "{{project-name}}",
+  "main": "dist/index.js",
+  "private": true,
+  "engines": {
+    "node": "^18",
+    "npm": "^9"
+  },
+  "scripts": {
+    "build": "firefly build",
+    "start": "firefly start",
+    "dev": "firefly start --dev"
+  }
+}

package/templates/javascript/src/app/app.controller.js.template

@@ -0,0 +1,12 @@
+import { Controller, Inject, Get } from "@outwalk/firefly";
+
+@Controller()
+export class AppController {
+
+    @Inject() appService;
+
+    @Get()
+    getHelloWorld() {
+        return this.appService.getHelloWorld();
+    }
+}

package/templates/javascript/src/app/app.service.js.template

@@ -0,0 +1,9 @@
+import { Injectable } from "@outwalk/firefly";
+
+@Injectable()
+export class AppService {
+
+    getHelloWorld() {
+        return "Hello World!";
+    }
+}

package/templates/javascript/src/index.js.template

@@ -0,0 +1,10 @@
+import { Application } from "@outwalk/firefly";
+{{import-platform}}
+{{import-database}}
+
+{{define-platform}}
+
+{{define-database}}
+
+/* start the application */
+new Application({{options}}).listen();

package/templates/snippets/custom-database/javascript/define-database.template

@@ -0,0 +1,7 @@
+/* implement a database using the firefly database interface */
+class CustomDatabase extends Database {
+    
+    async connect() {}
+}
+
+const database = new CustomDatabase();

package/templates/snippets/custom-database/javascript/import-database.template

@@ -0,0 +1 @@
+import { Database } from "@outwalk/firefly";

package/templates/snippets/custom-database/typescript/define-database.template

@@ -0,0 +1,7 @@
+/* implement a database using the firefly database interface */
+class CustomDatabase extends Database {
+    
+    async connect(): Promise<void> {}
+}
+
+const database = new CustomDatabase();

package/templates/snippets/custom-database/typescript/import-database.template

@@ -0,0 +1 @@
+import { Database } from "@outwalk/firefly";

package/templates/snippets/custom-platform/javascript/define-platform.template

@@ -0,0 +1,11 @@
+/* implement a platform using the firefly platform interface */
+class CustomPlatform extends Platform {
+    
+    loadController(route, middleware, routes) {}
+
+    loadErrorHandler() {}
+
+    listen(port) {}
+}
+
+const platform = new CustomPlatform();

package/templates/snippets/custom-platform/javascript/import-platform.template

@@ -0,0 +1 @@
+import { Platform } from "@outwalk/firefly";

package/templates/snippets/custom-platform/typescript/define-platform.template

@@ -0,0 +1,11 @@
+/* implement a platform using the firefly platform interface */
+class CustomPlatform extends Platform {
+    
+    loadController(route: string, middleware: Function[], routes: Route[]): void {}
+
+    loadErrorHandler(): void {}
+
+    listen(port: number): void {}
+}
+
+const platform = new CustomPlatform();

package/templates/snippets/custom-platform/typescript/import-platform.template

@@ -0,0 +1 @@
+import { Platform, Route } from "@outwalk/firefly";

package/templates/snippets/express/define-platform.template

@@ -0,0 +1,2 @@
+/* setup the platform and global middleware */
+const platform = new ExpressPlatform();

package/templates/snippets/express/import-platform.template

@@ -0,0 +1 @@
+import { ExpressPlatform } from "@outwalk/firefly/express";

package/templates/snippets/mongoose/define-database.template

@@ -0,0 +1,2 @@
+/* setup the database and global plugins */
+const database = new MongooseDriver();

package/templates/snippets/mongoose/import-database.template

@@ -0,0 +1 @@
+import { MongooseDriver } from "@outwalk/firefly/mongoose";

package/templates/typescript/.gitignore.template

@@ -0,0 +1,49 @@
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+.env.test
+
+# rollup.js default build output
+dist/
+
+# Temporary folders
+tmp/
+temp/

package/templates/typescript/package.json.template

@@ -0,0 +1,14 @@
+{
+  "name": "{{project-name}}",
+  "main": "dist/index.js",
+  "private": true,
+  "engines": {
+    "node": "^18",
+    "npm": "^9"
+  },
+  "scripts": {
+    "build": "firefly build",
+    "start": "firefly start",
+    "dev": "firefly start --dev"
+  }
+}

package/templates/typescript/src/app/app.controller.ts.template

@@ -0,0 +1,14 @@
+import { Controller, Inject, Get } from "@outwalk/firefly";
+import { AppService } from "./app.service";
+
+@Controller()
+export class AppController {
+
+    @Inject()
+    appService: AppService;
+
+    @Get()
+    getHelloWorld(): string {
+        return this.appService.getHelloWorld();
+    }
+}

package/templates/typescript/src/app/app.service.ts.template

@@ -0,0 +1,9 @@
+import { Injectable } from "@outwalk/firefly";
+
+@Injectable()
+export class AppService {
+
+    getHelloWorld(): string {
+        return "Hello World!";
+    }
+}

package/templates/typescript/src/index.ts.template

@@ -0,0 +1,10 @@
+import { Application } from "@outwalk/firefly";
+{{import-platform}}
+{{import-database}}
+
+{{define-platform}}
+
+{{define-database}}
+
+/* start the application */
+new Application({{options}}).listen();

package/templates/typescript/tsconfig.json.template

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "experimentalDecorators": true,
+        "baseUrl": "./src",
+        "paths": {
+            "@/*": [
+                "./*"
+            ]
+        }
+    }
+}