Skip to content

Commit

Permalink
chore: update JSON Schema to inform about Blueprint usage (#330)
Browse files Browse the repository at this point in the history
  • Loading branch information
novusnota authored May 8, 2024
1 parent c542fcc commit 79e87d5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Refactor AST types to simplify access to third-party tools: PR [#325](https://github.com/tact-lang/tact/pull/325)
- Refactor the compiler API used to access AST store: PR [#326](https://github.com/tact-lang/tact/pull/326)
- Update JSON Schema to inform about usage in Blueprint: PR [#330](https://github.com/tact-lang/tact/pull/330)

### Fixed

Expand Down
12 changes: 7 additions & 5 deletions grammar/configSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,21 @@
"properties": {
"name": {
"type": "string",
"description": "Name of the project. All generated files are prefixed with it."
"description": "Name of the project. All generated files are prefixed with it.\n\nIn Blueprint, `name` refers to the name of the contract itself."
},
"path": {
"type": "string",
"description": "Path to the project's Tact file. You can only specify one Tact file per project.\n\nIn Blueprint projects, `path` is superseded by the field `target` in `wrappers/ProjectName.compile.ts`."
"description": "Path to the project's Tact file. You can only specify one Tact file per project.\n\nIn Blueprint, `path` is superseded by the `target` field in `wrappers/ContractName.compile.ts`.",
"examples": ["./path/to/contract.tact"]
},
"output": {
"type": "string",
"description": "Path to the directory where all generated files will be placed.\n\nIn Blueprint projects, `output` is unused and all generated files are always placed in `build/ProjectName/`."
"description": "Path to the directory where all generated files will be placed.\n\nIn Blueprint, `output` is not used and all generated files are always placed in `build/ProjectName/`.",
"examples": ["./path/to/output/directory"]
},
"options": {
"type": "object",
"description": "Compilation options for the project.",
"description": "Compilation options for the project.\n\nIn Blueprint, they act as default unless modified in `wrappers/ContractName.compile.ts`.",
"properties": {
"debug": {
"type": "boolean",
Expand Down Expand Up @@ -61,7 +63,7 @@
"type": "string",
"default": "full",
"enum": ["full", "checkOnly", "funcOnly"],
"title": "Compilation mode of the project.",
"title": "Compilation mode of the project. In Blueprint, it's always set to `full` and cannot be overwritten.",
"description": "Set to `full` by default, which runs the whole pipeline of the compilation and emits FunC code, BoC and various utility files, including wrappers for TypeScript.\nIf set to `checkOnly`, only performs syntax and type checking, preventing further compilation.\nIf set to `funcOnly`, only outputs intermediate FunC code, preventing further compilation."
}
}
Expand Down

0 comments on commit 79e87d5

Please sign in to comment.