Skip to content

Commit

Permalink
update jsdoc2md
Browse files Browse the repository at this point in the history
  • Loading branch information
mmason2-godaddy committed Nov 30, 2023
1 parent f43f777 commit 96e97c3
Show file tree
Hide file tree
Showing 8 changed files with 237 additions and 98 deletions.
184 changes: 92 additions & 92 deletions package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/gasket-helper-intl/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"eslint-plugin-json": "^3.1.0",
"eslint-plugin-unicorn": "^44.0.0",
"jest": "^29.3.1",
"jsdoc-to-markdown": "^7.1.0",
"jsdoc-to-markdown": "^8.0.0",
"setup-env": "^2.0.0"
},
"eslintConfig": {
Expand Down
2 changes: 1 addition & 1 deletion packages/gasket-plugin-command/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"eslint-plugin-json": "^3.1.0",
"eslint-plugin-unicorn": "^44.0.0",
"jest": "^29.3.1",
"jsdoc-to-markdown": "^7.1.0"
"jsdoc-to-markdown": "^8.0.0"
},
"peerDependencies": {
"@oclif/config": "^1.13.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/gasket-plugin-docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"eslint-plugin-json": "^3.1.0",
"eslint-plugin-unicorn": "^44.0.0",
"jest": "^29.3.1",
"jsdoc-to-markdown": "^7.1.0"
"jsdoc-to-markdown": "^8.0.0"
},
"eslintConfig": {
"extends": [
Expand Down
139 changes: 139 additions & 0 deletions packages/gasket-plugin-metadata/docs/api.md
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
2 changes: 1 addition & 1 deletion packages/gasket-plugin-metadata/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"eslint-plugin-json": "^3.1.0",
"eslint-plugin-unicorn": "^44.0.0",
"jest": "^29.3.1",
"jsdoc-to-markdown": "^7.1.0"
"jsdoc-to-markdown": "^8.0.0"
},
"eslintConfig": {
"extends": [
Expand Down
2 changes: 1 addition & 1 deletion packages/gasket-resolve/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"eslint-plugin-mocha": "^10.0.3",
"eslint-plugin-unicorn": "^44.0.0",
"jest": "^29.3.1",
"jsdoc-to-markdown": "^7.1.0"
"jsdoc-to-markdown": "^8.0.0"
},
"eslintConfig": {
"extends": [
Expand Down
2 changes: 1 addition & 1 deletion packages/gasket-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"eslint-plugin-json": "^3.1.0",
"eslint-plugin-unicorn": "^44.0.0",
"jest": "^29.3.1",
"jsdoc-to-markdown": "^7.1.0"
"jsdoc-to-markdown": "^8.0.0"
},
"eslintConfig": {
"extends": [
Expand Down

0 comments on commit 96e97c3

Please sign in to comment.