Skip to content

Commit

Permalink
docs(site): create folder for semver groups
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieMason committed Jul 2, 2023
1 parent f6bcc5e commit cfde196
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 32 deletions.
37 changes: 6 additions & 31 deletions site/docs/config/semver-groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ Allow some packages to have different semver range rules to the rest of your mon
dependency can only belong to one semver group, the first rule which matches a given dependency and
package will apply.

There are 2 types of version groups:

- [Ignored](./semver-groups/ignored.mdx)
- [Standard](./semver-groups/standard.mdx)

## Example use cases

1: Every dependency of `@myrepo/library` should have a semver range of `~`, regardless of what the
Expand Down Expand Up @@ -67,7 +72,7 @@ of `^`, regardless of what the rest of that package or the rest of the monorepo
}
```

3: Production dependencies should have fixed version numbers, but development and peer dependencies
4: Production dependencies should have fixed version numbers, but development and peer dependencies
can be broader.

```json title=".syncpackrc"
Expand All @@ -94,33 +99,3 @@ can be broader.
]
}
```

## `semverGroup.range`

<Pills required />

Which of the [Supported Ranges](./semver-range.mdx#supported-ranges) this group should use.

## `semverGroup.dependencies`

<Pills required />

Works the same as [`versionGroup.dependencies`](./version-groups.mdx#dependencies).

## `semverGroup.isIgnored`

<Pills optional />

Works the same as [`versionGroup.isIgnored`](./version-groups.mdx#isignored).

## `semverGroup.packages`

<Pills required />

Works the same as [`versionGroup.packages`](./version-groups.mdx#packages).

## `semverGroup.dependencyTypes`

<Pills optional />

Works the same as [`versionGroup.dependencyTypes`](./version-groups.mdx#dependencytypes).
52 changes: 52 additions & 0 deletions site/docs/config/semver-groups/ignored.mdx
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 />
54 changes: 54 additions & 0 deletions site/docs/config/semver-groups/standard.mdx
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 />
12 changes: 11 additions & 1 deletion site/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,17 @@ const sidebars = {
'config/dependency-types',
'config/filter',
'config/indent',
'config/semver-groups',
{
type: 'category',
label: 'semverGroups',
collapsible: true,
collapsed: false,
link: {
type: 'doc',
id: 'config/semver-groups',
},
items: ['config/semver-groups/ignored', 'config/semver-groups/standard'],
},
'config/semver-range',
'config/sort-az',
'config/sort-first',
Expand Down

0 comments on commit cfde196

Please sign in to comment.