-
Notifications
You must be signed in to change notification settings - Fork 77
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
1 parent
f43f777
commit 96e97c3
Showing
8 changed files
with
237 additions
and
98 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
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,139 @@ | ||
|
||
## Typedefs | ||
|
||
Name | Description | ||
------ | ----------- | ||
[ModuleData] | Module with meta data | ||
[AppData] | App module with meta data | ||
[PluginData] | Plugin module with meta data | ||
[PresetData] | Preset module with meta data | ||
[DetailData] | Metadata for details of a plugin | ||
[LifecycleData] | Metadata with specifics details for plugin lifecycles | ||
[ConfigurationsData] | Metadata for plugin configuration properties | ||
[Metadata] | Collection data for modules configured for app | ||
|
||
|
||
## ModuleData | ||
|
||
Module with meta data | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| name | `string` | Name of preset | | ||
| module | `string` | Actual module content | | ||
| \[package\] | `string` | Package.json contents | | ||
| \[version\] | `string` | Resolved version | | ||
| \[path\] | `string` | Path to the root of package | | ||
| \[from\] | `string` | Name of module which requires this module | | ||
| \[range\] | `string` | Range by which this module was required | | ||
| \[link\] | `string` | Path to a doc file or URL | | ||
|
||
|
||
## AppData | ||
|
||
App module with meta data | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| \[modules\] | `Array.<DetailData>` | Description of modules supporting this plugin | | ||
|
||
|
||
## PluginData | ||
|
||
Plugin module with meta data | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| \[commands\] | `Array.<DetailData>` | Commands enabled by this plugin | | ||
| \[structures\] | `Array.<DetailData>` | App files and directories used by plugin | | ||
| \[lifecycles\] | `Array.<DetailData>` | Description of lifecycles invoked by plugin | | ||
| \[modules\] | `Array.<DetailData>` | Description of modules supporting this plugin | | ||
|
||
|
||
## PresetData | ||
|
||
Preset module with meta data | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| \[presets\] | `Array.<PresetData>` | Presets that this preset extends | | ||
| plugins | `Array.<PluginData>` | Plugins this preset uses | | ||
|
||
|
||
## DetailData | ||
|
||
Metadata for details of a plugin | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| name | `string` | Name of the the module or element | | ||
| \[description\] | `string` | Description of the module or element | | ||
| \[link\] | `string` | Path to a doc file or URL | | ||
|
||
|
||
## LifecycleData | ||
|
||
Metadata with specifics details for plugin lifecycles | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| method | `string` | Executing method from the engine | | ||
| \[parent\] | `string` | Lifecycle from which this one is invoked | | ||
| \[command\] | `string` | Command from which this lifecycle is invoked | | ||
|
||
|
||
## ConfigurationsData | ||
|
||
Metadata for plugin configuration properties | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| type | `string` | Configuration property type | | ||
|
||
|
||
## Metadata | ||
|
||
Collection data for modules configured for app | ||
|
||
**Kind**: global typedef | ||
**Properties** | ||
|
||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| app | [`AppData`] | App and main package data | | ||
| presets | `Array.<PresetData>` | Preset data with dependency hierarchy | | ||
| plugins | `Array.<PluginData>` | Flat list of registered plugin data | | ||
| modules | `Array.<ModuleData>` | Supporting module data | | ||
|
||
<!-- LINKS --> | ||
|
||
[ModuleData]:#moduledata | ||
[AppData]:#appdata | ||
[PluginData]:#plugindata | ||
[PresetData]:#presetdata | ||
[DetailData]:#detaildata | ||
[LifecycleData]:#lifecycledata | ||
[ConfigurationsData]:#configurationsdata | ||
[Metadata]:#metadata | ||
[`AppData`]:#appdata |
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
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
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