feat(cli, core): write some initial files for demo

- write some initial files for demo
- fix in-memory code loader name

Author: oscar60310

packages/build/tsconfig.lib.json

@@ -5,6 +5,12 @@
     "declaration": true,
     "types": []
   },
-  "include": ["**/*.ts", "../../types/*.d.ts"],
+  "include": [
+    "jest.config.ts",
+    "**/*.test.ts",
+    "**/*.spec.ts",
+    "**/*.d.ts",
+    "../../types/*.d.ts"
+  ],
   "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"]
 }

packages/cli/package.json

@@ -1,5 +1,26 @@
 {
   "name": "@vulcan-sql/cli",
   "version": "0.1.0",
-  "type": "commonjs"
+  "type": "commonjs",
+  "bin": {
+    "vulcan": "./src/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "vulcan",
+    "vulcan-sql",
+    "data",
+    "sql",
+    "database",
+    "data-warehouse",
+    "data-lake",
+    "api-builder"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Canner/vulcan.git"
+  },
+  "license": "MIT"
 }

packages/cli/project.json

@@ -44,12 +44,52 @@
       "executor": "@nrwl/workspace:run-commands",
       "options": {
         "command": "node src/index.js {args.cmd}",
-        "cwd": "dist/packages/cli"
+        "cwd": "dist/packages/cli",
+        "forwardAllArgs": false
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "build"
+        },
+        {
+          "projects": "self",
+          "target": "cp-assets"
+        }
+      ]
+    },
+    "cp-assets": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "commands": [
+          {
+            "command": "cp -r packages/cli/src/schemas dist/packages/cli/src",
+            "forwardAllArgs": false
+          }
+        ]
+      },
+      "dependsOn": [
+        {
+          "projects": "self",
+          "target": "build"
+        }
+      ]
+    },
+    "install": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "commands": [
+          {
+            "command": "chmod +x ./src/index.js && npm i -g . && echo done.",
+            "forwardAllArgs": false
+          }
+        ],
+        "cwd": "dist/packages/cli"
+      },
+      "dependsOn": [
+        {
+          "projects": "self",
+          "target": "cp-assets"
         }
       ]
     }

packages/cli/src/commands/init.ts

@@ -5,6 +5,8 @@ import * as path from 'path';
 import { version } from '../../package.json';
 import * as ora from 'ora';
 import { exec } from 'child_process';
+import * as nunjucks from 'nunjucks';
+import * as glob from 'glob';
 
 const validators: Record<
   string,
@@ -73,6 +75,7 @@ export class InitCommand extends Command {
             name: options.projectName,
             dependencies: {
               '@vulcan-sql/core': options.version,
+              // TODO: Install build/serve package when they are ready
             },
           },
           null,
@@ -84,6 +87,13 @@ export class InitCommand extends Command {
       installSpinner.start('Installing dependencies...');
       await this.execAndWait(`yarn --silent`, projectPath);
       installSpinner.succeed(`Dependencies have been installed.`);
+      installSpinner.start('Writing initial content...');
+      await this.addInitFiles(projectPath, options);
+      installSpinner.succeed('Initial done.');
+
+      this.logger.info(
+        `Project has been initialized. Run "cd ${projectPath} && vulcan start" to start the server.`
+      );
     } catch (e) {
       installSpinner.fail();
       throw e;
@@ -102,4 +112,36 @@ export class InitCommand extends Command {
       });
     });
   }
+
+  private async addInitFiles(projectPath: string, options: InitCommandOptions) {
+    const files = await this.listFiles(
+      path.resolve(__dirname, '..', 'schemas', 'init', '**/*.*')
+    );
+    for (const file of files) {
+      const relativePath = path.relative(
+        path.resolve(__dirname, '..', 'schemas', 'init'),
+        file
+      );
+      let templateContent = await fs.readFile(file, 'utf8');
+      if (path.extname(file) === '.yaml') {
+        // Only render yaml files because sql files have some template scripts which are used by Vulcan.
+        templateContent = nunjucks.renderString(templateContent, {
+          options,
+        });
+      }
+      const targetPath = path.resolve(projectPath, relativePath);
+      const dir = path.dirname(targetPath);
+      await fs.mkdir(dir, { recursive: true });
+      await fs.writeFile(targetPath, templateContent, 'utf8');
+    }
+  }
+
+  private async listFiles(path: string) {
+    return new Promise<string[]>((resolve, reject) => {
+      glob(path, (err, files) => {
+        if (err) return reject(err);
+        return resolve(files);
+      });
+    });
+  }
 }

packages/cli/src/index.ts

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 import { program } from 'commander';
 import { InitCommand } from './commands';
 import { Logger } from 'tslog';

packages/cli/src/schemas/init/sqls/user.sql

@@ -0,0 +1,4 @@
+select *
+from public.users
+where id = "{{ context.params.id }}"
+limit 1;

packages/cli/src/schemas/init/sqls/user.yaml

@@ -0,0 +1,8 @@
+url: /user/:id
+request:
+  - fieldName: id
+    fieldIn: path
+    description: user id
+    validators:
+      - uuid
+      - required

packages/cli/src/schemas/init/vulcan.yaml

@@ -0,0 +1,23 @@
+name: '{{ options.projectName }}'
+description: A starter Vulcan project
+version: 0.1.0
+template:
+  provider: LocalFile
+  # Path to .sql files
+  folderPath: sqls
+  codeLoader: InMemory
+artifact:
+  provider: LocalFile
+  serializer: JSON
+  # Path to build result
+  filePath: result.json
+schema-parser:
+  reader: LocalFile
+  # Path to .yaml files
+  folderPath: sqls
+document-generator:
+  spec:
+    - oas3
+  folderPath: .
+types:
+  - RESTFUL

packages/cli/tsconfig.json

@@ -8,7 +8,8 @@
     "noPropertyAccessFromIndexSignature": true,
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "sourceMap": false
   },
   "files": [],
   "include": [],

packages/cli/tsconfig.lib.json

@@ -5,6 +5,6 @@
     "declaration": true,
     "types": ["node"]
   },
-  "include": ["**/*.ts"],
+  "include": ["**/*.ts", "../../types/*.d.ts"],
   "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"]
 }

packages/core/src/lib/template-engine/code-loader/inMemoryCodeLoader.ts

@@ -6,7 +6,7 @@ import {
 } from '@vulcan-sql/core/models';
 
 @VulcanInternalExtension()
-@VulcanExtensionId('inMemory')
+@VulcanExtensionId('InMemory')
 export class InMemoryCodeLoader extends CodeLoader {
   private source = new Map<string, object>();