docs(site): mark up required/optional config

JamieMason · Feb 21, 2023 · 9137df2 · 9137df2
1 parent a17e423
commit 9137df2
Show file tree

Hide file tree

Showing 15 changed files with 87 additions and 0 deletions.
diff --git a/site/docs/config/custom-types.mdx b/site/docs/config/custom-types.mdx
@@ -3,8 +3,12 @@ id: custom-types
 title: customTypes
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `customTypes` object
 
+<Pills optional />
+
 Extend syncpack to find and fix versions in your packages which are not
 available by default. Custom types behave like any other dependency, so can be
 included in [versionGroups](./version-groups.mdx) or
@@ -35,6 +39,8 @@ The example below adds support for synchronising versions found in:
 
 ## customTypes\[name\]
 
+<Pills required />
+
 The key of each custom type is its name, this can be used in the following
 places to toggle when it is enabled:
 
@@ -45,11 +51,15 @@ places to toggle when it is enabled:
 
 ## customTypes\[name\].path
 
+<Pills required />
+
 Where the version can be found in each package.json file, such as `engines`,
 `packageManager` or `some.nested.property`.
 
 ## customTypes\[name\].strategy
 
+<Pills required />
+
 A strategy defines how syncpack needs to read and write dependency names and
 versions, there are 3 to choose from:
 

diff --git a/site/docs/config/dependency-types.mdx b/site/docs/config/dependency-types.mdx
@@ -4,9 +4,12 @@ title: dependencyTypes
 ---
 
 import DefaultDependencyTypes from '@site/src/partials/default-dependency-types.mdx';
+import Pills from '@site/src/components/pill';
 
 # `dependencyTypes` string[]
 
+<Pills optional />
+
 All of the [default dependency types](#default-dependency-types) are enabled by
 default, but can be reduced to a smaller list via the `dependencyTypes` property
 of your config file.

diff --git a/site/docs/config/filter.mdx b/site/docs/config/filter.mdx
@@ -3,8 +3,12 @@ id: filter
 title: filter
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `filter` string[]
 
+<Pills optional />
+
 A string which will be passed to `new RegExp()` to match against package names
 that should be included.
 

diff --git a/site/docs/config/indent.mdx b/site/docs/config/indent.mdx
@@ -3,8 +3,12 @@ id: indent
 title: indent
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `indent` string
 
+<Pills optional />
+
 The character(s) to be used to indent your package.json files when writing to
 disk.
 

diff --git a/site/docs/config/semver-groups.mdx b/site/docs/config/semver-groups.mdx
@@ -3,8 +3,12 @@ id: semver-groups
 title: semverGroups
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `semverGroups` object[]
 
+<Pills optional />
+
 Allow some packages to have different semver range rules to the rest of your
 monorepo. Each dependency can only belong to one semver group, the first rule
 which matches a given dependency and package will apply.
@@ -93,23 +97,33 @@ and peer dependencies 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).
diff --git a/site/docs/config/semver-range.mdx b/site/docs/config/semver-range.mdx
@@ -3,8 +3,12 @@ id: semver-range
 title: semverRange
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `semverRange` string
 
+<Pills optional />
+
 The semver range to be used consistently throughout your monorepo.
 
 ## Default Value

diff --git a/site/docs/config/sort-az.mdx b/site/docs/config/sort-az.mdx
@@ -3,8 +3,12 @@ id: sort-az
 title: sortAz
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `sortAz` string[]
 
+<Pills optional />
+
 When using the `format` command, determines which fields within package.json
 files should be sorted alphabetically. When the value is an Object, its keys are
 sorted alphabetically. When the value is an Array, its values are sorted

diff --git a/site/docs/config/sort-first.mdx b/site/docs/config/sort-first.mdx
@@ -3,8 +3,12 @@ id: sort-first
 title: sortFirst
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `sortFirst` string[]
 
+<Pills optional />
+
 When using the `format` command, determines which fields within package.json
 files should appear at the top, and in what order.
 

diff --git a/site/docs/config/source.mdx b/site/docs/config/source.mdx
@@ -3,8 +3,12 @@ id: source
 title: source
 ---
 
+import Pills from '@site/src/components/pill';
+
 # `source` string[]
 
+<Pills optional />
+
 Patterns supported by [glob](https://github.com/isaacs/node-glob) to find
 package.json files you want to manage with syncpack.
 

diff --git a/site/docs/option/config.mdx b/site/docs/option/config.mdx
@@ -3,6 +3,12 @@ id: config
 title: --config
 ---
 
+import Pills from '@site/src/components/pill';
+
+# `--config` string
+
+<Pills optional />
+
 If your [configuration file](../config-file.mdx) is not in the root of your
 monorepo or one of it's ancestor directories, you can specify its location via
 the --config option.

diff --git a/site/docs/option/filter.mdx b/site/docs/option/filter.mdx
@@ -3,6 +3,12 @@ id: filter
 title: --filter
 ---
 
+import Pills from '@site/src/components/pill';
+
+# `--filter` string
+
+<Pills optional />
+
 A string which will be passed to `new RegExp()` to match against package names
 that should be included. This is useful alongside [`syncpack list`](../list.mdx)
 to check the status of a subset of dependencies throughout your monorepo.

diff --git a/site/docs/option/indent.mdx b/site/docs/option/indent.mdx
@@ -3,6 +3,12 @@ id: indent
 title: --indent
 ---
 
+import Pills from '@site/src/components/pill';
+
+# `--indent` string
+
+<Pills optional />
+
 The character(s) to be used to indent your package.json files when writing to
 disk. This can be used to override your [`indent`](../config/indent.mdx)
 configuration on an ad hoc basis.

diff --git a/site/docs/option/semver-range.mdx b/site/docs/option/semver-range.mdx
@@ -3,6 +3,12 @@ id: semver-range
 title: --semver-range
 ---
 
+import Pills from '@site/src/components/pill';
+
+# `--semver-range` string
+
+<Pills optional />
+
 Can be used with [`syncpack set-semver-ranges`](../set-semver-ranges.mdx) and
 [`syncpack lint-semver-ranges`](../lint-semver-ranges.mdx) to override your
 [`semverRange`](../config/semver-range.mdx) configuration on an ad hoc basis.

diff --git a/site/docs/option/source.mdx b/site/docs/option/source.mdx
@@ -3,6 +3,12 @@ id: source
 title: --source
 ---
 
+import Pills from '@site/src/components/pill';
+
+# `--source` string[]
+
+<Pills optional />
+
 Override your [`source`](../config/source.mdx) configuration on an ad hoc basis.
 
 This can be useful when you only want to deal with one package at a single time,

diff --git a/site/docs/option/types.mdx b/site/docs/option/types.mdx
@@ -3,6 +3,12 @@ id: types
 title: --types
 ---
 
+import Pills from '@site/src/components/pill';
+
+# `--types` string
+
+<Pills optional />
+
 Override your [`dependencyTypes`](../config/dependency-types.mdx) configuration
 on an ad hoc basis.