docs(site): document specifierTypes

JamieMason · Dec 30, 2023 · ef70ce1 · ef70ce1
1 parent e0cb0ef
commit ef70ce1
Show file tree

Hide file tree

Showing 23 changed files with 201 additions and 9 deletions.
diff --git a/site/src/components/details.astro b/site/src/components/details.astro
@@ -6,3 +6,10 @@ const { title } = Astro.props;
   <summary>{title}</summary>
   <slot />
 </details>
+
+<style>
+  summary {
+    font-weight: bold;
+    cursor: pointer;
+  }
+</style>
diff --git a/site/src/content/docs/command/fix-mismatches.mdx b/site/src/content/docs/command/fix-mismatches.mdx
@@ -7,6 +7,7 @@ import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import IndentOption from '@site/partials/option/_indent.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -26,6 +27,10 @@ Ensure that multiple packages requiring the same dependency define the same vers
 
 <ConfigOption command="fix-mismatches" />
 
+### specs
+
+<SpecsOption command="fix-mismatches" />
+
 ### types
 
 <TypesOption command="fix-mismatches" />

diff --git a/site/src/content/docs/command/lint-semver-ranges.mdx b/site/src/content/docs/command/lint-semver-ranges.mdx
@@ -7,6 +7,7 @@ import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import IndentOption from '@site/partials/option/_indent.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -26,6 +27,10 @@ Check whether dependency versions used within "dependencies", "devDependencies"
 
 <ConfigOption command="lint-semver-ranges" />
 
+### specs
+
+<SpecsOption command="lint-semver-ranges" />
+
 ### types
 
 <TypesOption command="lint-semver-ranges" />

diff --git a/site/src/content/docs/command/list-mismatches.mdx b/site/src/content/docs/command/list-mismatches.mdx
@@ -6,6 +6,7 @@ import ConfigOption from '@site/partials/option/_config.mdx';
 import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -25,6 +26,10 @@ List dependencies which are required by multiple packages, where the version is
 
 <ConfigOption command="list-mismatches" />
 
+### specs
+
+<SpecsOption command="list-mismatches" />
+
 ### types
 
 <TypesOption command="list-mismatches" />

diff --git a/site/src/content/docs/command/list.mdx b/site/src/content/docs/command/list.mdx
@@ -6,6 +6,7 @@ import ConfigOption from '@site/partials/option/_config.mdx';
 import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -25,6 +26,10 @@ List all dependencies required by your packages.
 
 <ConfigOption command="list" />
 
+### specs
+
+<SpecsOption command="list" />
+
 ### types
 
 <TypesOption command="list" />

diff --git a/site/src/content/docs/command/prompt.mdx b/site/src/content/docs/command/prompt.mdx
@@ -6,6 +6,7 @@ import ConfigOption from '@site/partials/option/_config.mdx';
 import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -25,6 +26,10 @@ Displays a series of prompts to fix mismatches which syncpack cannot fix automat
 
 <ConfigOption command="prompt" />
 
+### specs
+
+<SpecsOption command="prompt" />
+
 ### types
 
 <TypesOption command="prompt" />

diff --git a/site/src/content/docs/command/set-semver-ranges.mdx b/site/src/content/docs/command/set-semver-ranges.mdx
@@ -7,6 +7,7 @@ import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import IndentOption from '@site/partials/option/_indent.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -26,6 +27,10 @@ Ensure dependency versions used within `"dependencies"`, `"devDependencies"` etc
 
 <ConfigOption command="set-semver-ranges" />
 
+### specs
+
+<SpecsOption command="set-semver-ranges" />
+
 ### types
 
 <TypesOption command="set-semver-ranges" />

diff --git a/site/src/content/docs/command/update.mdx b/site/src/content/docs/command/update.mdx
@@ -6,6 +6,7 @@ import ConfigOption from '@site/partials/option/_config.mdx';
 import FilterOption from '@site/partials/option/_filter.mdx';
 import HelpOption from '@site/partials/option/_help.mdx';
 import SourceOption from '@site/partials/option/_source.mdx';
+import SpecsOption from '@site/partials/option/_specs.mdx';
 import TypesOption from '@site/partials/option/_types.mdx';
 import LogLevelOption from '@site/partials/option/_log-level.mdx';
 
@@ -25,6 +26,10 @@ Interactively update packages to the latest versions from the npm registry.
 
 <ConfigOption command="update" />
 
+### specs
+
+<SpecsOption command="update" />
+
 ### types
 
 <TypesOption command="update" />

diff --git a/site/src/content/docs/config/semver-groups/ignored.mdx b/site/src/content/docs/config/semver-groups/ignored.mdx
@@ -6,11 +6,14 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 
 Have syncpack ignore the semver ranges of these dependencies completely.
 
-## `isIgnored` boolean
+## Configuration
+
+### isIgnored
 
 <RequiredPill />
 
@@ -34,6 +37,10 @@ Have syncpack ignore the semver ranges of these dependencies completely.
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/semver-groups/with-range.mdx b/site/src/content/docs/config/semver-groups/with-range.mdx
@@ -6,11 +6,14 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 
 Ensure all dependencies within this group have the specified semver range.
 
-## `semverGroup.range`
+## Configuration
+
+### range
 
 <RequiredPill />
 
