Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat!: release 1.0.0 with moveAllComponents option #252

Merged
merged 5 commits into from Apr 17, 2024
Merged

feat!: release 1.0.0 with moveAllComponents option #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
51e899d
feat: rename flag `moveToComponents` -> `moveDuplicatesToComponents` …
aeworxet Jan 9, 2024
1427b29
chore: rebase branch `master` into `next` (#234)
aeworxet Mar 15, 2024
0958b77
feat: rename flag move to components to move duplicates to components…
aeworxet Mar 15, 2024
d10b7a1
feat: add flag `moveAllToComponents` (#216)
aeworxet Apr 16, 2024
9f7ed78
Merge branch 'master' into next
KhudaDad414 Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .sonarcloud.properties
View file
Open in desktop
@@ -0,0 +1 @@
sonar.exclusions=test/**/*
30 changes: 28 additions & 2 deletions API.md
View file
Open in desktop
Expand Up @@ -10,6 +10,8 @@ user will only interact with this class. here we generate different kind of repo
## Functions

<dl>
<dt><a href="#findAllComponents">findAllComponents(optimizableComponentGroup)</a> ⇒</dt>
<dd></dd>
<dt><a href="#findDuplicateComponents">findDuplicateComponents(optimizableComponentGroup)</a> ⇒</dt>
<dd></dd>
<dt><a href="#hasParent">hasParent()</a></dt>
Expand All @@ -33,6 +35,8 @@ user will only interact with this class. here we generate different kind of repo
<dl>
<dt><a href="#Rules">Rules</a> : <code>Object</code></dt>
<dd></dd>
<dt><a href="#DisableOptimizationFor">DisableOptimizationFor</a> : <code>Object</code></dt>
<dd></dd>
<dt><a href="#Options">Options</a> : <code>Object</code></dt>
<dd></dd>
</dl>
Expand Down Expand Up @@ -76,6 +80,16 @@ This function is used to get the optimized document after seeing the report.
| --- | --- | --- |
| [Options] | [<code>Options</code>](#Options) | the options are a way to customize the final output. |

<a name="findAllComponents"></a>

## findAllComponents(optimizableComponentGroup) ⇒
**Kind**: global function
**Returns**: A list of optimization report elements.

| Param | Description |
| --- | --- |
| optimizableComponentGroup | all AsyncAPI Specification-valid components. |

<a name="findDuplicateComponents"></a>

## findDuplicateComponents(optimizableComponentGroup) ⇒
Expand All @@ -84,7 +98,7 @@ This function is used to get the optimized document after seeing the report.

| Param | Description |
| --- | --- |
| optimizableComponentGroup | components that you want to analyze for duplicates. |
| optimizableComponentGroup | all AsyncAPI Specification-valid components that you want to analyze for duplicates. |

<a name="hasParent"></a>

Expand Down Expand Up @@ -132,7 +146,18 @@ Converts JSON or YAML string object.
| --- | --- | --- |
| [reuseComponents] | <code>Boolean</code> | whether to reuse components from `components` section or not. Defaults to `true`. |
| [removeComponents] | <code>Boolean</code> | whether to remove un-used components from `components` section or not. Defaults to `true`. |
| [moveToComponents] | <code>Boolean</code> | whether to move duplicated components to the `components` section or not. Defaults to `true`. |
| [moveAllToComponents] | <code>Boolean</code> | whether to move all AsyncAPI Specification-valid components to the `components` section or not. Defaults to `true`. |
| [moveDuplicatesToComponents] | <code>Boolean</code> | whether to move duplicated components to the `components` section or not. Defaults to `false`. |

<a name="DisableOptimizationFor"></a>

## DisableOptimizationFor : <code>Object</code>
**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| [schema] | <code>Boolean</code> | whether object `schema` should be excluded from the process of optimization (`true` instructs **not** to add calculated `schemas` to the optimized AsyncAPI Document.) |

<a name="Options"></a>

Expand All @@ -144,4 +169,5 @@ Converts JSON or YAML string object.
| --- | --- | --- |
| [rules] | [<code>Rules</code>](#Rules) | the list of rules that specifies which type of optimizations should be applied. |
| [output] | <code>String</code> | specifies which type of output user wants, `'JSON'` or `'YAML'`. Defaults to `'YAML'`; |
| [disableOptimizationFor] | [<code>DisableOptimizationFor</code>](#DisableOptimizationFor) | the list of objects that should be excluded from the process of optimization. |