Skip to content

Commit cfa368e

Browse files
3.0.0
1 parent 6923391 commit cfa368e

11 files changed

+37
-31
lines changed

Diff for: CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
66

77
## [Unreleased]
88

9+
## [3.0.0] - 2021-04-03
10+
911
### Changed
1012
- Removed `esm` loader in favour of native ESM support.
1113
- Raised minimum NodeJS version from 10 to 12.17.0.

Diff for: docs/api/merge-package-dependencies.bower.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ export declare function bower<TTemplate extends IBowerTemplate>(template: TTempl
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| template | <code>TTemplate</code> | Template that packages will be merged into. Is validated with \[bower-json\](https://www.npmjs.com/package/bower-json). |
20-
| paths | <code>string[]</code> | Paths to bower.json files. EG: "path/to/" (bower.json is prepended) or "path/to/bower.json" or "path/to/different.json". |
21-
| saveTo | <code>string &#124; null</code> | If string, saves the generated bower.json to the specified path. Like 'paths', has 'bower.json' prepended if required. |
22-
| log | <code>LogOption</code> | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
19+
| template | TTemplate | Template that packages will be merged into. Is validated with \[bower-json\](https://www.npmjs.com/package/bower-json). |
20+
| paths | string\[\] | Paths to bower.json files. EG: "path/to/" (bower.json is prepended) or "path/to/bower.json" or "path/to/different.json". |
21+
| saveTo | string \| null | If string, saves the generated bower.json to the specified path. Like 'paths', has 'bower.json' prepended if required. |
22+
| log | [LogOption](./merge-package-dependencies.logoption.md) | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
2323

2424
<b>Returns:</b>
2525

26-
`TTemplate`
26+
TTemplate
2727

Diff for: docs/api/merge-package-dependencies.ibowertemplate.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ export interface IBowerTemplate
1515

1616
| Property | Type | Description |
1717
| --- | --- | --- |
18-
| [dependencies](./merge-package-dependencies.ibowertemplate.dependencies.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
19-
| [devDependencies](./merge-package-dependencies.ibowertemplate.devdependencies.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
20-
| [name](./merge-package-dependencies.ibowertemplate.name.md) | <code>string</code> | |
21-
| [resolutions](./merge-package-dependencies.ibowertemplate.resolutions.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
18+
| [dependencies?](./merge-package-dependencies.ibowertemplate.dependencies.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
19+
| [devDependencies?](./merge-package-dependencies.ibowertemplate.devdependencies.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
20+
| [name](./merge-package-dependencies.ibowertemplate.name.md) | string | |
21+
| [resolutions?](./merge-package-dependencies.ibowertemplate.resolutions.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
2222

Diff for: docs/api/merge-package-dependencies.inodetemplate.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ export interface INodeTemplate
1515

1616
| Property | Type | Description |
1717
| --- | --- | --- |
18-
| [dependencies](./merge-package-dependencies.inodetemplate.dependencies.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
19-
| [devDependencies](./merge-package-dependencies.inodetemplate.devdependencies.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
20-
| [name](./merge-package-dependencies.inodetemplate.name.md) | <code>string</code> | |
21-
| [peerDependencies](./merge-package-dependencies.inodetemplate.peerdependencies.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
22-
| [private](./merge-package-dependencies.inodetemplate.private.md) | <code>boolean</code> | |
23-
| [resolutions](./merge-package-dependencies.inodetemplate.resolutions.md) | <code>{</code><br/><code> [x: string]: string;</code><br/><code> }</code> | |
24-
| [version](./merge-package-dependencies.inodetemplate.version.md) | <code>string</code> | |
18+
| [dependencies?](./merge-package-dependencies.inodetemplate.dependencies.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
19+
| [devDependencies?](./merge-package-dependencies.inodetemplate.devdependencies.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
20+
| [name?](./merge-package-dependencies.inodetemplate.name.md) | string | <i>(Optional)</i> |
21+
| [peerDependencies?](./merge-package-dependencies.inodetemplate.peerdependencies.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
22+
| [private?](./merge-package-dependencies.inodetemplate.private.md) | boolean | <i>(Optional)</i> |
23+
| [resolutions?](./merge-package-dependencies.inodetemplate.resolutions.md) | { \[x: string\]: string; } | <i>(Optional)</i> |
24+
| [version?](./merge-package-dependencies.inodetemplate.version.md) | string | <i>(Optional)</i> |
2525

Diff for: docs/api/merge-package-dependencies.invalidbowerpackageexception.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@
1010
```typescript
1111
export declare class InvalidBowerPackageException extends LogicalException
1212
```
13+
<b>Extends:</b> LogicalException
14+

Diff for: docs/api/merge-package-dependencies.invalidnodepackageexception.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@
1010
```typescript
1111
export declare class InvalidNodePackageException extends LogicalException
1212
```
13+
<b>Extends:</b> LogicalException
14+

Diff for: docs/api/merge-package-dependencies.npm.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ export declare function npm<TTemplate extends INodeTemplate>(template: TTemplate
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| template | <code>TTemplate</code> | Template that packages will be merged into. Is validated with \[package-json-validator\](https://www.npmjs.com/package/package-json-validator) with template.private == true overriding this. |
20-
| paths | <code>string[]</code> | Paths to package.json files. EG: "path/to/" (package.json is prepended) or "path/to/package.json" or "path/to/different.json". |
21-
| saveTo | <code>string &#124; null</code> | If string, saves the generated package.json to the specified path. Like 'paths', has 'package.json' prepended if required. |
22-
| log | <code>LogOption</code> | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
19+
| template | TTemplate | Template that packages will be merged into. Is validated with \[package-json-validator\](https://www.npmjs.com/package/package-json-validator) with template.private == true overriding this. |
20+
| paths | string\[\] | Paths to package.json files. EG: "path/to/" (package.json is prepended) or "path/to/package.json" or "path/to/different.json". |
21+
| saveTo | string \| null | If string, saves the generated package.json to the specified path. Like 'paths', has 'package.json' prepended if required. |
22+
| log | [LogOption](./merge-package-dependencies.logoption.md) | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
2323

2424
<b>Returns:</b>
2525

26-
`TTemplate`
26+
TTemplate
2727

Diff for: docs/api/merge-package-dependencies.yarn.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ export declare function yarn<TTemplate extends INodeTemplate>(template: TTemplat
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| template | <code>TTemplate</code> | Template that packages will be merged into. Is validated with \[package-json-validator\](https://www.npmjs.com/package/package-json-validator) with template.private == true overriding this. |
20-
| paths | <code>string[]</code> | Paths to package.json files. EG: "path/to/" (package.json is prepended) or "path/to/package.json" or "path/to/different.json". |
21-
| saveTo | <code>string &#124; null</code> | If string, saves the generated package.json to the specified path. Like 'paths', has 'package.json' prepended if required. |
22-
| log | <code>LogOption</code> | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
19+
| template | TTemplate | Template that packages will be merged into. Is validated with \[package-json-validator\](https://www.npmjs.com/package/package-json-validator) with template.private == true overriding this. |
20+
| paths | string\[\] | Paths to package.json files. EG: "path/to/" (package.json is prepended) or "path/to/package.json" or "path/to/different.json". |
21+
| saveTo | string \| null | If string, saves the generated package.json to the specified path. Like 'paths', has 'package.json' prepended if required. |
22+
| log | [LogOption](./merge-package-dependencies.logoption.md) | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
2323

2424
<b>Returns:</b>
2525

26-
`TTemplate`
26+
TTemplate
2727

Diff for: docs/api/merge-package-dependencies.yarnisflat.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ export declare function yarnIsFlat(p?: string, log?: LogOption): boolean;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| p | <code>string</code> | Directory of <code>yarn.lock</code>. |
20-
| log | <code>LogOption</code> | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
19+
| p | string | Directory of <code>yarn.lock</code>. |
20+
| log | [LogOption](./merge-package-dependencies.logoption.md) | If true, progress and errors will be logged. Has no affect on exceptions thrown. |
2121

2222
<b>Returns:</b>
2323

24-
`boolean`
24+
boolean
2525

Diff for: package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@userfrosting/merge-package-dependencies",
3-
"version": "2.1.0",
3+
"version": "3.0.0",
44
"description": "Merge NPM, Yarn or Bower package dependencies into one package, with semver rules respected.",
55
"funding": "https://opencollective.com/userfrosting",
66
"type": "module",

0 commit comments

Comments
 (0)