v0.0.1 of Stencil Spec + Compiler

[techsavvyash]

Description

The version v0.0.1 of the stencil spec we have the following tasks

• [ ] Document which spec fields are taken and why are they taken
• [ ] Docs on what features we can add moving forward i.e. future scope
• [ ] v0.0.1 of the compiler in CLI which can parse this config and churn out a new stencil project will all the features setup

[techsavvyash]

@Savio629

• [ ] The PR is still marked as draft, can we review it?
• [ ] Does the PR adds docs on the spec?
• [ ] Does it contain test cases?

Please move this to ready for review once all the boxes are crossed off. For running review you can just drop a text here and click on the request a review button on the PR itself.

[Savio629]

README.md for Docker Command

Spec Command

stencil spec [path]

eg. stencil spec src/spec.yaml

The structure of specification file:

stencil: 0.0.1

info:
  properties:
    project-name: "Test"
    package-manager: "npm"

tooling: [prisma,monitoring]

docker:
  service: [temporal,logging,monitoring]
  adhoc-services: [postgres,hasura]

endpoints:

Description

Bootstrap a new project on basis of given specification file.

Arguments

Argument	Description
<path>	The path of the specification file

Structure of specification file

stencil: 0.0.1

• stencil: This field denotes the version of the stencil specification. It helps in identifying the format and compatibility of the specification file.

info:
  properties:
    project-name: "ProjectName"
    package-manager: "npm"

• info: This section contains metadata about the project.
• properties: A nested section under info containing specific attributes:
• project-name: Specifies the name of the project.
• package-manager: Supported package managers as of now are npm, pnpm, yarn and bun .

tooling: [prisma,monitoring]

• tooling: This is a list of tools utilized in the project. Supported tooling as of now are prisma, monitoring,service-temporal, service-user and service-file-upload

docker:
  service: [temporal,logging,monitoringService]
  adhoc-services: [postgres,hasura]

• docker: This section lists the Docker services used in the project.
  • service: A list of Tooling specific setup, which includes temporal, logging, and monitoringService.
  • adhoc-services: A list of À la Carte setup, which includes postgres and hasura.

endpoints:

• endpoints: This section is reserved for defining various endpoints used in the project.