Feature: Implement building components

[oscar60310]

This PR includes the MVP of three components: Template engine, schema parser, and artifact builder:

I have also added some test cases to demonstrate the usage of the whole build pipe located at /build/test/pipeline.

  const pipeline = BuildPipeline.default({
    sourceFolderPath: path.resolve(__dirname, 'source'),
    destinationFilePath: path.resolve(__dirname, 'result.json'),
  });
  pipeline.build()

This artifacts will be like below:

{
  "schemas": [
    {
      "sourceName": "detail/role",
      "name": "Role",
      "url": "/detail/role/:id",
      "request": [
        {
          "name": "id",
          "in": "query",
          "description": "role id",
          "validators": [
            { "name": "uuid", "args": {} },
            { "name": "required", "args": {} }
          ]
        }
      ],
      "urlPath": "/detail/role",
      "templateSource": "detail/role"
    },
    {
      "sourceName": "user",
      "name": "User",
      "url": "/user/:id",
      "request": [
        {
          "name": "id",
          "in": "query",
          "description": "user id",
          "validators": [
            { "name": "uuid", "args": {} },
            { "name": "required", "args": {} }
          ]
        }
      ],
      "error": [
        {
          "code": "Forbidden",
          "message": "You are not allowed to access this resource"
        }
      ],
      "urlPath": "/user",
      "templateSource": "user"
    }
  ],
  "compiler": "nunjucks",
  "templates": {
    "detail/role": "(() => {function root(env, context, frame, runtime, cb) {\nvar lineno = 0;\nvar colno = 0;\nvar output = \"\";\ntry {\nvar parentTemplate = null;\noutput += \"select * from public.role\\nwhere id = \";\noutput += runtime.suppressValue(runtime.memberLookup((runtime.memberLookup((runtime.contextOrFrameLookup(context, frame, \"context\")),\"params\")),\"id\"), env.opts.autoescape);\nif(parentTemplate) {\nparentTemplate.rootRenderFunc(env, context, frame, runtime, cb);\n} else {\ncb(null, output);\n}\n;\n} catch (e) {\n  cb(runtime.handleError(e, lineno, colno));\n}\n}\nreturn {\nroot: root\n};\n})()",
    "user": "(() => {function root(env, context, frame, runtime, cb) {\nvar lineno = 0;\nvar colno = 0;\nvar output = \"\";\ntry {\nvar parentTemplate = null;\noutput += \"select * from public.user where id = '\";\noutput += runtime.suppressValue(runtime.memberLookup((runtime.memberLookup((runtime.contextOrFrameLookup(context, frame, \"context\")),\"params\")),\"id\"), env.opts.autoescape);\noutput += \"';\";\nif(parentTemplate) {\nparentTemplate.rootRenderFunc(env, context, frame, runtime, cb);\n} else {\ncb(null, output);\n}\n;\n} catch (e) {\n  cb(runtime.handleError(e, lineno, colno));\n}\n}\nreturn {\nroot: root\n};\n})()"
  }
}

[oscar60310]

@wwwy3y3 @kokokuo This PR is ready for review, we can have a meeting before reviewing~

I'll continue to implement plugin loader of template engine at the next PR.

[kokokuo]

Great handling! Thanks for normalizing the schema validator format by handing the some-name -> {name: "some-name"}

[kokokuo]

Maybe here you could add a comment to let others know you give the schema file name by default if the template source is not set?

[oscar60310]

Sure, added.

[kokokuo]

How about SchemaDataFormat or SchemaFormat or SchemaFormatType ?

[oscar60310]

SchemaFormat sounds greate :_)

[kokokuo]

Suggest adding comment to describe what the result is and its purpose, e.g: object code, or intermediate, because these parts may not easy to understand for maintainer in the future.

[oscar60310]

I've added some comments here, but I'm afraid it won't help a lot. Because the compiler logic should be defined in child classes, for example, Nunjucks compiler turns the template to JavaScript code, but another compiler might compile some binary data. I can't have a clear explanation here.

[kokokuo]

Got it, you're right it not easy to explain if we'll provide other compliers in the future.

[kokokuo]

Great coding! and I have a question about compiler name:

I saw you record the compiler name (e.g: nunjucks ) in the PreCompiledResult and save the result with template and schema in file through ArtifactBuilder, but since did not according to the compiler name to switch compiler when using useDefaultLoader to create TemplateEngine and render the result.

Because I consider saving the compiler name in builder file is ordering to read different compiler when rendering through TemplateEngine by useDefaultLoader .

So, should we still record the compiler name in PreCompiledResult when compiling through TemplateEngine ?

[oscar60310]

Because I consider saving the compiler name in builder file is ordering to read different compiler when rendering through TemplateEngine by useDefaultLoader .

Yes, you were right. I thought we might have different compilers in the future. Saving the compiler name will let us indicate the different compilers.

But after implementing further features, I think we have little chance to provide multiple compilers in the same time because the extensions are coupled with compiler. So I removed the compiler name in comilerReulst, thanks!

[kokokuo]

Thanks for sharing more possible plans in your mind to let me know ~

[kokokuo]

Greate implementing! LTGM 👍

Keep some suggestion for commenting and question.

[oscar60310]

@kokokuo Thanks for reviewing, all issues were solved, cc @oscar60310 .

[kokokuo]

Checked, LGTM 👍 please feel free to merge.