-
-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(site): create folder for semver groups
- Loading branch information
1 parent
f6bcc5e
commit cfde196
Showing
4 changed files
with
123 additions
and
32 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
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,52 @@ | ||
--- | ||
id: ignored | ||
title: Ignored | ||
--- | ||
|
||
import Pills from '@site/src/components/pill'; | ||
import Packages from '@site/src/partials/version-group-config/packages.mdx'; | ||
import Dependencies from '@site/src/partials/version-group-config/dependencies.mdx'; | ||
import DependencyTypes from '@site/src/partials/version-group-config/dependency-types.mdx'; | ||
import Label from '@site/src/partials/version-group-config/label.mdx'; | ||
|
||
# Ignored | ||
|
||
Have syncpack ignore these dependencies completely. | ||
|
||
:::info | ||
|
||
One of the possible values for the [`semverGroups`](../semver-groups.mdx) configuration array. | ||
|
||
::: | ||
|
||
## `isIgnored` boolean | ||
|
||
<Pills required /> | ||
|
||
```json title="Hide dependencies from syncpack" | ||
{ | ||
"semverGroups": [ | ||
{ | ||
"packages": ["oops-moment", "workaround"], | ||
"dependencies": ["**"], | ||
"isIgnored": true | ||
} | ||
] | ||
} | ||
``` | ||
|
||
## `packages` string[] | ||
|
||
<Packages /> | ||
|
||
## `dependencies` string[] | ||
|
||
<Dependencies /> | ||
|
||
## `dependencyTypes` string[] | ||
|
||
<DependencyTypes /> | ||
|
||
## `label` string | ||
|
||
<Label /> |
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,54 @@ | ||
--- | ||
id: standard | ||
title: Standard | ||
--- | ||
|
||
import Pills from '@site/src/components/pill'; | ||
import Packages from '@site/src/partials/version-group-config/packages.mdx'; | ||
import Dependencies from '@site/src/partials/version-group-config/dependencies.mdx'; | ||
import DependencyTypes from '@site/src/partials/version-group-config/dependency-types.mdx'; | ||
import Label from '@site/src/partials/version-group-config/label.mdx'; | ||
|
||
# Standard | ||
|
||
Ensure all dependencies within this group have the specified semver range. | ||
|
||
:::info | ||
|
||
One of the possible values for the [`semverGroups`](../semver-groups.mdx) configuration array. | ||
|
||
::: | ||
|
||
## `semverGroup.range` | ||
|
||
<Pills required /> | ||
|
||
Which of the [Supported Ranges](../semver-range.mdx#supported-ranges) this group should use. | ||
|
||
```json title=".syncpackrc" | ||
{ | ||
"semverGroups": [ | ||
{ | ||
"range": "~", | ||
"dependencies": ["@alpha/**"], | ||
"packages": ["**"] | ||
} | ||
] | ||
} | ||
``` | ||
|
||
## `packages` string[] | ||
|
||
<Packages /> | ||
|
||
## `dependencies` string[] | ||
|
||
<Dependencies /> | ||
|
||
## `dependencyTypes` string[] | ||
|
||
<DependencyTypes /> | ||
|
||
## `label` string | ||
|
||
<Label /> |
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