@@ -36,6 +39,10 @@ Which of the Supported Ranges this group should use.
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/specifier-types.mdx b/site/src/content/docs/config/specifier-types.mdx
@@ -0,0 +1,38 @@
+---
+title: specifierTypes
+---
+
+import SpecifierTypes from '@site/partials/_specifier-types.mdx';
+import Details from '@site/components/details.astro';
+
+Dependencies can be toggled on and off by the type of version specifier they have via this property.
+
+<Details title="Example: Only include `latest` and `workspace-protocol`">
+
+**Only** `*` and `workspace:*`, `workspace:~` etc will be inspected:
+
+```json title=".syncpackrc"
+{
+  "dependencyTypes": ["latest", "workspace-protocol"]
+}
+```
+
+</Details>
+
+<Details title="Example: Exclude `file`">
+
+Everything **except** specifiers of the format `file:path/to/package.tgz` will be inspected:
+
+```json title=".syncpackrc"
+{
+  "dependencyTypes": ["!file"]
+}
+```
+
+</Details>
+
+## Available values
+
+All are enabled by default.
+
+<SpecifierTypes />
diff --git a/site/src/content/docs/config/syncpackrc.mdx b/site/src/content/docs/config/syncpackrc.mdx
@@ -25,15 +25,45 @@ Your config file only needs to define values for those you want to change from t
 
 /** @type {import("syncpack").RcFile} */
 const config = {
-  customTypes: [],
-  dependencyTypes: ['dev', 'local', 'overrides', 'peer', 'pnpmOverrides', 'prod', 'resolutions'],
+  customTypes: {
+    dev: {
+      strategy: 'versionsByName',
+      path: 'devDependencies',
+    },
+    local: {
+      strategy: 'name~version',
+      namePath: 'name',
+      path: 'version',
+    },
+    overrides: {
+      strategy: 'versionsByName',
+      path: 'overrides',
+    },
+    peer: {
+      strategy: 'versionsByName',
+      path: 'peerDependencies',
+    },
+    pnpmOverrides: {
+      strategy: 'versionsByName',
+      path: 'pnpm.overrides',
+    },
+    prod: {
+      strategy: 'versionsByName',
+      path: 'dependencies',
+    },
+    resolutions: {
+      strategy: 'versionsByName',
+      path: 'resolutions',
+    },
+  },
+  dependencyTypes: ['**'],
   filter: '.',
   indent: '  ',
   semverGroups: [],
-  semverRange: '',
   sortAz: ['contributors', 'dependencies', 'devDependencies', 'keywords', 'peerDependencies', 'resolutions', 'scripts'],
   sortFirst: ['name', 'description', 'version', 'author'],
   source: ['package.json', 'packages/*/package.json'],
+  specifierTypes: ['**'],
   versionGroups: [],
 };
 

diff --git a/site/src/content/docs/config/version-groups/banned.mdx b/site/src/content/docs/config/version-groups/banned.mdx
@@ -6,6 +6,7 @@ import BanAlwaysExample from '@site/partials/examples/_ban-always.mdx';
 import BanTypesExample from '@site/partials/examples/_ban-types.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import RequiredPill from '@site/components/pill/required.astro';
@@ -52,6 +53,10 @@ This property activates this behaviour for a given Version Group.
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/version-groups/ignored.mdx b/site/src/content/docs/config/version-groups/ignored.mdx
@@ -6,6 +6,7 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 import Example from '@site/partials/examples/_ignore-deps.mdx';
 import Details from '@site/components/details.astro';
@@ -46,6 +47,10 @@ This property activates this behaviour for a given Version Group.
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/version-groups/lowest-version.mdx b/site/src/content/docs/config/version-groups/lowest-version.mdx
@@ -6,6 +6,7 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 
 Fix mismatched versions in this group by choosing the lowest/oldest semver version in use.
@@ -41,6 +42,10 @@ Defaults to `highestSemver` but can be optionally changed to `lowestSemver`.
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/version-groups/pinned.mdx b/site/src/content/docs/config/version-groups/pinned.mdx
@@ -6,6 +6,7 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 import AwsExample from '@site/partials/examples/_pin-aws.mdx';
 import Details from '@site/components/details.astro';
@@ -46,6 +47,10 @@ The version specifier you would like to use, this can be anything supported by a
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/version-groups/same-range.mdx b/site/src/content/docs/config/version-groups/same-range.mdx
@@ -6,6 +6,7 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 import Example from '@site/partials/examples/_same-range.mdx';
 import Details from '@site/components/details.astro';
@@ -47,6 +48,10 @@ Currently the only custom policy in syncpack is "sameRange", which is what cause
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />

diff --git a/site/src/content/docs/config/version-groups/snapped-to.mdx b/site/src/content/docs/config/version-groups/snapped-to.mdx
@@ -6,6 +6,7 @@ import RequiredPill from '@site/components/pill/required.astro';
 import Packages from '@site/partials/group-config/_packages.mdx';
 import Dependencies from '@site/partials/group-config/_dependencies.mdx';
 import DependencyTypes from '@site/partials/group-config/_dependency-types.mdx';
+import SpecifierTypes from '@site/partials/group-config/_specifier-types.mdx';
 import Label from '@site/partials/group-config/_label.mdx';
 import Example from '@site/partials/examples/_react-native.mdx';
 import Details from '@site/components/details.astro';
@@ -48,6 +49,10 @@ Pin the version of all dependencies in this group to follow the versions used by
 
 <DependencyTypes />
 
+### specifierTypes
+
+<SpecifierTypes />
+
 ### label
 
 <Label />