Skip to content

Commit

Permalink
fix sync ci after structure changes (#289)
Browse files Browse the repository at this point in the history
  • Loading branch information
notch1p authored Aug 27, 2024
1 parent 9925c6b commit 5fd5953
Show file tree
Hide file tree
Showing 5 changed files with 413 additions and 22 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/sync-json-schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ jobs:
pip install jsonschema2md
jsonschema2md mod.schema.json mod.md
jsonschema2md pkg.schema.json pkg.md
cat mod.md pkg.md > build-system-configuration.md
cp build-system-configuration.md zh-docs/build-system-configuration.md
cat mod.md pkg.md > ./moonbit-docs/docs/build-system-configuration.md
cp ./moonbit-docs/docs/build-system-configuration.md ./moonbit-docs/i18n/zh/docusaurus-plugin-content-docs/current/build-system-configuration.md
rm mod.md pkg.md
- name: Create PR based on changes
Expand Down
91 changes: 91 additions & 0 deletions mod.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "JSON schema for MoonBit moon.mod.json files",
"description": "A module of MoonBit lang",
"type": "object",
"required": [
"name"
],
"properties": {
"alert-list": {
"description": "Alert list setting of the module",
"type": [
"string",
"null"
]
},
"deps": {
"description": "third-party dependencies of the module",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"description": {
"description": "description of this module",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "keywords of this module",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"license": {
"description": "license of this module",
"type": [
"string",
"null"
]
},
"name": {
"description": "name of the module",
"type": "string"
},
"readme": {
"description": "path to module's README file",
"type": [
"string",
"null"
]
},
"repository": {
"description": "url to module's repository",
"type": [
"string",
"null"
]
},
"source": {
"description": "source code directory of this module",
"type": [
"string",
"null"
]
},
"version": {
"description": "version of the module",
"type": [
"string",
"null"
]
},
"warn-list": {
"description": "Warn list setting of the module",
"type": [
"string",
"null"
]
}
}
}
20 changes: 10 additions & 10 deletions moonbit-docs/docs/build-system-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@

## Properties

- **`alert_list`** *(['string', 'null'])*: Alert list setting of the package.
- **`alert-list`** *(['string', 'null'])*: Alert list setting of the package.
- **`import`**: Imported packages of the package.
- **Any of**
- : Refer to *[#/definitions/PkgJSONImport](#definitions/PkgJSONImport)*.
- *null*
- **`is_main`** *(['boolean', 'null'])*: Specify whether this package is a main package or not.
- **`is-main`** *(['boolean', 'null'])*: Specify whether this package is a main package or not.
- **`link`**
- **Any of**
- : Refer to *[#/definitions/BoolOrLink](#definitions/BoolOrLink)*.
- *null*
- **`name`** *(['string', 'null'])*
- **`test_import`**: Black box test imported packages of the package.
- **`test-import`**: Black box test imported packages of the package.
- **Any of**
- : Refer to *[#/definitions/PkgJSONImport](#definitions/PkgJSONImport)*.
- *null*
- **`warn_list`** *(['string', 'null'])*: Warn list setting of the package.
- **`wbtest_import`**: White box test imported packages of the package.
- **`warn-list`** *(['string', 'null'])*: Warn list setting of the package.
- **`wbtest-import`**: White box test imported packages of the package.
- **Any of**
- : Refer to *[#/definitions/PkgJSONImport](#definitions/PkgJSONImport)*.
- *null*
Expand All @@ -49,9 +49,6 @@
- **Any of**
- *boolean*
- : Refer to *[#/definitions/Link](#definitions/Link)*.
- <a id="definitions/ImportMemory"></a>**`ImportMemory`** *(object)*
- **`module`** *(string, required)*
- **`name`** *(string, required)*
- <a id="definitions/JsFormat"></a>**`JsFormat`** *(string)*: Must be one of: `["esm", "cjs", "iife"]`.
- <a id="definitions/JsLinkConfig"></a>**`JsLinkConfig`** *(object)*
- **`exports`** *(['array', 'null'])*
Expand Down Expand Up @@ -93,7 +90,7 @@
- **Items** *(string)*
- **`import-memory`**
- **Any of**
- : Refer to *[#/definitions/ImportMemory](#definitions/ImportMemory)*.
- : Refer to *[#/definitions/import-memory](#definitions/import-memory)*.
- *null*
- <a id="definitions/WasmLinkConfig"></a>**`WasmLinkConfig`** *(object)*
- **`export-memory-name`** *(['string', 'null'])*
Expand All @@ -104,5 +101,8 @@
- **`heap-start-address`** *(['integer', 'null'], format: uint32)*: Minimum: `0.0`.
- **`import-memory`**
- **Any of**
- : Refer to *[#/definitions/ImportMemory](#definitions/ImportMemory)*.
- : Refer to *[#/definitions/import-memory](#definitions/import-memory)*.
- *null*
- <a id="definitions/import-memory"></a>**`import-memory`** *(object)*
- **`module`** *(string, required)*
- **`name`** *(string, required)*
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@

## Properties

- **`alert_list`** *(['string', 'null'])*: Alert list setting of the package.
- **`alert-list`** *(['string', 'null'])*: Alert list setting of the package.
- **`import`**: Imported packages of the package.
- **Any of**
- : Refer to *[#/definitions/PkgJSONImport](#definitions/PkgJSONImport)*.
- *null*
- **`is_main`** *(['boolean', 'null'])*: Specify whether this package is a main package or not.
- **`is-main`** *(['boolean', 'null'])*: Specify whether this package is a main package or not.
- **`link`**
- **Any of**
- : Refer to *[#/definitions/BoolOrLink](#definitions/BoolOrLink)*.
- *null*
- **`name`** *(['string', 'null'])*
- **`test_import`**: Black box test imported packages of the package.
- **`test-import`**: Black box test imported packages of the package.
- **Any of**
- : Refer to *[#/definitions/PkgJSONImport](#definitions/PkgJSONImport)*.
- *null*
- **`warn_list`** *(['string', 'null'])*: Warn list setting of the package.
- **`wbtest_import`**: White box test imported packages of the package.
- **`warn-list`** *(['string', 'null'])*: Warn list setting of the package.
- **`wbtest-import`**: White box test imported packages of the package.
- **Any of**
- : Refer to *[#/definitions/PkgJSONImport](#definitions/PkgJSONImport)*.
- *null*
Expand All @@ -49,9 +49,6 @@
- **Any of**
- *boolean*
- : Refer to *[#/definitions/Link](#definitions/Link)*.
- <a id="definitions/ImportMemory"></a>**`ImportMemory`** *(object)*
- **`module`** *(string, required)*
- **`name`** *(string, required)*
- <a id="definitions/JsFormat"></a>**`JsFormat`** *(string)*: Must be one of: `["esm", "cjs", "iife"]`.
- <a id="definitions/JsLinkConfig"></a>**`JsLinkConfig`** *(object)*
- **`exports`** *(['array', 'null'])*
Expand Down Expand Up @@ -93,7 +90,7 @@
- **Items** *(string)*
- **`import-memory`**
- **Any of**
- : Refer to *[#/definitions/ImportMemory](#definitions/ImportMemory)*.
- : Refer to *[#/definitions/import-memory](#definitions/import-memory)*.
- *null*
- <a id="definitions/WasmLinkConfig"></a>**`WasmLinkConfig`** *(object)*
- **`export-memory-name`** *(['string', 'null'])*
Expand All @@ -104,5 +101,8 @@
- **`heap-start-address`** *(['integer', 'null'], format: uint32)*: Minimum: `0.0`.
- **`import-memory`**
- **Any of**
- : Refer to *[#/definitions/ImportMemory](#definitions/ImportMemory)*.
- : Refer to *[#/definitions/import-memory](#definitions/import-memory)*.
- *null*
- <a id="definitions/import-memory"></a>**`import-memory`** *(object)*
- **`module`** *(string, required)*
- **`name`** *(string, required)*
Loading

0 comments on commit 5fd5953

Please sign in to comment.