-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
191 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
|
||
title: xCDL Components Definitions | ||
description: The members of the xCDL components | ||
keywords: | ||
- xpack | ||
- xcdl | ||
- cdl | ||
- component | ||
|
||
date: 2024-11-21 11:58:00 +0300 | ||
|
||
--- | ||
|
||
# xCDL Components Definitions | ||
|
||
:::note | ||
|
||
Work in progress. | ||
|
||
::: | ||
|
||
The `cdlComponents` are maps of component definitions. | ||
|
||
## Component name | ||
|
||
Component names are dash separated lower case words, preferably ASCII only. | ||
|
||
Examples: | ||
|
||
- `utils-lists` | ||
- `micro-test-plus` | ||
|
||
## Component members | ||
|
||
The components objects have the following members: | ||
|
||
### `description` | ||
|
||
TBD | ||
|
||
### `parent` | ||
|
||
TBD | ||
|
||
### `compilerIncludeFolders` | ||
|
||
TBD | ||
|
||
### `compilerSourceFiles` | ||
|
||
TBD | ||
|
||
### `compilerDefinitions` | ||
|
||
TBD | ||
|
||
### `compilerOptions` | ||
|
||
TBD | ||
|
||
### `dependencies` | ||
|
||
TBD | ||
|
||
### `generatedDefinition` | ||
|
||
TBD | ||
|
||
### `cdlOptions` | ||
|
||
TBD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
|
||
title: xCDL Options Definitions | ||
description: The members of the xCDL options | ||
keywords: | ||
- xpack | ||
- xcdl | ||
- cdl | ||
- option | ||
|
||
date: 2024-11-21 11:59:00 +0300 | ||
|
||
--- | ||
|
||
# xCDL Options Definitions | ||
|
||
:::note | ||
|
||
Work in progress. | ||
|
||
::: | ||
|
||
The `cdlOptions` are maps of option definitions. | ||
|
||
## Option name | ||
|
||
Component names are dash separated lower case words, preferably ASCII only. | ||
|
||
Examples: | ||
|
||
- `trace-utils-lists` | ||
|
||
## Option members | ||
|
||
The options objects has the following members: | ||
|
||
### `generatedDefinition` | ||
|
||
TBD | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
|
||
title: xCDL Metadata | ||
description: The members of the xCDL components | ||
keywords: | ||
- xpack | ||
- xcdl | ||
- cdl | ||
- component | ||
|
||
date: 2024-11-21 11:58:00 +0300 | ||
|
||
--- | ||
|
||
# xCDL Metadata | ||
|
||
:::note | ||
|
||
Work in progress. | ||
|
||
::: | ||
|
||
The xCDL metadata is a set of definitions used by `xcdl` to drive the | ||
configuration process. | ||
|
||
These definitions are stored in `package.json`, in the `xpack` object. | ||
|
||
## `minimumXcdlRequired` | ||
|
||
A string with a SemVer. | ||
|
||
Defines the minimum version of `xcdl` that can process the xCDL definitions. | ||
|
||
## `license` | ||
|
||
TBD | ||
|
||
## `copyright` | ||
|
||
TBD | ||
|
||
## `cdlComponents` | ||
|
||
TBD | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters