Skip to content

Commit e435e21

Browse files
JamieMasonJamieMason
committed
docs(site): update glossary and status codes
1 parent 0887bd3 commit e435e21

37 files changed

+179
-99
lines changed

‎site/astro.config.mjs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,10 @@ export default defineConfig({
134134

135135
return function transformer(tree) {
136136
visit(tree, 'link', node => {
137-
if (linksById[node.url]) {
138-
node.url = linksById[node.url];
137+
const [id, hash] = node.url.split('#');
138+
const link = linksById[id];
139+
if (link) {
140+
node.url = hash ? `${link}#${hash}` : link;
139141
}
140142
});
141143
return tree;

‎site/src/content/docs/reference/glossary.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Glossary
33
slug: glossary
44
---
55

6+
## Complex Semver
7+
8+
A semver version with conditional logic, such as `^1.2.3-alpha || ~1.2.3-rc.1`.
9+
610
## Custom Type
711

812
A user-defined configuration that extends syncpack to manage parts of your package.json files beyond the default dependency types. Custom types behave identically to the default dependency types (such as `prod` or `peer`) but allow you to manage additional sections like `engines`, `packageManager`, or arbitrary nested properties.
@@ -30,6 +34,10 @@ A specific occurrence of a dependency in your monorepo, for example:
3034

3135
There are 5 "instances" of the 1 "dependency" `uuid`.
3236

37+
## Local Instance
38+
39+
A specific occurrence of a dependency in your monorepo that is defined by the package's own `version` property. This is a package developed internally within your monorepo.
40+
3341
## Package
3442

3543
A module within your monorepo defined by a package.json file. In a monorepo, you typically have multiple packages that may depend on each other and on external dependencies.
@@ -42,6 +50,10 @@ A configuration file for syncpack (typically `.syncpackrc`, `.syncpackrc.js`, `.
4250

4351
A configuration that defines how semver ranges should be formatted for a specific set of dependencies. For example, you might want production dependencies to use exact versions (`1.2.3`) while development dependencies use caret ranges (`^1.2.3`).
4452

53+
## Semver Number
54+
55+
The version number portion of the version specifier, such as `1.2.3`, excluding any [Semver Range](#semver-range) that may be present.
56+
4557
## Semver Range
4658

4759
A pattern that specifies which versions of a dependency are acceptable. Common ranges include exact (`1.2.3`), caret (`^1.2.3`, which allows compatible minor and patch updates), and tilde (`~1.2.3`, which allows compatible patch updates).
@@ -50,6 +62,10 @@ A pattern that specifies which versions of a dependency are acceptable. Common r
5062

5163
Semantic Versioning, a versioning scheme that uses a three-part number (MAJOR.MINOR.PATCH) to convey meaning about the underlying changes. Major versions indicate breaking changes, minor versions indicate new features without breaking changes, and patch versions indicate bug fixes.
5264

65+
## Simple Semver
66+
67+
A typical semver version such as `1.2.3`, `^1.2.3`, or `1.2.3.alpha`.
68+
5369
## Specifier
5470

5571
The full version string for a dependency, including any prefixes or range indicators. Examples include `^1.2.3`, `~1.2.3`, `>=1.0.0`, `1.x`, and `*`.

‎site/src/content/docs/status/depends-on-invalid-local-package.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
21
---
32
title: DependsOnInvalidLocalPackage
43
status: unfixable
54
---
65

6+
## When this happens
7+
8+
- ✓ Instance is in a [Highest Semver](VERSION_GROUP_HIGHEST_SEMVER) or [Lowest Semver](VERSION_GROUP_LOWEST_SEMVER) version group
79
- ✘ Instance depends on a local package whose package.json version is not exact semver
810
- ? We can't know what the version should be

‎site/src/content/docs/status/depends-on-missing-snap-target.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
21
---
32
title: DependsOnMissingSnapTarget
43
status: suspect
54
---
65

7-
- ✓ Instance is in a snapped to version group
6+
## When this happens
7+
8+
- ✓ Instance is in a [Snapped To](VERSION_GROUP_SNAPPED_TO) version group
89
- ✘ An instance of the same dependency was not found in any of the snapped to packages
910
- ! This is a misconfiguration resulting in this instance being orphaned

‎site/src/content/docs/status/differs-to-highest-or-lowest-semver.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
21
---
32
title: DiffersToHighestOrLowestSemver
43
status: fixable
54
---
65

6+
## When this happens
7+
8+
- ✓ Instance is in a [Highest Semver](VERSION_GROUP_HIGHEST_SEMVER) or [Lowest Semver](VERSION_GROUP_LOWEST_SEMVER) version group
79
- ✘ Instance mismatches highest/lowest semver in its group

‎site/src/content/docs/status/differs-to-local.mdx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
21
---
32
title: DiffersToLocal
43
status: fixable
54
---
65

7-
- ✘ Instance mismatches the version of its locally-developed package
6+
## When this happens
7+
8+
- ✓ Instance is in a [Highest Semver](VERSION_GROUP_HIGHEST_SEMVER) or [Lowest Semver](VERSION_GROUP_LOWEST_SEMVER) version group
9+
- ✘ Instance mismatches the version of its [Local Instance](REF_GLOSSARY#local-instance)

‎site/src/content/docs/status/differs-to-npm-registry.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
21
---
32
title: DiffersToNpmRegistry
43
status: fixable
54
---
65

6+
## When this happens
7+
8+
- ✓ Instance is in a [Highest Semver](VERSION_GROUP_HIGHEST_SEMVER) or [Lowest Semver](VERSION_GROUP_LOWEST_SEMVER) version group
79
- ✘ Instance is older than highest semver published to the registry

‎site/src/content/docs/status/differs-to-pin.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
21
---
32
title: DiffersToPin
43
status: fixable
54
---
65

6+
## When this happens
7+
8+
- ✓ Instance is in a [Pinned](VERSION_GROUP_PINNED) version group
79
- ✘ Instance mismatches its pinned version group

‎site/src/content/docs/status/differs-to-snap-target.mdx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
21
---
32
title: DiffersToSnapTarget
43
status: fixable
54
---
65

7-
- ✘ Instance mismatches the matching snapTo instance
6+
## When this happens
7+
8+
- ✓ Instance is in a [Snapped To](VERSION_GROUP_SNAPPED_TO) version group
9+
- ✘ Instance mismatches the matching [snapTo](VERSION_GROUP_SNAPPED_TO#snapto) instance

‎site/src/content/docs/status/invalid-local-version.mdx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
21
---
32
title: InvalidLocalVersion
43
status: suspect
54
---
65

7-
- ! Local Instance has no version property
6+
## When this happens
7+
8+
- ✓ Instance is in a [Highest Semver](VERSION_GROUP_HIGHEST_SEMVER) or [Lowest Semver](VERSION_GROUP_LOWEST_SEMVER) version group
9+
- ! [Local Instance](REF_GLOSSARY#local-instance) has no version property
810
- ! Not an error on its own unless an instance of it mismatches

0 commit comments

Comments
 (0)