From 396296a9d782ef495d11697353f0ddf80dcb0a9d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 10 Nov 2023 15:51:27 +0000 Subject: [PATCH] deploy: e6311a51d91cecbe470a02158f5bc826422a5146 --- 404.html | 2 +- assets/js/02605378.2a1e3224.js | 1 + assets/js/02605378.649134e1.js | 1 - assets/js/02e69fcd.05f5722b.js | 1 + assets/js/02e69fcd.58ad7f78.js | 1 - assets/js/06cb05cb.748e2b48.js | 1 - assets/js/06cb05cb.a9b2bc4b.js | 1 + assets/js/0d01d214.45cb76ca.js | 1 - assets/js/0d01d214.82131173.js | 1 + assets/js/0df5a4e0.1213e08f.js | 1 - assets/js/0df5a4e0.42794c53.js | 1 + assets/js/114c1d06.8eaf47bc.js | 1 - assets/js/114c1d06.cc772645.js | 1 + assets/js/{13576bc4.c44ac701.js => 13576bc4.3ca2db05.js} | 2 +- assets/js/1c97758f.5faac0e1.js | 1 + assets/js/1c97758f.735af0d0.js | 1 - assets/js/202d6f24.26b2842e.js | 1 + assets/js/202d6f24.a150a27e.js | 1 - assets/js/2518a329.445a612b.js | 1 - assets/js/2518a329.4710dc84.js | 1 + assets/js/25517a24.24813d9b.js | 1 - assets/js/25517a24.321bcae1.js | 1 + assets/js/2c8a7579.14cdfb7f.js | 1 - assets/js/2c8a7579.52d97031.js | 1 + assets/js/2dc772c2.3b069c40.js | 1 - assets/js/2dc772c2.d0caab76.js | 1 + assets/js/{325cf86f.479f940e.js => 325cf86f.e3e8b82c.js} | 2 +- assets/js/3928ec54.1b9c0ba9.js | 1 - assets/js/3928ec54.80d2bcf9.js | 1 + assets/js/3f7238a2.5e95bb8d.js | 1 - assets/js/3f7238a2.875a0e28.js | 1 + assets/js/3fc261aa.13396074.js | 1 - assets/js/3fc261aa.87a98e27.js | 1 + assets/js/{49dbd26f.7864c024.js => 49dbd26f.655caa94.js} | 2 +- assets/js/4b98dbff.79cc04cb.js | 1 + assets/js/4b98dbff.f284835b.js | 1 - assets/js/4ff4677f.7bfa5e42.js | 1 + assets/js/4ff4677f.f972a29c.js | 1 - assets/js/58229b23.4639080b.js | 1 - assets/js/58229b23.f9325709.js | 1 + assets/js/{60482745.02c9da00.js => 60482745.38915c7b.js} | 2 +- assets/js/60617550.00df6689.js | 1 - assets/js/60617550.17a08b93.js | 1 + assets/js/61b0711c.9d1ef70a.js | 1 + assets/js/61b0711c.e944936c.js | 1 - assets/js/{6a19cf64.0e9b13ee.js => 6a19cf64.7cd0359c.js} | 2 +- assets/js/6f4c3bf3.05aa5679.js | 1 - assets/js/6f4c3bf3.e0946522.js | 1 + assets/js/764c736e.26093551.js | 1 + assets/js/764c736e.3a1bcde7.js | 1 - assets/js/7de4e94d.320720f5.js | 1 + assets/js/7de4e94d.3baa0766.js | 1 - assets/js/8ad702f6.123fa477.js | 1 + assets/js/8ad702f6.89a56461.js | 1 - assets/js/957a0050.5dbcb3b1.js | 1 + assets/js/957a0050.f0f5323c.js | 1 - assets/js/a0d46b54.2e5e93c8.js | 1 - assets/js/a0d46b54.34f8f838.js | 1 + assets/js/{a424efa6.40be1d1b.js => a424efa6.b208872f.js} | 2 +- assets/js/bbf0b0c6.d8d9a344.js | 1 + assets/js/bbf0b0c6.eeac5642.js | 1 - assets/js/{c046c6d8.fb79c697.js => c046c6d8.65836e20.js} | 2 +- assets/js/c7de8929.552ba940.js | 1 - assets/js/c7de8929.a73a774d.js | 1 + assets/js/c87b078f.bc782301.js | 1 + assets/js/c87b078f.d22e8017.js | 1 - assets/js/{c8e40d44.d92491d0.js => c8e40d44.5c3d0a70.js} | 2 +- assets/js/c901ad87.14ff5426.js | 1 + assets/js/c901ad87.52a41696.js | 1 - assets/js/{cde22a48.fdfc03ea.js => cde22a48.88b9eaf7.js} | 2 +- assets/js/d024088c.35d9fbd3.js | 1 + assets/js/d024088c.c050e4ee.js | 1 - assets/js/d29174f6.2f74743b.js | 1 - assets/js/d29174f6.de6802af.js | 1 + assets/js/{dc016e2d.40cbb44b.js => dc016e2d.99b54cfe.js} | 2 +- assets/js/df68d44b.44edbb57.js | 1 + assets/js/df68d44b.875f2b24.js | 1 - assets/js/e0464cb3.06cfea97.js | 1 + assets/js/e0464cb3.4305b157.js | 1 - assets/js/ea90761c.1d83a569.js | 1 + assets/js/ea90761c.ac2d81d9.js | 1 - assets/js/{f0862f9b.f8c32cad.js => f0862f9b.5cf6077c.js} | 2 +- assets/js/f7b7f548.1bc594b0.js | 1 - assets/js/f7b7f548.a93112b5.js | 1 + assets/js/{fc9a440c.267fbcdc.js => fc9a440c.dbbded60.js} | 2 +- assets/js/fce71488.5156b15f.js | 1 - assets/js/fce71488.dd397375.js | 1 + assets/js/ff78ae8b.049fb9f2.js | 1 + assets/js/ff78ae8b.7cdaf007.js | 1 - assets/js/runtime~main.00510078.js | 1 - assets/js/runtime~main.ea50e035.js | 1 + blog.html | 4 ++-- blog/archive.html | 4 ++-- blog/atom.xml | 4 ++-- blog/index.html | 6 +++--- blog/rss.xml | 4 ++-- command/fix-mismatches.html | 4 ++-- command/format.html | 4 ++-- command/lint-semver-ranges.html | 4 ++-- command/lint.html | 4 ++-- command/list-mismatches.html | 4 ++-- command/list.html | 4 ++-- command/prompt.html | 4 ++-- command/set-semver-ranges.html | 4 ++-- command/update.html | 4 ++-- config/custom-types.html | 4 ++-- config/dependency-types.html | 4 ++-- config/indent.html | 4 ++-- config/semver-groups/ignored.html | 4 ++-- config/semver-groups/with-range.html | 4 ++-- config/sort-az.html | 4 ++-- config/sort-first.html | 4 ++-- config/source.html | 4 ++-- config/syncpackrc.html | 4 ++-- config/version-groups/banned.html | 4 ++-- config/version-groups/ignored.html | 4 ++-- config/version-groups/lowest-version.html | 4 ++-- config/version-groups/pinned.html | 4 ++-- config/version-groups/same-range.html | 4 ++-- config/version-groups/snapped-to.html | 4 ++-- config/version-groups/standard.html | 4 ++-- examples.html | 2 +- examples/ban-dependency-from-monorepo.html | 4 ++-- examples/ensure-versions-satisfy-same-range.html | 4 ++-- examples/fix-aws-sdk-version-mismatch.html | 4 ++-- examples/fix-react-native-version-mismatch.html | 4 ++-- examples/ignore-dependencies-in-syncpack.html | 4 ++-- examples/only-allow-types-in-dev-dependencies.html | 4 ++-- examples/pnpm-workspace-protocol.html | 4 ++-- examples/sync-engines-in-monorepo.html | 4 ++-- examples/sync-nodejs-version-in-monorepo.html | 4 ++-- examples/sync-package-manager-version.html | 4 ++-- guide/getting-started.html | 4 ++-- guide/local-package-versions.html | 4 ++-- guide/semver-groups.html | 4 ++-- guide/version-groups.html | 4 ++-- index.html | 2 +- integrations/github-actions.html | 4 ++-- integrations/intellisense.html | 4 ++-- integrations/json-schema.html | 4 ++-- integrations/lerna.html | 4 ++-- integrations/npm.html | 4 ++-- integrations/pnpm.html | 4 ++-- integrations/yarn.html | 4 ++-- status-codes.html | 4 ++-- 145 files changed, 159 insertions(+), 159 deletions(-) create mode 100644 assets/js/02605378.2a1e3224.js delete mode 100644 assets/js/02605378.649134e1.js create mode 100644 assets/js/02e69fcd.05f5722b.js delete mode 100644 assets/js/02e69fcd.58ad7f78.js delete mode 100644 assets/js/06cb05cb.748e2b48.js create mode 100644 assets/js/06cb05cb.a9b2bc4b.js delete mode 100644 assets/js/0d01d214.45cb76ca.js create mode 100644 assets/js/0d01d214.82131173.js delete mode 100644 assets/js/0df5a4e0.1213e08f.js create mode 100644 assets/js/0df5a4e0.42794c53.js delete mode 100644 assets/js/114c1d06.8eaf47bc.js create mode 100644 assets/js/114c1d06.cc772645.js rename assets/js/{13576bc4.c44ac701.js => 13576bc4.3ca2db05.js} (76%) create mode 100644 assets/js/1c97758f.5faac0e1.js delete mode 100644 assets/js/1c97758f.735af0d0.js create mode 100644 assets/js/202d6f24.26b2842e.js delete mode 100644 assets/js/202d6f24.a150a27e.js delete mode 100644 assets/js/2518a329.445a612b.js create mode 100644 assets/js/2518a329.4710dc84.js delete mode 100644 assets/js/25517a24.24813d9b.js create mode 100644 assets/js/25517a24.321bcae1.js delete mode 100644 assets/js/2c8a7579.14cdfb7f.js create mode 100644 assets/js/2c8a7579.52d97031.js delete mode 100644 assets/js/2dc772c2.3b069c40.js create mode 100644 assets/js/2dc772c2.d0caab76.js rename assets/js/{325cf86f.479f940e.js => 325cf86f.e3e8b82c.js} (53%) delete mode 100644 assets/js/3928ec54.1b9c0ba9.js create mode 100644 assets/js/3928ec54.80d2bcf9.js delete mode 100644 assets/js/3f7238a2.5e95bb8d.js create mode 100644 assets/js/3f7238a2.875a0e28.js delete mode 100644 assets/js/3fc261aa.13396074.js create mode 100644 assets/js/3fc261aa.87a98e27.js rename assets/js/{49dbd26f.7864c024.js => 49dbd26f.655caa94.js} (89%) create mode 100644 assets/js/4b98dbff.79cc04cb.js delete mode 100644 assets/js/4b98dbff.f284835b.js create mode 100644 assets/js/4ff4677f.7bfa5e42.js delete mode 100644 assets/js/4ff4677f.f972a29c.js delete mode 100644 assets/js/58229b23.4639080b.js create mode 100644 assets/js/58229b23.f9325709.js rename assets/js/{60482745.02c9da00.js => 60482745.38915c7b.js} (54%) delete mode 100644 assets/js/60617550.00df6689.js create mode 100644 assets/js/60617550.17a08b93.js create mode 100644 assets/js/61b0711c.9d1ef70a.js delete mode 100644 assets/js/61b0711c.e944936c.js rename assets/js/{6a19cf64.0e9b13ee.js => 6a19cf64.7cd0359c.js} (63%) delete mode 100644 assets/js/6f4c3bf3.05aa5679.js create mode 100644 assets/js/6f4c3bf3.e0946522.js create mode 100644 assets/js/764c736e.26093551.js delete mode 100644 assets/js/764c736e.3a1bcde7.js create mode 100644 assets/js/7de4e94d.320720f5.js delete mode 100644 assets/js/7de4e94d.3baa0766.js create mode 100644 assets/js/8ad702f6.123fa477.js delete mode 100644 assets/js/8ad702f6.89a56461.js create mode 100644 assets/js/957a0050.5dbcb3b1.js delete mode 100644 assets/js/957a0050.f0f5323c.js delete mode 100644 assets/js/a0d46b54.2e5e93c8.js create mode 100644 assets/js/a0d46b54.34f8f838.js rename assets/js/{a424efa6.40be1d1b.js => a424efa6.b208872f.js} (51%) create mode 100644 assets/js/bbf0b0c6.d8d9a344.js delete mode 100644 assets/js/bbf0b0c6.eeac5642.js rename assets/js/{c046c6d8.fb79c697.js => c046c6d8.65836e20.js} (53%) delete mode 100644 assets/js/c7de8929.552ba940.js create mode 100644 assets/js/c7de8929.a73a774d.js create mode 100644 assets/js/c87b078f.bc782301.js delete mode 100644 assets/js/c87b078f.d22e8017.js rename assets/js/{c8e40d44.d92491d0.js => c8e40d44.5c3d0a70.js} (50%) create mode 100644 assets/js/c901ad87.14ff5426.js delete mode 100644 assets/js/c901ad87.52a41696.js rename assets/js/{cde22a48.fdfc03ea.js => cde22a48.88b9eaf7.js} (53%) create mode 100644 assets/js/d024088c.35d9fbd3.js delete mode 100644 assets/js/d024088c.c050e4ee.js delete mode 100644 assets/js/d29174f6.2f74743b.js create mode 100644 assets/js/d29174f6.de6802af.js rename assets/js/{dc016e2d.40cbb44b.js => dc016e2d.99b54cfe.js} (51%) create mode 100644 assets/js/df68d44b.44edbb57.js delete mode 100644 assets/js/df68d44b.875f2b24.js create mode 100644 assets/js/e0464cb3.06cfea97.js delete mode 100644 assets/js/e0464cb3.4305b157.js create mode 100644 assets/js/ea90761c.1d83a569.js delete mode 100644 assets/js/ea90761c.ac2d81d9.js rename assets/js/{f0862f9b.f8c32cad.js => f0862f9b.5cf6077c.js} (53%) delete mode 100644 assets/js/f7b7f548.1bc594b0.js create mode 100644 assets/js/f7b7f548.a93112b5.js rename assets/js/{fc9a440c.267fbcdc.js => fc9a440c.dbbded60.js} (83%) delete mode 100644 assets/js/fce71488.5156b15f.js create mode 100644 assets/js/fce71488.dd397375.js create mode 100644 assets/js/ff78ae8b.049fb9f2.js delete mode 100644 assets/js/ff78ae8b.7cdaf007.js delete mode 100644 assets/js/runtime~main.00510078.js create mode 100644 assets/js/runtime~main.ea50e035.js diff --git a/404.html b/404.html index 98c40ced..9172b0e5 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Syncpack - + diff --git a/assets/js/02605378.2a1e3224.js b/assets/js/02605378.2a1e3224.js new file mode 100644 index 00000000..f7989786 --- /dev/null +++ b/assets/js/02605378.2a1e3224.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8752],{1900:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>E,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>m});var n=t(5893),r=t(1151),s=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133),a=t(9848);const F={id:"ignored",title:"Ignored"},h=void 0,y={id:"config/version-groups/ignored",title:"Ignored",description:"Have syncpack ignore the versions of these dependencies completely.",source:"@site/docs/config/version-groups/ignored.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/ignored",permalink:"/syncpack/config/version-groups/ignored",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/ignored.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"ignored",title:"Ignored"},sidebar:"docs",previous:{title:"Banned",permalink:"/syncpack/config/version-groups/banned"},next:{title:"Lowest Version",permalink:"/syncpack/config/version-groups/lowest-version"}},u={},g={annotations:s.ds,Code:s.EK},E={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},m=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"isIgnored",id:"isignored",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Have syncpack ignore the versions of these dependencies completely."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Ignore one or more dependencies"}),(0,n.jsx)(a.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"isignored",children:"isIgnored"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"This property activates this behaviour for a given Version Group."}),"\n",(0,n.jsx)(g.Code,{codeConfig:E,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"keep-walking",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},9848:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=(t(9960),t(292),t(6217));const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)("p",{children:"Ignore one or more dependencies so that syncpack does not inspect them."}),"\n",(0,n.jsx)(c.Hx,{level:o.level,children:"1. Add an ignored version group"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["Match 2 specific ",(0,n.jsx)(e.strong,{children:"packages"})," in the repo."]}),"\n",(0,n.jsxs)(e.li,{children:["Match only the ",(0,n.jsx)(e.strong,{children:"peerDependencies"})," in those packages."]}),"\n",(0,n.jsxs)(e.li,{children:["Add a ",(0,n.jsx)(e.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Nothing to see here, will fix soon",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["With this configuration in place, syncpack will now completely ignore every dependency listed under ",(0,n.jsx)(e.code,{children:"peerDependencies"})," in the two named packages ",(0,n.jsx)(e.code,{children:"oops-moment"})," and ",(0,n.jsx)(e.code,{children:"workaround"})," only."]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>r});t(7294);var n=t(5893);function r(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/02605378.649134e1.js b/assets/js/02605378.649134e1.js deleted file mode 100644 index a2e48351..00000000 --- a/assets/js/02605378.649134e1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8752],{1900:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>E,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>m});var n=t(5893),r=t(1151),s=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133),a=t(9848);const F={id:"ignored",title:"Ignored"},h=void 0,y={id:"config/version-groups/ignored",title:"Ignored",description:"Have syncpack ignore the versions of these dependencies completely.",source:"@site/docs/config/version-groups/ignored.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/ignored",permalink:"/syncpack/config/version-groups/ignored",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/ignored.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"ignored",title:"Ignored"},sidebar:"docs",previous:{title:"Banned",permalink:"/syncpack/config/version-groups/banned"},next:{title:"Lowest Version",permalink:"/syncpack/config/version-groups/lowest-version"}},u={},g={annotations:s.ds,Code:s.EK},E={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},m=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"isIgnored",id:"isignored",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Have syncpack ignore the versions of these dependencies completely."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Ignore one or more dependencies"}),(0,n.jsx)(a.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"isignored",children:"isIgnored"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"This property activates this behaviour for a given Version Group."}),"\n",(0,n.jsx)(g.Code,{codeConfig:E,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"keep-walking",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},9848:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=(t(9960),t(292),t(6217));const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)("p",{children:"Ignore one or more dependencies so that syncpack does not inspect them."}),"\n",(0,n.jsx)(c.Hx,{level:o.level,children:"1. Add an ignored version group"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["Match 2 specific ",(0,n.jsx)(e.strong,{children:"packages"})," in the repo."]}),"\n",(0,n.jsxs)(e.li,{children:["Match only the ",(0,n.jsx)(e.strong,{children:"peerDependencies"})," in those packages."]}),"\n",(0,n.jsxs)(e.li,{children:["Add a ",(0,n.jsx)(e.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Nothing to see here, will fix soon",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["With this configuration in place, syncpack will now completely ignore every dependency listed under ",(0,n.jsx)(e.code,{children:"peerDependencies"})," in the two named packages ",(0,n.jsx)(e.code,{children:"oops-moment"})," and ",(0,n.jsx)(e.code,{children:"workaround"})," only."]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>r});t(7294);var n=t(5893);function r(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/02e69fcd.05f5722b.js b/assets/js/02e69fcd.05f5722b.js new file mode 100644 index 00000000..b095c3fd --- /dev/null +++ b/assets/js/02e69fcd.05f5722b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3691],{9654:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>g,default:()=>b,frontMatter:()=>l,metadata:()=>p,toc:()=>f});var o=n(5893),c=n(1151),r=n(8984),i=n(6085),a=n(2474),d=n(7463),s=n(3107),h=n(2065),u=n(4086);const l={id:"fix-mismatches",title:"fix-mismatches"},g=void 0,p={id:"command/fix-mismatches",title:"fix-mismatches",description:"Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. react@16.4.2, instead of a combination of react@16.4.2, react@0.15.9, and react@16.0.0.",source:"@site/docs/command/fix-mismatches.mdx",sourceDirName:"command",slug:"/command/fix-mismatches",permalink:"/syncpack/command/fix-mismatches",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/fix-mismatches.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"fix-mismatches",title:"fix-mismatches"},sidebar:"docs",previous:{title:"Version Groups",permalink:"/syncpack/guide/version-groups"},next:{title:"format",permalink:"/syncpack/command/format"}},m={},f=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={code:"code",h2:"h2",h3:"h3",p:"p",...(0,c.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(t.p,{children:["Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. ",(0,o.jsx)(t.code,{children:"react@16.4.2"}),", instead of a combination of ",(0,o.jsx)(t.code,{children:"react@16.4.2"}),", ",(0,o.jsx)(t.code,{children:"react@0.15.9"}),", and ",(0,o.jsx)(t.code,{children:"react@16.0.0"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,o.jsx)(s.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,o.jsx)(i.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(r.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,o.jsx)(h.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"indent",children:"indent"}),"\n",(0,o.jsx)(d.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(a.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(u.ZP,{command:"fix-mismatches"})]})}function b(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(F,{...e})}):F(e)}},8984:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,n)=>{n.d(t,{ZP:()=>h});var o=n(5893),c=n(1151),r=n(9794),i=n(9286);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(t.p,{children:["Only run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,o.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,n)=>{n.d(t,{ZP:()=>h});var o=n(5893),c=n(1151),r=n(9794),i=n(9286);n(9960);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,n)=>{n.d(t,{ZP:()=>a});var o=n(5893),c=n(1151),r=n(9286);function i(e){const t={p:"p",...(0,c.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(r.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},3107:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(t.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsxs)(t.p,{children:["Add quotes around your ",(0,o.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(t.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,o.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/02e69fcd.58ad7f78.js b/assets/js/02e69fcd.58ad7f78.js deleted file mode 100644 index 1c3491ac..00000000 --- a/assets/js/02e69fcd.58ad7f78.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3691],{9654:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>g,default:()=>b,frontMatter:()=>l,metadata:()=>p,toc:()=>f});var o=n(5893),c=n(1151),r=n(8984),i=n(6085),a=n(2474),d=n(7463),s=n(3107),h=n(2065),u=n(4086);const l={id:"fix-mismatches",title:"fix-mismatches"},g=void 0,p={id:"command/fix-mismatches",title:"fix-mismatches",description:"Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. react@16.4.2, instead of a combination of react@16.4.2, react@0.15.9, and react@16.0.0.",source:"@site/docs/command/fix-mismatches.mdx",sourceDirName:"command",slug:"/command/fix-mismatches",permalink:"/syncpack/command/fix-mismatches",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/fix-mismatches.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"fix-mismatches",title:"fix-mismatches"},sidebar:"docs",previous:{title:"Version Groups",permalink:"/syncpack/guide/version-groups"},next:{title:"format",permalink:"/syncpack/command/format"}},m={},f=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={code:"code",h2:"h2",h3:"h3",p:"p",...(0,c.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(t.p,{children:["Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. ",(0,o.jsx)(t.code,{children:"react@16.4.2"}),", instead of a combination of ",(0,o.jsx)(t.code,{children:"react@16.4.2"}),", ",(0,o.jsx)(t.code,{children:"react@0.15.9"}),", and ",(0,o.jsx)(t.code,{children:"react@16.0.0"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,o.jsx)(s.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,o.jsx)(i.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(r.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,o.jsx)(h.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"indent",children:"indent"}),"\n",(0,o.jsx)(d.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(a.ZP,{command:"fix-mismatches"}),"\n",(0,o.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(u.ZP,{command:"fix-mismatches"})]})}function b(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(F,{...e})}):F(e)}},8984:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,n)=>{n.d(t,{ZP:()=>h});var o=n(5893),c=n(1151),r=n(9794),i=n(9286);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(t.p,{children:["Only run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,o.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,n)=>{n.d(t,{ZP:()=>h});var o=n(5893),c=n(1151),r=n(9794),i=n(9286);n(9960);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(t.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,n)=>{n.d(t,{ZP:()=>a});var o=n(5893),c=n(1151),r=n(9286);function i(e){const t={p:"p",...(0,c.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(r.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},3107:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(t.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsxs)(t.p,{children:["Add quotes around your ",(0,o.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,n)=>{n.d(t,{ZP:()=>u});var o=n(5893),c=n(1151),r=n(9794),i=n(9286),a=n(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(t.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,o.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/06cb05cb.748e2b48.js b/assets/js/06cb05cb.748e2b48.js deleted file mode 100644 index f6a8d52f..00000000 --- a/assets/js/06cb05cb.748e2b48.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6492],{185:(t,i,e)=>{e.r(i),e.d(i,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var n=e(5893),s=e(1151);const a={id:"github-actions",title:"Github Actions"},c=void 0,o={id:"integrations/github-actions",title:"Github Actions",description:"As of May 2022 there is now a Syncpack GitHub Action.",source:"@site/docs/integrations/github-actions.mdx",sourceDirName:"integrations",slug:"/integrations/github-actions",permalink:"/syncpack/integrations/github-actions",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/github-actions.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"github-actions",title:"Github Actions"},sidebar:"docs",previous:{title:"Standard",permalink:"/syncpack/config/version-groups/standard"},next:{title:"TypeScript Intellisense",permalink:"/syncpack/integrations/intellisense"}},r={},d=[];function p(t){const i={a:"a",p:"p",...(0,s.a)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(i.p,{children:["As of May 2022 there is now a ",(0,n.jsx)(i.a,{href:"https://github.com/marketplace/actions/syncpack-synchronise-monorepo-dependency-versions",children:"Syncpack GitHub Action"}),"."]}),"\n",(0,n.jsxs)(i.p,{children:["It is new and less stable than syncpack itself, but please give it a try and ",(0,n.jsx)(i.a,{href:"https://github.com/JamieMason/syncpack-github-action/issues/new",children:"give your feedback"}),"."]})]})}function u(t={}){const{wrapper:i}={...(0,s.a)(),...t.components};return i?(0,n.jsx)(i,{...t,children:(0,n.jsx)(p,{...t})}):p(t)}}}]); \ No newline at end of file diff --git a/assets/js/06cb05cb.a9b2bc4b.js b/assets/js/06cb05cb.a9b2bc4b.js new file mode 100644 index 00000000..e66415db --- /dev/null +++ b/assets/js/06cb05cb.a9b2bc4b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6492],{185:(t,i,e)=>{e.r(i),e.d(i,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var n=e(5893),s=e(1151);const a={id:"github-actions",title:"Github Actions"},c=void 0,o={id:"integrations/github-actions",title:"Github Actions",description:"As of May 2022 there is now a Syncpack GitHub Action.",source:"@site/docs/integrations/github-actions.mdx",sourceDirName:"integrations",slug:"/integrations/github-actions",permalink:"/syncpack/integrations/github-actions",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/github-actions.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"github-actions",title:"Github Actions"},sidebar:"docs",previous:{title:"Standard",permalink:"/syncpack/config/version-groups/standard"},next:{title:"TypeScript Intellisense",permalink:"/syncpack/integrations/intellisense"}},r={},d=[];function p(t){const i={a:"a",p:"p",...(0,s.a)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(i.p,{children:["As of May 2022 there is now a ",(0,n.jsx)(i.a,{href:"https://github.com/marketplace/actions/syncpack-synchronise-monorepo-dependency-versions",children:"Syncpack GitHub Action"}),"."]}),"\n",(0,n.jsxs)(i.p,{children:["It is new and less stable than syncpack itself, but please give it a try and ",(0,n.jsx)(i.a,{href:"https://github.com/JamieMason/syncpack-github-action/issues/new",children:"give your feedback"}),"."]})]})}function u(t={}){const{wrapper:i}={...(0,s.a)(),...t.components};return i?(0,n.jsx)(i,{...t,children:(0,n.jsx)(p,{...t})}):p(t)}}}]); \ No newline at end of file diff --git a/assets/js/0d01d214.45cb76ca.js b/assets/js/0d01d214.45cb76ca.js deleted file mode 100644 index 1a95c7da..00000000 --- a/assets/js/0d01d214.45cb76ca.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4732],{5712:(e,o,t)=>{t.r(o),t.d(o,{CH:()=>p,assets:()=>d,chCodeConfig:()=>h,contentTitle:()=>a,default:()=>g,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var n=t(5893),r=t(1151),c=t(9794);const s={id:"source",title:"source"},a=void 0,i={id:"config/source",title:"source",description:"Patterns supported by glob to find package.json files you want to manage with syncpack.",source:"@site/docs/config/source.mdx",sourceDirName:"config",slug:"/config/source",permalink:"/syncpack/config/source",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/source.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"source",title:"source"},sidebar:"docs",previous:{title:"sortFirst",permalink:"/syncpack/config/sort-first"},next:{title:"Banned",permalink:"/syncpack/config/version-groups/banned"}},d={},l=[{value:"Default Value",id:"default-value",level:2},{value:"Resolving Packages",id:"resolving-packages",level:2}],p={annotations:c.ds,Code:c.EK},h={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function u(e){const o={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",...(0,r.a)(),...e.components};return p||f("CH",!1),p.Code||f("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsxs)(o.p,{children:["Patterns supported by ",(0,n.jsx)(o.a,{href:"https://github.com/isaacs/node-glob",children:"glob"})," to find package.json files you want to manage with syncpack."]}),"\n",(0,n.jsx)(o.h2,{id:"default-value",children:"Default Value"}),"\n",(0,n.jsx)(o.p,{children:"Defaulted to match most Projects using Lerna or Yarn Workspaces"}),"\n",(0,n.jsx)(p.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"source",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"package.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/*/package.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.h2,{id:"resolving-packages",children:"Resolving Packages"}),"\n",(0,n.jsx)(o.p,{children:"package.json files are resolved in this order of precedence:"}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsxs)(o.li,{children:["If ",(0,n.jsx)(o.code,{children:"--source"})," ",(0,n.jsx)(o.a,{href:"https://github.com/isaacs/node-glob#glob-primer",children:"glob patterns"})," are provided, use those."]}),"\n",(0,n.jsxs)(o.li,{children:["If using ",(0,n.jsx)(o.a,{href:"https://yarnpkg.com/lang/en/docs/workspaces/",children:"Yarn Workspaces"}),", read ",(0,n.jsx)(o.code,{children:"workspaces"})," from ",(0,n.jsx)(o.code,{children:"./package.json"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["If using ",(0,n.jsx)(o.a,{href:"https://lerna.js.org/",children:"Lerna"}),", read ",(0,n.jsx)(o.code,{children:"packages"})," from ",(0,n.jsx)(o.code,{children:"./lerna.json"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["If using ",(0,n.jsx)(o.a,{href:"https://pnpm.js.org/",children:"Pnpm"}),", read ",(0,n.jsx)(o.code,{children:"packages"})," from ",(0,n.jsx)(o.code,{children:"./pnpm-workspace.yaml"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["Default to ",(0,n.jsx)(o.code,{children:"'package.json'"})," and ",(0,n.jsx)(o.code,{children:"'packages/*/package.json'"}),"."]}),"\n"]})]})}function g(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}function f(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/0d01d214.82131173.js b/assets/js/0d01d214.82131173.js new file mode 100644 index 00000000..b68560ac --- /dev/null +++ b/assets/js/0d01d214.82131173.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4732],{5712:(e,o,t)=>{t.r(o),t.d(o,{CH:()=>p,assets:()=>d,chCodeConfig:()=>h,contentTitle:()=>a,default:()=>g,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var n=t(5893),r=t(1151),c=t(9794);const s={id:"source",title:"source"},a=void 0,i={id:"config/source",title:"source",description:"Patterns supported by glob to find package.json files you want to manage with syncpack.",source:"@site/docs/config/source.mdx",sourceDirName:"config",slug:"/config/source",permalink:"/syncpack/config/source",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/source.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"source",title:"source"},sidebar:"docs",previous:{title:"sortFirst",permalink:"/syncpack/config/sort-first"},next:{title:"Banned",permalink:"/syncpack/config/version-groups/banned"}},d={},l=[{value:"Default Value",id:"default-value",level:2},{value:"Resolving Packages",id:"resolving-packages",level:2}],p={annotations:c.ds,Code:c.EK},h={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function u(e){const o={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",...(0,r.a)(),...e.components};return p||f("CH",!1),p.Code||f("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsxs)(o.p,{children:["Patterns supported by ",(0,n.jsx)(o.a,{href:"https://github.com/isaacs/node-glob",children:"glob"})," to find package.json files you want to manage with syncpack."]}),"\n",(0,n.jsx)(o.h2,{id:"default-value",children:"Default Value"}),"\n",(0,n.jsx)(o.p,{children:"Defaulted to match most Projects using Lerna or Yarn Workspaces"}),"\n",(0,n.jsx)(p.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"source",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"package.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/*/package.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.h2,{id:"resolving-packages",children:"Resolving Packages"}),"\n",(0,n.jsx)(o.p,{children:"package.json files are resolved in this order of precedence:"}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsxs)(o.li,{children:["If ",(0,n.jsx)(o.code,{children:"--source"})," ",(0,n.jsx)(o.a,{href:"https://github.com/isaacs/node-glob#glob-primer",children:"glob patterns"})," are provided, use those."]}),"\n",(0,n.jsxs)(o.li,{children:["If using ",(0,n.jsx)(o.a,{href:"https://yarnpkg.com/lang/en/docs/workspaces/",children:"Yarn Workspaces"}),", read ",(0,n.jsx)(o.code,{children:"workspaces"})," from ",(0,n.jsx)(o.code,{children:"./package.json"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["If using ",(0,n.jsx)(o.a,{href:"https://lerna.js.org/",children:"Lerna"}),", read ",(0,n.jsx)(o.code,{children:"packages"})," from ",(0,n.jsx)(o.code,{children:"./lerna.json"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["If using ",(0,n.jsx)(o.a,{href:"https://pnpm.js.org/",children:"Pnpm"}),", read ",(0,n.jsx)(o.code,{children:"packages"})," from ",(0,n.jsx)(o.code,{children:"./pnpm-workspace.yaml"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["Default to ",(0,n.jsx)(o.code,{children:"'package.json'"})," and ",(0,n.jsx)(o.code,{children:"'packages/*/package.json'"}),"."]}),"\n"]})]})}function g(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}function f(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/0df5a4e0.1213e08f.js b/assets/js/0df5a4e0.1213e08f.js deleted file mode 100644 index ae3e43a4..00000000 --- a/assets/js/0df5a4e0.1213e08f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8332],{7359:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>l,toc:()=>p});var n=t(5893),r=t(1151),c=t(8984),a=t(2474),i=t(7463),d=t(3107),s=t(4086);const h={id:"format",title:"format"},u=void 0,l={id:"command/format",title:"format",description:'Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the "repository" and "bugs" fields.',source:"@site/docs/command/format.mdx",sourceDirName:"command",slug:"/command/format",permalink:"/syncpack/command/format",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/format.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"format",title:"format"},sidebar:"docs",previous:{title:"fix-mismatches",permalink:"/syncpack/command/fix-mismatches"},next:{title:"lint-semver-ranges",permalink:"/syncpack/command/lint-semver-ranges"}},g={},p=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"config",id:"config",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function m(e){const o={code:"code",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(o.p,{children:["Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the ",(0,n.jsx)(o.code,{children:'"repository"'})," and ",(0,n.jsx)(o.code,{children:'"bugs"'})," fields."]}),"\n",(0,n.jsx)(o.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(o.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(c.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h3,{id:"indent",children:"indent"}),"\n",(0,n.jsx)(i.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(s.ZP,{command:"format"})]})}function f(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(m,{...e})}):m(e)}},8984:(e,o,t)=>{t.d(o,{ZP:()=>u});var n=t(5893),r=t(1151),c=t(9794),a=t(9286),i=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const o={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(o.p,{children:["Syncpack uses ",(0,n.jsx)(i.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(a.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,o,t)=>{t.d(o,{ZP:()=>h});var n=t(5893),r=t(1151),c=t(9794),a=t(9286);t(9960);const i={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const o={p:"p",...(0,r.a)(),...e.components};return i||u("CH",!1),i.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,o,t)=>{t.d(o,{ZP:()=>u});var n=t(5893),r=t(1151),c=t(9794),a=t(9286),i=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const o={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(o.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,o,t)=>{t.d(o,{ZP:()=>i});var n=t(5893),r=t(1151),c=t(9286);function a(e){const o={p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function i(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},3107:(e,o,t)=>{t.d(o,{ZP:()=>u});var n=t(5893),r=t(1151),c=t(9794),a=t(9286),i=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const o={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(o.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(o.admonition,{type:"tip",children:(0,n.jsxs)(o.p,{children:["Add quotes around your ",(0,n.jsx)(o.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/0df5a4e0.42794c53.js b/assets/js/0df5a4e0.42794c53.js new file mode 100644 index 00000000..d5bd4a2d --- /dev/null +++ b/assets/js/0df5a4e0.42794c53.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8332],{7359:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>l,toc:()=>p});var n=t(5893),r=t(1151),c=t(8984),a=t(2474),i=t(7463),d=t(3107),s=t(4086);const h={id:"format",title:"format"},u=void 0,l={id:"command/format",title:"format",description:'Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the "repository" and "bugs" fields.',source:"@site/docs/command/format.mdx",sourceDirName:"command",slug:"/command/format",permalink:"/syncpack/command/format",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/format.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"format",title:"format"},sidebar:"docs",previous:{title:"fix-mismatches",permalink:"/syncpack/command/fix-mismatches"},next:{title:"lint-semver-ranges",permalink:"/syncpack/command/lint-semver-ranges"}},g={},p=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"config",id:"config",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function m(e){const o={code:"code",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(o.p,{children:["Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the ",(0,n.jsx)(o.code,{children:'"repository"'})," and ",(0,n.jsx)(o.code,{children:'"bugs"'})," fields."]}),"\n",(0,n.jsx)(o.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(o.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(c.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h3,{id:"indent",children:"indent"}),"\n",(0,n.jsx)(i.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"format"}),"\n",(0,n.jsx)(o.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(s.ZP,{command:"format"})]})}function f(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(m,{...e})}):m(e)}},8984:(e,o,t)=>{t.d(o,{ZP:()=>u});var n=t(5893),r=t(1151),c=t(9794),a=t(9286),i=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const o={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(o.p,{children:["Syncpack uses ",(0,n.jsx)(i.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(a.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,o,t)=>{t.d(o,{ZP:()=>h});var n=t(5893),r=t(1151),c=t(9794),a=t(9286);t(9960);const i={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const o={p:"p",...(0,r.a)(),...e.components};return i||u("CH",!1),i.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,o,t)=>{t.d(o,{ZP:()=>u});var n=t(5893),r=t(1151),c=t(9794),a=t(9286),i=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const o={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(o.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,o,t)=>{t.d(o,{ZP:()=>i});var n=t(5893),r=t(1151),c=t(9286);function a(e){const o={p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function i(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},3107:(e,o,t)=>{t.d(o,{ZP:()=>u});var n=t(5893),r=t(1151),c=t(9794),a=t(9286),i=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const o={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(o.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(o.admonition,{type:"tip",children:(0,n.jsxs)(o.p,{children:["Add quotes around your ",(0,n.jsx)(o.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/114c1d06.8eaf47bc.js b/assets/js/114c1d06.8eaf47bc.js deleted file mode 100644 index 28aa4dba..00000000 --- a/assets/js/114c1d06.8eaf47bc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2028],{9020:(o,e,n)=>{n.r(e),n.d(e,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>p,toc:()=>a});var t=n(5893),s=n(1151),c=(n(9960),n(4383));const r={title:"Synchronise Node.js version in monorepo"},l=void 0,p={id:"examples/sync-nodejs-version-in-monorepo",title:"Synchronise Node.js version in monorepo",description:"",source:"@site/docs/examples/sync-nodejs-version-in-monorepo.mdx",sourceDirName:"examples",slug:"/examples/sync-nodejs-version-in-monorepo",permalink:"/syncpack/examples/sync-nodejs-version-in-monorepo",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/sync-nodejs-version-in-monorepo.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Synchronise Node.js version in monorepo"},sidebar:"examples",previous:{title:"Manage npm engines throughout monorepo",permalink:"/syncpack/examples/sync-engines-in-monorepo"},next:{title:"Manage monorepo packageManager version",permalink:"/syncpack/examples/sync-package-manager-version"}},i={},a=[];function F(o){return(0,t.jsx)(c.ZP,{level:"h2"})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,t.jsx)(e,{...o,children:(0,t.jsx)(F,{...o})}):F()}},4383:(o,e,n)=>{n.d(e,{ZP:()=>d});var t=n(5893),s=n(1151),c=n(9794),r=n(9960),l=n(292),p=n(6217);const i={annotations:c.ds,Code:c.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const e={code:"code",p:"p",...(0,s.a)(),...o.components};return i||y("CH",!1),i.Code||y("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsxs)(e.p,{children:["Ensure ",(0,t.jsx)(r.Z,{to:l.K.engines,children:(0,t.jsx)(e.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,t.jsxs)(e.p,{children:["I've chosen a name of ",(0,t.jsx)(e.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,t.jsxs)(e.p,{children:["Perform a one-off check for every usage of ",(0,t.jsx)(e.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,t.jsxs)(e.p,{children:["Add your new custom type to your ",(0,t.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(e.p,{children:["Now when you run any syncpack command, ",(0,t.jsx)(e.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,t.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,t.jsx)(r.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,t.jsx)(e,{...o,children:(0,t.jsx)(F,{...o})}):F(o)}function y(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,n)=>{n.d(e,{Hx:()=>s});n(7294);var t=n(5893);function s(o){let{children:e,level:n}=o;return(0,t.jsx)(n,{children:e})}},292:(o,e,n)=>{n.d(e,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/114c1d06.cc772645.js b/assets/js/114c1d06.cc772645.js new file mode 100644 index 00000000..779cb73d --- /dev/null +++ b/assets/js/114c1d06.cc772645.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2028],{9020:(o,e,n)=>{n.r(e),n.d(e,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>p,toc:()=>a});var t=n(5893),s=n(1151),c=(n(9960),n(4383));const r={title:"Synchronise Node.js version in monorepo"},l=void 0,p={id:"examples/sync-nodejs-version-in-monorepo",title:"Synchronise Node.js version in monorepo",description:"",source:"@site/docs/examples/sync-nodejs-version-in-monorepo.mdx",sourceDirName:"examples",slug:"/examples/sync-nodejs-version-in-monorepo",permalink:"/syncpack/examples/sync-nodejs-version-in-monorepo",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/sync-nodejs-version-in-monorepo.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Synchronise Node.js version in monorepo"},sidebar:"examples",previous:{title:"Manage npm engines throughout monorepo",permalink:"/syncpack/examples/sync-engines-in-monorepo"},next:{title:"Manage monorepo packageManager version",permalink:"/syncpack/examples/sync-package-manager-version"}},i={},a=[];function F(o){return(0,t.jsx)(c.ZP,{level:"h2"})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,t.jsx)(e,{...o,children:(0,t.jsx)(F,{...o})}):F()}},4383:(o,e,n)=>{n.d(e,{ZP:()=>d});var t=n(5893),s=n(1151),c=n(9794),r=n(9960),l=n(292),p=n(6217);const i={annotations:c.ds,Code:c.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const e={code:"code",p:"p",...(0,s.a)(),...o.components};return i||y("CH",!1),i.Code||y("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsxs)(e.p,{children:["Ensure ",(0,t.jsx)(r.Z,{to:l.K.engines,children:(0,t.jsx)(e.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,t.jsxs)(e.p,{children:["I've chosen a name of ",(0,t.jsx)(e.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,t.jsxs)(e.p,{children:["Perform a one-off check for every usage of ",(0,t.jsx)(e.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,t.jsxs)(e.p,{children:["Add your new custom type to your ",(0,t.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(e.p,{children:["Now when you run any syncpack command, ",(0,t.jsx)(e.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,t.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,t.jsx)(r.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,t.jsx)(e,{...o,children:(0,t.jsx)(F,{...o})}):F(o)}function y(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,n)=>{n.d(e,{Hx:()=>s});n(7294);var t=n(5893);function s(o){let{children:e,level:n}=o;return(0,t.jsx)(n,{children:e})}},292:(o,e,n)=>{n.d(e,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/13576bc4.c44ac701.js b/assets/js/13576bc4.3ca2db05.js similarity index 76% rename from assets/js/13576bc4.c44ac701.js rename to assets/js/13576bc4.3ca2db05.js index 94594c25..106eb93d 100644 --- a/assets/js/13576bc4.c44ac701.js +++ b/assets/js/13576bc4.3ca2db05.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8568],{1037:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>P,contentTitle:()=>C,default:()=>E,frontMatter:()=>B,metadata:()=>O,toc:()=>A});var t=s(5893),o=s(1151),i=s(9960);function r(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/banned",children:"Banned"})," Version Group, it is not allowed in the location it's in and should be removed."]})}function c(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(r,{...e})}):r(e)}function a(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance did not match the RegExp provided for the ",(0,t.jsx)(i.Z,{to:"/command/list#filter",children:"filter"})," option and will be ignored."]})}function d(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}function h(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsx)(n.p,{children:"Every instance of this dependency has a valid semver version number, but they are not all identical. Of those versions currently in use, the one with the highest semver version should be used."})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}function l(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by an ",(0,t.jsx)(i.Z,{to:"/config/version-groups/ignored",children:"Ignored"})," Version Group, it is ignored completely by Syncpack."]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}function m(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This dependency is a package developed in your monorepo and the ",(0,t.jsx)(n.code,{children:"local"})," ",(0,t.jsx)(i.Z,{to:"/config/dependency-types",children:"dependencyType"})," is enabled. The ",(0,t.jsx)(n.code,{children:"version"})," property of its package.json file is considered the canonical source of truth for the correct version to be used by all instances \u2013 but one of more of them are not identical to it."]})}function j(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}function x(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["Every instance of this dependency has a valid semver version number, but they are not all identical. Of those versions currently in use, the one with the lowest semver version should be used. The lowest version should be used because these instances belong to a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/lowest-version",children:"Lowest Version"})," Group."]})}function v(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(x,{...e})}):x(e)}function f(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["This dependency is a package developed in your monorepo and the ",(0,t.jsx)(n.code,{children:"local"})," ",(0,t.jsx)(i.Z,{to:"/config/dependency-types",children:"dependencyType"})," is enabled. The ",(0,t.jsx)(n.code,{children:"version"})," property of its package.json file is missing, so the correct version to be used by all instances can not be determined."]}),"\n",(0,t.jsx)(n.p,{children:"Syncpack can't know what to do and this will need to be manually resolved."})]})}function g(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}function y(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To"})," Version Group, the version it should use is the one set in the packages named in the ",(0,t.jsx)(n.code,{children:"snapTo"})," array of this Version Group \u2013 but none of those packages depend on this dependency."]}),"\n",(0,t.jsx)(n.p,{children:"Syncpack can't know what to do and this will need to be manually resolved."})]})}function w(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}function b(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/pinned",children:"Pinned"})," Version Group, its version should be identical to the ",(0,t.jsx)(n.code,{children:"pinVersion"})," property of the Version Group, but is is not."]})}function k(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}function M(e){const n={p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["These instances were matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group, the version numbers do not have to be identical but they do all need to have a semver range which satisfies ",(0,t.jsx)(n.strong,{children:"all of the others"}),". In this case, one or more of the version numbers do not match all of the others."]})}function T(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(M,{...e})}):M(e)}function S(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance belongs to a ",(0,t.jsx)(i.Z,{to:"/config/semver-groups/with-range",children:"With Range"})," Semver Group, but the semver range it is using does not match the one defined on the ",(0,t.jsx)(n.code,{children:"range"})," property of that group."]})}function V(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(S,{...e})}):S(e)}function G(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To"})," Version Group, the version it should use is the one set in the first package named in the ",(0,t.jsx)(n.code,{children:"snapTo"})," array of this Version Group which depends on this dependency \u2013 but its version is not identical to that."]})}function Z(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(G,{...e})}):G(e)}function L(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"One or more of the instances of this dependency features a version specifier which syncpack does not support. As such, syncpack can't know what to do and this will need to be manually resolved."}),"\n",(0,t.jsxs)(n.p,{children:["This can also occur if the name of the package is not supported. A common case of this is ",(0,t.jsx)(i.Z,{to:"https://pnpm.io/package_json#pnpmoverrides",children:"pnpm overrides"}),"."]})]})}function R(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(L,{...e})}):L(e)}function F(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsx)(n.p,{children:"These instances fully meet the rules of their Version and Semver Group."})}function U(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(F,{...e})}):F(e)}const B={id:"status-codes",title:"Status Codes"},C=void 0,O={id:"status-codes",title:"Status Codes",description:"Banned",source:"@site/docs/status-codes.mdx",sourceDirName:".",slug:"/status-codes",permalink:"/syncpack/status-codes",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/status-codes.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"status-codes",title:"Status Codes"},sidebar:"docs",previous:{title:"Yarn",permalink:"/syncpack/integrations/yarn"}},P={},A=[{value:"Banned",id:"banned",level:2},{value:"FilteredOut",id:"filteredout",level:2},{value:"HighestSemverMismatch",id:"highestsemvermismatch",level:2},{value:"Ignored",id:"ignored",level:2},{value:"LocalPackageMismatch",id:"localpackagemismatch",level:2},{value:"LowestSemverMismatch",id:"lowestsemvermismatch",level:2},{value:"MissingLocalVersion",id:"missinglocalversion",level:2},{value:"MissingSnappedToMismatch",id:"missingsnappedtomismatch",level:2},{value:"PinnedMismatch",id:"pinnedmismatch",level:2},{value:"SameRangeMismatch",id:"samerangemismatch",level:2},{value:"SemverRangeMismatch",id:"semverrangemismatch",level:2},{value:"SnappedToMismatch",id:"snappedtomismatch",level:2},{value:"UnsupportedMismatch",id:"unsupportedmismatch",level:2},{value:"Valid",id:"valid",level:2}];function I(e){const n={h2:"h2",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"banned",children:"Banned"}),"\n",(0,t.jsx)(c,{}),"\n",(0,t.jsx)(n.h2,{id:"filteredout",children:"FilteredOut"}),"\n",(0,t.jsx)(d,{}),"\n",(0,t.jsx)(n.h2,{id:"highestsemvermismatch",children:"HighestSemverMismatch"}),"\n",(0,t.jsx)(p,{}),"\n",(0,t.jsx)(n.h2,{id:"ignored",children:"Ignored"}),"\n",(0,t.jsx)(u,{}),"\n",(0,t.jsx)(n.h2,{id:"localpackagemismatch",children:"LocalPackageMismatch"}),"\n",(0,t.jsx)(j,{}),"\n",(0,t.jsx)(n.h2,{id:"lowestsemvermismatch",children:"LowestSemverMismatch"}),"\n",(0,t.jsx)(v,{}),"\n",(0,t.jsx)(n.h2,{id:"missinglocalversion",children:"MissingLocalVersion"}),"\n",(0,t.jsx)(g,{}),"\n",(0,t.jsx)(n.h2,{id:"missingsnappedtomismatch",children:"MissingSnappedToMismatch"}),"\n",(0,t.jsx)(w,{}),"\n",(0,t.jsx)(n.h2,{id:"pinnedmismatch",children:"PinnedMismatch"}),"\n",(0,t.jsx)(k,{}),"\n",(0,t.jsx)(n.h2,{id:"samerangemismatch",children:"SameRangeMismatch"}),"\n",(0,t.jsx)(T,{}),"\n",(0,t.jsx)(n.h2,{id:"semverrangemismatch",children:"SemverRangeMismatch"}),"\n",(0,t.jsx)(V,{}),"\n",(0,t.jsx)(n.h2,{id:"snappedtomismatch",children:"SnappedToMismatch"}),"\n",(0,t.jsx)(Z,{}),"\n",(0,t.jsx)(n.h2,{id:"unsupportedmismatch",children:"UnsupportedMismatch"}),"\n",(0,t.jsx)(R,{}),"\n",(0,t.jsx)(n.h2,{id:"valid",children:"Valid"}),"\n",(0,t.jsx)(U,{})]})}function E(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8568],{1037:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>P,contentTitle:()=>C,default:()=>E,frontMatter:()=>B,metadata:()=>O,toc:()=>A});var t=s(5893),o=s(1151),i=s(9960);function r(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/banned",children:"Banned"})," Version Group, it is not allowed in the location it's in and should be removed."]})}function c(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(r,{...e})}):r(e)}function a(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance did not match the RegExp provided for the ",(0,t.jsx)(i.Z,{to:"/command/list#filter",children:"filter"})," option and will be ignored."]})}function d(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}function h(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsx)(n.p,{children:"Every instance of this dependency has a valid semver version number, but they are not all identical. Of those versions currently in use, the one with the highest semver version should be used."})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}function l(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by an ",(0,t.jsx)(i.Z,{to:"/config/version-groups/ignored",children:"Ignored"})," Version Group, it is ignored completely by Syncpack."]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}function m(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This dependency is a package developed in your monorepo and the ",(0,t.jsx)(n.code,{children:"local"})," ",(0,t.jsx)(i.Z,{to:"/config/dependency-types",children:"dependencyType"})," is enabled. The ",(0,t.jsx)(n.code,{children:"version"})," property of its package.json file is considered the canonical source of truth for the correct version to be used by all instances \u2013 but one of more of them are not identical to it."]})}function j(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}function x(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["Every instance of this dependency has a valid semver version number, but they are not all identical. Of those versions currently in use, the one with the lowest semver version should be used. The lowest version should be used because these instances belong to a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/lowest-version",children:"Lowest Version"})," Group."]})}function v(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(x,{...e})}):x(e)}function f(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["This dependency is a package developed in your monorepo and the ",(0,t.jsx)(n.code,{children:"local"})," ",(0,t.jsx)(i.Z,{to:"/config/dependency-types",children:"dependencyType"})," is enabled. The ",(0,t.jsx)(n.code,{children:"version"})," property of its package.json file is missing, so the correct version to be used by all instances can not be determined."]}),"\n",(0,t.jsx)(n.p,{children:"Syncpack can't know what to do and this will need to be manually resolved."})]})}function g(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}function y(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To"})," Version Group, the version it should use is the one set in the packages named in the ",(0,t.jsx)(n.code,{children:"snapTo"})," array of this Version Group \u2013 but none of those packages depend on this dependency."]}),"\n",(0,t.jsx)(n.p,{children:"Syncpack can't know what to do and this will need to be manually resolved."})]})}function w(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}function b(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/pinned",children:"Pinned"})," Version Group, its version should be identical to the ",(0,t.jsx)(n.code,{children:"pinVersion"})," property of the Version Group, but is is not."]})}function k(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}function M(e){const n={p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["These instances were matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group, the version numbers do not have to be identical but they do all need to have a semver range which satisfies ",(0,t.jsx)(n.strong,{children:"all of the others"}),". In this case, one or more of the version numbers do not match all of the others."]})}function T(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(M,{...e})}):M(e)}function S(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance belongs to a ",(0,t.jsx)(i.Z,{to:"/config/semver-groups/with-range",children:"With Range"})," Semver Group, but the semver range it is using does not match the one defined on the ",(0,t.jsx)(n.code,{children:"range"})," property of that group."]})}function V(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(S,{...e})}):S(e)}function G(e){const n={code:"code",p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(n.p,{children:["This instance was matched by a ",(0,t.jsx)(i.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To"})," Version Group, the version it should use is the one set in the first package named in the ",(0,t.jsx)(n.code,{children:"snapTo"})," array of this Version Group which depends on this dependency \u2013 but its version is not identical to that."]})}function Z(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(G,{...e})}):G(e)}function L(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"One or more of the instances of this dependency features a version specifier which syncpack does not support. As such, syncpack can't know what to do and this will need to be manually resolved."}),"\n",(0,t.jsxs)(n.p,{children:["This can also occur if the name of the package is not supported. A common case of this is ",(0,t.jsx)(i.Z,{to:"https://pnpm.io/package_json#pnpmoverrides",children:"pnpm overrides"}),"."]})]})}function R(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(L,{...e})}):L(e)}function F(e){const n={p:"p",...(0,o.a)(),...e.components};return(0,t.jsx)(n.p,{children:"These instances fully meet the rules of their Version and Semver Group."})}function U(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(F,{...e})}):F(e)}const B={id:"status-codes",title:"Status Codes"},C=void 0,O={id:"status-codes",title:"Status Codes",description:"Banned",source:"@site/docs/status-codes.mdx",sourceDirName:".",slug:"/status-codes",permalink:"/syncpack/status-codes",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/status-codes.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"status-codes",title:"Status Codes"},sidebar:"docs",previous:{title:"Yarn",permalink:"/syncpack/integrations/yarn"}},P={},A=[{value:"Banned",id:"banned",level:2},{value:"FilteredOut",id:"filteredout",level:2},{value:"HighestSemverMismatch",id:"highestsemvermismatch",level:2},{value:"Ignored",id:"ignored",level:2},{value:"LocalPackageMismatch",id:"localpackagemismatch",level:2},{value:"LowestSemverMismatch",id:"lowestsemvermismatch",level:2},{value:"MissingLocalVersion",id:"missinglocalversion",level:2},{value:"MissingSnappedToMismatch",id:"missingsnappedtomismatch",level:2},{value:"PinnedMismatch",id:"pinnedmismatch",level:2},{value:"SameRangeMismatch",id:"samerangemismatch",level:2},{value:"SemverRangeMismatch",id:"semverrangemismatch",level:2},{value:"SnappedToMismatch",id:"snappedtomismatch",level:2},{value:"UnsupportedMismatch",id:"unsupportedmismatch",level:2},{value:"Valid",id:"valid",level:2}];function I(e){const n={h2:"h2",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"banned",children:"Banned"}),"\n",(0,t.jsx)(c,{}),"\n",(0,t.jsx)(n.h2,{id:"filteredout",children:"FilteredOut"}),"\n",(0,t.jsx)(d,{}),"\n",(0,t.jsx)(n.h2,{id:"highestsemvermismatch",children:"HighestSemverMismatch"}),"\n",(0,t.jsx)(p,{}),"\n",(0,t.jsx)(n.h2,{id:"ignored",children:"Ignored"}),"\n",(0,t.jsx)(u,{}),"\n",(0,t.jsx)(n.h2,{id:"localpackagemismatch",children:"LocalPackageMismatch"}),"\n",(0,t.jsx)(j,{}),"\n",(0,t.jsx)(n.h2,{id:"lowestsemvermismatch",children:"LowestSemverMismatch"}),"\n",(0,t.jsx)(v,{}),"\n",(0,t.jsx)(n.h2,{id:"missinglocalversion",children:"MissingLocalVersion"}),"\n",(0,t.jsx)(g,{}),"\n",(0,t.jsx)(n.h2,{id:"missingsnappedtomismatch",children:"MissingSnappedToMismatch"}),"\n",(0,t.jsx)(w,{}),"\n",(0,t.jsx)(n.h2,{id:"pinnedmismatch",children:"PinnedMismatch"}),"\n",(0,t.jsx)(k,{}),"\n",(0,t.jsx)(n.h2,{id:"samerangemismatch",children:"SameRangeMismatch"}),"\n",(0,t.jsx)(T,{}),"\n",(0,t.jsx)(n.h2,{id:"semverrangemismatch",children:"SemverRangeMismatch"}),"\n",(0,t.jsx)(V,{}),"\n",(0,t.jsx)(n.h2,{id:"snappedtomismatch",children:"SnappedToMismatch"}),"\n",(0,t.jsx)(Z,{}),"\n",(0,t.jsx)(n.h2,{id:"unsupportedmismatch",children:"UnsupportedMismatch"}),"\n",(0,t.jsx)(R,{}),"\n",(0,t.jsx)(n.h2,{id:"valid",children:"Valid"}),"\n",(0,t.jsx)(U,{})]})}function E(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(I,{...e})}):I(e)}}}]); \ No newline at end of file diff --git a/assets/js/1c97758f.5faac0e1.js b/assets/js/1c97758f.5faac0e1.js new file mode 100644 index 00000000..0b1efc88 --- /dev/null +++ b/assets/js/1c97758f.5faac0e1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9470],{9551:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>x,frontMatter:()=>a,metadata:()=>h,toc:()=>E});var n=t(5893),r=t(1151),s=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"ignored",title:"Ignored"},F="Ignored",h={id:"config/semver-groups/ignored",title:"Ignored",description:"Have syncpack ignore the semver ranges of these dependencies completely.",source:"@site/docs/config/semver-groups/ignored.mdx",sourceDirName:"config/semver-groups",slug:"/config/semver-groups/ignored",permalink:"/syncpack/config/semver-groups/ignored",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/semver-groups/ignored.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"ignored",title:"Ignored"},sidebar:"docs",previous:{title:"indent",permalink:"/syncpack/config/indent"},next:{title:"With Range",permalink:"/syncpack/config/semver-groups/with-range"}},y={},u={annotations:s.ds,Code:s.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"isIgnored boolean",id:"isignored-boolean",level:2},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function m(o){const e={code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components};return u||j("CH",!1),u.Code||j("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.h1,{id:"ignored",children:"Ignored"}),"\n",(0,n.jsx)(e.p,{children:"Have syncpack ignore the semver ranges of these dependencies completely."}),"\n",(0,n.jsxs)(e.h2,{id:"isignored-boolean",children:[(0,n.jsx)(e.code,{children:"isIgnored"})," boolean"]}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:["dependencies"],active:"dependencies",heightRatio:1},files:[{name:"dependencies",title:'"Hide',from:!0,'syncpack"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function x(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(m,{...o})}):m(o)}function j(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/1c97758f.735af0d0.js b/assets/js/1c97758f.735af0d0.js deleted file mode 100644 index 1cd72559..00000000 --- a/assets/js/1c97758f.735af0d0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9470],{9551:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>x,frontMatter:()=>a,metadata:()=>h,toc:()=>E});var n=t(5893),r=t(1151),s=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"ignored",title:"Ignored"},F="Ignored",h={id:"config/semver-groups/ignored",title:"Ignored",description:"Have syncpack ignore the semver ranges of these dependencies completely.",source:"@site/docs/config/semver-groups/ignored.mdx",sourceDirName:"config/semver-groups",slug:"/config/semver-groups/ignored",permalink:"/syncpack/config/semver-groups/ignored",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/semver-groups/ignored.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"ignored",title:"Ignored"},sidebar:"docs",previous:{title:"indent",permalink:"/syncpack/config/indent"},next:{title:"With Range",permalink:"/syncpack/config/semver-groups/with-range"}},y={},u={annotations:s.ds,Code:s.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"isIgnored boolean",id:"isignored-boolean",level:2},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function m(o){const e={code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components};return u||j("CH",!1),u.Code||j("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.h1,{id:"ignored",children:"Ignored"}),"\n",(0,n.jsx)(e.p,{children:"Have syncpack ignore the semver ranges of these dependencies completely."}),"\n",(0,n.jsxs)(e.h2,{id:"isignored-boolean",children:[(0,n.jsx)(e.code,{children:"isIgnored"})," boolean"]}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:["dependencies"],active:"dependencies",heightRatio:1},files:[{name:"dependencies",title:'"Hide',from:!0,'syncpack"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function x(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(m,{...o})}):m(o)}function j(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/202d6f24.26b2842e.js b/assets/js/202d6f24.26b2842e.js new file mode 100644 index 00000000..3f76024d --- /dev/null +++ b/assets/js/202d6f24.26b2842e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5147],{4665:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>m,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>x});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133),a=t(527);const F={id:"pinned",title:"Pinned"},h=void 0,y={id:"config/version-groups/pinned",title:"Pinned",description:"Pin the version of all dependencies in this group to match a specific version you've defined.",source:"@site/docs/config/version-groups/pinned.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/pinned",permalink:"/syncpack/config/version-groups/pinned",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/pinned.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"pinned",title:"Pinned"},sidebar:"docs",previous:{title:"Lowest Version",permalink:"/syncpack/config/version-groups/lowest-version"},next:{title:"Same Range",permalink:"/syncpack/config/version-groups/same-range"}},u={},g={annotations:r.ds,Code:r.EK},m={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"pinVersion",id:"pinversion",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function E(o){const e={h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Pin the version of all dependencies in this group to match a specific version you've defined."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Ensure AWS SDK dependencies always have the same version"}),(0,n.jsx)(a.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"pinversion",children:"pinVersion"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"The version specifier you would like to use, this can be anything supported by a package manager."}),"\n",(0,n.jsx)(g.Code,{codeConfig:m,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"18.14.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(E,{...o})}):E(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},527:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),s=t(1151),r=t(9794),c=t(9960),l=t(292),p=t(6217);const i={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Pin all dependencies from ",(0,n.jsx)(c.Z,{to:l.K.awsSdk,children:"@aws-sdk"})," so that they are always identical."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a pinned version group"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["Match all ",(0,n.jsx)(e.strong,{children:"dependencies"})," whose name starts with ",(0,n.jsx)(e.code,{children:"@aws-sdk/"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Mark the version as being pinned to ",(0,n.jsx)(e.strong,{children:"3.272.0"})," in this case."]}),"\n",(0,n.jsxs)(e.li,{children:["Add a ",(0,n.jsx)(e.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"3.272.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"AWS SDK Dependencies should all have the same version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Any ",(0,n.jsx)(e.code,{children:"@aws-sdk"})," packages which do not have the expected version can then be found:"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"And fixed:"}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function F(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/202d6f24.a150a27e.js b/assets/js/202d6f24.a150a27e.js deleted file mode 100644 index e6e3ef24..00000000 --- a/assets/js/202d6f24.a150a27e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5147],{4665:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>m,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>x});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133),a=t(527);const F={id:"pinned",title:"Pinned"},h=void 0,y={id:"config/version-groups/pinned",title:"Pinned",description:"Pin the version of all dependencies in this group to match a specific version you've defined.",source:"@site/docs/config/version-groups/pinned.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/pinned",permalink:"/syncpack/config/version-groups/pinned",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/pinned.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"pinned",title:"Pinned"},sidebar:"docs",previous:{title:"Lowest Version",permalink:"/syncpack/config/version-groups/lowest-version"},next:{title:"Same Range",permalink:"/syncpack/config/version-groups/same-range"}},u={},g={annotations:r.ds,Code:r.EK},m={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"pinVersion",id:"pinversion",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function E(o){const e={h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Pin the version of all dependencies in this group to match a specific version you've defined."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Ensure AWS SDK dependencies always have the same version"}),(0,n.jsx)(a.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"pinversion",children:"pinVersion"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"The version specifier you would like to use, this can be anything supported by a package manager."}),"\n",(0,n.jsx)(g.Code,{codeConfig:m,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"18.14.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(E,{...o})}):E(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},527:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),s=t(1151),r=t(9794),c=t(9960),l=t(292),p=t(6217);const i={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Pin all dependencies from ",(0,n.jsx)(c.Z,{to:l.K.awsSdk,children:"@aws-sdk"})," so that they are always identical."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a pinned version group"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["Match all ",(0,n.jsx)(e.strong,{children:"dependencies"})," whose name starts with ",(0,n.jsx)(e.code,{children:"@aws-sdk/"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Mark the version as being pinned to ",(0,n.jsx)(e.strong,{children:"3.272.0"})," in this case."]}),"\n",(0,n.jsxs)(e.li,{children:["Add a ",(0,n.jsx)(e.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"3.272.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"AWS SDK Dependencies should all have the same version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Any ",(0,n.jsx)(e.code,{children:"@aws-sdk"})," packages which do not have the expected version can then be found:"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"And fixed:"}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function F(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/2518a329.445a612b.js b/assets/js/2518a329.445a612b.js deleted file mode 100644 index 90e836f9..00000000 --- a/assets/js/2518a329.445a612b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3952],{9377:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>m,frontMatter:()=>a,metadata:()=>h,toc:()=>E});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"lowest-version",title:"Lowest Version"},F=void 0,h={id:"config/version-groups/lowest-version",title:"Lowest Version",description:"Fix mismatched versions in this group by choosing the lowest/oldest semver version in use.",source:"@site/docs/config/version-groups/lowest-version.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/lowest-version",permalink:"/syncpack/config/version-groups/lowest-version",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/lowest-version.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"lowest-version",title:"Lowest Version"},sidebar:"docs",previous:{title:"Ignored",permalink:"/syncpack/config/version-groups/ignored"},next:{title:"Pinned",permalink:"/syncpack/config/version-groups/pinned"}},y={},u={annotations:r.ds,Code:r.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"preferVersion",id:"preferversion",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={code:"code",h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components};return u||f("CH",!1),u.Code||f("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Fix mismatched versions in this group by choosing the lowest/oldest semver version in use."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:["the"],active:"the",heightRatio:1},files:[{name:"the",title:'"Choose',lowest:!0,valid:!0,semver:!0,version:!0,when:!0,fixing:!0,'mismatches"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"preferVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"lowestSemver",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"preferversion",children:"preferVersion"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsxs)(e.p,{children:["Defaults to ",(0,n.jsx)(e.code,{children:"highestSemver"})," but can be optionally changed to ",(0,n.jsx)(e.code,{children:"lowestSemver"}),"."]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function m(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/2518a329.4710dc84.js b/assets/js/2518a329.4710dc84.js new file mode 100644 index 00000000..6af28d73 --- /dev/null +++ b/assets/js/2518a329.4710dc84.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3952],{9377:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>m,frontMatter:()=>a,metadata:()=>h,toc:()=>E});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"lowest-version",title:"Lowest Version"},F=void 0,h={id:"config/version-groups/lowest-version",title:"Lowest Version",description:"Fix mismatched versions in this group by choosing the lowest/oldest semver version in use.",source:"@site/docs/config/version-groups/lowest-version.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/lowest-version",permalink:"/syncpack/config/version-groups/lowest-version",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/lowest-version.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"lowest-version",title:"Lowest Version"},sidebar:"docs",previous:{title:"Ignored",permalink:"/syncpack/config/version-groups/ignored"},next:{title:"Pinned",permalink:"/syncpack/config/version-groups/pinned"}},y={},u={annotations:r.ds,Code:r.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"preferVersion",id:"preferversion",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={code:"code",h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components};return u||f("CH",!1),u.Code||f("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Fix mismatched versions in this group by choosing the lowest/oldest semver version in use."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:["the"],active:"the",heightRatio:1},files:[{name:"the",title:'"Choose',lowest:!0,valid:!0,semver:!0,version:!0,when:!0,fixing:!0,'mismatches"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"preferVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"lowestSemver",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"preferversion",children:"preferVersion"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsxs)(e.p,{children:["Defaults to ",(0,n.jsx)(e.code,{children:"highestSemver"})," but can be optionally changed to ",(0,n.jsx)(e.code,{children:"lowestSemver"}),"."]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function m(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/25517a24.24813d9b.js b/assets/js/25517a24.24813d9b.js deleted file mode 100644 index 7554957a..00000000 --- a/assets/js/25517a24.24813d9b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6621],{3131:(e,o,n)=>{n.r(o),n.d(o,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>m,frontMatter:()=>d,metadata:()=>h,toc:()=>x});var t=n(5893),s=n(1151),r=n(9794),c=n(9960);function l(e){const o={code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,t.jsxs)(o.table,{children:[(0,t.jsx)(o.thead,{children:(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.th,{children:"Range"}),(0,t.jsx)(o.th,{children:"Example"})]})}),(0,t.jsxs)(o.tbody,{children:[(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<="})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<=1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:'""'})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"~"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"~1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"^"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"^1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">="})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">=1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"*"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"*"})})]})]})]})}function p(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}function i(e){return(0,t.jsxs)("span",{children:[(0,t.jsx)(c.Z,{to:"/config/version-groups/banned",children:"Banned"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/ignored",children:"Ignored"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/lowest-version",children:"Lowest Version"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/pinned",children:"Pinned"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To"}),", and ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard",children:"Standard"})]})}function a(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(i,{...e})}):i()}const d={id:"getting-started",title:"Getting Started"},F=void 0,h={id:"guide/getting-started",title:"Getting Started",description:"Syncpack is a command-line tool to manage multiple package.json files.",source:"@site/docs/guide/getting-started.mdx",sourceDirName:"guide",slug:"/guide/getting-started",permalink:"/syncpack/guide/getting-started",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/getting-started.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"getting-started",title:"Getting Started"},sidebar:"docs",next:{title:"Local Package Versions",permalink:"/syncpack/guide/local-package-versions"}},y={},u={annotations:r.ds,Code:r.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Quick run",id:"quick-run",level:2},{value:"Install",id:"install",level:2},{value:"Run",id:"run",level:2},{value:"Start Small",id:"start-small",level:2},{value:"peerDependencies",id:"peerdependencies",level:3},{value:"workspace:*",id:"workspace",level:3},{value:"Audit",id:"audit",level:2},{value:"Semver Ranges",id:"semver-ranges",level:2},{value:"Adding overrides",id:"adding-overrides",level:3},{value:"Version Mismatches",id:"version-mismatches",level:2},{value:"Adding overrides",id:"adding-overrides-1",level:3},{value:"Version Groups",id:"version-groups",level:3},{value:"Incompatible packages using the same framework",id:"incompatible-packages-using-the-same-framework",level:4},{value:"Keep going",id:"keep-going",level:2},{value:"Update monorepo dependencies",id:"update-monorepo-dependencies",level:2},{value:"Next Steps",id:"next-steps",level:2}];function j(e){const o={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",li:"li",mdxAdmonitionTitle:"mdxAdmonitionTitle",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components},{Details:n}=o;return u||E("CH",!1),u.Code||E("CH.Code",!0),n||E("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,t.jsx)(o.p,{children:"Syncpack is a command-line tool to manage multiple package.json files."}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"Find and fix dependency version mismatches."}),"\n",(0,t.jsx)(o.li,{children:"Enforce a single version policy, or create partitions with separate policies."}),"\n",(0,t.jsx)(o.li,{children:"Find and bump outdated versions from the npm registry."}),"\n",(0,t.jsx)(o.li,{children:"Ensure some dependencies always remain pinned at a specific version."}),"\n",(0,t.jsx)(o.li,{children:"Ban some dependencies from being used: anywhere, or in specific places."}),"\n",(0,t.jsx)(o.li,{children:"Define rules for where exact or loose semver ranges should be used."}),"\n",(0,t.jsx)(o.li,{children:"Assign packages as the source of truth for specific dependencies' versions."}),"\n",(0,t.jsx)(o.li,{children:"Sort and format package.json files consistently."}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"quick-run",children:"Quick run"}),"\n",(0,t.jsxs)(o.p,{children:["The quickest way to run syncpack to try it is via ",(0,t.jsx)(o.a,{href:"https://docs.npmjs.com/cli/v7/commands/npx",children:"npx"}),"."]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"npx ",props:{style:{color:"#F8F8F2"}}},{content:"syncpack list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h2,{id:"install",children:"Install"}),"\n",(0,t.jsx)(o.p,{children:"It's best to install syncpack as a dev dependency, so that everyone working on your project uses the same version."}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"npm ",props:{style:{color:"#F8F8F2"}}},{content:"install syncpack ",props:{style:{color:"#F1FA8C"}}},{content:"--save-dev",props:{style:{color:"#BD93F9"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["Anyone on the team can now use ",(0,t.jsx)(o.a,{href:"https://docs.npmjs.com/cli/v10/commands/npm-exec",children:"npm exec"})," to access their local installation of syncpack:"]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"npm ",props:{style:{color:"#F8F8F2"}}},{content:"exec syncpack ",props:{style:{color:"#F1FA8C"}}},{content:"-- ",props:{style:{color:"#BD93F9"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"For the rest of this guide I will run synpack as if it is installed globally."}),"\n",(0,t.jsx)(o.h2,{id:"run",children:"Run"}),"\n",(0,t.jsx)(o.p,{children:"List every dependency in every package.json file in the project:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["List only the contents of the ",(0,t.jsx)(o.code,{children:"dependencies"})," and ",(0,t.jsx)(o.code,{children:"devDependencies"})," objects:"]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"dev,prod",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"List the versions of packages developed in this project:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"local",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h2,{id:"start-small",children:"Start Small"}),"\n",(0,t.jsx)(o.p,{children:"When setting up a project, I'd recommend that you start small and focus on only production dependencies. Monorepos are large and complex and I think it's better to tackle them in stages."}),"\n",(0,t.jsx)(o.p,{children:"Create the following config file in the root of your project:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["Now syncpack commands will only inspect the ",(0,t.jsx)(o.code,{children:"dependencies"})," properties of package.json files."]}),"\n",(0,t.jsxs)(o.admonition,{title:"Why start small?",type:"tip",children:[(0,t.jsx)(o.p,{children:"If you have a monorepo-wide single version policy which applies universally without exception, you will not need to define any configuration, but most projects are not like that."}),(0,t.jsx)(o.p,{children:"Here are two common examples where a single version policy is unsuitable."}),(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsx)(o.h3,{id:"peerdependencies",children:(0,t.jsx)(o.code,{children:"peerDependencies"})}),"\n",(0,t.jsxs)(o.p,{children:["One of the packages you develop is an ESLint Plugin and in its ",(0,t.jsx)(o.code,{children:"peerDependencies"})," you define a range of ",(0,t.jsx)(o.code,{children:'"eslint": ">=6.0.0 <9.0.0"'})," for the ESLint versions it is compatible with."]}),"\n",(0,t.jsxs)(o.p,{children:["In the root package.json you have ",(0,t.jsx)(o.code,{children:'"eslint": "8.53.0"'})," installed under ",(0,t.jsx)(o.code,{children:"devDependencies"})," because you use ESLint to lint the monorepo."]}),"\n",(0,t.jsx)(o.p,{children:"That's a version mismatch because ESLint is referenced twice with different versions. As Developers on the project we know this is Ok but a tool like syncpack can't know whether any given mismatch is deliberate or a mistake, without information about the project."}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsx)(o.h3,{id:"workspace",children:(0,t.jsx)(o.code,{children:"workspace:*"})}),"\n",(0,t.jsxs)(o.p,{children:["Projects using the ",(0,t.jsx)(c.Z,{to:"https://pnpm.io/workspaces#workspace-protocol-workspace",children:"pnpm workspace protocol"})," may use ",(0,t.jsx)(o.code,{children:"workspace:*"})," when referencing a local package in ",(0,t.jsx)(o.code,{children:"devDependencies"}),", but the latest semver version in ",(0,t.jsx)(o.code,{children:"dependencies"})," so it is understood by other package managers."]}),"\n",(0,t.jsx)(o.p,{children:"Again, this is a mismatch but a deliberate one which syncpack needs to be informed of."}),"\n"]}),"\n"]})]}),"\n",(0,t.jsx)(o.h2,{id:"audit",children:"Audit"}),"\n",(0,t.jsx)(o.p,{children:"Now take a look at your production dependencies:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["You will likely see some warnings, and each warning will display an error code to identify the reason it is invalid. Every warning is explained in the ",(0,t.jsx)(c.Z,{to:"/status-codes",children:"Error Codes"})," documentation."]}),"\n",(0,t.jsx)(o.p,{children:"We'll look at how to fix mismatching versions, but first let's look at the semver ranges."}),"\n",(0,t.jsx)(o.h2,{id:"semver-ranges",children:"Semver Ranges"}),"\n",(0,t.jsxs)(n,{children:[(0,t.jsx)("summary",{children:"Examples of Semver Ranges"}),(0,t.jsx)(p,{})]}),"\n",(0,t.jsxs)(o.p,{children:["Looking at your ",(0,t.jsx)(o.code,{children:"syncpack list"})," output, which semver range is used in the majority of cases?"]}),"\n",(0,t.jsx)(o.p,{children:"Supposing you prefer exact version numbers, you can define a policy to standardise them:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"3:11",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use exact version numbers in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(o.admonition,{type:"tip",children:(0,t.jsxs)(o.p,{children:[(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range#packages",children:"packages"})," and ",(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range#dependencies",children:"dependencies"})," match all by default, so you can remove those properties from your config if you prefer."]})}),"\n",(0,t.jsxs)(o.p,{children:["What we've created is called a ",(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range",children:"Semver Group"}),". Whenever syncpack finds an ",(0,t.jsx)(c.Z,{to:"#whats-an-instance",children:"instance of a dependency"}),", it walks through your ",(0,t.jsx)(o.code,{children:"semverGroups"})," array in source code order until it finds a match \u2013 the first match wins and syncpack stops searching. An instance can only belong to one Semver Group (and one ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard",children:"Version Group"}),", which we'll see later) and the groups an instance belongs to define the rules that form its version policy."]}),"\n",(0,t.jsxs)(o.p,{children:["In our case we've decided that every instance under a ",(0,t.jsx)(o.code,{children:"dependencies"})," object must always have a semver range of ",(0,t.jsx)(o.code,{children:'""'})," for an exact version number."]}),"\n",(0,t.jsx)("div",{id:"whats-an-instance",children:(0,t.jsxs)(o.admonition,{title:"What's an instance of a dependency?",type:"info",children:[(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"There are 4 packages in your monorepo (A, B, C, and D)."}),"\n",(0,t.jsxs)(o.li,{children:["A B C D all depend on ",(0,t.jsx)(o.code,{children:"uuid"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["A B C each have it under ",(0,t.jsx)(o.code,{children:"dependencies"})," (3x)."]}),"\n",(0,t.jsxs)(o.li,{children:["D has it under ",(0,t.jsx)(o.code,{children:"devDependencies"})," and ",(0,t.jsx)(o.code,{children:"peerDependencies"})," (2x)."]}),"\n"]}),(0,t.jsxs)(o.p,{children:['There are 5 "instances" of the dependency ',(0,t.jsx)(o.code,{children:"uuid"}),"."]})]})}),"\n",(0,t.jsx)(o.p,{children:"We can now check the semver ranges of our production dependencies:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"lint-semver-ranges",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"...fix them"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"set-semver-ranges",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"...and see that they are now valid"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"lint-semver-ranges",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h3,{id:"adding-overrides",children:"Adding overrides"}),"\n",(0,t.jsxs)(o.p,{children:["Sometimes you will have exceptions to a rule, instances which for whatever reason can't conform to a broader policy and need special treatment. To override a Semver or Version Group, define a more specific one nearer the start of the ",(0,t.jsx)(o.code,{children:"semverGroups"})," or ",(0,t.jsx)(o.code,{children:"versionGroups"})," array."]}),"\n",(0,t.jsxs)(o.p,{children:["For example, to use ",(0,t.jsx)(o.code,{children:"^"})," in just one package we could use the following config, where ",(0,t.jsx)(o.code,{children:"dashboard-ui"})," is the ",(0,t.jsx)(o.code,{children:"name"})," property of the package.json file we want to make an exception for."]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"4:10",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use caret ranges in the dashboard-ui in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use exact version numbers in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(o.admonition,{title:"Order groups by most to least specific",type:"info",children:[(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"Syncpack matches instances against each group from first to last."}),"\n",(0,t.jsx)(o.li,{children:"The first group which matches a given instance wins and syncpack stops searching."}),"\n",(0,t.jsxs)(o.li,{children:["The ",(0,t.jsx)(o.code,{children:"^"})," group we just added requires that an instance be located in ",(0,t.jsx)(o.code,{children:"dependencies"})," ",(0,t.jsx)(o.em,{children:"and"})," in a local package.json file with a ",(0,t.jsx)(o.code,{children:"name"})," property of ",(0,t.jsx)(o.code,{children:"dashboard-ui"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["The ",(0,t.jsx)(o.code,{children:'""'})," group only requires that an instance be located in ",(0,t.jsx)(o.code,{children:"dependencies"})," and nothing more."]}),"\n"]}),(0,t.jsxs)(o.p,{children:["So our new ",(0,t.jsx)(o.code,{children:"^"})," group must appear before the ",(0,t.jsx)(o.code,{children:'""'})," group or else the more generic requirements of only needing to be in ",(0,t.jsx)(o.code,{children:"dependencies"})," would win out and syncpack would stop searching before looking at which package the instance is in."]})]}),"\n",(0,t.jsxs)(o.p,{children:["Now when we run ",(0,t.jsx)(o.code,{children:"syncpack lint-semver-ranges"})," we will see that ",(0,t.jsx)(o.code,{children:"dashboard-ui"})," is invalid because we updated out configuration to expect caret ranges and haven't updated them yet. When we run ",(0,t.jsx)(o.code,{children:"syncpack set-semver-ranges"})," they are fixed to have caret ranges as expected. The rest of the monorepo continues to use exact version numbers for production dependencies."]}),"\n",(0,t.jsx)(o.h2,{id:"version-mismatches",children:"Version Mismatches"}),"\n",(0,t.jsxs)(o.p,{children:["Now that we're using consistent semver ranges under ",(0,t.jsx)(o.code,{children:"dependencies"}),", let's return to version mismatches."]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["The most common of syncpack's ",(0,t.jsx)(c.Z,{to:"/status-codes",children:"Error Codes"})," is ",(0,t.jsx)(o.code,{children:"HighestSemverMismatch"})," which tells us that all versions used for that dependency are valid semver, but they are not identical and the one with the highest semver version should be used by all."]}),"\n",(0,t.jsx)(o.p,{children:"If you don't have any special requirements, they can be fixed automatically"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["If you see ",(0,t.jsx)(o.code,{children:"UnsupportedMismatch"})," warnings, those are cases where there is no semver version (such as a reference to a file or a git hash) and syncpack cannot know what you would want to do."]}),"\n",(0,t.jsx)(o.p,{children:"You can resolve those using an interactive walkthrough:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"prompt",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h3,{id:"adding-overrides-1",children:"Adding overrides"}),"\n",(0,t.jsxs)(o.p,{children:["We saw earlier how to handle overrides for ",(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range",children:"Semver Groups"})," and ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard",children:"Version Groups"})," work in exactly the same way."]}),"\n",(0,t.jsx)(o.p,{children:"A group can be applied to an entire monorepo, specific instances, or anything in between. Groups can be layered over others to apply overrides as we saw in the previous section."}),"\n",(0,t.jsxs)(o.p,{children:["You should hopefully now have a good intuition for how instances get assigned to groups. All that remains is to choose groups which exhibit the behaviour you need and to apply combinations of the ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard#dependencies",children:"dependencies"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard#dependencyTypes",children:"dependencyTypes"}),", and ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard#packages",children:"packages"})," properties to them to target the instances you need to."]}),"\n",(0,t.jsx)(o.p,{children:"Version Groups provide a lot of really useful functionality, let's look at them some more."}),"\n",(0,t.jsx)(o.h3,{id:"version-groups",children:"Version Groups"}),"\n",(0,t.jsx)(o.p,{children:"Version Groups create partitions where dependencies inside each group can be internally consistent, without affecting the other groups. They let you handle special cases or provide more specific rules for what to do in certain situations and are best understood by looking at some example use cases."}),"\n",(0,t.jsx)(o.h4,{id:"incompatible-packages-using-the-same-framework",children:"Incompatible packages using the same framework"}),"\n",(0,t.jsx)(o.p,{children:"A 3rd party framework has had a major update which requires breaking changes but some of your packages can't easily be upgraded and will need to remain on an older version, while the rest are able to upgrade today."}),"\n",(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["You ",(0,t.jsx)(o.strong,{children:"don't"})," want mismatches between your packages using the latest version of the framework - they should all use eg. ",(0,t.jsx)(o.code,{children:"next@13.1.6"})," and ",(0,t.jsx)(o.code,{children:"react@18.2.0"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["You ",(0,t.jsx)(o.strong,{children:"don't"})," want mismatches between the packages using the old version - they should all use eg. ",(0,t.jsx)(o.code,{children:"next@11.1.4"})," and ",(0,t.jsx)(o.code,{children:"react@17.0.2"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["You ",(0,t.jsx)(o.strong,{children:"do"})," want those groups to use ",(0,t.jsx)(o.strong,{children:"different versions to each other"})," and not have Syncpack make them all the same."]}),"\n",(0,t.jsxs)(o.li,{children:["You only have this problem with ",(0,t.jsx)(o.code,{children:"next"})," and ",(0,t.jsx)(o.code,{children:"react"}),", other dependencies can continue to be kept consistent with each other throughout the full monorepo."]}),"\n"]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"19:26",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use caret ranges in the dashboard-ui in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use exact version numbers in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"These packages are stuck on next@11 for now",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@stricken/server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@stricken/ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"next",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(o.admonition,{title:"Syncpack will make ensure that",type:"info",children:(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["The versions of ",(0,t.jsx)(o.code,{children:"next"})," and ",(0,t.jsx)(o.code,{children:"react"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Are the same between ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Are the same across every package ",(0,t.jsx)(o.strong,{children:"except"})," ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Can be different in ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"})," to the other packages."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["The versions of every ",(0,t.jsx)(o.strong,{children:"other"})," dependency in the monorepo (eg ",(0,t.jsx)(o.code,{children:"lodash"}),") are the same across every package ",(0,t.jsx)(o.strong,{children:"including"})," ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"}),"."]}),"\n"]})}),"\n",(0,t.jsx)(o.h2,{id:"keep-going",children:"Keep going"}),"\n",(0,t.jsxs)(o.admonition,{type:"warning",children:[(0,t.jsxs)(o.mdxAdmonitionTitle,{children:["Remember, We've only been linting ",(0,t.jsx)(o.code,{children:"dependencies"})]}),(0,t.jsxs)(o.p,{children:["At the start of this guide we used ",(0,t.jsx)(c.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," to configure syncpack to only look at ",(0,t.jsx)(o.code,{children:"dependencies"}),", so the rest of our monorepo is currently being ignored."]}),(0,t.jsxs)(o.p,{children:["Move onto ",(0,t.jsx)(o.code,{children:"dev"})," for ",(0,t.jsx)(o.code,{children:"devDependencies"})," next and repeat the process we just followed."]}),(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"2[31:35]",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),(0,t.jsxs)(o.p,{children:["Then do the same for ",(0,t.jsx)(o.code,{children:"local"})," (versions of your local packages) and ",(0,t.jsx)(o.code,{children:"peer"})," (",(0,t.jsx)(o.code,{children:"peerDependencies"}),")."]})]}),"\n",(0,t.jsx)(o.h2,{id:"update-monorepo-dependencies",children:"Update monorepo dependencies"}),"\n",(0,t.jsx)(o.p,{children:"Syncpack can also update dependencies to the latest versions from the npm registry and is best demonstrated by example."}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"# update packages in `devDependencies` in the whole repo",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}}]},{tokens:[{content:"# update eslint related packages",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--filter ",props:{style:{color:"#BD93F9"}}},{content:"eslint",props:{style:{color:"#F1FA8C"}}}]},{tokens:[{content:"# update `dependencies` in just one package",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--source ",props:{style:{color:"#BD93F9"}}},{content:"packages/foo ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}}]},{tokens:[{content:"# update react related packages in `dependencies` only",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--filter ",props:{style:{color:"#BD93F9"}}},{content:"react ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"You'll be guided through an interactive prompt to choose which updates you want to apply."}),"\n",(0,t.jsx)(o.h2,{id:"next-steps",children:"Next Steps"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Browse the ",(0,t.jsx)(c.Z,{to:"/examples",children:"Examples"})," to see some common use cases and how to handle them."]}),"\n",(0,t.jsxs)(o.li,{children:["See what other functionality is provided by Version Groups ",(0,t.jsx)(a,{}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Read the guide on ",(0,t.jsx)(c.Z,{to:"/guide/local-package-versions",children:"Local Package Versions"}),", which is an advanced topic."]}),"\n",(0,t.jsxs)(o.li,{children:["If you like Syncpack, ",(0,t.jsx)(o.strong,{children:"tell people about it"}),". Syncpack is a single person project done in what spare time I can find, has been an absolute ton of work, and is completely free."]}),"\n"]})]})}function m(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(j,{...e})}):j(e)}function E(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/25517a24.321bcae1.js b/assets/js/25517a24.321bcae1.js new file mode 100644 index 00000000..6dc255fd --- /dev/null +++ b/assets/js/25517a24.321bcae1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6621],{3131:(e,o,n)=>{n.r(o),n.d(o,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>m,frontMatter:()=>d,metadata:()=>h,toc:()=>x});var t=n(5893),s=n(1151),r=n(9794),c=n(9960);function l(e){const o={code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,t.jsxs)(o.table,{children:[(0,t.jsx)(o.thead,{children:(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.th,{children:"Range"}),(0,t.jsx)(o.th,{children:"Example"})]})}),(0,t.jsxs)(o.tbody,{children:[(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<="})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"<=1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:'""'})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"~"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"~1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"^"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"^1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">="})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">=1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:">1.4.2"})})]}),(0,t.jsxs)(o.tr,{children:[(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"*"})}),(0,t.jsx)(o.td,{children:(0,t.jsx)(o.code,{children:"*"})})]})]})]})}function p(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}function i(e){return(0,t.jsxs)("span",{children:[(0,t.jsx)(c.Z,{to:"/config/version-groups/banned",children:"Banned"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/ignored",children:"Ignored"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/lowest-version",children:"Lowest Version"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/pinned",children:"Pinned"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To"}),", and ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard",children:"Standard"})]})}function a(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(i,{...e})}):i()}const d={id:"getting-started",title:"Getting Started"},F=void 0,h={id:"guide/getting-started",title:"Getting Started",description:"Syncpack is a command-line tool to manage multiple package.json files.",source:"@site/docs/guide/getting-started.mdx",sourceDirName:"guide",slug:"/guide/getting-started",permalink:"/syncpack/guide/getting-started",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/getting-started.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"getting-started",title:"Getting Started"},sidebar:"docs",next:{title:"Local Package Versions",permalink:"/syncpack/guide/local-package-versions"}},y={},u={annotations:r.ds,Code:r.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Quick run",id:"quick-run",level:2},{value:"Install",id:"install",level:2},{value:"Run",id:"run",level:2},{value:"Start Small",id:"start-small",level:2},{value:"peerDependencies",id:"peerdependencies",level:3},{value:"workspace:*",id:"workspace",level:3},{value:"Audit",id:"audit",level:2},{value:"Semver Ranges",id:"semver-ranges",level:2},{value:"Adding overrides",id:"adding-overrides",level:3},{value:"Version Mismatches",id:"version-mismatches",level:2},{value:"Adding overrides",id:"adding-overrides-1",level:3},{value:"Version Groups",id:"version-groups",level:3},{value:"Incompatible packages using the same framework",id:"incompatible-packages-using-the-same-framework",level:4},{value:"Keep going",id:"keep-going",level:2},{value:"Update monorepo dependencies",id:"update-monorepo-dependencies",level:2},{value:"Next Steps",id:"next-steps",level:2}];function j(e){const o={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",li:"li",mdxAdmonitionTitle:"mdxAdmonitionTitle",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components},{Details:n}=o;return u||E("CH",!1),u.Code||E("CH.Code",!0),n||E("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,t.jsx)(o.p,{children:"Syncpack is a command-line tool to manage multiple package.json files."}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"Find and fix dependency version mismatches."}),"\n",(0,t.jsx)(o.li,{children:"Enforce a single version policy, or create partitions with separate policies."}),"\n",(0,t.jsx)(o.li,{children:"Find and bump outdated versions from the npm registry."}),"\n",(0,t.jsx)(o.li,{children:"Ensure some dependencies always remain pinned at a specific version."}),"\n",(0,t.jsx)(o.li,{children:"Ban some dependencies from being used: anywhere, or in specific places."}),"\n",(0,t.jsx)(o.li,{children:"Define rules for where exact or loose semver ranges should be used."}),"\n",(0,t.jsx)(o.li,{children:"Assign packages as the source of truth for specific dependencies' versions."}),"\n",(0,t.jsx)(o.li,{children:"Sort and format package.json files consistently."}),"\n"]}),"\n",(0,t.jsx)(o.h2,{id:"quick-run",children:"Quick run"}),"\n",(0,t.jsxs)(o.p,{children:["The quickest way to run syncpack to try it is via ",(0,t.jsx)(o.a,{href:"https://docs.npmjs.com/cli/v7/commands/npx",children:"npx"}),"."]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"npx ",props:{style:{color:"#F8F8F2"}}},{content:"syncpack list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h2,{id:"install",children:"Install"}),"\n",(0,t.jsx)(o.p,{children:"It's best to install syncpack as a dev dependency, so that everyone working on your project uses the same version."}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"npm ",props:{style:{color:"#F8F8F2"}}},{content:"install syncpack ",props:{style:{color:"#F1FA8C"}}},{content:"--save-dev",props:{style:{color:"#BD93F9"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["Anyone on the team can now use ",(0,t.jsx)(o.a,{href:"https://docs.npmjs.com/cli/v10/commands/npm-exec",children:"npm exec"})," to access their local installation of syncpack:"]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"npm ",props:{style:{color:"#F8F8F2"}}},{content:"exec syncpack ",props:{style:{color:"#F1FA8C"}}},{content:"-- ",props:{style:{color:"#BD93F9"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"For the rest of this guide I will run synpack as if it is installed globally."}),"\n",(0,t.jsx)(o.h2,{id:"run",children:"Run"}),"\n",(0,t.jsx)(o.p,{children:"List every dependency in every package.json file in the project:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["List only the contents of the ",(0,t.jsx)(o.code,{children:"dependencies"})," and ",(0,t.jsx)(o.code,{children:"devDependencies"})," objects:"]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"dev,prod",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"List the versions of packages developed in this project:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"local",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h2,{id:"start-small",children:"Start Small"}),"\n",(0,t.jsx)(o.p,{children:"When setting up a project, I'd recommend that you start small and focus on only production dependencies. Monorepos are large and complex and I think it's better to tackle them in stages."}),"\n",(0,t.jsx)(o.p,{children:"Create the following config file in the root of your project:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["Now syncpack commands will only inspect the ",(0,t.jsx)(o.code,{children:"dependencies"})," properties of package.json files."]}),"\n",(0,t.jsxs)(o.admonition,{title:"Why start small?",type:"tip",children:[(0,t.jsx)(o.p,{children:"If you have a monorepo-wide single version policy which applies universally without exception, you will not need to define any configuration, but most projects are not like that."}),(0,t.jsx)(o.p,{children:"Here are two common examples where a single version policy is unsuitable."}),(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsx)(o.h3,{id:"peerdependencies",children:(0,t.jsx)(o.code,{children:"peerDependencies"})}),"\n",(0,t.jsxs)(o.p,{children:["One of the packages you develop is an ESLint Plugin and in its ",(0,t.jsx)(o.code,{children:"peerDependencies"})," you define a range of ",(0,t.jsx)(o.code,{children:'"eslint": ">=6.0.0 <9.0.0"'})," for the ESLint versions it is compatible with."]}),"\n",(0,t.jsxs)(o.p,{children:["In the root package.json you have ",(0,t.jsx)(o.code,{children:'"eslint": "8.53.0"'})," installed under ",(0,t.jsx)(o.code,{children:"devDependencies"})," because you use ESLint to lint the monorepo."]}),"\n",(0,t.jsx)(o.p,{children:"That's a version mismatch because ESLint is referenced twice with different versions. As Developers on the project we know this is Ok but a tool like syncpack can't know whether any given mismatch is deliberate or a mistake, without information about the project."}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["\n",(0,t.jsx)(o.h3,{id:"workspace",children:(0,t.jsx)(o.code,{children:"workspace:*"})}),"\n",(0,t.jsxs)(o.p,{children:["Projects using the ",(0,t.jsx)(c.Z,{to:"https://pnpm.io/workspaces#workspace-protocol-workspace",children:"pnpm workspace protocol"})," may use ",(0,t.jsx)(o.code,{children:"workspace:*"})," when referencing a local package in ",(0,t.jsx)(o.code,{children:"devDependencies"}),", but the latest semver version in ",(0,t.jsx)(o.code,{children:"dependencies"})," so it is understood by other package managers."]}),"\n",(0,t.jsx)(o.p,{children:"Again, this is a mismatch but a deliberate one which syncpack needs to be informed of."}),"\n"]}),"\n"]})]}),"\n",(0,t.jsx)(o.h2,{id:"audit",children:"Audit"}),"\n",(0,t.jsx)(o.p,{children:"Now take a look at your production dependencies:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["You will likely see some warnings, and each warning will display an error code to identify the reason it is invalid. Every warning is explained in the ",(0,t.jsx)(c.Z,{to:"/status-codes",children:"Error Codes"})," documentation."]}),"\n",(0,t.jsx)(o.p,{children:"We'll look at how to fix mismatching versions, but first let's look at the semver ranges."}),"\n",(0,t.jsx)(o.h2,{id:"semver-ranges",children:"Semver Ranges"}),"\n",(0,t.jsxs)(n,{children:[(0,t.jsx)("summary",{children:"Examples of Semver Ranges"}),(0,t.jsx)(p,{})]}),"\n",(0,t.jsxs)(o.p,{children:["Looking at your ",(0,t.jsx)(o.code,{children:"syncpack list"})," output, which semver range is used in the majority of cases?"]}),"\n",(0,t.jsx)(o.p,{children:"Supposing you prefer exact version numbers, you can define a policy to standardise them:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"3:11",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use exact version numbers in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(o.admonition,{type:"tip",children:(0,t.jsxs)(o.p,{children:[(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range#packages",children:"packages"})," and ",(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range#dependencies",children:"dependencies"})," match all by default, so you can remove those properties from your config if you prefer."]})}),"\n",(0,t.jsxs)(o.p,{children:["What we've created is called a ",(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range",children:"Semver Group"}),". Whenever syncpack finds an ",(0,t.jsx)(c.Z,{to:"#whats-an-instance",children:"instance of a dependency"}),", it walks through your ",(0,t.jsx)(o.code,{children:"semverGroups"})," array in source code order until it finds a match \u2013 the first match wins and syncpack stops searching. An instance can only belong to one Semver Group (and one ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard",children:"Version Group"}),", which we'll see later) and the groups an instance belongs to define the rules that form its version policy."]}),"\n",(0,t.jsxs)(o.p,{children:["In our case we've decided that every instance under a ",(0,t.jsx)(o.code,{children:"dependencies"})," object must always have a semver range of ",(0,t.jsx)(o.code,{children:'""'})," for an exact version number."]}),"\n",(0,t.jsx)("div",{id:"whats-an-instance",children:(0,t.jsxs)(o.admonition,{title:"What's an instance of a dependency?",type:"info",children:[(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"There are 4 packages in your monorepo (A, B, C, and D)."}),"\n",(0,t.jsxs)(o.li,{children:["A B C D all depend on ",(0,t.jsx)(o.code,{children:"uuid"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["A B C each have it under ",(0,t.jsx)(o.code,{children:"dependencies"})," (3x)."]}),"\n",(0,t.jsxs)(o.li,{children:["D has it under ",(0,t.jsx)(o.code,{children:"devDependencies"})," and ",(0,t.jsx)(o.code,{children:"peerDependencies"})," (2x)."]}),"\n"]}),(0,t.jsxs)(o.p,{children:['There are 5 "instances" of the dependency ',(0,t.jsx)(o.code,{children:"uuid"}),"."]})]})}),"\n",(0,t.jsx)(o.p,{children:"We can now check the semver ranges of our production dependencies:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"lint-semver-ranges",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"...fix them"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"set-semver-ranges",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"...and see that they are now valid"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"lint-semver-ranges",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h3,{id:"adding-overrides",children:"Adding overrides"}),"\n",(0,t.jsxs)(o.p,{children:["Sometimes you will have exceptions to a rule, instances which for whatever reason can't conform to a broader policy and need special treatment. To override a Semver or Version Group, define a more specific one nearer the start of the ",(0,t.jsx)(o.code,{children:"semverGroups"})," or ",(0,t.jsx)(o.code,{children:"versionGroups"})," array."]}),"\n",(0,t.jsxs)(o.p,{children:["For example, to use ",(0,t.jsx)(o.code,{children:"^"})," in just one package we could use the following config, where ",(0,t.jsx)(o.code,{children:"dashboard-ui"})," is the ",(0,t.jsx)(o.code,{children:"name"})," property of the package.json file we want to make an exception for."]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"4:10",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use caret ranges in the dashboard-ui in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use exact version numbers in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(o.admonition,{title:"Order groups by most to least specific",type:"info",children:[(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsx)(o.li,{children:"Syncpack matches instances against each group from first to last."}),"\n",(0,t.jsx)(o.li,{children:"The first group which matches a given instance wins and syncpack stops searching."}),"\n",(0,t.jsxs)(o.li,{children:["The ",(0,t.jsx)(o.code,{children:"^"})," group we just added requires that an instance be located in ",(0,t.jsx)(o.code,{children:"dependencies"})," ",(0,t.jsx)(o.em,{children:"and"})," in a local package.json file with a ",(0,t.jsx)(o.code,{children:"name"})," property of ",(0,t.jsx)(o.code,{children:"dashboard-ui"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["The ",(0,t.jsx)(o.code,{children:'""'})," group only requires that an instance be located in ",(0,t.jsx)(o.code,{children:"dependencies"})," and nothing more."]}),"\n"]}),(0,t.jsxs)(o.p,{children:["So our new ",(0,t.jsx)(o.code,{children:"^"})," group must appear before the ",(0,t.jsx)(o.code,{children:'""'})," group or else the more generic requirements of only needing to be in ",(0,t.jsx)(o.code,{children:"dependencies"})," would win out and syncpack would stop searching before looking at which package the instance is in."]})]}),"\n",(0,t.jsxs)(o.p,{children:["Now when we run ",(0,t.jsx)(o.code,{children:"syncpack lint-semver-ranges"})," we will see that ",(0,t.jsx)(o.code,{children:"dashboard-ui"})," is invalid because we updated out configuration to expect caret ranges and haven't updated them yet. When we run ",(0,t.jsx)(o.code,{children:"syncpack set-semver-ranges"})," they are fixed to have caret ranges as expected. The rest of the monorepo continues to use exact version numbers for production dependencies."]}),"\n",(0,t.jsx)(o.h2,{id:"version-mismatches",children:"Version Mismatches"}),"\n",(0,t.jsxs)(o.p,{children:["Now that we're using consistent semver ranges under ",(0,t.jsx)(o.code,{children:"dependencies"}),", let's return to version mismatches."]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["The most common of syncpack's ",(0,t.jsx)(c.Z,{to:"/status-codes",children:"Error Codes"})," is ",(0,t.jsx)(o.code,{children:"HighestSemverMismatch"})," which tells us that all versions used for that dependency are valid semver, but they are not identical and the one with the highest semver version should be used by all."]}),"\n",(0,t.jsx)(o.p,{children:"If you don't have any special requirements, they can be fixed automatically"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["If you see ",(0,t.jsx)(o.code,{children:"UnsupportedMismatch"})," warnings, those are cases where there is no semver version (such as a reference to a file or a git hash) and syncpack cannot know what you would want to do."]}),"\n",(0,t.jsx)(o.p,{children:"You can resolve those using an interactive walkthrough:"}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"prompt",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.h3,{id:"adding-overrides-1",children:"Adding overrides"}),"\n",(0,t.jsxs)(o.p,{children:["We saw earlier how to handle overrides for ",(0,t.jsx)(c.Z,{to:"/config/semver-groups/with-range",children:"Semver Groups"})," and ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard",children:"Version Groups"})," work in exactly the same way."]}),"\n",(0,t.jsx)(o.p,{children:"A group can be applied to an entire monorepo, specific instances, or anything in between. Groups can be layered over others to apply overrides as we saw in the previous section."}),"\n",(0,t.jsxs)(o.p,{children:["You should hopefully now have a good intuition for how instances get assigned to groups. All that remains is to choose groups which exhibit the behaviour you need and to apply combinations of the ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard#dependencies",children:"dependencies"}),", ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard#dependencyTypes",children:"dependencyTypes"}),", and ",(0,t.jsx)(c.Z,{to:"/config/version-groups/standard#packages",children:"packages"})," properties to them to target the instances you need to."]}),"\n",(0,t.jsx)(o.p,{children:"Version Groups provide a lot of really useful functionality, let's look at them some more."}),"\n",(0,t.jsx)(o.h3,{id:"version-groups",children:"Version Groups"}),"\n",(0,t.jsx)(o.p,{children:"Version Groups create partitions where dependencies inside each group can be internally consistent, without affecting the other groups. They let you handle special cases or provide more specific rules for what to do in certain situations and are best understood by looking at some example use cases."}),"\n",(0,t.jsx)(o.h4,{id:"incompatible-packages-using-the-same-framework",children:"Incompatible packages using the same framework"}),"\n",(0,t.jsx)(o.p,{children:"A 3rd party framework has had a major update which requires breaking changes but some of your packages can't easily be upgraded and will need to remain on an older version, while the rest are able to upgrade today."}),"\n",(0,t.jsxs)(o.ol,{children:["\n",(0,t.jsxs)(o.li,{children:["You ",(0,t.jsx)(o.strong,{children:"don't"})," want mismatches between your packages using the latest version of the framework - they should all use eg. ",(0,t.jsx)(o.code,{children:"next@13.1.6"})," and ",(0,t.jsx)(o.code,{children:"react@18.2.0"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["You ",(0,t.jsx)(o.strong,{children:"don't"})," want mismatches between the packages using the old version - they should all use eg. ",(0,t.jsx)(o.code,{children:"next@11.1.4"})," and ",(0,t.jsx)(o.code,{children:"react@17.0.2"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["You ",(0,t.jsx)(o.strong,{children:"do"})," want those groups to use ",(0,t.jsx)(o.strong,{children:"different versions to each other"})," and not have Syncpack make them all the same."]}),"\n",(0,t.jsxs)(o.li,{children:["You only have this problem with ",(0,t.jsx)(o.code,{children:"next"})," and ",(0,t.jsx)(o.code,{children:"react"}),", other dependencies can continue to be kept consistent with each other throughout the full monorepo."]}),"\n"]}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"19:26",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use caret ranges in the dashboard-ui in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"use exact version numbers in production",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"These packages are stuck on next@11 for now",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@stricken/server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@stricken/ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"next",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(o.admonition,{title:"Syncpack will make ensure that",type:"info",children:(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["The versions of ",(0,t.jsx)(o.code,{children:"next"})," and ",(0,t.jsx)(o.code,{children:"react"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Are the same between ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Are the same across every package ",(0,t.jsx)(o.strong,{children:"except"})," ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Can be different in ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"})," to the other packages."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(o.li,{children:["The versions of every ",(0,t.jsx)(o.strong,{children:"other"})," dependency in the monorepo (eg ",(0,t.jsx)(o.code,{children:"lodash"}),") are the same across every package ",(0,t.jsx)(o.strong,{children:"including"})," ",(0,t.jsx)(o.code,{children:"@stricken/server"})," and ",(0,t.jsx)(o.code,{children:"@stricken/ui"}),"."]}),"\n"]})}),"\n",(0,t.jsx)(o.h2,{id:"keep-going",children:"Keep going"}),"\n",(0,t.jsxs)(o.admonition,{type:"warning",children:[(0,t.jsxs)(o.mdxAdmonitionTitle,{children:["Remember, We've only been linting ",(0,t.jsx)(o.code,{children:"dependencies"})]}),(0,t.jsxs)(o.p,{children:["At the start of this guide we used ",(0,t.jsx)(c.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," to configure syncpack to only look at ",(0,t.jsx)(o.code,{children:"dependencies"}),", so the rest of our monorepo is currently being ignored."]}),(0,t.jsxs)(o.p,{children:["Move onto ",(0,t.jsx)(o.code,{children:"dev"})," for ",(0,t.jsx)(o.code,{children:"devDependencies"})," next and repeat the process we just followed."]}),(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"2[31:35]",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),(0,t.jsxs)(o.p,{children:["Then do the same for ",(0,t.jsx)(o.code,{children:"local"})," (versions of your local packages) and ",(0,t.jsx)(o.code,{children:"peer"})," (",(0,t.jsx)(o.code,{children:"peerDependencies"}),")."]})]}),"\n",(0,t.jsx)(o.h2,{id:"update-monorepo-dependencies",children:"Update monorepo dependencies"}),"\n",(0,t.jsx)(o.p,{children:"Syncpack can also update dependencies to the latest versions from the npm registry and is best demonstrated by example."}),"\n",(0,t.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"# update packages in `devDependencies` in the whole repo",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}}]},{tokens:[{content:"# update eslint related packages",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--filter ",props:{style:{color:"#BD93F9"}}},{content:"eslint",props:{style:{color:"#F1FA8C"}}}]},{tokens:[{content:"# update `dependencies` in just one package",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--source ",props:{style:{color:"#BD93F9"}}},{content:"packages/foo ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}}]},{tokens:[{content:"# update react related packages in `dependencies` only",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"update ",props:{style:{color:"#F1FA8C"}}},{content:"--filter ",props:{style:{color:"#BD93F9"}}},{content:"react ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"You'll be guided through an interactive prompt to choose which updates you want to apply."}),"\n",(0,t.jsx)(o.h2,{id:"next-steps",children:"Next Steps"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Browse the ",(0,t.jsx)(c.Z,{to:"/examples",children:"Examples"})," to see some common use cases and how to handle them."]}),"\n",(0,t.jsxs)(o.li,{children:["See what other functionality is provided by Version Groups ",(0,t.jsx)(a,{}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Read the guide on ",(0,t.jsx)(c.Z,{to:"/guide/local-package-versions",children:"Local Package Versions"}),", which is an advanced topic."]}),"\n",(0,t.jsxs)(o.li,{children:["If you like Syncpack, ",(0,t.jsx)(o.strong,{children:"tell people about it"}),". Syncpack is a single person project done in what spare time I can find, has been an absolute ton of work, and is completely free."]}),"\n"]})]})}function m(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(j,{...e})}):j(e)}function E(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/2c8a7579.14cdfb7f.js b/assets/js/2c8a7579.14cdfb7f.js deleted file mode 100644 index fc683fa2..00000000 --- a/assets/js/2c8a7579.14cdfb7f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8817],{3654:(o,t,e)=>{e.r(t),e.d(t,{CH:()=>d,assets:()=>i,chCodeConfig:()=>a,contentTitle:()=>p,default:()=>u,frontMatter:()=>l,metadata:()=>F,toc:()=>y});var n=e(5893),c=e(1151),r=e(9794),s=(e(292),e(8984),e(1700),e(9605),e(4284),e(9960));e(4383),e(7029);const l={id:"syncpackrc",title:".syncpackrc"},p=void 0,F={id:"config/syncpackrc",title:".syncpackrc",description:"Configuration File",source:"@site/docs/config/syncpackrc.mdx",sourceDirName:"config",slug:"/config/syncpackrc",permalink:"/syncpack/config/syncpackrc",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/syncpackrc.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"syncpackrc",title:".syncpackrc"},sidebar:"docs",previous:{title:"update",permalink:"/syncpack/command/update"},next:{title:"customTypes",permalink:"/syncpack/config/custom-types"}},i={},d={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},y=[{value:"Configuration File",id:"configuration-file",level:2},{value:"Defaults",id:"defaults",level:2}];function h(o){const t={code:"code",h2:"h2",li:"li",p:"p",ul:"ul",...(0,c.a)(),...o.components};return d||g("CH",!1),d.Code||g("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(t.h2,{id:"configuration-file",children:"Configuration File"}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(s.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to search the current and ancestor directories for a:"]}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:".syncpackrc"})," file in JSON or YAML format."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:".syncpackrc.json"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.yaml"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.yml"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.js"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.cjs"}),", ",(0,n.jsx)(t.code,{children:"syncpack.config.js"}),", ",(0,n.jsx)(t.code,{children:"syncpack.config.cjs"})," file."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"config.syncpack"})," or ",(0,n.jsx)(t.code,{children:"syncpack"})," property in ",(0,n.jsx)(t.code,{children:"package.json"}),"."]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"A custom name and location can be provided instead:"}),"\n",(0,n.jsx)(d.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--config ",props:{style:{color:"#BD93F9"}}},{content:"./config/syncpack.json",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(t.h2,{id:"defaults",children:"Defaults"}),"\n",(0,n.jsx)(t.p,{children:"Your config file only needs to define values for those you want to change from the defaults below."}),"\n",(0,n.jsx)(d.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" customTypes",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencyTypes",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"local",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"overrides",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"pnpmOverrides",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"resolutions",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" filter",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:".",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" indent",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"' '",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" semverGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" semverRange",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"''",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" sortAz",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"contributors",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"dependencies",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"devDependencies",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"keywords",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"peerDependencies",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"resolutions",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"scripts",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" sortFirst",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"name",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"description",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"author",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" source",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"package.json",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"packages/*/package.json",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]})]})}function u(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(h,{...o})}):h(o)}function g(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,t,e)=>{e.d(t,{ZP:()=>s});var n=e(5893),c=e(1151);function r(o){const t={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components};return(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"dev"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(t.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"local"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(t.code,{children:"version"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"overrides"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(t.code,{children:"overrides"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"peer"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(t.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"pnpmOverrides"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(t.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"prod"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(t.code,{children:"dependencies"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"resolutions"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(t.code,{children:"resolutions"})})})]})]})]})}function s(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},9605:(o,t,e)=>{e.d(t,{ZP:()=>i});var n=e(5893),c=e(1151),r=e(9794),s=e(9960);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const t={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,c.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(s.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsxs)(t.p,{children:["Ensure that ",(0,n.jsx)(t.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(t.strong,{children:"not"})," set in ",(0,n.jsx)(t.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function i(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}function d(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4284:(o,t,e)=>{e.d(t,{ZP:()=>F});var n=e(5893),c=e(1151),r=e(9794);const s={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const t={p:"p",...(0,c.a)(),...o.components};return s||i("CH",!1),s.Code||i("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(t.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(s.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function F(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function i(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4383:(o,t,e)=>{e.d(t,{ZP:()=>a});var n=e(5893),c=e(1151),r=e(9794),s=e(9960),l=e(292),p=e(6217);const F={annotations:r.ds,Code:r.EK},i={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(o){const t={code:"code",p:"p",...(0,c.a)(),...o.components};return F||y("CH",!1),F.Code||y("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(t.p,{children:["Ensure ",(0,n.jsx)(s.Z,{to:l.K.engines,children:(0,n.jsx)(t.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(t.p,{children:["I've chosen a name of ",(0,n.jsx)(t.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(t.p,{children:["Perform a one-off check for every usage of ",(0,n.jsx)(t.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(t.p,{children:["Add your new custom type to your ",(0,n.jsx)(t.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Now when you run any syncpack command, ",(0,n.jsx)(t.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(t.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(s.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}function y(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},8984:(o,t,e)=>{e.d(t,{ZP:()=>d});var n=e(5893),c=e(1151),r=e(9794),s=e(9286),l=e(9960);const p={annotations:r.ds,Code:r.EK},F={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const t={p:"p",...(0,c.a)(),...o.components};return p||a("CH",!1),p.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(p.Code,{codeConfig:F,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(l.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(s.Z,{children:`syncpack ${o.command} --config ./config/.syncpackrc`})]})}function d(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,t,e)=>{e.d(t,{Hx:()=>c});e(7294);var n=e(5893);function c(o){let{children:t,level:e}=o;return(0,n.jsx)(e,{children:t})}},7029:(o,t,e)=>{e.d(t,{Z:()=>r});e(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var c=e(5893);function r(o){let{required:t,optional:e}=o;return(0,c.jsxs)("p",{children:[t&&(0,c.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),e&&(0,c.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,t,e)=>{e.d(t,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/2c8a7579.52d97031.js b/assets/js/2c8a7579.52d97031.js new file mode 100644 index 00000000..2d166b63 --- /dev/null +++ b/assets/js/2c8a7579.52d97031.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8817],{3654:(o,t,e)=>{e.r(t),e.d(t,{CH:()=>d,assets:()=>i,chCodeConfig:()=>a,contentTitle:()=>p,default:()=>u,frontMatter:()=>l,metadata:()=>F,toc:()=>y});var n=e(5893),c=e(1151),r=e(9794),s=(e(292),e(8984),e(1700),e(9605),e(4284),e(9960));e(4383),e(7029);const l={id:"syncpackrc",title:".syncpackrc"},p=void 0,F={id:"config/syncpackrc",title:".syncpackrc",description:"Configuration File",source:"@site/docs/config/syncpackrc.mdx",sourceDirName:"config",slug:"/config/syncpackrc",permalink:"/syncpack/config/syncpackrc",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/syncpackrc.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"syncpackrc",title:".syncpackrc"},sidebar:"docs",previous:{title:"update",permalink:"/syncpack/command/update"},next:{title:"customTypes",permalink:"/syncpack/config/custom-types"}},i={},d={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},y=[{value:"Configuration File",id:"configuration-file",level:2},{value:"Defaults",id:"defaults",level:2}];function h(o){const t={code:"code",h2:"h2",li:"li",p:"p",ul:"ul",...(0,c.a)(),...o.components};return d||g("CH",!1),d.Code||g("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(t.h2,{id:"configuration-file",children:"Configuration File"}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(s.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to search the current and ancestor directories for a:"]}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:".syncpackrc"})," file in JSON or YAML format."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:".syncpackrc.json"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.yaml"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.yml"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.js"}),", ",(0,n.jsx)(t.code,{children:".syncpackrc.cjs"}),", ",(0,n.jsx)(t.code,{children:"syncpack.config.js"}),", ",(0,n.jsx)(t.code,{children:"syncpack.config.cjs"})," file."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.code,{children:"config.syncpack"})," or ",(0,n.jsx)(t.code,{children:"syncpack"})," property in ",(0,n.jsx)(t.code,{children:"package.json"}),"."]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"A custom name and location can be provided instead:"}),"\n",(0,n.jsx)(d.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--config ",props:{style:{color:"#BD93F9"}}},{content:"./config/syncpack.json",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(t.h2,{id:"defaults",children:"Defaults"}),"\n",(0,n.jsx)(t.p,{children:"Your config file only needs to define values for those you want to change from the defaults below."}),"\n",(0,n.jsx)(d.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" customTypes",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencyTypes",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"local",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"overrides",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"pnpmOverrides",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"resolutions",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" filter",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:".",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" indent",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"' '",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" semverGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" semverRange",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"''",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" sortAz",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"contributors",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"dependencies",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"devDependencies",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"keywords",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"peerDependencies",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"resolutions",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"scripts",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" sortFirst",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"name",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"description",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"author",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" source",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"package.json",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"packages/*/package.json",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]})]})}function u(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(h,{...o})}):h(o)}function g(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,t,e)=>{e.d(t,{ZP:()=>s});var n=e(5893),c=e(1151);function r(o){const t={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components};return(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"dev"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(t.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"local"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(t.code,{children:"version"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"overrides"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(t.code,{children:"overrides"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"peer"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(t.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"pnpmOverrides"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(t.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"prod"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(t.code,{children:"dependencies"})})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"resolutions"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(t.code,{children:"resolutions"})})})]})]})]})}function s(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},9605:(o,t,e)=>{e.d(t,{ZP:()=>i});var n=e(5893),c=e(1151),r=e(9794),s=e(9960);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const t={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,c.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(s.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsxs)(t.p,{children:["Ensure that ",(0,n.jsx)(t.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(t.strong,{children:"not"})," set in ",(0,n.jsx)(t.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function i(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}function d(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4284:(o,t,e)=>{e.d(t,{ZP:()=>F});var n=e(5893),c=e(1151),r=e(9794);const s={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const t={p:"p",...(0,c.a)(),...o.components};return s||i("CH",!1),s.Code||i("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(t.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(s.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function F(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function i(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4383:(o,t,e)=>{e.d(t,{ZP:()=>a});var n=e(5893),c=e(1151),r=e(9794),s=e(9960),l=e(292),p=e(6217);const F={annotations:r.ds,Code:r.EK},i={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(o){const t={code:"code",p:"p",...(0,c.a)(),...o.components};return F||y("CH",!1),F.Code||y("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(t.p,{children:["Ensure ",(0,n.jsx)(s.Z,{to:l.K.engines,children:(0,n.jsx)(t.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(t.p,{children:["I've chosen a name of ",(0,n.jsx)(t.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(t.p,{children:["Perform a one-off check for every usage of ",(0,n.jsx)(t.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(t.p,{children:["Add your new custom type to your ",(0,n.jsx)(t.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Now when you run any syncpack command, ",(0,n.jsx)(t.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(t.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(s.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,n.jsx)(F.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}function y(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},8984:(o,t,e)=>{e.d(t,{ZP:()=>d});var n=e(5893),c=e(1151),r=e(9794),s=e(9286),l=e(9960);const p={annotations:r.ds,Code:r.EK},F={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const t={p:"p",...(0,c.a)(),...o.components};return p||a("CH",!1),p.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(p.Code,{codeConfig:F,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(l.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(s.Z,{children:`syncpack ${o.command} --config ./config/.syncpackrc`})]})}function d(o={}){const{wrapper:t}={...(0,c.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,t,e)=>{e.d(t,{Hx:()=>c});e(7294);var n=e(5893);function c(o){let{children:t,level:e}=o;return(0,n.jsx)(e,{children:t})}},7029:(o,t,e)=>{e.d(t,{Z:()=>r});e(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var c=e(5893);function r(o){let{required:t,optional:e}=o;return(0,c.jsxs)("p",{children:[t&&(0,c.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),e&&(0,c.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,t,e)=>{e.d(t,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/2dc772c2.3b069c40.js b/assets/js/2dc772c2.3b069c40.js deleted file mode 100644 index 4a88e748..00000000 --- a/assets/js/2dc772c2.3b069c40.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3228],{6696:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>m,frontMatter:()=>a,metadata:()=>h,toc:()=>E});var n=t(5893),r=t(1151),s=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"with-range",title:"With Range"},F="Standard",h={id:"config/semver-groups/with-range",title:"With Range",description:"Ensure all dependencies within this group have the specified semver range.",source:"@site/docs/config/semver-groups/with-range.mdx",sourceDirName:"config/semver-groups",slug:"/config/semver-groups/with-range",permalink:"/syncpack/config/semver-groups/with-range",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/semver-groups/with-range.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"with-range",title:"With Range"},sidebar:"docs",previous:{title:"Ignored",permalink:"/syncpack/config/semver-groups/ignored"},next:{title:"sortAz",permalink:"/syncpack/config/sort-az"}},y={},u={annotations:s.ds,Code:s.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"semverGroup.range",id:"semvergrouprange",level:2},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components};return u||j("CH",!1),u.Code||j("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.h1,{id:"standard",children:"Standard"}),"\n",(0,n.jsx)(e.p,{children:"Ensure all dependencies within this group have the specified semver range."}),"\n",(0,n.jsx)(e.h2,{id:"semvergrouprange",children:(0,n.jsx)(e.code,{children:"semverGroup.range"})}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"Which of the Supported Ranges this group should use."}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@alpha/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function m(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function j(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/2dc772c2.d0caab76.js b/assets/js/2dc772c2.d0caab76.js new file mode 100644 index 00000000..186d4407 --- /dev/null +++ b/assets/js/2dc772c2.d0caab76.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3228],{6696:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>m,frontMatter:()=>a,metadata:()=>h,toc:()=>E});var n=t(5893),r=t(1151),s=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"with-range",title:"With Range"},F="Standard",h={id:"config/semver-groups/with-range",title:"With Range",description:"Ensure all dependencies within this group have the specified semver range.",source:"@site/docs/config/semver-groups/with-range.mdx",sourceDirName:"config/semver-groups",slug:"/config/semver-groups/with-range",permalink:"/syncpack/config/semver-groups/with-range",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/semver-groups/with-range.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"with-range",title:"With Range"},sidebar:"docs",previous:{title:"Ignored",permalink:"/syncpack/config/semver-groups/ignored"},next:{title:"sortAz",permalink:"/syncpack/config/sort-az"}},y={},u={annotations:s.ds,Code:s.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"semverGroup.range",id:"semvergrouprange",level:2},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components};return u||j("CH",!1),u.Code||j("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.h1,{id:"standard",children:"Standard"}),"\n",(0,n.jsx)(e.p,{children:"Ensure all dependencies within this group have the specified semver range."}),"\n",(0,n.jsx)(e.h2,{id:"semvergrouprange",children:(0,n.jsx)(e.code,{children:"semverGroup.range"})}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"Which of the Supported Ranges this group should use."}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@alpha/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function m(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function j(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/325cf86f.479f940e.js b/assets/js/325cf86f.e3e8b82c.js similarity index 53% rename from assets/js/325cf86f.479f940e.js rename to assets/js/325cf86f.e3e8b82c.js index 3646a45d..5d7b6207 100644 --- a/assets/js/325cf86f.479f940e.js +++ b/assets/js/325cf86f.e3e8b82c.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3334],{4682:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var s=n(5893),a=n(1151);const i={id:"yarn",title:"Yarn"},r=void 0,o={id:"integrations/yarn",title:"Yarn",description:"When using Yarn Workspaces, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/yarn.mdx",sourceDirName:"integrations",slug:"/integrations/yarn",permalink:"/syncpack/integrations/yarn",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/yarn.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"yarn",title:"Yarn"},sidebar:"docs",previous:{title:"pnpm",permalink:"/syncpack/integrations/pnpm"},next:{title:"Status Codes",permalink:"/syncpack/status-codes"}},c={},p=[];function d(t){const e={p:"p",...(0,a.a)(),...t.components};return(0,s.jsx)(e.p,{children:"When using Yarn Workspaces, syncpack will use its configuration to discover where your package.json files are."})}function u(t={}){const{wrapper:e}={...(0,a.a)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(d,{...t})}):d(t)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3334],{4682:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var s=n(5893),a=n(1151);const i={id:"yarn",title:"Yarn"},r=void 0,o={id:"integrations/yarn",title:"Yarn",description:"When using Yarn Workspaces, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/yarn.mdx",sourceDirName:"integrations",slug:"/integrations/yarn",permalink:"/syncpack/integrations/yarn",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/yarn.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"yarn",title:"Yarn"},sidebar:"docs",previous:{title:"pnpm",permalink:"/syncpack/integrations/pnpm"},next:{title:"Status Codes",permalink:"/syncpack/status-codes"}},c={},p=[];function d(t){const e={p:"p",...(0,a.a)(),...t.components};return(0,s.jsx)(e.p,{children:"When using Yarn Workspaces, syncpack will use its configuration to discover where your package.json files are."})}function u(t={}){const{wrapper:e}={...(0,a.a)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(d,{...t})}):d(t)}}}]); \ No newline at end of file diff --git a/assets/js/3928ec54.1b9c0ba9.js b/assets/js/3928ec54.1b9c0ba9.js deleted file mode 100644 index b5472b62..00000000 --- a/assets/js/3928ec54.1b9c0ba9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2381],{3339:(o,t,e)=>{e.r(t),e.d(t,{CH:()=>a,assets:()=>y,chCodeConfig:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>p,metadata:()=>F,toc:()=>E});var n=e(5893),s=e(1151),r=e(9794),c=e(9960);const p={id:"semver-groups",title:"Semver Groups"},l=void 0,F={id:"guide/semver-groups",title:"Semver Groups",description:"This is an addendum to the Getting Started guide.",source:"@site/docs/guide/semver-groups.mdx",sourceDirName:"guide",slug:"/guide/semver-groups",permalink:"/syncpack/guide/semver-groups",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/semver-groups.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"semver-groups",title:"Semver Groups"},sidebar:"docs",previous:{title:"Local Package Versions",permalink:"/syncpack/guide/local-package-versions"},next:{title:"Version Groups",permalink:"/syncpack/guide/version-groups"}},y={},a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2}];function i(o){const t={code:"code",h2:"h2",p:"p",...(0,s.a)(),...o.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["This is an addendum to the ",(0,n.jsx)(c.Z,{to:"/guide/getting-started",children:"Getting Started"})," guide."]}),"\n",(0,n.jsx)(t.p,{children:"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."}),"\n",(0,n.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t.p,{children:["1: Every dependency of ",(0,n.jsx)(t.code,{children:"@myrepo/library"})," should have a semver range of ",(0,n.jsx)(t.code,{children:"~"}),", regardless of what the rest of the monorepo uses:"]}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@myrepo/library",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["2: Every dependency of ",(0,n.jsx)(t.code,{children:"@myrepo/library"})," whose name matches ",(0,n.jsx)(t.code,{children:"@alpha/**"})," should have a semver range of ",(0,n.jsx)(t.code,{children:"^"}),", regardless of what the rest of that package or the rest of the monorepo uses:"]}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@alpha/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@myrepo/library",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["3: Every dependency in the monorepo whose name matches ",(0,n.jsx)(t.code,{children:"@alpha/**"})," should have a semver range of ",(0,n.jsx)(t.code,{children:"~"}),", regardless of what the rest of the monorepo uses:"]}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@alpha/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"4: Production dependencies should have fixed version numbers, but development and peer dependencies can be broader."}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"resolutions",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"overrides",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"pnpmOverrides",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"local",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function h(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function u(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/3928ec54.80d2bcf9.js b/assets/js/3928ec54.80d2bcf9.js new file mode 100644 index 00000000..2d603ebf --- /dev/null +++ b/assets/js/3928ec54.80d2bcf9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2381],{3339:(o,t,e)=>{e.r(t),e.d(t,{CH:()=>a,assets:()=>y,chCodeConfig:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>p,metadata:()=>F,toc:()=>E});var n=e(5893),s=e(1151),r=e(9794),c=e(9960);const p={id:"semver-groups",title:"Semver Groups"},l=void 0,F={id:"guide/semver-groups",title:"Semver Groups",description:"This is an addendum to the Getting Started guide.",source:"@site/docs/guide/semver-groups.mdx",sourceDirName:"guide",slug:"/guide/semver-groups",permalink:"/syncpack/guide/semver-groups",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/semver-groups.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"semver-groups",title:"Semver Groups"},sidebar:"docs",previous:{title:"Local Package Versions",permalink:"/syncpack/guide/local-package-versions"},next:{title:"Version Groups",permalink:"/syncpack/guide/version-groups"}},y={},a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2}];function i(o){const t={code:"code",h2:"h2",p:"p",...(0,s.a)(),...o.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["This is an addendum to the ",(0,n.jsx)(c.Z,{to:"/guide/getting-started",children:"Getting Started"})," guide."]}),"\n",(0,n.jsx)(t.p,{children:"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."}),"\n",(0,n.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t.p,{children:["1: Every dependency of ",(0,n.jsx)(t.code,{children:"@myrepo/library"})," should have a semver range of ",(0,n.jsx)(t.code,{children:"~"}),", regardless of what the rest of the monorepo uses:"]}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@myrepo/library",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["2: Every dependency of ",(0,n.jsx)(t.code,{children:"@myrepo/library"})," whose name matches ",(0,n.jsx)(t.code,{children:"@alpha/**"})," should have a semver range of ",(0,n.jsx)(t.code,{children:"^"}),", regardless of what the rest of that package or the rest of the monorepo uses:"]}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@alpha/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@myrepo/library",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["3: Every dependency in the monorepo whose name matches ",(0,n.jsx)(t.code,{children:"@alpha/**"})," should have a semver range of ",(0,n.jsx)(t.code,{children:"~"}),", regardless of what the rest of the monorepo uses:"]}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@alpha/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"4: Production dependencies should have fixed version numbers, but development and peer dependencies can be broader."}),"\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"semverGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'""',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"resolutions",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"overrides",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"pnpmOverrides",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"local",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"~",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"range",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function h(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function u(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/3f7238a2.5e95bb8d.js b/assets/js/3f7238a2.5e95bb8d.js deleted file mode 100644 index 79c4af34..00000000 --- a/assets/js/3f7238a2.5e95bb8d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9809],{6869:(o,t,e)=>{e.r(t),e.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>F});var n=e(5893),s=e(1151),r=e(9605);const c={id:"intellisense",title:"TypeScript Intellisense"},l=void 0,p={id:"integrations/intellisense",title:"TypeScript Intellisense",description:"",source:"@site/docs/integrations/intellisense.mdx",sourceDirName:"integrations",slug:"/integrations/intellisense",permalink:"/syncpack/integrations/intellisense",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/intellisense.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"intellisense",title:"TypeScript Intellisense"},sidebar:"docs",previous:{title:"Github Actions",permalink:"/syncpack/integrations/github-actions"},next:{title:"JSON Schema",permalink:"/syncpack/integrations/json-schema"}},i={},F=[];function a(o){return(0,n.jsx)(r.ZP,{})}function d(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(a,{...o})}):a()}},9605:(o,t,e)=>{e.d(t,{ZP:()=>F});var n=e(5893),s=e(1151),r=e(9794),c=e(9960);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const t={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(c.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsxs)(t.p,{children:["Ensure that ",(0,n.jsx)(t.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(t.strong,{children:"not"})," set in ",(0,n.jsx)(t.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function F(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/3f7238a2.875a0e28.js b/assets/js/3f7238a2.875a0e28.js new file mode 100644 index 00000000..0d8a8982 --- /dev/null +++ b/assets/js/3f7238a2.875a0e28.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9809],{6869:(o,t,e)=>{e.r(t),e.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>F});var n=e(5893),s=e(1151),r=e(9605);const c={id:"intellisense",title:"TypeScript Intellisense"},l=void 0,p={id:"integrations/intellisense",title:"TypeScript Intellisense",description:"",source:"@site/docs/integrations/intellisense.mdx",sourceDirName:"integrations",slug:"/integrations/intellisense",permalink:"/syncpack/integrations/intellisense",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/intellisense.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"intellisense",title:"TypeScript Intellisense"},sidebar:"docs",previous:{title:"Github Actions",permalink:"/syncpack/integrations/github-actions"},next:{title:"JSON Schema",permalink:"/syncpack/integrations/json-schema"}},i={},F=[];function a(o){return(0,n.jsx)(r.ZP,{})}function d(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(a,{...o})}):a()}},9605:(o,t,e)=>{e.d(t,{ZP:()=>F});var n=e(5893),s=e(1151),r=e(9794),c=e(9960);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const t={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(c.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsxs)(t.p,{children:["Ensure that ",(0,n.jsx)(t.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(t.strong,{children:"not"})," set in ",(0,n.jsx)(t.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function F(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/3fc261aa.13396074.js b/assets/js/3fc261aa.13396074.js deleted file mode 100644 index b0188ba1..00000000 --- a/assets/js/3fc261aa.13396074.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[7256],{8503:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>a,contentTitle:()=>l,default:()=>F,frontMatter:()=>c,metadata:()=>p,toc:()=>i});var n=t(5893),s=t(1151),r=(t(9960),t(4498));const c={title:"Ensure that semver ranges for a dependency all match each other"},l=void 0,p={id:"examples/ensure-versions-satisfy-same-range",title:"Ensure that semver ranges for a dependency all match each other",description:"",source:"@site/docs/examples/ensure-versions-satisfy-same-range.mdx",sourceDirName:"examples",slug:"/examples/ensure-versions-satisfy-same-range",permalink:"/syncpack/examples/ensure-versions-satisfy-same-range",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/ensure-versions-satisfy-same-range.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Ensure that semver ranges for a dependency all match each other"},sidebar:"examples",previous:{title:"Ban dependency from monorepo",permalink:"/syncpack/examples/ban-dependency-from-monorepo"},next:{title:"Ensure AWS SDK dependencies always have the same version",permalink:"/syncpack/examples/fix-aws-sdk-version-mismatch"}},a={},i=[];function d(e){return(0,n.jsx)(r.ZP,{level:"h2"})}function F(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},4498:(e,o,t)=>{t.d(o,{ZP:()=>i});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," which allows local packages installed in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"})," to use different semver ranges, as long as they all match the local package version."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"policy"})," of ",(0,n.jsx)(o.strong,{children:"sameRange"})," states that these dependencies are considered valid if every range matches the others."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure semver ranges for locally developed packages satisfy the local version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function i(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/3fc261aa.87a98e27.js b/assets/js/3fc261aa.87a98e27.js new file mode 100644 index 00000000..91d6fa0d --- /dev/null +++ b/assets/js/3fc261aa.87a98e27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[7256],{8503:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>a,contentTitle:()=>l,default:()=>F,frontMatter:()=>c,metadata:()=>p,toc:()=>i});var n=t(5893),s=t(1151),r=(t(9960),t(4498));const c={title:"Ensure that semver ranges for a dependency all match each other"},l=void 0,p={id:"examples/ensure-versions-satisfy-same-range",title:"Ensure that semver ranges for a dependency all match each other",description:"",source:"@site/docs/examples/ensure-versions-satisfy-same-range.mdx",sourceDirName:"examples",slug:"/examples/ensure-versions-satisfy-same-range",permalink:"/syncpack/examples/ensure-versions-satisfy-same-range",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/ensure-versions-satisfy-same-range.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Ensure that semver ranges for a dependency all match each other"},sidebar:"examples",previous:{title:"Ban dependency from monorepo",permalink:"/syncpack/examples/ban-dependency-from-monorepo"},next:{title:"Ensure AWS SDK dependencies always have the same version",permalink:"/syncpack/examples/fix-aws-sdk-version-mismatch"}},a={},i=[];function d(e){return(0,n.jsx)(r.ZP,{level:"h2"})}function F(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},4498:(e,o,t)=>{t.d(o,{ZP:()=>i});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," which allows local packages installed in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"})," to use different semver ranges, as long as they all match the local package version."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"policy"})," of ",(0,n.jsx)(o.strong,{children:"sameRange"})," states that these dependencies are considered valid if every range matches the others."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure semver ranges for locally developed packages satisfy the local version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function i(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/49dbd26f.7864c024.js b/assets/js/49dbd26f.655caa94.js similarity index 89% rename from assets/js/49dbd26f.7864c024.js rename to assets/js/49dbd26f.655caa94.js index eccd7192..22aab36f 100644 --- a/assets/js/49dbd26f.7864c024.js +++ b/assets/js/49dbd26f.655caa94.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9221],{9049:(o,e,t)=>{t.r(e),t.d(e,{assets:()=>m,contentTitle:()=>g,default:()=>f,frontMatter:()=>h,metadata:()=>u,toc:()=>k});var n=t(5893),s=t(1151),c=t(9960),r=t(9794),l=t(292),p=t(6217);const i={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const e={code:"code",p:"p",...(0,s.a)(),...o.components};return i||y("CH",!1),i.Code||y("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Add the ",(0,n.jsx)(c.Z,{to:l.K.engines,children:(0,n.jsx)(e.code,{children:"engines"})})," property of package.json files to also be inspected by syncpack."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(e.p,{children:["I've chosen a name of ",(0,n.jsx)(e.code,{children:"engines"})," but it can be anything you like."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"engines",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // ^ this is your custom name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"versionsByName",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"jsonc"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Perform a one-off check of all versions defined under ",(0,n.jsx)(e.code,{children:"engines"})," in your monorepo."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(e.p,{children:["Add your new custom type to your ",(0,n.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Now when you run any syncpack command, versions under ",(0,n.jsx)(e.code,{children:"engines"})," will also be checked."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group. This defines an exception which only applies to Node.js, leaving anything else found under ",(0,n.jsx)(e.code,{children:"engines"})," unaffected."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}function y(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}const h={title:"Manage npm engines throughout monorepo"},g=void 0,u={id:"examples/sync-engines-in-monorepo",title:"Manage npm engines throughout monorepo",description:"",source:"@site/docs/examples/sync-engines-in-monorepo.mdx",sourceDirName:"examples",slug:"/examples/sync-engines-in-monorepo",permalink:"/syncpack/examples/sync-engines-in-monorepo",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/sync-engines-in-monorepo.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Manage npm engines throughout monorepo"},sidebar:"examples",previous:{title:"Pin local versions to pnpm workspace:*",permalink:"/syncpack/examples/pnpm-workspace-protocol"},next:{title:"Synchronise Node.js version in monorepo",permalink:"/syncpack/examples/sync-nodejs-version-in-monorepo"}},m={},k=[];function E(o){return(0,n.jsx)(d,{level:"h2"})}function f(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(E,{...o})}):E()}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9221],{9049:(o,e,t)=>{t.r(e),t.d(e,{assets:()=>m,contentTitle:()=>g,default:()=>f,frontMatter:()=>h,metadata:()=>u,toc:()=>k});var n=t(5893),s=t(1151),c=t(9960),r=t(9794),l=t(292),p=t(6217);const i={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const e={code:"code",p:"p",...(0,s.a)(),...o.components};return i||y("CH",!1),i.Code||y("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Add the ",(0,n.jsx)(c.Z,{to:l.K.engines,children:(0,n.jsx)(e.code,{children:"engines"})})," property of package.json files to also be inspected by syncpack."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(e.p,{children:["I've chosen a name of ",(0,n.jsx)(e.code,{children:"engines"})," but it can be anything you like."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"engines",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // ^ this is your custom name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"versionsByName",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"jsonc"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Perform a one-off check of all versions defined under ",(0,n.jsx)(e.code,{children:"engines"})," in your monorepo."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(e.p,{children:["Add your new custom type to your ",(0,n.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Now when you run any syncpack command, versions under ",(0,n.jsx)(e.code,{children:"engines"})," will also be checked."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group. This defines an exception which only applies to Node.js, leaving anything else found under ",(0,n.jsx)(e.code,{children:"engines"})," unaffected."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}function y(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}const h={title:"Manage npm engines throughout monorepo"},g=void 0,u={id:"examples/sync-engines-in-monorepo",title:"Manage npm engines throughout monorepo",description:"",source:"@site/docs/examples/sync-engines-in-monorepo.mdx",sourceDirName:"examples",slug:"/examples/sync-engines-in-monorepo",permalink:"/syncpack/examples/sync-engines-in-monorepo",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/sync-engines-in-monorepo.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Manage npm engines throughout monorepo"},sidebar:"examples",previous:{title:"Pin local versions to pnpm workspace:*",permalink:"/syncpack/examples/pnpm-workspace-protocol"},next:{title:"Synchronise Node.js version in monorepo",permalink:"/syncpack/examples/sync-nodejs-version-in-monorepo"}},m={},k=[];function E(o){return(0,n.jsx)(d,{level:"h2"})}function f(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(E,{...o})}):E()}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/4b98dbff.79cc04cb.js b/assets/js/4b98dbff.79cc04cb.js new file mode 100644 index 00000000..e1197a0a --- /dev/null +++ b/assets/js/4b98dbff.79cc04cb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[7888],{1102:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>m,assets:()=>g,chCodeConfig:()=>x,contentTitle:()=>y,default:()=>f,frontMatter:()=>h,metadata:()=>u,toc:()=>E});var n=t(5893),r=t(1151),s=t(9794),c=t(5739),l=t(7318),p=t(2369),i=t(4684),d=t(3133),a=t(4422),F=t(7029);const h={id:"banned",title:"Banned"},y=void 0,u={id:"config/version-groups/banned",title:"Banned",description:"Find and remove dependencies which you've decided should never be used.",source:"@site/docs/config/version-groups/banned.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/banned",permalink:"/syncpack/config/version-groups/banned",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/banned.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"banned",title:"Banned"},sidebar:"docs",previous:{title:"source",permalink:"/syncpack/config/source"},next:{title:"Ignored",permalink:"/syncpack/config/version-groups/ignored"}},g={},m={annotations:s.ds,Code:s.EK},x={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"isBanned",id:"isbanned",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function j(o){const e={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components},{Details:t}=e;return m||k("CH",!1),m.Code||k("CH.Code",!0),t||k("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Find and remove dependencies which you've decided should never be used."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Completely ban a dependency from being used"}),(0,n.jsx)(c.ZP,{level:"h3"})]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsxs)(e.p,{children:["Example: Ensure ",(0,n.jsx)("code",{children:"@types"})," are only installed as ",(0,n.jsx)("code",{children:"devDependencies"})]})}),(0,n.jsx)(l.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"isbanned",children:"isBanned"}),"\n",(0,n.jsx)(F.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"This property activates this behaviour for a given Version Group."}),"\n",(0,n.jsx)(m.Code,{codeConfig:x,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"never-gonna",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(a.ZP,{})]})}function f(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(j,{...o})}):j(o)}function k(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},5739:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=(t(9960),t(292),t(6217));const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={p:"p",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(e.p,{children:"Ban a dependency from being used anywhere in your monorepo."}),"\n",(0,n.jsx)(c.Hx,{level:o.level,children:"1. Add a version group"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"never-gonna",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(c.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsx)(e.p,{children:"Now when you run any syncpack command, banned dependencies will be listed:"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"And can be removed:"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7318:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),r=t(1151),s=t(9794),c=t(9960),l=t(292),p=t(6217);const i={annotations:s.ds,Code:s.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Only allow TypeScript ",(0,n.jsx)(c.Z,{to:l.K["@types"],children:"@types"})," packages from being used anywhere other than in the ",(0,n.jsx)("code",{children:"devDependencies"})," section of package.json."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a version group"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["Match all ",(0,n.jsx)(e.strong,{children:"dependencies"})," whose name starts with ",(0,n.jsx)(e.code,{children:"@types/"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Only match those dependencies when they appear anywhere ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Define the behaviour of this group as ",(0,n.jsx)(e.strong,{children:"isBanned"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Add a ",(0,n.jsx)(e.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types packages should only be under devDependencies",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Any ",(0,n.jsx)(e.code,{children:"@types"})," packages which are in the wrong location can then be found and manually moved:"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function F(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>r});t(7294);var n=t(5893);function r(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/4b98dbff.f284835b.js b/assets/js/4b98dbff.f284835b.js deleted file mode 100644 index 4af23993..00000000 --- a/assets/js/4b98dbff.f284835b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[7888],{1102:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>m,assets:()=>g,chCodeConfig:()=>x,contentTitle:()=>y,default:()=>f,frontMatter:()=>h,metadata:()=>u,toc:()=>E});var n=t(5893),r=t(1151),s=t(9794),c=t(5739),l=t(7318),p=t(2369),i=t(4684),d=t(3133),a=t(4422),F=t(7029);const h={id:"banned",title:"Banned"},y=void 0,u={id:"config/version-groups/banned",title:"Banned",description:"Find and remove dependencies which you've decided should never be used.",source:"@site/docs/config/version-groups/banned.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/banned",permalink:"/syncpack/config/version-groups/banned",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/banned.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"banned",title:"Banned"},sidebar:"docs",previous:{title:"source",permalink:"/syncpack/config/source"},next:{title:"Ignored",permalink:"/syncpack/config/version-groups/ignored"}},g={},m={annotations:s.ds,Code:s.EK},x={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"isBanned",id:"isbanned",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function j(o){const e={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...o.components},{Details:t}=e;return m||k("CH",!1),m.Code||k("CH.Code",!0),t||k("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Find and remove dependencies which you've decided should never be used."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Completely ban a dependency from being used"}),(0,n.jsx)(c.ZP,{level:"h3"})]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsxs)(e.p,{children:["Example: Ensure ",(0,n.jsx)("code",{children:"@types"})," are only installed as ",(0,n.jsx)("code",{children:"devDependencies"})]})}),(0,n.jsx)(l.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"isbanned",children:"isBanned"}),"\n",(0,n.jsx)(F.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"This property activates this behaviour for a given Version Group."}),"\n",(0,n.jsx)(m.Code,{codeConfig:x,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"never-gonna",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(a.ZP,{})]})}function f(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(j,{...o})}):j(o)}function k(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),r=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},5739:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=(t(9960),t(292),t(6217));const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={p:"p",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(e.p,{children:"Ban a dependency from being used anywhere in your monorepo."}),"\n",(0,n.jsx)(c.Hx,{level:o.level,children:"1. Add a version group"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"never-gonna",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(c.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsx)(e.p,{children:"Now when you run any syncpack command, banned dependencies will be listed:"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"And can be removed:"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7318:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),r=t(1151),s=t(9794),c=t(9960),l=t(292),p=t(6217);const i={annotations:s.ds,Code:s.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Only allow TypeScript ",(0,n.jsx)(c.Z,{to:l.K["@types"],children:"@types"})," packages from being used anywhere other than in the ",(0,n.jsx)("code",{children:"devDependencies"})," section of package.json."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a version group"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["Match all ",(0,n.jsx)(e.strong,{children:"dependencies"})," whose name starts with ",(0,n.jsx)(e.code,{children:"@types/"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Only match those dependencies when they appear anywhere ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Define the behaviour of this group as ",(0,n.jsx)(e.strong,{children:"isBanned"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["Add a ",(0,n.jsx)(e.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types packages should only be under devDependencies",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Any ",(0,n.jsx)(e.code,{children:"@types"})," packages which are in the wrong location can then be found and manually moved:"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function F(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),r=t(1151),s=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,r.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),r=t(1151),s=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,r.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),r=t(1151),s=t(9794),c=t(7029);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,r.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>r});t(7294);var n=t(5893);function r(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var r=t(5893);function s(o){let{required:e,optional:t}=o;return(0,r.jsxs)("p",{children:[e&&(0,r.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,r.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/4ff4677f.7bfa5e42.js b/assets/js/4ff4677f.7bfa5e42.js new file mode 100644 index 00000000..e3ab6503 --- /dev/null +++ b/assets/js/4ff4677f.7bfa5e42.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6567],{3542:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>m,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>x});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),a=t(3133),d=t(4192);const F={id:"snapped-to",title:"Snapped To"},h=void 0,y={id:"config/version-groups/snapped-to",title:"Snapped To",description:"Pin the version of all dependencies in this group to follow the versions used by the other packages named within the snapTo array.",source:"@site/docs/config/version-groups/snapped-to.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/snapped-to",permalink:"/syncpack/config/version-groups/snapped-to",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/snapped-to.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"snapped-to",title:"Snapped To"},sidebar:"docs",previous:{title:"Same Range",permalink:"/syncpack/config/version-groups/same-range"},next:{title:"Standard",permalink:"/syncpack/config/version-groups/standard"}},u={},g={annotations:r.ds,Code:r.EK},m={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"snapTo",id:"snapto",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function E(o){const e={code:"code",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,s.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(e.p,{children:["Pin the version of all dependencies in this group to follow the versions used by the other packages named within the ",(0,n.jsx)(e.code,{children:"snapTo"})," array."]}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsx)(e.p,{children:"Example: Fix React Native version mismatch"})}),(0,n.jsx)(d.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"snapto",children:"snapTo"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["The values refer to the ",(0,n.jsx)(e.code,{children:"name"})," property of the package.json files developed in your monorepo."]}),"\n",(0,n.jsx)(e.li,{children:"Multiple values can be added to provide fallback packages to try in the event that the dependency is not present in the earlier packages in the array."}),"\n"]}),"\n",(0,n.jsx)(g.Code,{codeConfig:m,northPanel:{tabs:["all"],active:"all",heightRatio:1},files:[{name:"all",title:'"Ensure',packages:!0,use:!0,whatever:!0,version:!0,of:!0,react:!0,that:!0,"mobile-app":!0,is:!0,'using"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-app",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(a.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(E,{...o})}):E(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},4192:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To Version Group"}),' which allows some of the packages in your monorepo to "follow" other packages in terms of which versions they should use.']}),"\n",(0,n.jsxs)(e.p,{children:["In this example we want our Mobile App package to be the single source of truth for what the versions of ",(0,n.jsx)(e.code,{children:"react"})," and ",(0,n.jsx)(e.code,{children:"react-native"})," should be. Every other package will be required to use the same version it does."]}),"\n",(0,n.jsx)(e.p,{children:"Here is the Version Group configuration to do it:"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An optional ",(0,n.jsx)(e.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"snapTo"})," array lists the ",(0,n.jsx)(e.code,{children:"name"})," properties of the locally developed package.json files which should be searched for a version of ",(0,n.jsx)(e.code,{children:"react"})," or ",(0,n.jsx)(e.code,{children:"react-native"}),"."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Always use the versions of react brought in by the Mobile App",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-app",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function a(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/4ff4677f.f972a29c.js b/assets/js/4ff4677f.f972a29c.js deleted file mode 100644 index 4907e001..00000000 --- a/assets/js/4ff4677f.f972a29c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6567],{3542:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>m,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>x});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),a=t(3133),d=t(4192);const F={id:"snapped-to",title:"Snapped To"},h=void 0,y={id:"config/version-groups/snapped-to",title:"Snapped To",description:"Pin the version of all dependencies in this group to follow the versions used by the other packages named within the snapTo array.",source:"@site/docs/config/version-groups/snapped-to.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/snapped-to",permalink:"/syncpack/config/version-groups/snapped-to",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/snapped-to.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"snapped-to",title:"Snapped To"},sidebar:"docs",previous:{title:"Same Range",permalink:"/syncpack/config/version-groups/same-range"},next:{title:"Standard",permalink:"/syncpack/config/version-groups/standard"}},u={},g={annotations:r.ds,Code:r.EK},m={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"snapTo",id:"snapto",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function E(o){const e={code:"code",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,s.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(e.p,{children:["Pin the version of all dependencies in this group to follow the versions used by the other packages named within the ",(0,n.jsx)(e.code,{children:"snapTo"})," array."]}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsx)(e.p,{children:"Example: Fix React Native version mismatch"})}),(0,n.jsx)(d.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"snapto",children:"snapTo"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["The values refer to the ",(0,n.jsx)(e.code,{children:"name"})," property of the package.json files developed in your monorepo."]}),"\n",(0,n.jsx)(e.li,{children:"Multiple values can be added to provide fallback packages to try in the event that the dependency is not present in the earlier packages in the array."}),"\n"]}),"\n",(0,n.jsx)(g.Code,{codeConfig:m,northPanel:{tabs:["all"],active:"all",heightRatio:1},files:[{name:"all",title:'"Ensure',packages:!0,use:!0,whatever:!0,version:!0,of:!0,react:!0,that:!0,"mobile-app":!0,is:!0,'using"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-app",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(a.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(E,{...o})}):E(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},4192:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To Version Group"}),' which allows some of the packages in your monorepo to "follow" other packages in terms of which versions they should use.']}),"\n",(0,n.jsxs)(e.p,{children:["In this example we want our Mobile App package to be the single source of truth for what the versions of ",(0,n.jsx)(e.code,{children:"react"})," and ",(0,n.jsx)(e.code,{children:"react-native"})," should be. Every other package will be required to use the same version it does."]}),"\n",(0,n.jsx)(e.p,{children:"Here is the Version Group configuration to do it:"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An optional ",(0,n.jsx)(e.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"snapTo"})," array lists the ",(0,n.jsx)(e.code,{children:"name"})," properties of the locally developed package.json files which should be searched for a version of ",(0,n.jsx)(e.code,{children:"react"})," or ",(0,n.jsx)(e.code,{children:"react-native"}),"."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Always use the versions of react brought in by the Mobile App",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-app",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function a(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/58229b23.4639080b.js b/assets/js/58229b23.4639080b.js deleted file mode 100644 index 62a9a075..00000000 --- a/assets/js/58229b23.4639080b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9057],{1488:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>j,frontMatter:()=>a,metadata:()=>h,toc:()=>x});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"standard",title:"Standard"},F=void 0,h={id:"config/version-groups/standard",title:"Standard",description:"Configuration",source:"@site/docs/config/version-groups/standard.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/standard",permalink:"/syncpack/config/version-groups/standard",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/standard.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"standard",title:"Standard"},sidebar:"docs",previous:{title:"Snapped To",permalink:"/syncpack/config/version-groups/snapped-to"},next:{title:"Github Actions",permalink:"/syncpack/integrations/github-actions"}},y={},u={annotations:r.ds,Code:r.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Configuration",id:"configuration",level:2},{value:"preferVersion",id:"preferversion",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function f(o){const e={code:"code",h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components};return u||E("CH",!1),u.Code||E("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"preferversion",children:"preferVersion"}),"\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.p,{children:["Defaults to ",(0,n.jsx)(e.code,{children:"highestSemver"})," but can be optionally changed to ",(0,n.jsx)(e.code,{children:"lowestSemver"}),"."]}),"\n",(0,n.jsxs)(e.p,{children:["To set this as your standard policy, create a version group which applies to every dependency as the last item in your ",(0,n.jsx)(e.code,{children:"versionGroups"})," array. You can also just set this for some of the packages if you need to."]}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:["the"],active:"the",heightRatio:1},files:[{name:"the",title:'"Choose',lowest:!0,valid:!0,semver:!0,version:!0,when:!0,fixing:!0,'mismatches"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"preferVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"lowestSemver",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(f,{...o})}):f(o)}function E(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/58229b23.f9325709.js b/assets/js/58229b23.f9325709.js new file mode 100644 index 00000000..0f6968f8 --- /dev/null +++ b/assets/js/58229b23.f9325709.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9057],{1488:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>u,assets:()=>y,chCodeConfig:()=>g,contentTitle:()=>F,default:()=>j,frontMatter:()=>a,metadata:()=>h,toc:()=>x});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),d=t(3133);const a={id:"standard",title:"Standard"},F=void 0,h={id:"config/version-groups/standard",title:"Standard",description:"Configuration",source:"@site/docs/config/version-groups/standard.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/standard",permalink:"/syncpack/config/version-groups/standard",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/standard.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"standard",title:"Standard"},sidebar:"docs",previous:{title:"Snapped To",permalink:"/syncpack/config/version-groups/snapped-to"},next:{title:"Github Actions",permalink:"/syncpack/integrations/github-actions"}},y={},u={annotations:r.ds,Code:r.EK},g={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},x=[{value:"Configuration",id:"configuration",level:2},{value:"preferVersion",id:"preferversion",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function f(o){const e={code:"code",h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components};return u||E("CH",!1),u.Code||E("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"preferversion",children:"preferVersion"}),"\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.p,{children:["Defaults to ",(0,n.jsx)(e.code,{children:"highestSemver"})," but can be optionally changed to ",(0,n.jsx)(e.code,{children:"lowestSemver"}),"."]}),"\n",(0,n.jsxs)(e.p,{children:["To set this as your standard policy, create a version group which applies to every dependency as the last item in your ",(0,n.jsx)(e.code,{children:"versionGroups"})," array. You can also just set this for some of the packages if you need to."]}),"\n",(0,n.jsx)(u.Code,{codeConfig:g,northPanel:{tabs:["the"],active:"the",heightRatio:1},files:[{name:"the",title:'"Choose',lowest:!0,valid:!0,semver:!0,version:!0,when:!0,fixing:!0,'mismatches"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"preferVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"lowestSemver",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(d.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(f,{...o})}):f(o)}function E(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},2369:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}}}]); \ No newline at end of file diff --git a/assets/js/60482745.02c9da00.js b/assets/js/60482745.38915c7b.js similarity index 54% rename from assets/js/60482745.02c9da00.js rename to assets/js/60482745.38915c7b.js index f7770a34..d157e7b5 100644 --- a/assets/js/60482745.02c9da00.js +++ b/assets/js/60482745.38915c7b.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4086],{1265:(t,s,e)=>{e.r(s),e.d(s,{assets:()=>c,contentTitle:()=>n,default:()=>f,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=e(5893),r=e(1151);const o={id:"sort-first",title:"sortFirst"},n=void 0,a={id:"config/sort-first",title:"sortFirst",description:"When using the format command, determines which fields within package.json files should appear at the top, and in what order.",source:"@site/docs/config/sort-first.mdx",sourceDirName:"config",slug:"/config/sort-first",permalink:"/syncpack/config/sort-first",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/sort-first.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"sort-first",title:"sortFirst"},sidebar:"docs",previous:{title:"sortAz",permalink:"/syncpack/config/sort-az"},next:{title:"source",permalink:"/syncpack/config/source"}},c={},d=[];function p(t){const s={code:"code",p:"p",...(0,r.a)(),...t.components};return(0,i.jsxs)(s.p,{children:["When using the ",(0,i.jsx)(s.code,{children:"format"})," command, determines which fields within package.json files should appear at the top, and in what order."]})}function f(t={}){const{wrapper:s}={...(0,r.a)(),...t.components};return s?(0,i.jsx)(s,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4086],{1265:(t,s,e)=>{e.r(s),e.d(s,{assets:()=>c,contentTitle:()=>n,default:()=>f,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=e(5893),r=e(1151);const o={id:"sort-first",title:"sortFirst"},n=void 0,a={id:"config/sort-first",title:"sortFirst",description:"When using the format command, determines which fields within package.json files should appear at the top, and in what order.",source:"@site/docs/config/sort-first.mdx",sourceDirName:"config",slug:"/config/sort-first",permalink:"/syncpack/config/sort-first",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/sort-first.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"sort-first",title:"sortFirst"},sidebar:"docs",previous:{title:"sortAz",permalink:"/syncpack/config/sort-az"},next:{title:"source",permalink:"/syncpack/config/source"}},c={},d=[];function p(t){const s={code:"code",p:"p",...(0,r.a)(),...t.components};return(0,i.jsxs)(s.p,{children:["When using the ",(0,i.jsx)(s.code,{children:"format"})," command, determines which fields within package.json files should appear at the top, and in what order."]})}function f(t={}){const{wrapper:s}={...(0,r.a)(),...t.components};return s?(0,i.jsx)(s,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}}}]); \ No newline at end of file diff --git a/assets/js/60617550.00df6689.js b/assets/js/60617550.00df6689.js deleted file mode 100644 index 07e64ca7..00000000 --- a/assets/js/60617550.00df6689.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[1555],{4443:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),c=o(1151),r=o(8984),i=o(6085),a=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"list",title:"list"},l=void 0,p={id:"command/list",title:"list",description:"List all dependencies required by your packages.",source:"@site/docs/command/list.mdx",sourceDirName:"command",slug:"/command/list",permalink:"/syncpack/command/list",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/list.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"list",title:"list"},sidebar:"docs",previous:{title:"list-mismatches",permalink:"/syncpack/command/list-mismatches"},next:{title:"prompt",permalink:"/syncpack/command/prompt"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"List all dependencies required by your packages."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(i.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(r.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"list"})]})}function b(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);o(9960);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>a});var n=o(5893),c=o(1151),r=o(9286);function i(e){const t={p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(r.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/60617550.17a08b93.js b/assets/js/60617550.17a08b93.js new file mode 100644 index 00000000..3b28ddd8 --- /dev/null +++ b/assets/js/60617550.17a08b93.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[1555],{4443:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),c=o(1151),r=o(8984),i=o(6085),a=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"list",title:"list"},l=void 0,p={id:"command/list",title:"list",description:"List all dependencies required by your packages.",source:"@site/docs/command/list.mdx",sourceDirName:"command",slug:"/command/list",permalink:"/syncpack/command/list",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/list.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"list",title:"list"},sidebar:"docs",previous:{title:"list-mismatches",permalink:"/syncpack/command/list-mismatches"},next:{title:"prompt",permalink:"/syncpack/command/prompt"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"List all dependencies required by your packages."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(i.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(r.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"list"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"list"})]})}function b(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);o(9960);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>a});var n=o(5893),c=o(1151),r=o(9286);function i(e){const t={p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(r.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/61b0711c.9d1ef70a.js b/assets/js/61b0711c.9d1ef70a.js new file mode 100644 index 00000000..4ce383b6 --- /dev/null +++ b/assets/js/61b0711c.9d1ef70a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2740],{2490:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>p,default:()=>F,frontMatter:()=>c,metadata:()=>l,toc:()=>a});var n=t(5893),s=t(1151),r=(t(9960),t(1341));const c={title:"Pin local versions to pnpm workspace:*"},p=void 0,l={id:"examples/pnpm-workspace-protocol",title:"Pin local versions to pnpm workspace:*",description:"",source:"@site/docs/examples/pnpm-workspace-protocol.mdx",sourceDirName:"examples",slug:"/examples/pnpm-workspace-protocol",permalink:"/syncpack/examples/pnpm-workspace-protocol",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/pnpm-workspace-protocol.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Pin local versions to pnpm workspace:*"},sidebar:"examples",previous:{title:"Only allow @types packages in devDependencies",permalink:"/syncpack/examples/only-allow-types-in-dev-dependencies"},next:{title:"Manage npm engines throughout monorepo",permalink:"/syncpack/examples/sync-engines-in-monorepo"}},i={},a=[];function d(e){return(0,n.jsx)(r.ZP,{level:"h2"})}function F(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},1341:(e,o,t)=>{t.d(o,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const p={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return p||d("CH",!1),p.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/pinned",children:"Pinned Version Group"})," so that local packages are always installed using ",(0,n.jsx)(o.code,{children:"workspace:*"})," when they are used in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"pinVersion"})," states that these dependencies must always use ",(0,n.jsx)(o.code,{children:"workspace:*"}),"."]}),"\n"]}),"\n",(0,n.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Use workspace protocol when developing local packages",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workspace:*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function a(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/61b0711c.e944936c.js b/assets/js/61b0711c.e944936c.js deleted file mode 100644 index 0b03f80a..00000000 --- a/assets/js/61b0711c.e944936c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2740],{2490:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>i,contentTitle:()=>p,default:()=>F,frontMatter:()=>c,metadata:()=>l,toc:()=>a});var n=t(5893),s=t(1151),r=(t(9960),t(1341));const c={title:"Pin local versions to pnpm workspace:*"},p=void 0,l={id:"examples/pnpm-workspace-protocol",title:"Pin local versions to pnpm workspace:*",description:"",source:"@site/docs/examples/pnpm-workspace-protocol.mdx",sourceDirName:"examples",slug:"/examples/pnpm-workspace-protocol",permalink:"/syncpack/examples/pnpm-workspace-protocol",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/pnpm-workspace-protocol.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Pin local versions to pnpm workspace:*"},sidebar:"examples",previous:{title:"Only allow @types packages in devDependencies",permalink:"/syncpack/examples/only-allow-types-in-dev-dependencies"},next:{title:"Manage npm engines throughout monorepo",permalink:"/syncpack/examples/sync-engines-in-monorepo"}},i={},a=[];function d(e){return(0,n.jsx)(r.ZP,{level:"h2"})}function F(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},1341:(e,o,t)=>{t.d(o,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const p={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return p||d("CH",!1),p.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/pinned",children:"Pinned Version Group"})," so that local packages are always installed using ",(0,n.jsx)(o.code,{children:"workspace:*"})," when they are used in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"pinVersion"})," states that these dependencies must always use ",(0,n.jsx)(o.code,{children:"workspace:*"}),"."]}),"\n"]}),"\n",(0,n.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Use workspace protocol when developing local packages",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workspace:*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function a(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/6a19cf64.0e9b13ee.js b/assets/js/6a19cf64.7cd0359c.js similarity index 63% rename from assets/js/6a19cf64.0e9b13ee.js rename to assets/js/6a19cf64.7cd0359c.js index fcbebfca..1a8144b2 100644 --- a/assets/js/6a19cf64.0e9b13ee.js +++ b/assets/js/6a19cf64.7cd0359c.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[990],{6291:e=>{e.exports=JSON.parse('{"blogPosts":[{"id":"/index","metadata":{"permalink":"/syncpack/blog/index","editUrl":"https://github.com/JamieMason/syncpack/tree/main/site/blog/index.md","source":"@site/blog/index.md","title":"Blog","description":"","date":"2023-11-06T19:50:01.000Z","formattedDate":"November 6, 2023","tags":[],"hasTruncateMarker":false,"authors":[],"frontMatter":{},"unlisted":false},"content":""}]}')}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[990],{6291:e=>{e.exports=JSON.parse('{"blogPosts":[{"id":"/index","metadata":{"permalink":"/syncpack/blog/index","editUrl":"https://github.com/JamieMason/syncpack/tree/main/site/blog/index.md","source":"@site/blog/index.md","title":"Blog","description":"","date":"2023-11-10T15:49:57.000Z","formattedDate":"November 10, 2023","tags":[],"hasTruncateMarker":false,"authors":[],"frontMatter":{},"unlisted":false},"content":""}]}')}}]); \ No newline at end of file diff --git a/assets/js/6f4c3bf3.05aa5679.js b/assets/js/6f4c3bf3.05aa5679.js deleted file mode 100644 index c4e4a822..00000000 --- a/assets/js/6f4c3bf3.05aa5679.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9664],{3164:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>p});var n=t(5893),s=t(1151),c=(t(9960),t(527));const r={title:"Ensure AWS SDK dependencies always have the same version"},a=void 0,i={id:"examples/fix-aws-sdk-version-mismatch",title:"Ensure AWS SDK dependencies always have the same version",description:"",source:"@site/docs/examples/fix-aws-sdk-version-mismatch.mdx",sourceDirName:"examples",slug:"/examples/fix-aws-sdk-version-mismatch",permalink:"/syncpack/examples/fix-aws-sdk-version-mismatch",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/fix-aws-sdk-version-mismatch.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Ensure AWS SDK dependencies always have the same version"},sidebar:"examples",previous:{title:"Ensure that semver ranges for a dependency all match each other",permalink:"/syncpack/examples/ensure-versions-satisfy-same-range"},next:{title:"Fix React Native version mismatch",permalink:"/syncpack/examples/fix-react-native-version-mismatch"}},l={},p=[];function d(e){return(0,n.jsx)(c.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},527:(e,o,t)=>{t.d(o,{ZP:()=>h});var n=t(5893),s=t(1151),c=t(9794),r=t(9960),a=t(292),i=t(6217);const l={annotations:c.ds,Code:c.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||F("CH",!1),l.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Pin all dependencies from ",(0,n.jsx)(r.Z,{to:a.K.awsSdk,children:"@aws-sdk"})," so that they are always identical."]}),"\n",(0,n.jsx)(i.Hx,{level:e.level,children:"1. Add a pinned version group"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["Match all ",(0,n.jsx)(o.strong,{children:"dependencies"})," whose name starts with ",(0,n.jsx)(o.code,{children:"@aws-sdk/"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["Mark the version as being pinned to ",(0,n.jsx)(o.strong,{children:"3.272.0"})," in this case."]}),"\n",(0,n.jsxs)(o.li,{children:["Add a ",(0,n.jsx)(o.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"3.272.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"AWS SDK Dependencies should all have the same version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(i.Hx,{level:e.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(o.p,{children:["Any ",(0,n.jsx)(o.code,{children:"@aws-sdk"})," packages which do not have the expected version can then be found:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"And fixed:"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}function F(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/6f4c3bf3.e0946522.js b/assets/js/6f4c3bf3.e0946522.js new file mode 100644 index 00000000..5cef6fe5 --- /dev/null +++ b/assets/js/6f4c3bf3.e0946522.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9664],{3164:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>p});var n=t(5893),s=t(1151),c=(t(9960),t(527));const r={title:"Ensure AWS SDK dependencies always have the same version"},a=void 0,i={id:"examples/fix-aws-sdk-version-mismatch",title:"Ensure AWS SDK dependencies always have the same version",description:"",source:"@site/docs/examples/fix-aws-sdk-version-mismatch.mdx",sourceDirName:"examples",slug:"/examples/fix-aws-sdk-version-mismatch",permalink:"/syncpack/examples/fix-aws-sdk-version-mismatch",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/fix-aws-sdk-version-mismatch.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Ensure AWS SDK dependencies always have the same version"},sidebar:"examples",previous:{title:"Ensure that semver ranges for a dependency all match each other",permalink:"/syncpack/examples/ensure-versions-satisfy-same-range"},next:{title:"Fix React Native version mismatch",permalink:"/syncpack/examples/fix-react-native-version-mismatch"}},l={},p=[];function d(e){return(0,n.jsx)(c.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},527:(e,o,t)=>{t.d(o,{ZP:()=>h});var n=t(5893),s=t(1151),c=t(9794),r=t(9960),a=t(292),i=t(6217);const l={annotations:c.ds,Code:c.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||F("CH",!1),l.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Pin all dependencies from ",(0,n.jsx)(r.Z,{to:a.K.awsSdk,children:"@aws-sdk"})," so that they are always identical."]}),"\n",(0,n.jsx)(i.Hx,{level:e.level,children:"1. Add a pinned version group"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["Match all ",(0,n.jsx)(o.strong,{children:"dependencies"})," whose name starts with ",(0,n.jsx)(o.code,{children:"@aws-sdk/"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["Mark the version as being pinned to ",(0,n.jsx)(o.strong,{children:"3.272.0"})," in this case."]}),"\n",(0,n.jsxs)(o.li,{children:["Add a ",(0,n.jsx)(o.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"3.272.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"AWS SDK Dependencies should all have the same version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(i.Hx,{level:e.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(o.p,{children:["Any ",(0,n.jsx)(o.code,{children:"@aws-sdk"})," packages which do not have the expected version can then be found:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"And fixed:"}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}function F(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/764c736e.26093551.js b/assets/js/764c736e.26093551.js new file mode 100644 index 00000000..b80b1dbe --- /dev/null +++ b/assets/js/764c736e.26093551.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9697],{6356:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),r=o(1151),c=o(8984),i=o(6085),a=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"prompt",title:"prompt"},l=void 0,p={id:"command/prompt",title:"prompt",description:"Displays a series of prompts to fix mismatches which syncpack cannot fix automatically.",source:"@site/docs/command/prompt.mdx",sourceDirName:"command",slug:"/command/prompt",permalink:"/syncpack/command/prompt",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/prompt.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"prompt",title:"prompt"},sidebar:"docs",previous:{title:"list",permalink:"/syncpack/command/list"},next:{title:"set-semver-ranges",permalink:"/syncpack/command/set-semver-ranges"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Displays a series of prompts to fix mismatches which syncpack cannot fix automatically."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(i.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(c.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"prompt"})]})}function b(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),i=o(9286),a=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),i=o(9286);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),i=o(9286);o(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>a});var n=o(5893),r=o(1151),c=o(9286);function i(e){const t={p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),i=o(9286),a=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),i=o(9286),a=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/764c736e.3a1bcde7.js b/assets/js/764c736e.3a1bcde7.js deleted file mode 100644 index 51f9de8e..00000000 --- a/assets/js/764c736e.3a1bcde7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9697],{6356:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),r=o(1151),c=o(8984),i=o(6085),a=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"prompt",title:"prompt"},l=void 0,p={id:"command/prompt",title:"prompt",description:"Displays a series of prompts to fix mismatches which syncpack cannot fix automatically.",source:"@site/docs/command/prompt.mdx",sourceDirName:"command",slug:"/command/prompt",permalink:"/syncpack/command/prompt",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/prompt.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"prompt",title:"prompt"},sidebar:"docs",previous:{title:"list",permalink:"/syncpack/command/list"},next:{title:"set-semver-ranges",permalink:"/syncpack/command/set-semver-ranges"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Displays a series of prompts to fix mismatches which syncpack cannot fix automatically."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(i.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(c.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"prompt"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"prompt"})]})}function b(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),i=o(9286),a=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),i=o(9286);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),i=o(9286);o(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>a});var n=o(5893),r=o(1151),c=o(9286);function i(e){const t={p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),i=o(9286),a=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),i=o(9286),a=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/7de4e94d.320720f5.js b/assets/js/7de4e94d.320720f5.js new file mode 100644 index 00000000..1698fc66 --- /dev/null +++ b/assets/js/7de4e94d.320720f5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[7547],{6525:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>g,default:()=>f,frontMatter:()=>l,metadata:()=>p,toc:()=>F});var o=t(5893),r=t(1151),c=t(8984),i=t(6085),a=t(2474),d=t(7463),s=t(3107),h=t(2065),u=t(4086);const l={id:"set-semver-ranges",title:"set-semver-ranges"},g=void 0,p={id:"command/set-semver-ranges",title:"set-semver-ranges",description:'Ensure dependency versions used within "dependencies", "devDependencies" etc follow a consistent format.',source:"@site/docs/command/set-semver-ranges.mdx",sourceDirName:"command",slug:"/command/set-semver-ranges",permalink:"/syncpack/command/set-semver-ranges",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/set-semver-ranges.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"set-semver-ranges",title:"set-semver-ranges"},sidebar:"docs",previous:{title:"prompt",permalink:"/syncpack/command/prompt"},next:{title:"update",permalink:"/syncpack/command/update"}},m={},F=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function b(e){const n={code:"code",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["Ensure dependency versions used within ",(0,o.jsx)(n.code,{children:'"dependencies"'}),", ",(0,o.jsx)(n.code,{children:'"devDependencies"'})," etc follow a consistent format."]}),"\n",(0,o.jsx)(n.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(n.h3,{id:"source",children:"source"}),"\n",(0,o.jsx)(s.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"filter",children:"filter"}),"\n",(0,o.jsx)(i.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(c.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"types",children:"types"}),"\n",(0,o.jsx)(h.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"indent",children:"indent"}),"\n",(0,o.jsx)(d.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(a.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(u.ZP,{command:"set-semver-ranges"})]})}function f(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}},8984:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Only run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,o.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);t(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(n.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,n,t)=>{t.d(n,{ZP:()=>a});var o=t(5893),r=t(1151),c=t(9286);function i(e){const n={p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},3107:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Add quotes around your ",(0,o.jsx)(n.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,o.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/7de4e94d.3baa0766.js b/assets/js/7de4e94d.3baa0766.js deleted file mode 100644 index aeabb127..00000000 --- a/assets/js/7de4e94d.3baa0766.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[7547],{6525:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>g,default:()=>f,frontMatter:()=>l,metadata:()=>p,toc:()=>F});var o=t(5893),r=t(1151),c=t(8984),i=t(6085),a=t(2474),d=t(7463),s=t(3107),h=t(2065),u=t(4086);const l={id:"set-semver-ranges",title:"set-semver-ranges"},g=void 0,p={id:"command/set-semver-ranges",title:"set-semver-ranges",description:'Ensure dependency versions used within "dependencies", "devDependencies" etc follow a consistent format.',source:"@site/docs/command/set-semver-ranges.mdx",sourceDirName:"command",slug:"/command/set-semver-ranges",permalink:"/syncpack/command/set-semver-ranges",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/set-semver-ranges.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"set-semver-ranges",title:"set-semver-ranges"},sidebar:"docs",previous:{title:"prompt",permalink:"/syncpack/command/prompt"},next:{title:"update",permalink:"/syncpack/command/update"}},m={},F=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function b(e){const n={code:"code",h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["Ensure dependency versions used within ",(0,o.jsx)(n.code,{children:'"dependencies"'}),", ",(0,o.jsx)(n.code,{children:'"devDependencies"'})," etc follow a consistent format."]}),"\n",(0,o.jsx)(n.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(n.h3,{id:"source",children:"source"}),"\n",(0,o.jsx)(s.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"filter",children:"filter"}),"\n",(0,o.jsx)(i.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(c.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"types",children:"types"}),"\n",(0,o.jsx)(h.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"indent",children:"indent"}),"\n",(0,o.jsx)(d.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(a.ZP,{command:"set-semver-ranges"}),"\n",(0,o.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(u.ZP,{command:"set-semver-ranges"})]})}function f(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}},8984:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Only run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,o.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);t(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(n.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,n,t)=>{t.d(n,{ZP:()=>a});var o=t(5893),r=t(1151),c=t(9286);function i(e){const n={p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},3107:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Add quotes around your ",(0,o.jsx)(n.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,o.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/8ad702f6.123fa477.js b/assets/js/8ad702f6.123fa477.js new file mode 100644 index 00000000..1c8e3b80 --- /dev/null +++ b/assets/js/8ad702f6.123fa477.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4461],{7371:(o,t,e)=>{e.r(t),e.d(t,{CH:()=>i,assets:()=>y,chCodeConfig:()=>a,contentTitle:()=>p,default:()=>u,frontMatter:()=>l,metadata:()=>F,toc:()=>d});var n=e(5893),s=e(1151),r=e(9794),c=e(9960);const l={id:"version-groups",title:"Version Groups"},p=void 0,F={id:"guide/version-groups",title:"Version Groups",description:"This is an addendum to the Getting Started guide.",source:"@site/docs/guide/version-groups.mdx",sourceDirName:"guide",slug:"/guide/version-groups",permalink:"/syncpack/guide/version-groups",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/version-groups.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"version-groups",title:"Version Groups"},sidebar:"docs",previous:{title:"Semver Groups",permalink:"/syncpack/guide/semver-groups"},next:{title:"fix-mismatches",permalink:"/syncpack/command/fix-mismatches"}},y={},i={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},d=[{value:"Examples",id:"examples",level:2}];function E(o){const t={code:"code",h2:"h2",li:"li",p:"p",ul:"ul",...(0,s.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["This is an addendum to the ",(0,n.jsx)(c.Z,{to:"/guide/getting-started",children:"Getting Started"})," guide."]}),"\n",(0,n.jsx)(t.p,{children:"Version groups are an array of objects which partition your monorepo into isolated sections which each have their own rules/policy/strategy for how versions should be managed."}),"\n",(0,n.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["Let's say your monorepo directly depends on ",(0,n.jsx)(t.code,{children:"react"}),", 3 of your packages have it under ",(0,n.jsx)(t.code,{children:"dependencies"})," and another 2 have it under ",(0,n.jsx)(t.code,{children:"peerDependencies"}),". Each of those 5 specific places where ",(0,n.jsx)(t.code,{children:"react"}),' is depended on we refer to as an "instance".']}),"\n",(0,n.jsx)(t.li,{children:"Every instance of every dependency in your repo is assigned to the first version group it matches."}),"\n",(0,n.jsx)(t.li,{children:"Each instance can only belong to one version group."}),"\n",(0,n.jsx)(t.li,{children:"If you do not define any version groups, or a given instance of a dependency does not match any of them, it is assigned to an internal catch-all version group."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Here is an example which uses every kind of version group:"}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Pinned",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure AWS SDK dependencies always use the same version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"3.272.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Banned",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Please use lodash instead of underscore",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"underscore",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Ignored",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ignore issues in these dodgy packages",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Snapped",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure all packages use whatever version the mobile-core package is using",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-core",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Pinned",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Use '*' under 'peerDependencies' everywhere",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Standard",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Resolve mismatches here with the oldest version instead of the newest",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@vintage/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"preferVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"lowestSemver",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function u(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(E,{...o})}):E(o)}function h(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/8ad702f6.89a56461.js b/assets/js/8ad702f6.89a56461.js deleted file mode 100644 index 2b57eed3..00000000 --- a/assets/js/8ad702f6.89a56461.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4461],{7371:(o,t,e)=>{e.r(t),e.d(t,{CH:()=>i,assets:()=>y,chCodeConfig:()=>a,contentTitle:()=>p,default:()=>u,frontMatter:()=>l,metadata:()=>F,toc:()=>d});var n=e(5893),s=e(1151),r=e(9794),c=e(9960);const l={id:"version-groups",title:"Version Groups"},p=void 0,F={id:"guide/version-groups",title:"Version Groups",description:"This is an addendum to the Getting Started guide.",source:"@site/docs/guide/version-groups.mdx",sourceDirName:"guide",slug:"/guide/version-groups",permalink:"/syncpack/guide/version-groups",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/version-groups.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"version-groups",title:"Version Groups"},sidebar:"docs",previous:{title:"Semver Groups",permalink:"/syncpack/guide/semver-groups"},next:{title:"fix-mismatches",permalink:"/syncpack/command/fix-mismatches"}},y={},i={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},d=[{value:"Examples",id:"examples",level:2}];function E(o){const t={code:"code",h2:"h2",li:"li",p:"p",ul:"ul",...(0,s.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(t.p,{children:["This is an addendum to the ",(0,n.jsx)(c.Z,{to:"/guide/getting-started",children:"Getting Started"})," guide."]}),"\n",(0,n.jsx)(t.p,{children:"Version groups are an array of objects which partition your monorepo into isolated sections which each have their own rules/policy/strategy for how versions should be managed."}),"\n",(0,n.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["Let's say your monorepo directly depends on ",(0,n.jsx)(t.code,{children:"react"}),", 3 of your packages have it under ",(0,n.jsx)(t.code,{children:"dependencies"})," and another 2 have it under ",(0,n.jsx)(t.code,{children:"peerDependencies"}),". Each of those 5 specific places where ",(0,n.jsx)(t.code,{children:"react"}),' is depended on we refer to as an "instance".']}),"\n",(0,n.jsx)(t.li,{children:"Every instance of every dependency in your repo is assigned to the first version group it matches."}),"\n",(0,n.jsx)(t.li,{children:"Each instance can only belong to one version group."}),"\n",(0,n.jsx)(t.li,{children:"If you do not define any version groups, or a given instance of a dependency does not match any of them, it is assigned to an internal catch-all version group."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Here is an example which uses every kind of version group:"}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Pinned",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure AWS SDK dependencies always use the same version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"3.272.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Banned",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Please use lodash instead of underscore",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"underscore",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Ignored",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ignore issues in these dodgy packages",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Snapped",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure all packages use whatever version the mobile-core package is using",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-core",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Pinned",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Use '*' under 'peerDependencies' everywhere",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" // Standard",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Resolve mismatches here with the oldest version instead of the newest",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@vintage/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"preferVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"lowestSemver",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function u(o={}){const{wrapper:t}={...(0,s.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(E,{...o})}):E(o)}function h(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/957a0050.5dbcb3b1.js b/assets/js/957a0050.5dbcb3b1.js new file mode 100644 index 00000000..ac183a7b --- /dev/null +++ b/assets/js/957a0050.5dbcb3b1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3573],{7007:(o,e,t)=>{t.r(e),t.d(e,{assets:()=>d,contentTitle:()=>p,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>a});var n=t(5893),c=t(1151),s=(t(292),t(8984),t(1700),t(9605),t(4284),t(9960),t(4383)),r=t(7029);const l={id:"custom-types",title:"customTypes"},p=void 0,i={id:"config/custom-types",title:"customTypes",description:"Extend syncpack to manage other parts of your package.json files than those provided by default.",source:"@site/docs/config/custom-types.mdx",sourceDirName:"config",slug:"/config/custom-types",permalink:"/syncpack/config/custom-types",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/custom-types.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"custom-types",title:"customTypes"},sidebar:"docs",previous:{title:".syncpackrc",permalink:"/syncpack/config/syncpackrc"},next:{title:"dependencyTypes",permalink:"/syncpack/config/dependency-types"}},d={},a=[{value:"[name]",id:"name",level:2},{value:"[name].path",id:"namepath",level:2},{value:"[name].strategy",id:"namestrategy",level:2}];function F(o){const e={code:"code",h2:"h2",li:"li",ol:"ol",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components},{Details:t}=e;return t||function(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.p,{children:"Extend syncpack to manage other parts of your package.json files than those provided by default."}),"\n",(0,n.jsxs)(e.p,{children:["Custom types behave indentically to the default dependency types (such as ",(0,n.jsx)(e.code,{children:"prod"})," or ",(0,n.jsx)(e.code,{children:"peer"}),") and can be used in all of the same places."]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsxs)(e.p,{children:["Example: Manage ",(0,n.jsx)("code",{children:"engines"})," property of package.json files"]})}),(0,n.jsx)(s.ZP,{level:"h4"})]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Synchronise Node.js version"}),(0,n.jsx)(s.ZP,{level:"h4"})]}),"\n",(0,n.jsx)(e.h2,{id:"name",children:"[name]"}),"\n",(0,n.jsx)(r.Z,{required:!0}),"\n",(0,n.jsxs)(e.p,{children:["The key of each custom type is its name, this is equivalent to the default names such as ",(0,n.jsx)(e.code,{children:"prod"})," and ",(0,n.jsx)(e.code,{children:"dev"})," and can be used in all of the same places those can:"]}),"\n",(0,n.jsxs)(e.ol,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"--types"})," and ",(0,n.jsx)(e.code,{children:"dependencyTypes"})]}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.code,{children:"versionGroup.dependencyTypes"})}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.code,{children:"semverGroup.dependencyTypes"})}),"\n"]}),"\n",(0,n.jsx)(e.h2,{id:"namepath",children:"[name].path"}),"\n",(0,n.jsx)(r.Z,{required:!0}),"\n",(0,n.jsxs)(e.p,{children:["Where the version can be found in each package.json file, such as ",(0,n.jsx)(e.code,{children:"engines"}),", ",(0,n.jsx)(e.code,{children:"packageManager"})," or ",(0,n.jsx)(e.code,{children:"some.nested.property"}),"."]}),"\n",(0,n.jsx)(e.h2,{id:"namestrategy",children:"[name].strategy"}),"\n",(0,n.jsx)(r.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"A strategy defines how syncpack needs to read and write dependency names and versions, there are 3 to choose from:"}),"\n",(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{children:"Name"}),(0,n.jsx)(e.th,{children:"Example"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"name@version"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"pnpm@7.27.0"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"version"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"12.4.2"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"versionsByName"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:'{"pnpm":"7.27.0", "semver": "7.3.8"}'})})]})]})]})]})}function h(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}},1700:(o,e,t)=>{t.d(e,{ZP:()=>r});var n=t(5893),c=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function r(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},9605:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),c=t(1151),s=t(9794),r=t(9960);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,c.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(e.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(r.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(e.admonition,{type:"note",children:(0,n.jsxs)(e.p,{children:["Ensure that ",(0,n.jsx)(e.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(e.strong,{children:"not"})," set in ",(0,n.jsx)(e.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function d(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4284:(o,e,t)=>{t.d(e,{ZP:()=>i});var n=t(5893),c=t(1151),s=t(9794);const r={annotations:s.ds,Code:s.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const e={p:"p",...(0,c.a)(),...o.components};return r||d("CH",!1),r.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(e.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(r.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function i(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4383:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),c=t(1151),s=t(9794),r=t(9960),l=t(292),p=t(6217);const i={annotations:s.ds,Code:s.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(o){const e={code:"code",p:"p",...(0,c.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Ensure ",(0,n.jsx)(r.Z,{to:l.K.engines,children:(0,n.jsx)(e.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(e.p,{children:["I've chosen a name of ",(0,n.jsx)(e.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Perform a one-off check for every usage of ",(0,n.jsx)(e.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(e.p,{children:["Add your new custom type to your ",(0,n.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Now when you run any syncpack command, ",(0,n.jsx)(e.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(r.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function F(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},8984:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),c=t(1151),s=t(9794),r=t(9286),l=t(9960);const p={annotations:s.ds,Code:s.EK},i={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(o){const e={p:"p",...(0,c.a)(),...o.components};return p||F("CH",!1),p.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(p.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Syncpack uses ",(0,n.jsx)(l.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(r.Z,{children:`syncpack ${o.command} --config ./config/.syncpackrc`})]})}function a(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}function F(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>c});t(7294);var n=t(5893);function c(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var c=t(5893);function s(o){let{required:e,optional:t}=o;return(0,c.jsxs)("p",{children:[e&&(0,c.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,c.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/957a0050.f0f5323c.js b/assets/js/957a0050.f0f5323c.js deleted file mode 100644 index e0d0ac0d..00000000 --- a/assets/js/957a0050.f0f5323c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3573],{7007:(o,e,t)=>{t.r(e),t.d(e,{assets:()=>d,contentTitle:()=>p,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>a});var n=t(5893),c=t(1151),s=(t(292),t(8984),t(1700),t(9605),t(4284),t(9960),t(4383)),r=t(7029);const l={id:"custom-types",title:"customTypes"},p=void 0,i={id:"config/custom-types",title:"customTypes",description:"Extend syncpack to manage other parts of your package.json files than those provided by default.",source:"@site/docs/config/custom-types.mdx",sourceDirName:"config",slug:"/config/custom-types",permalink:"/syncpack/config/custom-types",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/custom-types.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"custom-types",title:"customTypes"},sidebar:"docs",previous:{title:".syncpackrc",permalink:"/syncpack/config/syncpackrc"},next:{title:"dependencyTypes",permalink:"/syncpack/config/dependency-types"}},d={},a=[{value:"[name]",id:"name",level:2},{value:"[name].path",id:"namepath",level:2},{value:"[name].strategy",id:"namestrategy",level:2}];function F(o){const e={code:"code",h2:"h2",li:"li",ol:"ol",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components},{Details:t}=e;return t||function(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.p,{children:"Extend syncpack to manage other parts of your package.json files than those provided by default."}),"\n",(0,n.jsxs)(e.p,{children:["Custom types behave indentically to the default dependency types (such as ",(0,n.jsx)(e.code,{children:"prod"})," or ",(0,n.jsx)(e.code,{children:"peer"}),") and can be used in all of the same places."]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsxs)(e.p,{children:["Example: Manage ",(0,n.jsx)("code",{children:"engines"})," property of package.json files"]})}),(0,n.jsx)(s.ZP,{level:"h4"})]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Example: Synchronise Node.js version"}),(0,n.jsx)(s.ZP,{level:"h4"})]}),"\n",(0,n.jsx)(e.h2,{id:"name",children:"[name]"}),"\n",(0,n.jsx)(r.Z,{required:!0}),"\n",(0,n.jsxs)(e.p,{children:["The key of each custom type is its name, this is equivalent to the default names such as ",(0,n.jsx)(e.code,{children:"prod"})," and ",(0,n.jsx)(e.code,{children:"dev"})," and can be used in all of the same places those can:"]}),"\n",(0,n.jsxs)(e.ol,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"--types"})," and ",(0,n.jsx)(e.code,{children:"dependencyTypes"})]}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.code,{children:"versionGroup.dependencyTypes"})}),"\n",(0,n.jsx)(e.li,{children:(0,n.jsx)(e.code,{children:"semverGroup.dependencyTypes"})}),"\n"]}),"\n",(0,n.jsx)(e.h2,{id:"namepath",children:"[name].path"}),"\n",(0,n.jsx)(r.Z,{required:!0}),"\n",(0,n.jsxs)(e.p,{children:["Where the version can be found in each package.json file, such as ",(0,n.jsx)(e.code,{children:"engines"}),", ",(0,n.jsx)(e.code,{children:"packageManager"})," or ",(0,n.jsx)(e.code,{children:"some.nested.property"}),"."]}),"\n",(0,n.jsx)(e.h2,{id:"namestrategy",children:"[name].strategy"}),"\n",(0,n.jsx)(r.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:"A strategy defines how syncpack needs to read and write dependency names and versions, there are 3 to choose from:"}),"\n",(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{children:"Name"}),(0,n.jsx)(e.th,{children:"Example"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"name@version"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"pnpm@7.27.0"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"version"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"12.4.2"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"versionsByName"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:'{"pnpm":"7.27.0", "semver": "7.3.8"}'})})]})]})]})]})}function h(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}},1700:(o,e,t)=>{t.d(e,{ZP:()=>r});var n=t(5893),c=t(1151);function s(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function r(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(s,{...o})}):s(o)}},9605:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),c=t(1151),s=t(9794),r=t(9960);const l={annotations:s.ds,Code:s.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,c.a)(),...o.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(e.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(r.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(e.admonition,{type:"note",children:(0,n.jsxs)(e.p,{children:["Ensure that ",(0,n.jsx)(e.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(e.strong,{children:"not"})," set in ",(0,n.jsx)(e.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function d(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4284:(o,e,t)=>{t.d(e,{ZP:()=>i});var n=t(5893),c=t(1151),s=t(9794);const r={annotations:s.ds,Code:s.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const e={p:"p",...(0,c.a)(),...o.components};return r||d("CH",!1),r.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(e.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(r.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function i(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4383:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),c=t(1151),s=t(9794),r=t(9960),l=t(292),p=t(6217);const i={annotations:s.ds,Code:s.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function a(o){const e={code:"code",p:"p",...(0,c.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Ensure ",(0,n.jsx)(r.Z,{to:l.K.engines,children:(0,n.jsx)(e.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(e.p,{children:["I've chosen a name of ",(0,n.jsx)(e.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Perform a one-off check for every usage of ",(0,n.jsx)(e.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(e.p,{children:["Add your new custom type to your ",(0,n.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Now when you run any syncpack command, ",(0,n.jsx)(e.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(r.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function F(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},8984:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),c=t(1151),s=t(9794),r=t(9286),l=t(9960);const p={annotations:s.ds,Code:s.EK},i={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(o){const e={p:"p",...(0,c.a)(),...o.components};return p||F("CH",!1),p.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(p.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Syncpack uses ",(0,n.jsx)(l.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(r.Z,{children:`syncpack ${o.command} --config ./config/.syncpackrc`})]})}function a(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}function F(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>c});t(7294);var n=t(5893);function c(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>s});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var c=t(5893);function s(o){let{required:e,optional:t}=o;return(0,c.jsxs)("p",{children:[e&&(0,c.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,c.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/a0d46b54.2e5e93c8.js b/assets/js/a0d46b54.2e5e93c8.js deleted file mode 100644 index bd51bbd6..00000000 --- a/assets/js/a0d46b54.2e5e93c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3682],{2879:(o,t,e)=>{e.r(t),e.d(t,{assets:()=>F,contentTitle:()=>l,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>a});var n=e(5893),r=e(1151),s=e(4284);const c={id:"json-schema",title:"JSON Schema"},l=void 0,p={id:"integrations/json-schema",title:"JSON Schema",description:"",source:"@site/docs/integrations/json-schema.mdx",sourceDirName:"integrations",slug:"/integrations/json-schema",permalink:"/syncpack/integrations/json-schema",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/json-schema.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"json-schema",title:"JSON Schema"},sidebar:"docs",previous:{title:"TypeScript Intellisense",permalink:"/syncpack/integrations/intellisense"},next:{title:"Lerna",permalink:"/syncpack/integrations/lerna"}},F={},a=[];function i(o){return(0,n.jsx)(s.ZP,{})}function d(o={}){const{wrapper:t}={...(0,r.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i()}},4284:(o,t,e)=>{e.d(t,{ZP:()=>F});var n=e(5893),r=e(1151),s=e(9794);const c={annotations:s.ds,Code:s.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const t={p:"p",...(0,r.a)(),...o.components};return c||a("CH",!1),c.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(t.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(c.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function F(o={}){const{wrapper:t}={...(0,r.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function a(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/a0d46b54.34f8f838.js b/assets/js/a0d46b54.34f8f838.js new file mode 100644 index 00000000..ba54557e --- /dev/null +++ b/assets/js/a0d46b54.34f8f838.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3682],{2879:(o,t,e)=>{e.r(t),e.d(t,{assets:()=>F,contentTitle:()=>l,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>a});var n=e(5893),r=e(1151),s=e(4284);const c={id:"json-schema",title:"JSON Schema"},l=void 0,p={id:"integrations/json-schema",title:"JSON Schema",description:"",source:"@site/docs/integrations/json-schema.mdx",sourceDirName:"integrations",slug:"/integrations/json-schema",permalink:"/syncpack/integrations/json-schema",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/json-schema.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"json-schema",title:"JSON Schema"},sidebar:"docs",previous:{title:"TypeScript Intellisense",permalink:"/syncpack/integrations/intellisense"},next:{title:"Lerna",permalink:"/syncpack/integrations/lerna"}},F={},a=[];function i(o){return(0,n.jsx)(s.ZP,{})}function d(o={}){const{wrapper:t}={...(0,r.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(i,{...o})}):i()}},4284:(o,t,e)=>{e.d(t,{ZP:()=>F});var n=e(5893),r=e(1151),s=e(9794);const c={annotations:s.ds,Code:s.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const t={p:"p",...(0,r.a)(),...o.components};return c||a("CH",!1),c.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(t.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(c.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function F(o={}){const{wrapper:t}={...(0,r.a)(),...o.components};return t?(0,n.jsx)(t,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function a(o,t){throw new Error("Expected "+(t?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/a424efa6.40be1d1b.js b/assets/js/a424efa6.b208872f.js similarity index 51% rename from assets/js/a424efa6.40be1d1b.js rename to assets/js/a424efa6.b208872f.js index 2884de09..dd06434e 100644 --- a/assets/js/a424efa6.40be1d1b.js +++ b/assets/js/a424efa6.b208872f.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2076],{990:(t,e,s)=>{s.r(e),s.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var a=s(5893),n=s(1151);const r={},o="Blog",i={permalink:"/syncpack/blog/index",editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/blog/index.md",source:"@site/blog/index.md",title:"Blog",description:"",date:"2023-11-06T19:50:01.000Z",formattedDate:"November 6, 2023",tags:[],hasTruncateMarker:!1,authors:[],frontMatter:{},unlisted:!1},c={authorsImageUrls:[]},l=[];function u(t){return(0,a.jsx)(a.Fragment,{})}function d(t={}){const{wrapper:e}={...(0,n.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u()}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[2076],{990:(t,e,s)=>{s.r(e),s.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var a=s(5893),n=s(1151);const r={},o="Blog",i={permalink:"/syncpack/blog/index",editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/blog/index.md",source:"@site/blog/index.md",title:"Blog",description:"",date:"2023-11-10T15:49:57.000Z",formattedDate:"November 10, 2023",tags:[],hasTruncateMarker:!1,authors:[],frontMatter:{},unlisted:!1},c={authorsImageUrls:[]},l=[];function u(t){return(0,a.jsx)(a.Fragment,{})}function d(t={}){const{wrapper:e}={...(0,n.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u()}}}]); \ No newline at end of file diff --git a/assets/js/bbf0b0c6.d8d9a344.js b/assets/js/bbf0b0c6.d8d9a344.js new file mode 100644 index 00000000..b3acafa1 --- /dev/null +++ b/assets/js/bbf0b0c6.d8d9a344.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5269],{7824:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>m,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>E});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),a=t(3133),d=t(4498);const F={id:"same-range",title:"Same Range"},h=void 0,y={id:"config/version-groups/same-range",title:"Same Range",description:"Relax syncpack to ensure that all versions have semver ranges which all satisfy each other, instead of having to be identical.",source:"@site/docs/config/version-groups/same-range.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/same-range",permalink:"/syncpack/config/version-groups/same-range",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/same-range.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"same-range",title:"Same Range"},sidebar:"docs",previous:{title:"Pinned",permalink:"/syncpack/config/version-groups/pinned"},next:{title:"Snapped To",permalink:"/syncpack/config/version-groups/snapped-to"}},u={},g={annotations:r.ds,Code:r.EK},m={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"policy",id:"policy",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Relax syncpack to ensure that all versions have semver ranges which all satisfy each other, instead of having to be identical."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsx)(e.p,{children:"Example: Check that a dependency's semver ranges always match"})}),(0,n.jsx)(d.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"policy",children:"policy"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:'Currently the only custom policy in syncpack is "sameRange", which is what causes this behaviour to be applied to a Version Group.'}),"\n",(0,n.jsx)(g.Code,{codeConfig:m,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(a.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},4498:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," which allows local packages installed in ",(0,n.jsx)(e.code,{children:"devDependencies"})," or ",(0,n.jsx)(e.code,{children:"peerDependencies"})," to use different semver ranges, as long as they all match the local package version."]}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An optional ",(0,n.jsx)(e.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(e.code,{children:"devDependencies"})," or ",(0,n.jsx)(e.code,{children:"peerDependencies"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"policy"})," of ",(0,n.jsx)(e.strong,{children:"sameRange"})," states that these dependencies are considered valid if every range matches the others."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure semver ranges for locally developed packages satisfy the local version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.admonition,{type:"tip",children:[(0,n.jsxs)(e.p,{children:["The above example can be shortened: The ",(0,n.jsx)(e.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function a(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/bbf0b0c6.eeac5642.js b/assets/js/bbf0b0c6.eeac5642.js deleted file mode 100644 index c2bf0265..00000000 --- a/assets/js/bbf0b0c6.eeac5642.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5269],{7824:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>g,assets:()=>u,chCodeConfig:()=>m,contentTitle:()=>h,default:()=>j,frontMatter:()=>F,metadata:()=>y,toc:()=>E});var n=t(5893),s=t(1151),r=t(9794),c=t(7029),l=t(4422),p=t(2369),i=t(4684),a=t(3133),d=t(4498);const F={id:"same-range",title:"Same Range"},h=void 0,y={id:"config/version-groups/same-range",title:"Same Range",description:"Relax syncpack to ensure that all versions have semver ranges which all satisfy each other, instead of having to be identical.",source:"@site/docs/config/version-groups/same-range.mdx",sourceDirName:"config/version-groups",slug:"/config/version-groups/same-range",permalink:"/syncpack/config/version-groups/same-range",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/version-groups/same-range.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"same-range",title:"Same Range"},sidebar:"docs",previous:{title:"Pinned",permalink:"/syncpack/config/version-groups/pinned"},next:{title:"Snapped To",permalink:"/syncpack/config/version-groups/snapped-to"}},u={},g={annotations:r.ds,Code:r.EK},m={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},E=[{value:"Examples",id:"examples",level:2},{value:"Configuration",id:"configuration",level:2},{value:"policy",id:"policy",level:3},{value:"dependencies",id:"dependencies",level:3},{value:"dependencyTypes",id:"dependencytypes",level:3},{value:"label",id:"label",level:3},{value:"packages",id:"packages",level:3}];function x(o){const e={h2:"h2",h3:"h3",p:"p",...(0,s.a)(),...o.components},{Details:t}=e;return g||f("CH",!1),g.Code||f("CH.Code",!0),t||f("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Relax syncpack to ensure that all versions have semver ranges which all satisfy each other, instead of having to be identical."}),"\n",(0,n.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsx)(e.p,{children:"Example: Check that a dependency's semver ranges always match"})}),(0,n.jsx)(d.ZP,{level:"h3"})]}),"\n",(0,n.jsx)(e.h2,{id:"configuration",children:"Configuration"}),"\n",(0,n.jsx)(e.h3,{id:"policy",children:"policy"}),"\n",(0,n.jsx)(c.Z,{required:!0}),"\n",(0,n.jsx)(e.p,{children:'Currently the only custom policy in syncpack is "sameRange", which is what causes this behaviour to be applied to a Version Group.'}),"\n",(0,n.jsx)(g.Code,{codeConfig:m,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(e.h3,{id:"dependencies",children:"dependencies"}),"\n",(0,n.jsx)(p.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"dependencytypes",children:"dependencyTypes"}),"\n",(0,n.jsx)(i.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,n.jsx)(a.ZP,{}),"\n",(0,n.jsx)(e.h3,{id:"packages",children:"packages"}),"\n",(0,n.jsx)(l.ZP,{})]})}function j(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(x,{...o})}):x(o)}function f(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>c});var n=t(5893),s=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function c(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},4498:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," which allows local packages installed in ",(0,n.jsx)(e.code,{children:"devDependencies"})," or ",(0,n.jsx)(e.code,{children:"peerDependencies"})," to use different semver ranges, as long as they all match the local package version."]}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An optional ",(0,n.jsx)(e.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(e.code,{children:"devDependencies"})," or ",(0,n.jsx)(e.code,{children:"peerDependencies"}),"."]}),"\n",(0,n.jsxs)(e.li,{children:["The ",(0,n.jsx)(e.strong,{children:"policy"})," of ",(0,n.jsx)(e.strong,{children:"sameRange"})," states that these dependencies are considered valid if every range matches the others."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure semver ranges for locally developed packages satisfy the local version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.admonition,{type:"tip",children:[(0,n.jsxs)(e.p,{children:["The above example can be shortened: The ",(0,n.jsx)(e.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},2369:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"An array of names of dependencies you've installed or otherwise reference in your package.json files."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every dependency."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// match any dependency",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match all dependencies with a certain scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@aws-sdk/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// match specific dependencies by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"dependencies: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-dom",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pnpm",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"overrides",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" } },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"resolutions",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" { ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:"HERE",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4684:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(7029),c=t(1700),l=t(9960);function p(o){const e={admonition:"admonition",p:"p",...(0,s.a)(),...o.components};return(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)("p",{children:[(0,n.jsxs)(e.p,{children:["You can extend syncpack to inspect more parts of your package.json files by defining your own"," "]}),(0,n.jsx)(l.Z,{to:"/config/custom-types",children:(0,n.jsx)("code",{children:"customTypes"})}),(0,n.jsx)(e.p,{children:"."})]})})}function i(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function a(o){const e={code:"code",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsx)(i,{}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"When set, only dependencies present in the named locations will be assigned to this group."}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match dependencies everywhere they are found."}),"\n",(0,n.jsxs)(e.li,{children:["Negated types are also supported, so a value of ",(0,n.jsx)(e.code,{children:'["!dev", "!prod"]'})," would assign everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," to this group."]}),"\n"]}),"\n",(0,n.jsx)(e.h4,{id:"default-values",children:"Default values"}),"\n",(0,n.jsx)(c.ZP,{})]})}function d(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(a,{...o})}):a(o)}},3133:(o,e,t)=>{t.d(e,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(7029);function c(o){const e={li:"li",ul:"ul",...(0,s.a)(),...o.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsx)(e.li,{children:"A short name or description displayed as a header in syncpack's output."}),"\n",(0,n.jsx)(e.li,{children:'If a label is not set then eg. "Version Group 3" will be used instead.'}),"\n"]})]})}function l(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(c,{...o})}):c(o)}},4422:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),s=t(1151),r=t(9794),c=t(7029);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",code:"code",li:"li",ul:"ul",...(0,s.a)(),...o.components};return l||d("CH",!1),l.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(c.Z,{optional:!0}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:["An array of strings which should match the ",(0,n.jsx)(e.code,{children:"name"})," properties of your package.json files."]}),"\n",(0,n.jsx)(e.li,{children:"If omitted, the default behaviour is to match every package."}),"\n",(0,n.jsxs)(e.li,{children:["The strings can be any combination of exact matches or ",(0,n.jsx)(e.a,{href:"https://github.com/isaacs/minimatch",children:"minimatch"})," glob patterns:"]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["of"],active:"of",heightRatio:1},files:[{name:"of",title:'"Examples',valid:!0,'values"':!0,focus:"",code:{lines:[{tokens:[{content:"// \u2705 match any package name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match any package name with this scope",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@my-repo/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u2705 match specific packages by name",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-server",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system paths, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/my-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"// \u274c not file system globs, name properties of package.json files",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"packages: [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packages/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:["this"],active:"this",heightRatio:1},files:[{name:"this",title:'"Where',pattern:!0,is:!0,matched:!0,'against"':!0,focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"HERE",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.0.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,s.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>s});t(7294);var n=t(5893);function s(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var s=t(5893);function r(o){let{required:e,optional:t}=o;return(0,s.jsxs)("p",{children:[e&&(0,s.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,s.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/c046c6d8.fb79c697.js b/assets/js/c046c6d8.65836e20.js similarity index 53% rename from assets/js/c046c6d8.fb79c697.js rename to assets/js/c046c6d8.65836e20.js index 4ffdeb00..8ae626b7 100644 --- a/assets/js/c046c6d8.fb79c697.js +++ b/assets/js/c046c6d8.65836e20.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6921],{7352:(t,n,e)=>{e.r(n),e.d(n,{assets:()=>p,contentTitle:()=>r,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var s=e(5893),i=e(1151);const a={id:"npm",title:"npm"},r=void 0,o={id:"integrations/npm",title:"npm",description:"When using npm Workspaces, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/npm.mdx",sourceDirName:"integrations",slug:"/integrations/npm",permalink:"/syncpack/integrations/npm",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/npm.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"npm",title:"npm"},sidebar:"docs",previous:{title:"Lerna",permalink:"/syncpack/integrations/lerna"},next:{title:"pnpm",permalink:"/syncpack/integrations/pnpm"}},p={},c=[];function d(t){const n={p:"p",...(0,i.a)(),...t.components};return(0,s.jsx)(n.p,{children:"When using npm Workspaces, syncpack will use its configuration to discover where your package.json files are."})}function m(t={}){const{wrapper:n}={...(0,i.a)(),...t.components};return n?(0,s.jsx)(n,{...t,children:(0,s.jsx)(d,{...t})}):d(t)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6921],{7352:(t,n,e)=>{e.r(n),e.d(n,{assets:()=>p,contentTitle:()=>r,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var s=e(5893),i=e(1151);const a={id:"npm",title:"npm"},r=void 0,o={id:"integrations/npm",title:"npm",description:"When using npm Workspaces, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/npm.mdx",sourceDirName:"integrations",slug:"/integrations/npm",permalink:"/syncpack/integrations/npm",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/npm.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"npm",title:"npm"},sidebar:"docs",previous:{title:"Lerna",permalink:"/syncpack/integrations/lerna"},next:{title:"pnpm",permalink:"/syncpack/integrations/pnpm"}},p={},c=[];function d(t){const n={p:"p",...(0,i.a)(),...t.components};return(0,s.jsx)(n.p,{children:"When using npm Workspaces, syncpack will use its configuration to discover where your package.json files are."})}function m(t={}){const{wrapper:n}={...(0,i.a)(),...t.components};return n?(0,s.jsx)(n,{...t,children:(0,s.jsx)(d,{...t})}):d(t)}}}]); \ No newline at end of file diff --git a/assets/js/c7de8929.552ba940.js b/assets/js/c7de8929.552ba940.js deleted file mode 100644 index e1f354f5..00000000 --- a/assets/js/c7de8929.552ba940.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[1182],{7953:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>p,toc:()=>a});var t=n(5893),s=n(1151),c=(n(9960),n(7318));const r={title:"Only allow @types packages in devDependencies"},l=void 0,p={id:"examples/only-allow-types-in-dev-dependencies",title:"Only allow @types packages in devDependencies",description:"",source:"@site/docs/examples/only-allow-types-in-dev-dependencies.mdx",sourceDirName:"examples",slug:"/examples/only-allow-types-in-dev-dependencies",permalink:"/syncpack/examples/only-allow-types-in-dev-dependencies",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/only-allow-types-in-dev-dependencies.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Only allow @types packages in devDependencies"},sidebar:"examples",previous:{title:"Hide dependencies from syncpack",permalink:"/syncpack/examples/ignore-dependencies-in-syncpack"},next:{title:"Pin local versions to pnpm workspace:*",permalink:"/syncpack/examples/pnpm-workspace-protocol"}},i={},a=[];function d(e){return(0,t.jsx)(c.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d()}},7318:(e,o,n)=>{n.d(o,{ZP:()=>h});var t=n(5893),s=n(1151),c=n(9794),r=n(9960),l=n(292),p=n(6217);const i={annotations:c.ds,Code:c.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return i||F("CH",!1),i.Code||F("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsxs)(o.p,{children:["Only allow TypeScript ",(0,t.jsx)(r.Z,{to:l.K["@types"],children:"@types"})," packages from being used anywhere other than in the ",(0,t.jsx)("code",{children:"devDependencies"})," section of package.json."]}),"\n",(0,t.jsx)(p.Hx,{level:e.level,children:"1. Add a version group"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Match all ",(0,t.jsx)(o.strong,{children:"dependencies"})," whose name starts with ",(0,t.jsx)(o.code,{children:"@types/"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Only match those dependencies when they appear anywhere ",(0,t.jsx)(o.strong,{children:"except"})," ",(0,t.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Define the behaviour of this group as ",(0,t.jsx)(o.strong,{children:"isBanned"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Add a ",(0,t.jsx)(o.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types packages should only be under devDependencies",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:e.level,children:"2. Look for mismatches"}),"\n",(0,t.jsxs)(o.p,{children:["Any ",(0,t.jsx)(o.code,{children:"@types"})," packages which are in the wrong location can then be found and manually moved:"]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}function F(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,n)=>{n.d(o,{Hx:()=>s});n(7294);var t=n(5893);function s(e){let{children:o,level:n}=e;return(0,t.jsx)(n,{children:o})}},292:(e,o,n)=>{n.d(o,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/c7de8929.a73a774d.js b/assets/js/c7de8929.a73a774d.js new file mode 100644 index 00000000..3f53a3a3 --- /dev/null +++ b/assets/js/c7de8929.a73a774d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[1182],{7953:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>p,toc:()=>a});var t=n(5893),s=n(1151),c=(n(9960),n(7318));const r={title:"Only allow @types packages in devDependencies"},l=void 0,p={id:"examples/only-allow-types-in-dev-dependencies",title:"Only allow @types packages in devDependencies",description:"",source:"@site/docs/examples/only-allow-types-in-dev-dependencies.mdx",sourceDirName:"examples",slug:"/examples/only-allow-types-in-dev-dependencies",permalink:"/syncpack/examples/only-allow-types-in-dev-dependencies",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/only-allow-types-in-dev-dependencies.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Only allow @types packages in devDependencies"},sidebar:"examples",previous:{title:"Hide dependencies from syncpack",permalink:"/syncpack/examples/ignore-dependencies-in-syncpack"},next:{title:"Pin local versions to pnpm workspace:*",permalink:"/syncpack/examples/pnpm-workspace-protocol"}},i={},a=[];function d(e){return(0,t.jsx)(c.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d()}},7318:(e,o,n)=>{n.d(o,{ZP:()=>h});var t=n(5893),s=n(1151),c=n(9794),r=n(9960),l=n(292),p=n(6217);const i={annotations:c.ds,Code:c.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return i||F("CH",!1),i.Code||F("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsxs)(o.p,{children:["Only allow TypeScript ",(0,t.jsx)(r.Z,{to:l.K["@types"],children:"@types"})," packages from being used anywhere other than in the ",(0,t.jsx)("code",{children:"devDependencies"})," section of package.json."]}),"\n",(0,t.jsx)(p.Hx,{level:e.level,children:"1. Add a version group"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Match all ",(0,t.jsx)(o.strong,{children:"dependencies"})," whose name starts with ",(0,t.jsx)(o.code,{children:"@types/"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Only match those dependencies when they appear anywhere ",(0,t.jsx)(o.strong,{children:"except"})," ",(0,t.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Define the behaviour of this group as ",(0,t.jsx)(o.strong,{children:"isBanned"}),"."]}),"\n",(0,t.jsxs)(o.li,{children:["Add a ",(0,t.jsx)(o.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types packages should only be under devDependencies",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(p.Hx,{level:e.level,children:"2. Look for mismatches"}),"\n",(0,t.jsxs)(o.p,{children:["Any ",(0,t.jsx)(o.code,{children:"@types"})," packages which are in the wrong location can then be found and manually moved:"]}),"\n",(0,t.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}function F(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,n)=>{n.d(o,{Hx:()=>s});n(7294);var t=n(5893);function s(e){let{children:o,level:n}=e;return(0,t.jsx)(n,{children:o})}},292:(e,o,n)=>{n.d(o,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/c87b078f.bc782301.js b/assets/js/c87b078f.bc782301.js new file mode 100644 index 00000000..6a48b939 --- /dev/null +++ b/assets/js/c87b078f.bc782301.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8374],{6286:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>i,contentTitle:()=>p,default:()=>F,frontMatter:()=>r,metadata:()=>l,toc:()=>a});var t=n(5893),c=n(1151),s=(n(9960),n(9848));const r={title:"Hide dependencies from syncpack"},p=void 0,l={id:"examples/ignore-dependencies-in-syncpack",title:"Hide dependencies from syncpack",description:"",source:"@site/docs/examples/ignore-dependencies-in-syncpack.mdx",sourceDirName:"examples",slug:"/examples/ignore-dependencies-in-syncpack",permalink:"/syncpack/examples/ignore-dependencies-in-syncpack",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/ignore-dependencies-in-syncpack.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Hide dependencies from syncpack"},sidebar:"examples",previous:{title:"Fix React Native version mismatch",permalink:"/syncpack/examples/fix-react-native-version-mismatch"},next:{title:"Only allow @types packages in devDependencies",permalink:"/syncpack/examples/only-allow-types-in-dev-dependencies"}},i={},a=[];function d(e){return(0,t.jsx)(s.ZP,{level:"h2"})}function F(e={}){const{wrapper:o}={...(0,c.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d()}},9848:(e,o,n)=>{n.d(o,{ZP:()=>a});var t=n(5893),c=n(1151),s=n(9794),r=(n(9960),n(292),n(6217));const p={annotations:s.ds,Code:s.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,c.a)(),...e.components};return p||d("CH",!1),p.Code||d("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsx)("p",{children:"Ignore one or more dependencies so that syncpack does not inspect them."}),"\n",(0,t.jsx)(r.Hx,{level:e.level,children:"1. Add an ignored version group"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Match 2 specific ",(0,t.jsx)(o.strong,{children:"packages"})," in the repo."]}),"\n",(0,t.jsxs)(o.li,{children:["Match only the ",(0,t.jsx)(o.strong,{children:"peerDependencies"})," in those packages."]}),"\n",(0,t.jsxs)(o.li,{children:["Add a ",(0,t.jsx)(o.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,t.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Nothing to see here, will fix soon",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["With this configuration in place, syncpack will now completely ignore every dependency listed under ",(0,t.jsx)(o.code,{children:"peerDependencies"})," in the two named packages ",(0,t.jsx)(o.code,{children:"oops-moment"})," and ",(0,t.jsx)(o.code,{children:"workaround"})," only."]})]})}function a(e={}){const{wrapper:o}={...(0,c.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,n)=>{n.d(o,{Hx:()=>c});n(7294);var t=n(5893);function c(e){let{children:o,level:n}=e;return(0,t.jsx)(n,{children:o})}},292:(e,o,n)=>{n.d(o,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/c87b078f.d22e8017.js b/assets/js/c87b078f.d22e8017.js deleted file mode 100644 index fd92d286..00000000 --- a/assets/js/c87b078f.d22e8017.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8374],{6286:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>i,contentTitle:()=>p,default:()=>F,frontMatter:()=>r,metadata:()=>l,toc:()=>a});var t=n(5893),c=n(1151),s=(n(9960),n(9848));const r={title:"Hide dependencies from syncpack"},p=void 0,l={id:"examples/ignore-dependencies-in-syncpack",title:"Hide dependencies from syncpack",description:"",source:"@site/docs/examples/ignore-dependencies-in-syncpack.mdx",sourceDirName:"examples",slug:"/examples/ignore-dependencies-in-syncpack",permalink:"/syncpack/examples/ignore-dependencies-in-syncpack",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/ignore-dependencies-in-syncpack.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Hide dependencies from syncpack"},sidebar:"examples",previous:{title:"Fix React Native version mismatch",permalink:"/syncpack/examples/fix-react-native-version-mismatch"},next:{title:"Only allow @types packages in devDependencies",permalink:"/syncpack/examples/only-allow-types-in-dev-dependencies"}},i={},a=[];function d(e){return(0,t.jsx)(s.ZP,{level:"h2"})}function F(e={}){const{wrapper:o}={...(0,c.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d()}},9848:(e,o,n)=>{n.d(o,{ZP:()=>a});var t=n(5893),c=n(1151),s=n(9794),r=(n(9960),n(292),n(6217));const p={annotations:s.ds,Code:s.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,c.a)(),...e.components};return p||d("CH",!1),p.Code||d("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsx)("p",{children:"Ignore one or more dependencies so that syncpack does not inspect them."}),"\n",(0,t.jsx)(r.Hx,{level:e.level,children:"1. Add an ignored version group"}),"\n",(0,t.jsxs)(o.ul,{children:["\n",(0,t.jsxs)(o.li,{children:["Match 2 specific ",(0,t.jsx)(o.strong,{children:"packages"})," in the repo."]}),"\n",(0,t.jsxs)(o.li,{children:["Match only the ",(0,t.jsx)(o.strong,{children:"peerDependencies"})," in those packages."]}),"\n",(0,t.jsxs)(o.li,{children:["Add a ",(0,t.jsx)(o.strong,{children:"label"})," to document the decision/expectation."]}),"\n"]}),"\n",(0,t.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Nothing to see here, will fix soon",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"oops-moment",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workaround",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isIgnored",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsxs)(o.p,{children:["With this configuration in place, syncpack will now completely ignore every dependency listed under ",(0,t.jsx)(o.code,{children:"peerDependencies"})," in the two named packages ",(0,t.jsx)(o.code,{children:"oops-moment"})," and ",(0,t.jsx)(o.code,{children:"workaround"})," only."]})]})}function a(e={}){const{wrapper:o}={...(0,c.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,n)=>{n.d(o,{Hx:()=>c});n(7294);var t=n(5893);function c(e){let{children:o,level:n}=e;return(0,t.jsx)(n,{children:o})}},292:(e,o,n)=>{n.d(o,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/c8e40d44.d92491d0.js b/assets/js/c8e40d44.5c3d0a70.js similarity index 50% rename from assets/js/c8e40d44.d92491d0.js rename to assets/js/c8e40d44.5c3d0a70.js index e1c415c2..211d9eae 100644 --- a/assets/js/c8e40d44.d92491d0.js +++ b/assets/js/c8e40d44.5c3d0a70.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8714],{8437:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>n,metadata:()=>r,toc:()=>l});var a=s(5893),i=s(1151);const n={id:"sort-az",title:"sortAz"},o=void 0,r={id:"config/sort-az",title:"sortAz",description:"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 alphabetically. There is no equivalent CLI Option for this configuration.",source:"@site/docs/config/sort-az.mdx",sourceDirName:"config",slug:"/config/sort-az",permalink:"/syncpack/config/sort-az",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/sort-az.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"sort-az",title:"sortAz"},sidebar:"docs",previous:{title:"With Range",permalink:"/syncpack/config/semver-groups/with-range"},next:{title:"sortFirst",permalink:"/syncpack/config/sort-first"}},c={},l=[];function d(e){const t={code:"code",p:"p",...(0,i.a)(),...e.components};return(0,a.jsxs)(t.p,{children:["When using the ",(0,a.jsx)(t.code,{children:"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 alphabetically. There is no equivalent CLI Option for this configuration."]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[8714],{8437:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>n,metadata:()=>r,toc:()=>l});var a=s(5893),i=s(1151);const n={id:"sort-az",title:"sortAz"},o=void 0,r={id:"config/sort-az",title:"sortAz",description:"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 alphabetically. There is no equivalent CLI Option for this configuration.",source:"@site/docs/config/sort-az.mdx",sourceDirName:"config",slug:"/config/sort-az",permalink:"/syncpack/config/sort-az",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/sort-az.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"sort-az",title:"sortAz"},sidebar:"docs",previous:{title:"With Range",permalink:"/syncpack/config/semver-groups/with-range"},next:{title:"sortFirst",permalink:"/syncpack/config/sort-first"}},c={},l=[];function d(e){const t={code:"code",p:"p",...(0,i.a)(),...e.components};return(0,a.jsxs)(t.p,{children:["When using the ",(0,a.jsx)(t.code,{children:"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 alphabetically. There is no equivalent CLI Option for this configuration."]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/c901ad87.14ff5426.js b/assets/js/c901ad87.14ff5426.js new file mode 100644 index 00000000..eb644267 --- /dev/null +++ b/assets/js/c901ad87.14ff5426.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9210],{834:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),r=o(1151),c=o(8984),a=o(6085),i=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"update",title:"update"},l=void 0,p={id:"command/update",title:"update",description:"Interactively update packages to the latest versions from the npm registry.",source:"@site/docs/command/update.mdx",sourceDirName:"command",slug:"/command/update",permalink:"/syncpack/command/update",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/update.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"update",title:"update"},sidebar:"docs",previous:{title:"set-semver-ranges",permalink:"/syncpack/command/set-semver-ranges"},next:{title:".syncpackrc",permalink:"/syncpack/config/syncpackrc"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Interactively update packages to the latest versions from the npm registry."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(a.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(c.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(i.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"update"})]})}function b(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),a=o(9286),i=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(i.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(a.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),a=o(9286);const i={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return i||u("CH",!1),i.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),a=o(9286);o(9960);const i={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return i||u("CH",!1),i.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>i});var n=o(5893),r=o(1151),c=o(9286);function a(e){const t={p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function i(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),a=o(9286),i=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),a=o(9286),i=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/c901ad87.52a41696.js b/assets/js/c901ad87.52a41696.js deleted file mode 100644 index 26726207..00000000 --- a/assets/js/c901ad87.52a41696.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9210],{834:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),r=o(1151),c=o(8984),a=o(6085),i=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"update",title:"update"},l=void 0,p={id:"command/update",title:"update",description:"Interactively update packages to the latest versions from the npm registry.",source:"@site/docs/command/update.mdx",sourceDirName:"command",slug:"/command/update",permalink:"/syncpack/command/update",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/update.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"update",title:"update"},sidebar:"docs",previous:{title:"set-semver-ranges",permalink:"/syncpack/command/set-semver-ranges"},next:{title:".syncpackrc",permalink:"/syncpack/config/syncpackrc"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Interactively update packages to the latest versions from the npm registry."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(a.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(c.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(i.ZP,{command:"update"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"update"})]})}function b(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),a=o(9286),i=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(i.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(a.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),a=o(9286);const i={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return i||u("CH",!1),i.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),r=o(1151),c=o(9794),a=o(9286);o(9960);const i={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,r.a)(),...e.components};return i||u("CH",!1),i.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>i});var n=o(5893),r=o(1151),c=o(9286);function a(e){const t={p:"p",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function i(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),a=o(9286),i=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),r=o(1151),c=o(9794),a=o(9286),i=o(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(i.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(a.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/cde22a48.fdfc03ea.js b/assets/js/cde22a48.88b9eaf7.js similarity index 53% rename from assets/js/cde22a48.fdfc03ea.js rename to assets/js/cde22a48.88b9eaf7.js index 07b1f8dd..2fad5bdc 100644 --- a/assets/js/cde22a48.fdfc03ea.js +++ b/assets/js/cde22a48.88b9eaf7.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5535],{2521:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var a=n(5893),s=n(1151);const i={id:"lerna",title:"Lerna"},r=void 0,o={id:"integrations/lerna",title:"Lerna",description:"When using Lerna, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/lerna.mdx",sourceDirName:"integrations",slug:"/integrations/lerna",permalink:"/syncpack/integrations/lerna",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/lerna.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"lerna",title:"Lerna"},sidebar:"docs",previous:{title:"JSON Schema",permalink:"/syncpack/integrations/json-schema"},next:{title:"npm",permalink:"/syncpack/integrations/npm"}},c={},l=[];function p(e){const t={p:"p",...(0,s.a)(),...e.components};return(0,a.jsx)(t.p,{children:"When using Lerna, syncpack will use its configuration to discover where your package.json files are."})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5535],{2521:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var a=n(5893),s=n(1151);const i={id:"lerna",title:"Lerna"},r=void 0,o={id:"integrations/lerna",title:"Lerna",description:"When using Lerna, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/lerna.mdx",sourceDirName:"integrations",slug:"/integrations/lerna",permalink:"/syncpack/integrations/lerna",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/lerna.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"lerna",title:"Lerna"},sidebar:"docs",previous:{title:"JSON Schema",permalink:"/syncpack/integrations/json-schema"},next:{title:"npm",permalink:"/syncpack/integrations/npm"}},c={},l=[];function p(e){const t={p:"p",...(0,s.a)(),...e.components};return(0,a.jsx)(t.p,{children:"When using Lerna, syncpack will use its configuration to discover where your package.json files are."})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}}}]); \ No newline at end of file diff --git a/assets/js/d024088c.35d9fbd3.js b/assets/js/d024088c.35d9fbd3.js new file mode 100644 index 00000000..ea9fb959 --- /dev/null +++ b/assets/js/d024088c.35d9fbd3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9522],{4976:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>d,metadata:()=>h,toc:()=>u});var o=n(5893),r=n(1151),c=n(8984),i=n(2474),a=n(4086);const d={id:"lint",title:"lint"},s=void 0,h={id:"command/lint",title:"lint",description:"Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file.",source:"@site/docs/command/lint.mdx",sourceDirName:"command",slug:"/command/lint",permalink:"/syncpack/command/lint",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/lint.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"lint",title:"lint"},sidebar:"docs",previous:{title:"lint-semver-ranges",permalink:"/syncpack/command/lint-semver-ranges"},next:{title:"list-mismatches",permalink:"/syncpack/command/list-mismatches"}},l={},u=[{value:"CLI Options",id:"cli-options",level:2},{value:"config",id:"config",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function g(t){const e={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.p,{children:"Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file."}),"\n",(0,o.jsx)(e.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(e.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(c.ZP,{command:"lint"}),"\n",(0,o.jsx)(e.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(i.ZP,{command:"lint"}),"\n",(0,o.jsx)(e.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(a.ZP,{command:"lint"})]})}function p(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(g,{...t})}):g(t)}},8984:(t,e,n)=>{n.d(e,{ZP:()=>l});var o=n(5893),r=n(1151),c=n(9794),i=n(9286),a=n(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(t){const e={p:"p",...(0,r.a)(),...t.components};return d||u("CH",!1),d.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(e.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${t.command} --config ./config/.syncpackrc`})]})}function l(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(h,{...t})}):h(t)}function u(t,e){throw new Error("Expected "+(e?"component":"object")+" `"+t+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(t,e,n)=>{n.d(e,{ZP:()=>h});var o=n(5893),r=n(1151),c=n(9794),i=n(9286);n(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(t){const e={p:"p",...(0,r.a)(),...t.components};return a||l("CH",!1),a.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(e.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${t.command} --help\n`.trim()})]})}function h(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(s,{...t})}):s(t)}function l(t,e){throw new Error("Expected "+(e?"component":"object")+" `"+t+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(t,e,n)=>{n.d(e,{ZP:()=>a});var o=n(5893),r=n(1151),c=n(9286);function i(t){const e={p:"p",...(0,r.a)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${t.command}`})]})}function a(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(i,{...t})}):i(t)}}}]); \ No newline at end of file diff --git a/assets/js/d024088c.c050e4ee.js b/assets/js/d024088c.c050e4ee.js deleted file mode 100644 index c803f304..00000000 --- a/assets/js/d024088c.c050e4ee.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9522],{4976:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>d,metadata:()=>h,toc:()=>u});var o=n(5893),r=n(1151),c=n(8984),i=n(2474),a=n(4086);const d={id:"lint",title:"lint"},s=void 0,h={id:"command/lint",title:"lint",description:"Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file.",source:"@site/docs/command/lint.mdx",sourceDirName:"command",slug:"/command/lint",permalink:"/syncpack/command/lint",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/lint.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"lint",title:"lint"},sidebar:"docs",previous:{title:"lint-semver-ranges",permalink:"/syncpack/command/lint-semver-ranges"},next:{title:"list-mismatches",permalink:"/syncpack/command/list-mismatches"}},l={},u=[{value:"CLI Options",id:"cli-options",level:2},{value:"config",id:"config",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function g(t){const e={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.p,{children:"Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file."}),"\n",(0,o.jsx)(e.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(e.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(c.ZP,{command:"lint"}),"\n",(0,o.jsx)(e.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(i.ZP,{command:"lint"}),"\n",(0,o.jsx)(e.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(a.ZP,{command:"lint"})]})}function p(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(g,{...t})}):g(t)}},8984:(t,e,n)=>{n.d(e,{ZP:()=>l});var o=n(5893),r=n(1151),c=n(9794),i=n(9286),a=n(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(t){const e={p:"p",...(0,r.a)(),...t.components};return d||u("CH",!1),d.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(e.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${t.command} --config ./config/.syncpackrc`})]})}function l(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(h,{...t})}):h(t)}function u(t,e){throw new Error("Expected "+(e?"component":"object")+" `"+t+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(t,e,n)=>{n.d(e,{ZP:()=>h});var o=n(5893),r=n(1151),c=n(9794),i=n(9286);n(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(t){const e={p:"p",...(0,r.a)(),...t.components};return a||l("CH",!1),a.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(e.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${t.command} --help\n`.trim()})]})}function h(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(s,{...t})}):s(t)}function l(t,e){throw new Error("Expected "+(e?"component":"object")+" `"+t+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(t,e,n)=>{n.d(e,{ZP:()=>a});var o=n(5893),r=n(1151),c=n(9286);function i(t){const e={p:"p",...(0,r.a)(),...t.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${t.command}`})]})}function a(t={}){const{wrapper:e}={...(0,r.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(i,{...t})}):i(t)}}}]); \ No newline at end of file diff --git a/assets/js/d29174f6.2f74743b.js b/assets/js/d29174f6.2f74743b.js deleted file mode 100644 index c55f1d0a..00000000 --- a/assets/js/d29174f6.2f74743b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5914],{3558:(e,o,t)=>{t.r(o),t.d(o,{CH:()=>y,assets:()=>h,chCodeConfig:()=>u,contentTitle:()=>a,default:()=>E,frontMatter:()=>d,metadata:()=>F,toc:()=>g});var n=t(5893),s=t(1151),r=t(9794),c=t(9960),l=t(292),p=t(1341),i=t(4498);const d={id:"local-package-versions",title:"Local Package Versions"},a=void 0,F={id:"guide/local-package-versions",title:"Local Package Versions",description:"This is an addendum to the Getting Started guide.",source:"@site/docs/guide/local-package-versions.mdx",sourceDirName:"guide",slug:"/guide/local-package-versions",permalink:"/syncpack/guide/local-package-versions",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/local-package-versions.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"local-package-versions",title:"Local Package Versions"},sidebar:"docs",previous:{title:"Getting Started",permalink:"/syncpack/guide/getting-started"},next:{title:"Semver Groups",permalink:"/syncpack/guide/semver-groups"}},h={},y={annotations:r.ds,Code:r.EK},u={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},g=[{value:"Target Problem",id:"target-problem",level:2},{value:"The local dependency type",id:"the-local-dependency-type",level:2},{value:"Zero Configuration?",id:"zero-configuration",level:2},{value:"Possible Solutions",id:"possible-solutions",level:2}];function k(e){const o={code:"code",h2:"h2",li:"li",ol:"ol",p:"p",...(0,s.a)(),...e.components},{Details:t}=o;return y||j("CH",!1),y.Code||j("CH.Code",!0),t||j("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(o.p,{children:["This is an addendum to the ",(0,n.jsx)(c.Z,{to:"/guide/getting-started",children:"Getting Started"})," guide."]}),"\n",(0,n.jsx)(o.p,{children:"When some of the packages developed in your monorepo are installed as dependencies in other packages developed in your monorepo, syncpack can check that the versions used are valid and consistent."}),"\n",(0,n.jsx)(o.h2,{id:"target-problem",children:"Target Problem"}),"\n",(0,n.jsx)(o.p,{children:"A Node.js client to communicate with your HTTP API is developed in your repo:"}),"\n",(0,n.jsx)(y.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'"packages/node-client/package.json"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.2.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"As-is a front-end application which depends on it:"}),"\n",(0,n.jsx)(y.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'"apps/dashboard-ui/package.json"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.3.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.1.4",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.7.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"And a plugin which extends it:"}),"\n",(0,n.jsx)(y.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'"packages/node-client-plugin-retry/package.json"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.7.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workspace:*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^1.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"The Developers of this project:"}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsx)(o.li,{children:"Provide a Web Service which their customers interact with via their Node.js Client and various Plugins."}),"\n",(0,n.jsxs)(o.li,{children:["The Plugins are developed to be compatible with any version of the Node.js Client in the entire 1.x range, as defined in their ",(0,n.jsx)(o.code,{children:"peerDependencies"}),". Companies around the world depend on this Client and Plugin and there is no reason to impose that all of them must use the same exact version of the Client."]}),"\n",(0,n.jsxs)(o.li,{children:["Use the ",(0,n.jsxs)(c.Z,{to:l.K.workspaceProtocol,children:["pnpm ",(0,n.jsx)(o.code,{children:"workspace:*"})]})," protocol to ensure that the local workspace package of the Client is resolved when working locally on the Plugin."]}),"\n",(0,n.jsx)(o.li,{children:"Want exact versions of the Client and its Retry Plugin when running their Dashboard UI in production."}),"\n"]}),"\n",(0,n.jsxs)(o.h2,{id:"the-local-dependency-type",children:["The ",(0,n.jsx)(o.code,{children:"local"})," dependency type"]}),"\n",(0,n.jsxs)(o.p,{children:['The "local"'," ",(0,n.jsx)(c.Z,{to:"/config/dependency-types",children:(0,n.jsx)("code",{children:"dependencyType"})})," relates to the",(0,n.jsx)(c.Z,{to:l.K.version,children:(0,n.jsx)("code",{children:"version"})})," properties of the package.json files from your own packages being developed in your monorepo."]}),"\n",(0,n.jsxs)(o.p,{children:["When ",(0,n.jsx)(o.code,{children:"local"})," is enabled, syncpack can see that:"]}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsxs)(o.li,{children:["\u274c The UI is not using the latest client developed locally (",(0,n.jsx)(o.code,{children:"1.2.1"}),")."]}),"\n",(0,n.jsxs)(o.li,{children:["\u2705 The UI is using the latest plugin developed locally (",(0,n.jsx)(o.code,{children:"1.7.1"}),")."]}),"\n",(0,n.jsxs)(o.li,{children:["\u274c ",(0,n.jsx)(o.code,{children:"workspace:*"})," is not identical to ",(0,n.jsx)(o.code,{children:"1.2.1"})," (see below)."]}),"\n",(0,n.jsxs)(o.li,{children:["\u274c ",(0,n.jsx)(o.code,{children:"^1.0.0"})," is not identical to ",(0,n.jsx)(o.code,{children:"1.2.1"})," (see below)."]}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"zero-configuration",children:"Zero Configuration?"}),"\n",(0,n.jsx)(o.p,{children:"As a sensible default, syncpack defines a monorepo-wide exact version policy as a starting point which can be tuned from there. If your project uses exact versions everywhere, and you always want them to be identical, you will not need to define any configuration."}),"\n",(0,n.jsx)(o.p,{children:"But most projects are not like that, and we will need to use configuration for syncpack to know what our requirements are."}),"\n",(0,n.jsx)(o.h2,{id:"possible-solutions",children:"Possible Solutions"}),"\n",(0,n.jsxs)(o.p,{children:["Let's look at ",(0,n.jsx)(o.code,{children:"workspace:*"})," under ",(0,n.jsx)(o.code,{children:"devDependencies"})," first and decide on a rule for that:"]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsxs)(o.p,{children:["Option 1: Pin local versions to ",(0,n.jsx)("code",{children:"workspace:*"})]})}),(0,n.jsx)(p.ZP,{level:"h3"})]}),"\n",(0,n.jsxs)(o.p,{children:["The fix for the Peer Dependency of ",(0,n.jsx)("code",{children:"^1.0.0"})," can also be used to fix the use of ",(0,n.jsx)("code",{children:"workspace:*"}),". Since the current version of ",(0,n.jsx)("code",{children:"1.2.1"})," of the Client is satisfied by both of these ranges, a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," can be used."]}),"\n",(0,n.jsxs)(o.p,{children:["The versions will be considered a match unless eg. ",(0,n.jsx)(o.code,{children:"2.0.0"})," of the Client is released, or one of its dependents uses a range which does not include its current version."]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Option 2: Check that a dependency's semver ranges always match"}),(0,n.jsx)(i.ZP,{level:"h3"})]})]})}function E(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(k,{...e})}):k(e)}function j(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},1341:(e,o,t)=>{t.d(o,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/pinned",children:"Pinned Version Group"})," so that local packages are always installed using ",(0,n.jsx)(o.code,{children:"workspace:*"})," when they are used in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"pinVersion"})," states that these dependencies must always use ",(0,n.jsx)(o.code,{children:"workspace:*"}),"."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Use workspace protocol when developing local packages",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workspace:*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function d(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}function a(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4498:(e,o,t)=>{t.d(o,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," which allows local packages installed in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"})," to use different semver ranges, as long as they all match the local package version."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"policy"})," of ",(0,n.jsx)(o.strong,{children:"sameRange"})," states that these dependencies are considered valid if every range matches the others."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure semver ranges for locally developed packages satisfy the local version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function d(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}function a(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/d29174f6.de6802af.js b/assets/js/d29174f6.de6802af.js new file mode 100644 index 00000000..b0817053 --- /dev/null +++ b/assets/js/d29174f6.de6802af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5914],{3558:(e,o,t)=>{t.r(o),t.d(o,{CH:()=>y,assets:()=>h,chCodeConfig:()=>u,contentTitle:()=>a,default:()=>E,frontMatter:()=>d,metadata:()=>F,toc:()=>g});var n=t(5893),s=t(1151),r=t(9794),c=t(9960),l=t(292),p=t(1341),i=t(4498);const d={id:"local-package-versions",title:"Local Package Versions"},a=void 0,F={id:"guide/local-package-versions",title:"Local Package Versions",description:"This is an addendum to the Getting Started guide.",source:"@site/docs/guide/local-package-versions.mdx",sourceDirName:"guide",slug:"/guide/local-package-versions",permalink:"/syncpack/guide/local-package-versions",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/guide/local-package-versions.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"local-package-versions",title:"Local Package Versions"},sidebar:"docs",previous:{title:"Getting Started",permalink:"/syncpack/guide/getting-started"},next:{title:"Semver Groups",permalink:"/syncpack/guide/semver-groups"}},h={},y={annotations:r.ds,Code:r.EK},u={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},g=[{value:"Target Problem",id:"target-problem",level:2},{value:"The local dependency type",id:"the-local-dependency-type",level:2},{value:"Zero Configuration?",id:"zero-configuration",level:2},{value:"Possible Solutions",id:"possible-solutions",level:2}];function k(e){const o={code:"code",h2:"h2",li:"li",ol:"ol",p:"p",...(0,s.a)(),...e.components},{Details:t}=o;return y||j("CH",!1),y.Code||j("CH.Code",!0),t||j("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(o.p,{children:["This is an addendum to the ",(0,n.jsx)(c.Z,{to:"/guide/getting-started",children:"Getting Started"})," guide."]}),"\n",(0,n.jsx)(o.p,{children:"When some of the packages developed in your monorepo are installed as dependencies in other packages developed in your monorepo, syncpack can check that the versions used are valid and consistent."}),"\n",(0,n.jsx)(o.h2,{id:"target-problem",children:"Target Problem"}),"\n",(0,n.jsx)(o.p,{children:"A Node.js client to communicate with your HTTP API is developed in your repo:"}),"\n",(0,n.jsx)(y.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'"packages/node-client/package.json"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.2.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"As-is a front-end application which depends on it:"}),"\n",(0,n.jsx)(y.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'"apps/dashboard-ui/package.json"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"0.3.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.1.4",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.7.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"And a plugin which extends it:"}),"\n",(0,n.jsx)(y.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'"packages/node-client-plugin-retry/package.json"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"name",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"version",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"1.7.1",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"devDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workspace:*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"peerDependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"@your-repo/node-client",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"^1.0.0",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(o.p,{children:"The Developers of this project:"}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsx)(o.li,{children:"Provide a Web Service which their customers interact with via their Node.js Client and various Plugins."}),"\n",(0,n.jsxs)(o.li,{children:["The Plugins are developed to be compatible with any version of the Node.js Client in the entire 1.x range, as defined in their ",(0,n.jsx)(o.code,{children:"peerDependencies"}),". Companies around the world depend on this Client and Plugin and there is no reason to impose that all of them must use the same exact version of the Client."]}),"\n",(0,n.jsxs)(o.li,{children:["Use the ",(0,n.jsxs)(c.Z,{to:l.K.workspaceProtocol,children:["pnpm ",(0,n.jsx)(o.code,{children:"workspace:*"})]})," protocol to ensure that the local workspace package of the Client is resolved when working locally on the Plugin."]}),"\n",(0,n.jsx)(o.li,{children:"Want exact versions of the Client and its Retry Plugin when running their Dashboard UI in production."}),"\n"]}),"\n",(0,n.jsxs)(o.h2,{id:"the-local-dependency-type",children:["The ",(0,n.jsx)(o.code,{children:"local"})," dependency type"]}),"\n",(0,n.jsxs)(o.p,{children:['The "local"'," ",(0,n.jsx)(c.Z,{to:"/config/dependency-types",children:(0,n.jsx)("code",{children:"dependencyType"})})," relates to the",(0,n.jsx)(c.Z,{to:l.K.version,children:(0,n.jsx)("code",{children:"version"})})," properties of the package.json files from your own packages being developed in your monorepo."]}),"\n",(0,n.jsxs)(o.p,{children:["When ",(0,n.jsx)(o.code,{children:"local"})," is enabled, syncpack can see that:"]}),"\n",(0,n.jsxs)(o.ol,{children:["\n",(0,n.jsxs)(o.li,{children:["\u274c The UI is not using the latest client developed locally (",(0,n.jsx)(o.code,{children:"1.2.1"}),")."]}),"\n",(0,n.jsxs)(o.li,{children:["\u2705 The UI is using the latest plugin developed locally (",(0,n.jsx)(o.code,{children:"1.7.1"}),")."]}),"\n",(0,n.jsxs)(o.li,{children:["\u274c ",(0,n.jsx)(o.code,{children:"workspace:*"})," is not identical to ",(0,n.jsx)(o.code,{children:"1.2.1"})," (see below)."]}),"\n",(0,n.jsxs)(o.li,{children:["\u274c ",(0,n.jsx)(o.code,{children:"^1.0.0"})," is not identical to ",(0,n.jsx)(o.code,{children:"1.2.1"})," (see below)."]}),"\n"]}),"\n",(0,n.jsx)(o.h2,{id:"zero-configuration",children:"Zero Configuration?"}),"\n",(0,n.jsx)(o.p,{children:"As a sensible default, syncpack defines a monorepo-wide exact version policy as a starting point which can be tuned from there. If your project uses exact versions everywhere, and you always want them to be identical, you will not need to define any configuration."}),"\n",(0,n.jsx)(o.p,{children:"But most projects are not like that, and we will need to use configuration for syncpack to know what our requirements are."}),"\n",(0,n.jsx)(o.h2,{id:"possible-solutions",children:"Possible Solutions"}),"\n",(0,n.jsxs)(o.p,{children:["Let's look at ",(0,n.jsx)(o.code,{children:"workspace:*"})," under ",(0,n.jsx)(o.code,{children:"devDependencies"})," first and decide on a rule for that:"]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:(0,n.jsxs)(o.p,{children:["Option 1: Pin local versions to ",(0,n.jsx)("code",{children:"workspace:*"})]})}),(0,n.jsx)(p.ZP,{level:"h3"})]}),"\n",(0,n.jsxs)(o.p,{children:["The fix for the Peer Dependency of ",(0,n.jsx)("code",{children:"^1.0.0"})," can also be used to fix the use of ",(0,n.jsx)("code",{children:"workspace:*"}),". Since the current version of ",(0,n.jsx)("code",{children:"1.2.1"})," of the Client is satisfied by both of these ranges, a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," can be used."]}),"\n",(0,n.jsxs)(o.p,{children:["The versions will be considered a match unless eg. ",(0,n.jsx)(o.code,{children:"2.0.0"})," of the Client is released, or one of its dependents uses a range which does not include its current version."]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsx)("summary",{children:"Option 2: Check that a dependency's semver ranges always match"}),(0,n.jsx)(i.ZP,{level:"h3"})]})]})}function E(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(k,{...e})}):k(e)}function j(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},1341:(e,o,t)=>{t.d(o,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/pinned",children:"Pinned Version Group"})," so that local packages are always installed using ",(0,n.jsx)(o.code,{children:"workspace:*"})," when they are used in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"pinVersion"})," states that these dependencies must always use ",(0,n.jsx)(o.code,{children:"workspace:*"}),"."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Use workspace protocol when developing local packages",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"workspace:*",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function d(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}function a(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4498:(e,o,t)=>{t.d(o,{ZP:()=>d});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return l||a("CH",!1),l.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/same-range",children:"Same Range Version Group"})," which allows local packages installed in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"})," to use different semver ranges, as long as they all match the local package version."]}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:[(0,n.jsx)(o.strong,{children:"dependencyTypes"})," results in these dependencies only being targeted by this group when they are located in ",(0,n.jsx)(o.code,{children:"devDependencies"})," or ",(0,n.jsx)(o.code,{children:"peerDependencies"}),"."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"policy"})," of ",(0,n.jsx)(o.strong,{children:"sameRange"})," states that these dependencies are considered valid if every range matches the others."]}),"\n"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Ensure semver ranges for locally developed packages satisfy the local version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client-plugin-retry",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@your-repo/node-client",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dashboard-ui",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(o.admonition,{type:"tip",children:[(0,n.jsxs)(o.p,{children:["The above example can be shortened: The ",(0,n.jsx)(o.code,{children:"$LOCAL"})," keyword is a helper to avoid writing out the names of every local package."]}),(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'"dependencies": [',props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:'+ "$LOCAL"',props:{style:{color:"#50FA7B"}}}]},{tokens:[{content:'- "@your-repo/node-client-plugin-retry",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "@your-repo/node-client",',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:'- "dashboard-ui"',props:{style:{color:"#FF5555"}}}]},{tokens:[{content:"],",props:{style:{color:"#F8F8F2"}}}]}],lang:"diff"},annotations:[]}]})]})]})}function d(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}function a(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/dc016e2d.40cbb44b.js b/assets/js/dc016e2d.99b54cfe.js similarity index 51% rename from assets/js/dc016e2d.40cbb44b.js rename to assets/js/dc016e2d.99b54cfe.js index 9683ab1f..33293942 100644 --- a/assets/js/dc016e2d.40cbb44b.js +++ b/assets/js/dc016e2d.99b54cfe.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5635],{1205:(t,e,s)=>{s.r(e),s.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var a=s(5893),n=s(1151);const r={},o="Blog",i={permalink:"/syncpack/blog/index",editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/blog/index.md",source:"@site/blog/index.md",title:"Blog",description:"",date:"2023-11-06T19:50:01.000Z",formattedDate:"November 6, 2023",tags:[],hasTruncateMarker:!1,authors:[],frontMatter:{},unlisted:!1},c={authorsImageUrls:[]},l=[];function u(t){return(0,a.jsx)(a.Fragment,{})}function d(t={}){const{wrapper:e}={...(0,n.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u()}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[5635],{1205:(t,e,s)=>{s.r(e),s.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var a=s(5893),n=s(1151);const r={},o="Blog",i={permalink:"/syncpack/blog/index",editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/blog/index.md",source:"@site/blog/index.md",title:"Blog",description:"",date:"2023-11-10T15:49:57.000Z",formattedDate:"November 10, 2023",tags:[],hasTruncateMarker:!1,authors:[],frontMatter:{},unlisted:!1},c={authorsImageUrls:[]},l=[];function u(t){return(0,a.jsx)(a.Fragment,{})}function d(t={}){const{wrapper:e}={...(0,n.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u()}}}]); \ No newline at end of file diff --git a/assets/js/df68d44b.44edbb57.js b/assets/js/df68d44b.44edbb57.js new file mode 100644 index 00000000..7fcc829e --- /dev/null +++ b/assets/js/df68d44b.44edbb57.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4367],{9980:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>g,default:()=>f,frontMatter:()=>l,metadata:()=>p,toc:()=>F});var o=t(5893),r=t(1151),c=t(8984),i=t(6085),a=t(2474),d=t(7463),s=t(3107),h=t(2065),u=t(4086);const l={id:"lint-semver-ranges",title:"lint-semver-ranges"},g=void 0,p={id:"command/lint-semver-ranges",title:"lint-semver-ranges",description:'Check whether dependency versions used within "dependencies", "devDependencies" etc follow a consistent format.',source:"@site/docs/command/lint-semver-ranges.mdx",sourceDirName:"command",slug:"/command/lint-semver-ranges",permalink:"/syncpack/command/lint-semver-ranges",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/lint-semver-ranges.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"lint-semver-ranges",title:"lint-semver-ranges"},sidebar:"docs",previous:{title:"format",permalink:"/syncpack/command/format"},next:{title:"lint",permalink:"/syncpack/command/lint"}},m={},F=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function b(e){const n={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:'Check whether dependency versions used within "dependencies", "devDependencies" etc follow a consistent format.'}),"\n",(0,o.jsx)(n.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(n.h3,{id:"source",children:"source"}),"\n",(0,o.jsx)(s.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"filter",children:"filter"}),"\n",(0,o.jsx)(i.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(c.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"types",children:"types"}),"\n",(0,o.jsx)(h.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"indent",children:"indent"}),"\n",(0,o.jsx)(d.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(a.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(u.ZP,{command:"lint-semver-ranges"})]})}function f(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}},8984:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Only run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,o.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);t(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(n.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,n,t)=>{t.d(n,{ZP:()=>a});var o=t(5893),r=t(1151),c=t(9286);function i(e){const n={p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},3107:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Add quotes around your ",(0,o.jsx)(n.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,o.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/df68d44b.875f2b24.js b/assets/js/df68d44b.875f2b24.js deleted file mode 100644 index f0174922..00000000 --- a/assets/js/df68d44b.875f2b24.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4367],{9980:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>m,contentTitle:()=>g,default:()=>f,frontMatter:()=>l,metadata:()=>p,toc:()=>F});var o=t(5893),r=t(1151),c=t(8984),i=t(6085),a=t(2474),d=t(7463),s=t(3107),h=t(2065),u=t(4086);const l={id:"lint-semver-ranges",title:"lint-semver-ranges"},g=void 0,p={id:"command/lint-semver-ranges",title:"lint-semver-ranges",description:'Check whether dependency versions used within "dependencies", "devDependencies" etc follow a consistent format.',source:"@site/docs/command/lint-semver-ranges.mdx",sourceDirName:"command",slug:"/command/lint-semver-ranges",permalink:"/syncpack/command/lint-semver-ranges",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/lint-semver-ranges.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"lint-semver-ranges",title:"lint-semver-ranges"},sidebar:"docs",previous:{title:"format",permalink:"/syncpack/command/format"},next:{title:"lint",permalink:"/syncpack/command/lint"}},m={},F=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"indent",id:"indent",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function b(e){const n={h2:"h2",h3:"h3",p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:'Check whether dependency versions used within "dependencies", "devDependencies" etc follow a consistent format.'}),"\n",(0,o.jsx)(n.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,o.jsx)(n.h3,{id:"source",children:"source"}),"\n",(0,o.jsx)(s.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"filter",children:"filter"}),"\n",(0,o.jsx)(i.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,o.jsx)(c.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"types",children:"types"}),"\n",(0,o.jsx)(h.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"indent",children:"indent"}),"\n",(0,o.jsx)(d.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h3,{id:"help",children:"help"}),"\n",(0,o.jsx)(a.ZP,{command:"lint-semver-ranges"}),"\n",(0,o.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(u.ZP,{command:"lint-semver-ranges"})]})}function f(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(b,{...e})}):b(e)}},8984:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Syncpack uses ",(0,o.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,o.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Only run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,o.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,n,t)=>{t.d(n,{ZP:()=>h});var o=t(5893),r=t(1151),c=t(9794),i=t(9286);t(9960);const a={annotations:c.ds,Code:c.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const n={p:"p",...(0,r.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)(n.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}function u(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},7463:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-i, --indent [value]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/indent",children:"indent"})," configuration, which is 2 spaces by default."]}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# four spaces\nsyncpack ${e.command} --indent " "\n# one tab\nsyncpack ${e.command} --indent '\t'\n# \\t is converted into a tab\nsyncpack ${e.command} --indent '\\t'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,n,t)=>{t.d(n,{ZP:()=>a});var o=t(5893),r=t(1151),c=t(9286);function i(e){const n={p:"p",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,o.jsx)(c.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(i,{...e})}):i(e)}},3107:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={admonition:"admonition",code:"code",p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Add quotes around your ",(0,o.jsx)(n.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,n,t)=>{t.d(n,{ZP:()=>u});var o=t(5893),r=t(1151),c=t(9794),i=t(9286),a=t(9960);const d={annotations:c.ds,Code:c.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const n={p:"p",...(0,r.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,o.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,o.jsx)("p",{children:(0,o.jsxs)(n.p,{children:["Override your ",(0,o.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,o.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,o.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,o.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}function l(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/e0464cb3.06cfea97.js b/assets/js/e0464cb3.06cfea97.js new file mode 100644 index 00000000..bf846f31 --- /dev/null +++ b/assets/js/e0464cb3.06cfea97.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9066],{8931:(t,e,n)=>{n.r(e),n.d(e,{CH:()=>p,assets:()=>a,chCodeConfig:()=>l,contentTitle:()=>d,default:()=>g,frontMatter:()=>i,metadata:()=>s,toc:()=>h});var o=n(5893),c=n(1151),r=n(9794);const i={id:"indent",title:"indent"},d=void 0,s={id:"config/indent",title:"indent",description:"When syncpack writes to package.json files, determines which characters to indent the JSON with.",source:"@site/docs/config/indent.mdx",sourceDirName:"config",slug:"/config/indent",permalink:"/syncpack/config/indent",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/indent.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"indent",title:"indent"},sidebar:"docs",previous:{title:"dependencyTypes",permalink:"/syncpack/config/dependency-types"},next:{title:"Ignored",permalink:"/syncpack/config/semver-groups/ignored"}},a={},h=[],p={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function u(t){const e={p:"p",...(0,c.a)(),...t.components};return p||F("CH",!1),p.Code||F("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,o.jsx)(e.p,{children:"When syncpack writes to package.json files, determines which characters to indent the JSON with."}),"\n",(0,o.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"indent",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'" "',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function g(t={}){const{wrapper:e}={...(0,c.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(u,{...t})}):u(t)}function F(t,e){throw new Error("Expected "+(e?"component":"object")+" `"+t+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/e0464cb3.4305b157.js b/assets/js/e0464cb3.4305b157.js deleted file mode 100644 index 26795e12..00000000 --- a/assets/js/e0464cb3.4305b157.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[9066],{8931:(t,e,n)=>{n.r(e),n.d(e,{CH:()=>p,assets:()=>a,chCodeConfig:()=>l,contentTitle:()=>d,default:()=>g,frontMatter:()=>i,metadata:()=>s,toc:()=>h});var o=n(5893),c=n(1151),r=n(9794);const i={id:"indent",title:"indent"},d=void 0,s={id:"config/indent",title:"indent",description:"When syncpack writes to package.json files, determines which characters to indent the JSON with.",source:"@site/docs/config/indent.mdx",sourceDirName:"config",slug:"/config/indent",permalink:"/syncpack/config/indent",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/indent.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"indent",title:"indent"},sidebar:"docs",previous:{title:"dependencyTypes",permalink:"/syncpack/config/dependency-types"},next:{title:"Ignored",permalink:"/syncpack/config/semver-groups/ignored"}},a={},h=[],p={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function u(t){const e={p:"p",...(0,c.a)(),...t.components};return p||F("CH",!1),p.Code||F("CH.Code",!0),(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,o.jsx)(e.p,{children:"When syncpack writes to package.json files, determines which characters to indent the JSON with."}),"\n",(0,o.jsx)(p.Code,{codeConfig:l,northPanel:{tabs:[".syncpackrc"],active:".syncpackrc",heightRatio:1},files:[{name:".syncpackrc",focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"indent",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'" "',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function g(t={}){const{wrapper:e}={...(0,c.a)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(u,{...t})}):u(t)}function F(t,e){throw new Error("Expected "+(e?"component":"object")+" `"+t+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/ea90761c.1d83a569.js b/assets/js/ea90761c.1d83a569.js new file mode 100644 index 00000000..de533dcf --- /dev/null +++ b/assets/js/ea90761c.1d83a569.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4087],{6443:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>p,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var n=t(5893),s=t(1151),r=(t(9960),t(4192));const c={title:"Fix React Native version mismatch"},i=void 0,a={id:"examples/fix-react-native-version-mismatch",title:"Fix React Native version mismatch",description:"",source:"@site/docs/examples/fix-react-native-version-mismatch.mdx",sourceDirName:"examples",slug:"/examples/fix-react-native-version-mismatch",permalink:"/syncpack/examples/fix-react-native-version-mismatch",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/fix-react-native-version-mismatch.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Fix React Native version mismatch"},sidebar:"examples",previous:{title:"Ensure AWS SDK dependencies always have the same version",permalink:"/syncpack/examples/fix-aws-sdk-version-mismatch"},next:{title:"Hide dependencies from syncpack",permalink:"/syncpack/examples/ignore-dependencies-in-syncpack"}},p={},l=[];function d(e){return(0,n.jsx)(r.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},4192:(e,o,t)=>{t.d(o,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const i={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return i||d("CH",!1),i.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To Version Group"}),' which allows some of the packages in your monorepo to "follow" other packages in terms of which versions they should use.']}),"\n",(0,n.jsxs)(o.p,{children:["In this example we want our Mobile App package to be the single source of truth for what the versions of ",(0,n.jsx)(o.code,{children:"react"})," and ",(0,n.jsx)(o.code,{children:"react-native"})," should be. Every other package will be required to use the same version it does."]}),"\n",(0,n.jsx)(o.p,{children:"Here is the Version Group configuration to do it:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"snapTo"})," array lists the ",(0,n.jsx)(o.code,{children:"name"})," properties of the locally developed package.json files which should be searched for a version of ",(0,n.jsx)(o.code,{children:"react"})," or ",(0,n.jsx)(o.code,{children:"react-native"}),"."]}),"\n"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Always use the versions of react brought in by the Mobile App",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-app",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function l(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/ea90761c.ac2d81d9.js b/assets/js/ea90761c.ac2d81d9.js deleted file mode 100644 index 030cc47b..00000000 --- a/assets/js/ea90761c.ac2d81d9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4087],{6443:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>p,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var n=t(5893),s=t(1151),r=(t(9960),t(4192));const c={title:"Fix React Native version mismatch"},i=void 0,a={id:"examples/fix-react-native-version-mismatch",title:"Fix React Native version mismatch",description:"",source:"@site/docs/examples/fix-react-native-version-mismatch.mdx",sourceDirName:"examples",slug:"/examples/fix-react-native-version-mismatch",permalink:"/syncpack/examples/fix-react-native-version-mismatch",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/fix-react-native-version-mismatch.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Fix React Native version mismatch"},sidebar:"examples",previous:{title:"Ensure AWS SDK dependencies always have the same version",permalink:"/syncpack/examples/fix-aws-sdk-version-mismatch"},next:{title:"Hide dependencies from syncpack",permalink:"/syncpack/examples/ignore-dependencies-in-syncpack"}},p={},l=[];function d(e){return(0,n.jsx)(r.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d()}},4192:(e,o,t)=>{t.d(o,{ZP:()=>l});var n=t(5893),s=t(1151),r=t(9794),c=t(9960);t(292),t(6217);const i={annotations:r.ds,Code:r.EK},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(e){const o={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return i||d("CH",!1),i.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(o.p,{children:["Add a ",(0,n.jsx)(c.Z,{to:"/config/version-groups/snapped-to",children:"Snapped To Version Group"}),' which allows some of the packages in your monorepo to "follow" other packages in terms of which versions they should use.']}),"\n",(0,n.jsxs)(o.p,{children:["In this example we want our Mobile App package to be the single source of truth for what the versions of ",(0,n.jsx)(o.code,{children:"react"})," and ",(0,n.jsx)(o.code,{children:"react-native"})," should be. Every other package will be required to use the same version it does."]}),"\n",(0,n.jsx)(o.p,{children:"Here is the Version Group configuration to do it:"}),"\n",(0,n.jsxs)(o.ul,{children:["\n",(0,n.jsxs)(o.li,{children:["An optional ",(0,n.jsx)(o.strong,{children:"label"})," can be added to document the rule."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"dependencies"})," array defines the names of the dependencies we want to target."]}),"\n",(0,n.jsxs)(o.li,{children:["The ",(0,n.jsx)(o.strong,{children:"snapTo"})," array lists the ",(0,n.jsx)(o.code,{children:"name"})," properties of the locally developed package.json files which should be searched for a version of ",(0,n.jsx)(o.code,{children:"react"})," or ",(0,n.jsx)(o.code,{children:"react-native"}),"."]}),"\n"]}),"\n",(0,n.jsx)(i.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"label",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"Always use the versions of react brought in by the Mobile App",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"react-native",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"snapTo",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"mobile-app",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function l(e={}){const{wrapper:o}={...(0,s.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,t)=>{t.d(o,{Hx:()=>s});t(7294);var n=t(5893);function s(e){let{children:o,level:t}=e;return(0,n.jsx)(t,{children:o})}},292:(e,o,t)=>{t.d(o,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/f0862f9b.f8c32cad.js b/assets/js/f0862f9b.5cf6077c.js similarity index 53% rename from assets/js/f0862f9b.f8c32cad.js rename to assets/js/f0862f9b.5cf6077c.js index d5acf848..9a908137 100644 --- a/assets/js/f0862f9b.f8c32cad.js +++ b/assets/js/f0862f9b.5cf6077c.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3655],{4693:(t,n,e)=>{e.r(n),e.d(n,{assets:()=>o,contentTitle:()=>p,default:()=>m,frontMatter:()=>a,metadata:()=>r,toc:()=>c});var s=e(5893),i=e(1151);const a={id:"pnpm",title:"pnpm"},p=void 0,r={id:"integrations/pnpm",title:"pnpm",description:"When using Pnpm Workspaces, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/pnpm.mdx",sourceDirName:"integrations",slug:"/integrations/pnpm",permalink:"/syncpack/integrations/pnpm",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/pnpm.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"pnpm",title:"pnpm"},sidebar:"docs",previous:{title:"npm",permalink:"/syncpack/integrations/npm"},next:{title:"Yarn",permalink:"/syncpack/integrations/yarn"}},o={},c=[];function d(t){const n={p:"p",...(0,i.a)(),...t.components};return(0,s.jsx)(n.p,{children:"When using Pnpm Workspaces, syncpack will use its configuration to discover where your package.json files are."})}function m(t={}){const{wrapper:n}={...(0,i.a)(),...t.components};return n?(0,s.jsx)(n,{...t,children:(0,s.jsx)(d,{...t})}):d(t)}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[3655],{4693:(t,n,e)=>{e.r(n),e.d(n,{assets:()=>o,contentTitle:()=>p,default:()=>m,frontMatter:()=>a,metadata:()=>r,toc:()=>c});var s=e(5893),i=e(1151);const a={id:"pnpm",title:"pnpm"},p=void 0,r={id:"integrations/pnpm",title:"pnpm",description:"When using Pnpm Workspaces, syncpack will use its configuration to discover where your package.json files are.",source:"@site/docs/integrations/pnpm.mdx",sourceDirName:"integrations",slug:"/integrations/pnpm",permalink:"/syncpack/integrations/pnpm",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/integrations/pnpm.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"pnpm",title:"pnpm"},sidebar:"docs",previous:{title:"npm",permalink:"/syncpack/integrations/npm"},next:{title:"Yarn",permalink:"/syncpack/integrations/yarn"}},o={},c=[];function d(t){const n={p:"p",...(0,i.a)(),...t.components};return(0,s.jsx)(n.p,{children:"When using Pnpm Workspaces, syncpack will use its configuration to discover where your package.json files are."})}function m(t={}){const{wrapper:n}={...(0,i.a)(),...t.components};return n?(0,s.jsx)(n,{...t,children:(0,s.jsx)(d,{...t})}):d(t)}}}]); \ No newline at end of file diff --git a/assets/js/f7b7f548.1bc594b0.js b/assets/js/f7b7f548.1bc594b0.js deleted file mode 100644 index 91b602a8..00000000 --- a/assets/js/f7b7f548.1bc594b0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4835],{7929:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),c=o(1151),r=o(8984),i=o(6085),a=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"list-mismatches",title:"list-mismatches"},l=void 0,p={id:"command/list-mismatches",title:"list-mismatches",description:"List dependencies which are required by multiple packages, where the version is not the same across every package.",source:"@site/docs/command/list-mismatches.mdx",sourceDirName:"command",slug:"/command/list-mismatches",permalink:"/syncpack/command/list-mismatches",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/list-mismatches.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"list-mismatches",title:"list-mismatches"},sidebar:"docs",previous:{title:"lint",permalink:"/syncpack/command/lint"},next:{title:"list",permalink:"/syncpack/command/list"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"List dependencies which are required by multiple packages, where the version is not the same across every package."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(i.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(r.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"list-mismatches"})]})}function b(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);o(9960);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>a});var n=o(5893),c=o(1151),r=o(9286);function i(e){const t={p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(r.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/f7b7f548.a93112b5.js b/assets/js/f7b7f548.a93112b5.js new file mode 100644 index 00000000..63d48930 --- /dev/null +++ b/assets/js/f7b7f548.a93112b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[4835],{7929:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>b,frontMatter:()=>u,metadata:()=>p,toc:()=>m});var n=o(5893),c=o(1151),r=o(8984),i=o(6085),a=o(2474),d=o(3107),s=o(2065),h=o(4086);const u={id:"list-mismatches",title:"list-mismatches"},l=void 0,p={id:"command/list-mismatches",title:"list-mismatches",description:"List dependencies which are required by multiple packages, where the version is not the same across every package.",source:"@site/docs/command/list-mismatches.mdx",sourceDirName:"command",slug:"/command/list-mismatches",permalink:"/syncpack/command/list-mismatches",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/command/list-mismatches.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"list-mismatches",title:"list-mismatches"},sidebar:"docs",previous:{title:"lint",permalink:"/syncpack/command/lint"},next:{title:"list",permalink:"/syncpack/command/list"}},g={},m=[{value:"CLI Options",id:"cli-options",level:2},{value:"source",id:"source",level:3},{value:"filter",id:"filter",level:3},{value:"config",id:"config",level:3},{value:"types",id:"types",level:3},{value:"help",id:"help",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2}];function F(e){const t={h2:"h2",h3:"h3",p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"List dependencies which are required by multiple packages, where the version is not the same across every package."}),"\n",(0,n.jsx)(t.h2,{id:"cli-options",children:"CLI Options"}),"\n",(0,n.jsx)(t.h3,{id:"source",children:"source"}),"\n",(0,n.jsx)(d.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"filter",children:"filter"}),"\n",(0,n.jsx)(i.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,n.jsx)(r.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"types",children:"types"}),"\n",(0,n.jsx)(s.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h3,{id:"help",children:"help"}),"\n",(0,n.jsx)(a.ZP,{command:"list-mismatches"}),"\n",(0,n.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,n.jsx)(h.ZP,{command:"list-mismatches"})]})}function b(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(F,{...e})}):F(e)}},8984:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(t.p,{children:["Syncpack uses ",(0,n.jsx)(a.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(i.Z,{children:`syncpack ${e.command} --config ./config/.syncpackrc`})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6085:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-f, --filter [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Only run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on dependencies whose names match the given string, which will be passed to ",(0,n.jsx)("code",{children:"new RegExp()"}),"."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include react, react-dom, preact etc\nsyncpack ${e.command} --types 'react'\n# only include typescript or eslint packages\nsyncpack ${e.command} --types 'typescript|eslint'\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2474:(e,t,o)=>{o.d(t,{ZP:()=>h});var n=o(5893),c=o(1151),r=o(9794),i=o(9286);o(9960);const a={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function s(e){const t={p:"p",...(0,c.a)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(a.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-h, --help",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)(t.p,{children:"Display a list of CLI options and other help information."}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`syncpack ${e.command} --help\n`.trim()})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(s,{...e})}):s(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},4086:(e,t,o)=>{o.d(t,{ZP:()=>a});var n=o(5893),c=o(1151),r=o(9286);function i(e){const t={p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Verbose logging can be enabled by prefixing syncpack with the following environment variable:"}),"\n",(0,n.jsx)(r.Z,{language:"bash",children:`SYNCPACK_VERBOSE=true syncpack ${e.command}`})]})}function a(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(i,{...e})}):i(e)}},3107:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={admonition:"admonition",code:"code",p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-s, --source [pattern]",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/source",children:"source"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only some package.json files."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only the root package\nsyncpack ${e.command} --source 'package.json'\n# only packages matching a glob\nsyncpack ${e.command} --source 'packages/beta-*'\n# multiple values can be provided\nsyncpack ${e.command} --source 'package.json' --source 'packages/beta-*'\n`.trim()}),"\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsxs)(t.p,{children:["Add quotes around your ",(0,n.jsx)(t.code,{children:"--source"})," patterns so your shell does not interpret them before they're received by syncpack."]})})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},2065:(e,t,o)=>{o.d(t,{ZP:()=>u});var n=o(5893),c=o(1151),r=o(9794),i=o(9286),a=o(9960);const d={annotations:r.ds,Code:r.EK},s={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function h(e){const t={p:"p",...(0,c.a)(),...e.components};return d||l("CH",!1),d.Code||l("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(d.Code,{codeConfig:s,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-t, --types ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsx)("p",{children:(0,n.jsxs)(t.p,{children:["Override your ",(0,n.jsx)(a.Z,{to:"/config/dependency-types",children:"dependencyTypes"})," configuration to run ",(0,n.jsxs)("code",{children:["syncpack ",e.command]})," on only eg. ",(0,n.jsx)("code",{children:"peerDependencies"})," in every package in your monorepo."]})}),"\n",(0,n.jsx)(i.Z,{language:"bash",children:`# only include peerDependencies\nsyncpack ${e.command} --types 'peer'\n# only include dependencies and devDependencies\nsyncpack ${e.command} --types 'prod,dev'\n# exclude local package.json versions\nsyncpack ${e.command} --types '!local'\n`.trim()})]})}function u(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}function l(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/fc9a440c.267fbcdc.js b/assets/js/fc9a440c.dbbded60.js similarity index 83% rename from assets/js/fc9a440c.267fbcdc.js rename to assets/js/fc9a440c.dbbded60.js index 21234a80..9a148bee 100644 --- a/assets/js/fc9a440c.267fbcdc.js +++ b/assets/js/fc9a440c.dbbded60.js @@ -1 +1 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6594],{794:(o,e,t)=>{t.r(e),t.d(e,{assets:()=>m,contentTitle:()=>y,default:()=>E,frontMatter:()=>g,metadata:()=>h,toc:()=>u});var n=t(5893),r=t(1151),s=t(9960),c=t(9794),p=t(292);const a={annotations:c.ds,Code:c.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={p:"p",...(0,r.a)(),...o.components};return a||F("CH",!1),a.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)("p",{children:(0,n.jsxs)(e.p,{children:["Add support for managing versions in ",(0,n.jsx)(s.Z,{to:p.K.engines,children:"engines"})," and ",(0,n.jsx)(s.Z,{to:p.K.packageManager,children:"packageManager"})," properties of your package.json files."]})}),"\n",(0,n.jsx)(a.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"engines",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"versionsByName",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packageManager",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packageManager",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"name@version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function F(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}const g={title:"Manage monorepo packageManager version"},y=void 0,h={id:"examples/sync-package-manager-version",title:"Manage monorepo packageManager version",description:"",source:"@site/docs/examples/sync-package-manager-version.mdx",sourceDirName:"examples",slug:"/examples/sync-package-manager-version",permalink:"/syncpack/examples/sync-package-manager-version",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/sync-package-manager-version.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Manage monorepo packageManager version"},sidebar:"examples",previous:{title:"Synchronise Node.js version in monorepo",permalink:"/syncpack/examples/sync-nodejs-version-in-monorepo"}},m={},u=[];function k(o){return(0,n.jsx)(d,{level:"h2"})}function E(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(k,{...o})}):k()}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6594],{794:(o,e,t)=>{t.r(e),t.d(e,{assets:()=>m,contentTitle:()=>y,default:()=>E,frontMatter:()=>g,metadata:()=>h,toc:()=>u});var n=t(5893),r=t(1151),s=t(9960),c=t(9794),p=t(292);const a={annotations:c.ds,Code:c.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={p:"p",...(0,r.a)(),...o.components};return a||F("CH",!1),a.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)("p",{children:(0,n.jsxs)(e.p,{children:["Add support for managing versions in ",(0,n.jsx)(s.Z,{to:p.K.engines,children:"engines"})," and ",(0,n.jsx)(s.Z,{to:p.K.packageManager,children:"packageManager"})," properties of your package.json files."]})}),"\n",(0,n.jsx)(a.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"engines",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"versionsByName",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packageManager",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"packageManager",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"name@version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function d(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function F(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}const g={title:"Manage monorepo packageManager version"},y=void 0,h={id:"examples/sync-package-manager-version",title:"Manage monorepo packageManager version",description:"",source:"@site/docs/examples/sync-package-manager-version.mdx",sourceDirName:"examples",slug:"/examples/sync-package-manager-version",permalink:"/syncpack/examples/sync-package-manager-version",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/sync-package-manager-version.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Manage monorepo packageManager version"},sidebar:"examples",previous:{title:"Synchronise Node.js version in monorepo",permalink:"/syncpack/examples/sync-nodejs-version-in-monorepo"}},m={},u=[];function k(o){return(0,n.jsx)(d,{level:"h2"})}function E(o={}){const{wrapper:e}={...(0,r.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(k,{...o})}):k()}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/fce71488.5156b15f.js b/assets/js/fce71488.5156b15f.js deleted file mode 100644 index 3355823a..00000000 --- a/assets/js/fce71488.5156b15f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6283],{4902:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>a,assets:()=>F,chCodeConfig:()=>h,contentTitle:()=>i,default:()=>g,frontMatter:()=>p,metadata:()=>d,toc:()=>y});var n=t(5893),c=t(1151),r=t(9794),s=(t(292),t(8984),t(1700)),l=(t(9605),t(4284),t(9960));t(4383),t(7029);const p={id:"dependency-types",title:"dependencyTypes"},i=void 0,d={id:"config/dependency-types",title:"dependencyTypes",description:"Areas where versions are usually defined can be toggled on and off via this property.",source:"@site/docs/config/dependency-types.mdx",sourceDirName:"config",slug:"/config/dependency-types",permalink:"/syncpack/config/dependency-types",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/dependency-types.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{id:"dependency-types",title:"dependencyTypes"},sidebar:"docs",previous:{title:"customTypes",permalink:"/syncpack/config/custom-types"},next:{title:"indent",permalink:"/syncpack/config/indent"}},F={},a={annotations:r.ds,Code:r.EK},h={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},y=[{value:"Default dependency types",id:"default-dependency-types",level:2}];function u(o){const e={admonition:"admonition",code:"code",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...o.components},{Details:t}=e;return a||k("CH",!1),a.Code||k("CH.Code",!0),t||k("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Areas where versions are usually defined can be toggled on and off via this property."}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsxs)("summary",{children:["Example: Only include ",(0,n.jsx)("code",{children:"dependencies"})," and ",(0,n.jsx)("code",{children:"devDependencies"})]}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Only"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," will be inspected:"]}),(0,n.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsxs)("summary",{children:["Example: Exclude ",(0,n.jsx)("code",{children:"dependencies"})," and ",(0,n.jsx)("code",{children:"devDependencies"})]}),(0,n.jsxs)(e.p,{children:["Everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," will be inspected:"]}),(0,n.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]}),"\n",(0,n.jsx)(e.h2,{id:"default-dependency-types",children:"Default dependency types"}),"\n",(0,n.jsx)(e.p,{children:"All are enabled by default."}),"\n",(0,n.jsx)(s.ZP,{}),"\n",(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)(e.p,{children:["Learn more about the ",(0,n.jsxs)(l.Z,{to:"/guide/local-package-versions",children:[(0,n.jsx)(e.code,{children:"local"})," dependency type"]}),"."]})})]})}function g(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(u,{...o})}):u(o)}function k(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>s});var n=t(5893),c=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function s(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},9605:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),c=t(1151),r=t(9794),s=t(9960);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,c.a)(),...o.components};return l||F("CH",!1),l.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(e.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(s.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(e.admonition,{type:"note",children:(0,n.jsxs)(e.p,{children:["Ensure that ",(0,n.jsx)(e.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(e.strong,{children:"not"})," set in ",(0,n.jsx)(e.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function d(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function F(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4284:(o,e,t)=>{t.d(e,{ZP:()=>i});var n=t(5893),c=t(1151),r=t(9794);const s={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const e={p:"p",...(0,c.a)(),...o.components};return s||d("CH",!1),s.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(e.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(s.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function i(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4383:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),c=t(1151),r=t(9794),s=t(9960),l=t(292),p=t(6217);const i={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const e={code:"code",p:"p",...(0,c.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Ensure ",(0,n.jsx)(s.Z,{to:l.K.engines,children:(0,n.jsx)(e.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(e.p,{children:["I've chosen a name of ",(0,n.jsx)(e.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Perform a one-off check for every usage of ",(0,n.jsx)(e.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(e.p,{children:["Add your new custom type to your ",(0,n.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Now when you run any syncpack command, ",(0,n.jsx)(e.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(s.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},8984:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),c=t(1151),r=t(9794),s=t(9286),l=t(9960);const p={annotations:r.ds,Code:r.EK},i={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(o){const e={p:"p",...(0,c.a)(),...o.components};return p||a("CH",!1),p.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(p.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Syncpack uses ",(0,n.jsx)(l.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(s.Z,{children:`syncpack ${o.command} --config ./config/.syncpackrc`})]})}function F(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>c});t(7294);var n=t(5893);function c(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var c=t(5893);function r(o){let{required:e,optional:t}=o;return(0,c.jsxs)("p",{children:[e&&(0,c.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,c.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/fce71488.dd397375.js b/assets/js/fce71488.dd397375.js new file mode 100644 index 00000000..99664ce4 --- /dev/null +++ b/assets/js/fce71488.dd397375.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6283],{4902:(o,e,t)=>{t.r(e),t.d(e,{CH:()=>a,assets:()=>F,chCodeConfig:()=>h,contentTitle:()=>i,default:()=>g,frontMatter:()=>p,metadata:()=>d,toc:()=>y});var n=t(5893),c=t(1151),r=t(9794),s=(t(292),t(8984),t(1700)),l=(t(9605),t(4284),t(9960));t(4383),t(7029);const p={id:"dependency-types",title:"dependencyTypes"},i=void 0,d={id:"config/dependency-types",title:"dependencyTypes",description:"Areas where versions are usually defined can be toggled on and off via this property.",source:"@site/docs/config/dependency-types.mdx",sourceDirName:"config",slug:"/config/dependency-types",permalink:"/syncpack/config/dependency-types",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/config/dependency-types.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{id:"dependency-types",title:"dependencyTypes"},sidebar:"docs",previous:{title:"customTypes",permalink:"/syncpack/config/custom-types"},next:{title:"indent",permalink:"/syncpack/config/indent"}},F={},a={annotations:r.ds,Code:r.EK},h={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"},y=[{value:"Default dependency types",id:"default-dependency-types",level:2}];function u(o){const e={admonition:"admonition",code:"code",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...o.components},{Details:t}=e;return a||k("CH",!1),a.Code||k("CH.Code",!0),t||k("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(e.p,{children:"Areas where versions are usually defined can be toggled on and off via this property."}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsxs)("summary",{children:["Example: Only include ",(0,n.jsx)("code",{children:"dependencies"})," and ",(0,n.jsx)("code",{children:"devDependencies"})]}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Only"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," will be inspected:"]}),(0,n.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]}),"\n",(0,n.jsxs)(t,{children:[(0,n.jsxs)("summary",{children:["Example: Exclude ",(0,n.jsx)("code",{children:"dependencies"})," and ",(0,n.jsx)("code",{children:"devDependencies"})]}),(0,n.jsxs)(e.p,{children:["Everything ",(0,n.jsx)(e.strong,{children:"except"})," ",(0,n.jsx)(e.code,{children:"dependencies"})," and ",(0,n.jsx)(e.code,{children:"devDependencies"})," will be inspected:"]}),(0,n.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:", ",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"!prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]}),"\n",(0,n.jsx)(e.h2,{id:"default-dependency-types",children:"Default dependency types"}),"\n",(0,n.jsx)(e.p,{children:"All are enabled by default."}),"\n",(0,n.jsx)(s.ZP,{}),"\n",(0,n.jsx)(e.admonition,{type:"tip",children:(0,n.jsxs)(e.p,{children:["Learn more about the ",(0,n.jsxs)(l.Z,{to:"/guide/local-package-versions",children:[(0,n.jsx)(e.code,{children:"local"})," dependency type"]}),"."]})})]})}function g(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(u,{...o})}):u(o)}function k(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},1700:(o,e,t)=>{t.d(e,{ZP:()=>s});var n=t(5893),c=t(1151);function r(o){const e={a:"a",code:"code",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.a)(),...o.components};return(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Value"}),(0,n.jsx)(e.th,{style:{textAlign:"left"},children:"Property in package.json"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"dev"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",children:(0,n.jsx)(e.code,{children:"devDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"local"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",children:(0,n.jsx)(e.code,{children:"version"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"overrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides",children:(0,n.jsx)(e.code,{children:"overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"peer"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#peerDependencies",children:(0,n.jsx)(e.code,{children:"peerDependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"pnpmOverrides"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://pnpm.io/package_json#pnpmoverrides",children:(0,n.jsx)(e.code,{children:"pnpm.overrides"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"prod"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",children:(0,n.jsx)(e.code,{children:"dependencies"})})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.code,{children:"resolutions"})}),(0,n.jsx)(e.td,{style:{textAlign:"left"},children:(0,n.jsx)(e.a,{href:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#resolutions",children:(0,n.jsx)(e.code,{children:"resolutions"})})})]})]})]})}function s(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(r,{...o})}):r(o)}},9605:(o,e,t)=>{t.d(e,{ZP:()=>d});var n=t(5893),c=t(1151),r=t(9794),s=t(9960);const l={annotations:r.ds,Code:r.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(o){const e={a:"a",admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,c.a)(),...o.components};return l||F("CH",!1),l.Code||F("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsxs)(e.p,{children:["To enable validation and autocompletion for your ",(0,n.jsx)(s.Z,{to:"/config/syncpackrc",children:"configuration file"}),", you must use a JavaScript config file and annotate in keeping with the below example:"]}),"\n",(0,n.jsx)(l.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc.js"',focus:"",code:{lines:[{tokens:[{content:"// @ts-check",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"/** ",props:{style:{color:"#6272A4"}}},{content:"@type ",props:{style:{color:"#FF79C6"}}},{content:'{import("syncpack").RcFile}',props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:" */",props:{style:{color:"#6272A4"}}}]},{tokens:[{content:"const",props:{style:{color:"#FF79C6"}}},{content:" config ",props:{style:{color:"#F8F8F2"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" versionGroups",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" dependencies",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" packages",props:{style:{color:"#F8F8F2"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" pinVersion",props:{style:{color:"#F8F8F2"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:"'",props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"};",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"module",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:".",props:{style:{color:"#F8F8F2"}}},{content:"exports ",props:{style:{color:"#8BE9FD",fontStyle:"italic"}}},{content:"=",props:{style:{color:"#FF79C6"}}},{content:" config;",props:{style:{color:"#F8F8F2"}}}]}],lang:"js"},annotations:[]}]}),"\n",(0,n.jsx)(e.admonition,{type:"note",children:(0,n.jsxs)(e.p,{children:["Ensure that ",(0,n.jsx)(e.code,{children:'"javascript.validate.enable": false'})," is ",(0,n.jsx)(e.strong,{children:"not"})," set in ",(0,n.jsx)(e.a,{href:"https://code.visualstudio.com/docs/getstarted/settings",children:"VS Code"}),"."]})})]})}function d(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(i,{...o})}):i(o)}function F(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4284:(o,e,t)=>{t.d(e,{ZP:()=>i});var n=t(5893),c=t(1151),r=t(9794);const s={annotations:r.ds,Code:r.EK},l={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function p(o){const e={p:"p",...(0,c.a)(),...o.components};return s||d("CH",!1),s.Code||d("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n",(0,n.jsx)(e.p,{children:"From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being."}),"\n",(0,n.jsx)(s.Code,{codeConfig:l,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"$schema",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"https://unpkg.com/syncpack@11.2.1/dist/schema.json",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"@types/node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"14.18.36",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" },",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"chalk",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"packages",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"**",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"pinVersion",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"4.1.2",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function i(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(p,{...o})}):p(o)}function d(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},4383:(o,e,t)=>{t.d(e,{ZP:()=>a});var n=t(5893),c=t(1151),r=t(9794),s=t(9960),l=t(292),p=t(6217);const i={annotations:r.ds,Code:r.EK},d={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function F(o){const e={code:"code",p:"p",...(0,c.a)(),...o.components};return i||h("CH",!1),i.Code||h("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,n.jsxs)(e.p,{children:["Ensure ",(0,n.jsx)(s.Z,{to:l.K.engines,children:(0,n.jsx)(e.code,{children:"engines.node"})})," version is identical in every package."]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"1. Add a custom type"}),"\n",(0,n.jsxs)(e.p,{children:["I've chosen a name of ",(0,n.jsx)(e.code,{children:"nodeEngine"})," but it can be anything you like."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"customTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"nodeEngine",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"path",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"engines.node",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:",",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"strategy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"version",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"2. Look for mismatches"}),"\n",(0,n.jsxs)(e.p,{children:["Perform a one-off check for every usage of ",(0,n.jsx)(e.code,{children:"engines.node"})," in your monorepo."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(e.p,{children:"If the versions are not identical, they can be synchronised to all use the highest of the semver versions currently in use."}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches ",props:{style:{color:"#F1FA8C"}}},{content:"--types ",props:{style:{color:"#BD93F9"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"3. Track them in future"}),"\n",(0,n.jsxs)(e.p,{children:["Add your new custom type to your ",(0,n.jsx)(e.code,{children:"dependencyTypes"}),"."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Now when you run any syncpack command, ",(0,n.jsx)(e.code,{children:"engines.node"})," will also be checked."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,n.jsx)(p.Hx,{level:o.level,children:"4. Relax the rules (optional)"}),"\n",(0,n.jsxs)(e.p,{children:["If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a ",(0,n.jsx)(s.Z,{to:"/config/version-groups/same-range",children:"Same Range"})," Version Group."]}),"\n",(0,n.jsx)(i.Code,{codeConfig:d,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"dev",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"peer",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:' "',props:{style:{color:"#E9F284"}}},{content:"prod",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" ],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencyTypes",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"nodeEngine",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"policy",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"sameRange",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]})]})}function a(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(F,{...o})}):F(o)}function h(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},8984:(o,e,t)=>{t.d(e,{ZP:()=>F});var n=t(5893),c=t(1151),r=t(9794),s=t(9286),l=t(9960);const p={annotations:r.ds,Code:r.EK},i={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function d(o){const e={p:"p",...(0,c.a)(),...o.components};return p||a("CH",!1),p.Code||a("CH.Code",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n",(0,n.jsx)(p.Code,{codeConfig:i,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"-c, --config ",props:{}}]}],lang:"text"},annotations:[]}]}),"\n",(0,n.jsxs)(e.p,{children:["Syncpack uses ",(0,n.jsx)(l.Z,{to:"https://github.com/cosmiconfig/cosmiconfig",children:"cosmiconfig"})," to discover your config file, but a custom location can be provided instead."]}),"\n",(0,n.jsx)(s.Z,{children:`syncpack ${o.command} --config ./config/.syncpackrc`})]})}function F(o={}){const{wrapper:e}={...(0,c.a)(),...o.components};return e?(0,n.jsx)(e,{...o,children:(0,n.jsx)(d,{...o})}):d(o)}function a(o,e){throw new Error("Expected "+(e?"component":"object")+" `"+o+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(o,e,t)=>{t.d(e,{Hx:()=>c});t(7294);var n=t(5893);function c(o){let{children:e,level:t}=o;return(0,n.jsx)(t,{children:e})}},7029:(o,e,t)=>{t.d(e,{Z:()=>r});t(7294);const n={pill:"pill_lx6J",gray:"gray_oDNb",red:"red_TkSj",yellow:"yellow_uZjQ",green:"green_VuIk",blue:"blue_niGL",indigo:"indigo_t1co",purple:"purple_wWQZ",pink:"pink_hjd3"};var c=t(5893);function r(o){let{required:e,optional:t}=o;return(0,c.jsxs)("p",{children:[e&&(0,c.jsx)("span",{className:`${n.pill} ${n.red}`,children:"Required"}),t&&(0,c.jsx)("span",{className:`${n.pill} ${n.gray}`,children:"Optional"})]})}},292:(o,e,t)=>{t.d(e,{K:()=>n});const n={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/ff78ae8b.049fb9f2.js b/assets/js/ff78ae8b.049fb9f2.js new file mode 100644 index 00000000..f5127a68 --- /dev/null +++ b/assets/js/ff78ae8b.049fb9f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6372],{2478:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>i,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>p,toc:()=>l});var t=n(5893),r=n(1151),c=(n(9960),n(5739));const s={title:"Ban dependency from monorepo"},a=void 0,p={id:"examples/ban-dependency-from-monorepo",title:"Ban dependency from monorepo",description:"",source:"@site/docs/examples/ban-dependency-from-monorepo.mdx",sourceDirName:"examples",slug:"/examples/ban-dependency-from-monorepo",permalink:"/syncpack/examples/ban-dependency-from-monorepo",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/ban-dependency-from-monorepo.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699631397,formattedLastUpdatedAt:"Nov 10, 2023",frontMatter:{title:"Ban dependency from monorepo"},sidebar:"examples",previous:{title:"Examples",permalink:"/syncpack/examples"},next:{title:"Ensure that semver ranges for a dependency all match each other",permalink:"/syncpack/examples/ensure-versions-satisfy-same-range"}},i={},l=[];function d(e){return(0,t.jsx)(c.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d()}},5739:(e,o,n)=>{n.d(o,{ZP:()=>l});var t=n(5893),r=n(1151),c=n(9794),s=(n(9960),n(292),n(6217));const a={annotations:c.ds,Code:c.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={p:"p",...(0,r.a)(),...e.components};return a||d("CH",!1),a.Code||d("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsx)(o.p,{children:"Ban a dependency from being used anywhere in your monorepo."}),"\n",(0,t.jsx)(s.Hx,{level:e.level,children:"1. Add a version group"}),"\n",(0,t.jsx)(a.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"never-gonna",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(s.Hx,{level:e.level,children:"2. Look for mismatches"}),"\n",(0,t.jsx)(o.p,{children:"Now when you run any syncpack command, banned dependencies will be listed:"}),"\n",(0,t.jsx)(a.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"And can be removed:"}),"\n",(0,t.jsx)(a.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function l(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,n)=>{n.d(o,{Hx:()=>r});n(7294);var t=n(5893);function r(e){let{children:o,level:n}=e;return(0,t.jsx)(n,{children:o})}},292:(e,o,n)=>{n.d(o,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/ff78ae8b.7cdaf007.js b/assets/js/ff78ae8b.7cdaf007.js deleted file mode 100644 index 2e0530fc..00000000 --- a/assets/js/ff78ae8b.7cdaf007.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksite=self.webpackChunksite||[]).push([[6372],{2478:(e,o,n)=>{n.r(o),n.d(o,{assets:()=>i,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>p,toc:()=>l});var t=n(5893),r=n(1151),c=(n(9960),n(5739));const s={title:"Ban dependency from monorepo"},a=void 0,p={id:"examples/ban-dependency-from-monorepo",title:"Ban dependency from monorepo",description:"",source:"@site/docs/examples/ban-dependency-from-monorepo.mdx",sourceDirName:"examples",slug:"/examples/ban-dependency-from-monorepo",permalink:"/syncpack/examples/ban-dependency-from-monorepo",draft:!1,unlisted:!1,editUrl:"https://github.com/JamieMason/syncpack/tree/main/site/docs/examples/ban-dependency-from-monorepo.mdx",tags:[],version:"current",lastUpdatedBy:"Jamie Mason",lastUpdatedAt:1699300201,formattedLastUpdatedAt:"Nov 6, 2023",frontMatter:{title:"Ban dependency from monorepo"},sidebar:"examples",previous:{title:"Examples",permalink:"/syncpack/examples"},next:{title:"Ensure that semver ranges for a dependency all match each other",permalink:"/syncpack/examples/ensure-versions-satisfy-same-range"}},i={},l=[];function d(e){return(0,t.jsx)(c.ZP,{level:"h2"})}function h(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(d,{...e})}):d()}},5739:(e,o,n)=>{n.d(o,{ZP:()=>l});var t=n(5893),r=n(1151),c=n(9794),s=(n(9960),n(292),n(6217));const a={annotations:c.ds,Code:c.EK},p={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:void 0,showCopyButton:!0,themeName:"dracula"};function i(e){const o={p:"p",...(0,r.a)(),...e.components};return a||d("CH",!1),a.Code||d("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="dracula"] { --ch-t-colorScheme: dark;--ch-t-foreground: #F8F8F2;--ch-t-background: #282A36;--ch-t-lighter-inlineBackground: #282a36e6;--ch-t-editor-background: #282A36;--ch-t-editor-foreground: #F8F8F2;--ch-t-editor-rangeHighlightBackground: #BD93F915;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #44475A;--ch-t-focusBorder: #6272A4;--ch-t-tab-activeBackground: #282A36;--ch-t-tab-activeForeground: #F8F8F2;--ch-t-tab-inactiveBackground: #21222C;--ch-t-tab-inactiveForeground: #6272A4;--ch-t-tab-border: #191A21;--ch-t-tab-activeBorder: #282A36;--ch-t-editorGroup-border: #BD93F9;--ch-t-editorGroupHeader-tabsBackground: #191A21;--ch-t-editorLineNumber-foreground: #6272A4;--ch-t-input-background: #282A36;--ch-t-input-foreground: #F8F8F2;--ch-t-input-border: #191A21;--ch-t-icon-foreground: #C5C5C5;--ch-t-sideBar-background: #21222C;--ch-t-sideBar-foreground: #F8F8F2;--ch-t-sideBar-border: #21222C;--ch-t-list-activeSelectionBackground: #44475A;--ch-t-list-activeSelectionForeground: #F8F8F2;--ch-t-list-hoverBackground: #44475A75; }'}}),"\n","\n","\n","\n",(0,t.jsx)(o.p,{children:"Ban a dependency from being used anywhere in your monorepo."}),"\n",(0,t.jsx)(s.Hx,{level:e.level,children:"1. Add a version group"}),"\n",(0,t.jsx)(a.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",title:'".syncpackrc"',focus:"",code:{lines:[{tokens:[{content:"{",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"versionGroups",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" {",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"dependencies",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:":",props:{style:{color:"#FF79C6"}}},{content:" [",props:{style:{color:"#F8F8F2"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"never-gonna",props:{style:{color:"#F1FA8C"}}},{content:'"',props:{style:{color:"#E9F284"}}},{content:"],",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:' "',props:{style:{color:"#8BE9FE"}}},{content:"isBanned",props:{style:{color:"#8BE9FD"}}},{content:'"',props:{style:{color:"#8BE9FE"}}},{content:": ",props:{style:{color:"#FF79C6"}}},{content:"true",props:{style:{color:"#BD93F9"}}}]},{tokens:[{content:" }",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:" ]",props:{style:{color:"#F8F8F2"}}}]},{tokens:[{content:"}",props:{style:{color:"#F8F8F2"}}}]}],lang:"json"},annotations:[]}]}),"\n",(0,t.jsx)(s.Hx,{level:e.level,children:"2. Look for mismatches"}),"\n",(0,t.jsx)(o.p,{children:"Now when you run any syncpack command, banned dependencies will be listed:"}),"\n",(0,t.jsx)(a.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"list",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(o.p,{children:"And can be removed:"}),"\n",(0,t.jsx)(a.Code,{codeConfig:p,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"syncpack ",props:{style:{color:"#F8F8F2"}}},{content:"fix-mismatches",props:{style:{color:"#F1FA8C"}}}]}],lang:"bash"},annotations:[]}]})]})}function l(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}function d(e,o){throw new Error("Expected "+(o?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},6217:(e,o,n)=>{n.d(o,{Hx:()=>r});n(7294);var t=n(5893);function r(e){let{children:o,level:n}=e;return(0,t.jsx)(n,{children:o})}},292:(e,o,n)=>{n.d(o,{K:()=>t});const t={"@types":"https://github.com/DefinitelyTyped/DefinitelyTyped",awsSdk:"https://aws.amazon.com/sdk-for-javascript/",dependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#dependencies",devDependencies:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#devDependencies",engines:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#engines",packageManager:"https://nodejs.org/api/packages.html#packagemanager",version:"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version",workspaceProtocol:"https://pnpm.io/workspaces#workspace-protocol-workspace"}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.00510078.js b/assets/js/runtime~main.00510078.js deleted file mode 100644 index 9227ec45..00000000 --- a/assets/js/runtime~main.00510078.js +++ /dev/null @@ -1 +0,0 @@ -(()=>{"use strict";var e,f,c,a,d,t={},r={};function b(e){var f=r[e];if(void 0!==f)return f.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return t[e].call(c.exports,c,c.exports,b),c.loaded=!0,c.exports}b.m=t,b.c=r,e=[],b.O=(f,c,a,d)=>{if(!c){var t=1/0;for(i=0;i=d)&&Object.keys(b.O).every((e=>b.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[c,a,d]},b.n=e=>{var f=e&&e.__esModule?()=>e.default:()=>e;return b.d(f,{a:f}),f},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,b.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var d=Object.create(null);b.r(d);var t={};f=f||[null,c({}),c([]),c(c)];for(var r=2&a&&e;"object"==typeof r&&!~f.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((f=>t[f]=()=>e[f]));return t.default=()=>e,b.d(d,t),d},b.d=(e,f)=>{for(var c in f)b.o(f,c)&&!b.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:f[c]})},b.f={},b.e=e=>Promise.all(Object.keys(b.f).reduce(((f,c)=>(b.f[c](e,f),f)),[])),b.u=e=>"assets/js/"+({53:"935f2afb",990:"6a19cf64",1182:"c7de8929",1555:"60617550",2028:"114c1d06",2076:"a424efa6",2381:"3928ec54",2507:"faeb66c2",2535:"814f3328",2740:"61b0711c",2767:"9d98f47c",3089:"a6aa9e1f",3228:"2dc772c2",3237:"1df93b7f",3334:"325cf86f",3573:"957a0050",3608:"9e4087bc",3655:"f0862f9b",3682:"a0d46b54",3691:"02e69fcd",3952:"2518a329",4086:"60482745",4087:"ea90761c",4367:"df68d44b",4368:"a94703ab",4461:"8ad702f6",4655:"4f884afc",4732:"0d01d214",4835:"f7b7f548",5147:"202d6f24",5269:"bbf0b0c6",5535:"cde22a48",5635:"dc016e2d",5914:"d29174f6",6103:"ccc49370",6283:"fce71488",6372:"ff78ae8b",6492:"06cb05cb",6567:"4ff4677f",6594:"fc9a440c",6621:"25517a24",6921:"c046c6d8",7256:"3fc261aa",7547:"7de4e94d",7888:"4b98dbff",7918:"17896441",8332:"0df5a4e0",8374:"c87b078f",8518:"a7bd4aaa",8568:"13576bc4",8592:"common",8714:"c8e40d44",8752:"02605378",8817:"2c8a7579",9057:"58229b23",9066:"e0464cb3",9210:"c901ad87",9221:"49dbd26f",9470:"1c97758f",9473:"ac08f03f",9522:"d024088c",9605:"45dc5d25",9661:"5e95c892",9664:"6f4c3bf3",9697:"764c736e",9809:"3f7238a2",9817:"14eb3368"}[e]||e)+"."+{53:"fa8e6894",990:"0e9b13ee",1182:"552ba940",1555:"00df6689",1772:"35338a38",2028:"8eaf47bc",2076:"40be1d1b",2381:"1b9c0ba9",2507:"52b73022",2535:"5f7bf75f",2740:"e944936c",2767:"eec4318b",3089:"33729515",3228:"3b069c40",3237:"ff122e77",3334:"479f940e",3573:"f0f5323c",3608:"111460ca",3655:"f8c32cad",3682:"2e5e93c8",3691:"58ad7f78",3952:"445a612b",4086:"02c9da00",4087:"ac2d81d9",4367:"875f2b24",4368:"e3b1da01",4461:"89a56461",4655:"9c4a91d9",4732:"45cb76ca",4835:"1bc594b0",4989:"93cdb63e",5147:"a150a27e",5269:"eeac5642",5535:"fdfc03ea",5635:"40cbb44b",5914:"2f74743b",5980:"38dfe693",6103:"9e2c33df",6283:"5156b15f",6372:"7cdaf007",6492:"748e2b48",6567:"f972a29c",6594:"267fbcdc",6621:"24813d9b",6921:"fb79c697",7256:"13396074",7547:"3baa0766",7888:"f284835b",7918:"5a8e87d8",8332:"1213e08f",8374:"d22e8017",8518:"860a1687",8568:"c44ac701",8592:"62a118b1",8714:"d92491d0",8752:"649134e1",8817:"14cdfb7f",9057:"4639080b",9066:"4305b157",9210:"52a41696",9221:"7864c024",9286:"fbb011ca",9470:"735af0d0",9473:"c49a7bdb",9522:"c050e4ee",9605:"96172da6",9661:"f4f57762",9664:"05aa5679",9697:"3a1bcde7",9809:"5e95bb8d",9817:"c8a4ca56"}[e]+".js",b.miniCssF=e=>{},b.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),b.o=(e,f)=>Object.prototype.hasOwnProperty.call(e,f),a={},d="site:",b.l=(e,f,c,t)=>{if(a[e])a[e].push(f);else{var r,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{r.onerror=r.onload=null,clearTimeout(s);var d=a[e];if(delete a[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),f)return f(c)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=l.bind(null,r.onerror),r.onload=l.bind(null,r.onload),o&&document.head.appendChild(r)}},b.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},b.p="/syncpack/",b.gca=function(e){return e={17896441:"7918",60482745:"4086",60617550:"1555","935f2afb":"53","6a19cf64":"990",c7de8929:"1182","114c1d06":"2028",a424efa6:"2076","3928ec54":"2381",faeb66c2:"2507","814f3328":"2535","61b0711c":"2740","9d98f47c":"2767",a6aa9e1f:"3089","2dc772c2":"3228","1df93b7f":"3237","325cf86f":"3334","957a0050":"3573","9e4087bc":"3608",f0862f9b:"3655",a0d46b54:"3682","02e69fcd":"3691","2518a329":"3952",ea90761c:"4087",df68d44b:"4367",a94703ab:"4368","8ad702f6":"4461","4f884afc":"4655","0d01d214":"4732",f7b7f548:"4835","202d6f24":"5147",bbf0b0c6:"5269",cde22a48:"5535",dc016e2d:"5635",d29174f6:"5914",ccc49370:"6103",fce71488:"6283",ff78ae8b:"6372","06cb05cb":"6492","4ff4677f":"6567",fc9a440c:"6594","25517a24":"6621",c046c6d8:"6921","3fc261aa":"7256","7de4e94d":"7547","4b98dbff":"7888","0df5a4e0":"8332",c87b078f:"8374",a7bd4aaa:"8518","13576bc4":"8568",common:"8592",c8e40d44:"8714","02605378":"8752","2c8a7579":"8817","58229b23":"9057",e0464cb3:"9066",c901ad87:"9210","49dbd26f":"9221","1c97758f":"9470",ac08f03f:"9473",d024088c:"9522","45dc5d25":"9605","5e95c892":"9661","6f4c3bf3":"9664","764c736e":"9697","3f7238a2":"9809","14eb3368":"9817"}[e]||e,b.p+b.u(e)},(()=>{var e={1303:0,532:0};b.f.j=(f,c)=>{var a=b.o(e,f)?e[f]:void 0;if(0!==a)if(a)c.push(a[2]);else if(/^(1303|532)$/.test(f))e[f]=0;else{var d=new Promise(((c,d)=>a=e[f]=[c,d]));c.push(a[2]=d);var t=b.p+b.u(f),r=new Error;b.l(t,(c=>{if(b.o(e,f)&&(0!==(a=e[f])&&(e[f]=void 0),a)){var d=c&&("load"===c.type?"missing":c.type),t=c&&c.target&&c.target.src;r.message="Loading chunk "+f+" failed.\n("+d+": "+t+")",r.name="ChunkLoadError",r.type=d,r.request=t,a[1](r)}}),"chunk-"+f,f)}},b.O.j=f=>0===e[f];var f=(f,c)=>{var a,d,t=c[0],r=c[1],o=c[2],n=0;if(t.some((f=>0!==e[f]))){for(a in r)b.o(r,a)&&(b.m[a]=r[a]);if(o)var i=o(b)}for(f&&f(c);n{"use strict";var e,f,a,c,d,t={},r={};function b(e){var f=r[e];if(void 0!==f)return f.exports;var a=r[e]={id:e,loaded:!1,exports:{}};return t[e].call(a.exports,a,a.exports,b),a.loaded=!0,a.exports}b.m=t,b.c=r,e=[],b.O=(f,a,c,d)=>{if(!a){var t=1/0;for(i=0;i=d)&&Object.keys(b.O).every((e=>b.O[e](a[o])))?a.splice(o--,1):(r=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[a,c,d]},b.n=e=>{var f=e&&e.__esModule?()=>e.default:()=>e;return b.d(f,{a:f}),f},a=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,b.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);b.r(d);var t={};f=f||[null,a({}),a([]),a(a)];for(var r=2&c&&e;"object"==typeof r&&!~f.indexOf(r);r=a(r))Object.getOwnPropertyNames(r).forEach((f=>t[f]=()=>e[f]));return t.default=()=>e,b.d(d,t),d},b.d=(e,f)=>{for(var a in f)b.o(f,a)&&!b.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:f[a]})},b.f={},b.e=e=>Promise.all(Object.keys(b.f).reduce(((f,a)=>(b.f[a](e,f),f)),[])),b.u=e=>"assets/js/"+({53:"935f2afb",990:"6a19cf64",1182:"c7de8929",1555:"60617550",2028:"114c1d06",2076:"a424efa6",2381:"3928ec54",2507:"faeb66c2",2535:"814f3328",2740:"61b0711c",2767:"9d98f47c",3089:"a6aa9e1f",3228:"2dc772c2",3237:"1df93b7f",3334:"325cf86f",3573:"957a0050",3608:"9e4087bc",3655:"f0862f9b",3682:"a0d46b54",3691:"02e69fcd",3952:"2518a329",4086:"60482745",4087:"ea90761c",4367:"df68d44b",4368:"a94703ab",4461:"8ad702f6",4655:"4f884afc",4732:"0d01d214",4835:"f7b7f548",5147:"202d6f24",5269:"bbf0b0c6",5535:"cde22a48",5635:"dc016e2d",5914:"d29174f6",6103:"ccc49370",6283:"fce71488",6372:"ff78ae8b",6492:"06cb05cb",6567:"4ff4677f",6594:"fc9a440c",6621:"25517a24",6921:"c046c6d8",7256:"3fc261aa",7547:"7de4e94d",7888:"4b98dbff",7918:"17896441",8332:"0df5a4e0",8374:"c87b078f",8518:"a7bd4aaa",8568:"13576bc4",8592:"common",8714:"c8e40d44",8752:"02605378",8817:"2c8a7579",9057:"58229b23",9066:"e0464cb3",9210:"c901ad87",9221:"49dbd26f",9470:"1c97758f",9473:"ac08f03f",9522:"d024088c",9605:"45dc5d25",9661:"5e95c892",9664:"6f4c3bf3",9697:"764c736e",9809:"3f7238a2",9817:"14eb3368"}[e]||e)+"."+{53:"fa8e6894",990:"7cd0359c",1182:"a73a774d",1555:"17a08b93",1772:"35338a38",2028:"cc772645",2076:"b208872f",2381:"80d2bcf9",2507:"52b73022",2535:"5f7bf75f",2740:"9d1ef70a",2767:"eec4318b",3089:"33729515",3228:"d0caab76",3237:"ff122e77",3334:"e3e8b82c",3573:"5dbcb3b1",3608:"111460ca",3655:"5cf6077c",3682:"34f8f838",3691:"05f5722b",3952:"4710dc84",4086:"38915c7b",4087:"1d83a569",4367:"44edbb57",4368:"e3b1da01",4461:"123fa477",4655:"9c4a91d9",4732:"82131173",4835:"a93112b5",4989:"93cdb63e",5147:"26b2842e",5269:"d8d9a344",5535:"88b9eaf7",5635:"99b54cfe",5914:"de6802af",5980:"38dfe693",6103:"9e2c33df",6283:"dd397375",6372:"049fb9f2",6492:"a9b2bc4b",6567:"7bfa5e42",6594:"dbbded60",6621:"321bcae1",6921:"65836e20",7256:"87a98e27",7547:"320720f5",7888:"79cc04cb",7918:"5a8e87d8",8332:"42794c53",8374:"bc782301",8518:"860a1687",8568:"3ca2db05",8592:"62a118b1",8714:"5c3d0a70",8752:"2a1e3224",8817:"52d97031",9057:"f9325709",9066:"06cfea97",9210:"14ff5426",9221:"655caa94",9286:"fbb011ca",9470:"5faac0e1",9473:"c49a7bdb",9522:"35d9fbd3",9605:"96172da6",9661:"f4f57762",9664:"e0946522",9697:"26093551",9809:"875a0e28",9817:"c8a4ca56"}[e]+".js",b.miniCssF=e=>{},b.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),b.o=(e,f)=>Object.prototype.hasOwnProperty.call(e,f),c={},d="site:",b.l=(e,f,a,t)=>{if(c[e])c[e].push(f);else{var r,o;if(void 0!==a)for(var n=document.getElementsByTagName("script"),i=0;i{r.onerror=r.onload=null,clearTimeout(s);var d=c[e];if(delete c[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(a))),f)return f(a)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=l.bind(null,r.onerror),r.onload=l.bind(null,r.onload),o&&document.head.appendChild(r)}},b.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},b.p="/syncpack/",b.gca=function(e){return e={17896441:"7918",60482745:"4086",60617550:"1555","935f2afb":"53","6a19cf64":"990",c7de8929:"1182","114c1d06":"2028",a424efa6:"2076","3928ec54":"2381",faeb66c2:"2507","814f3328":"2535","61b0711c":"2740","9d98f47c":"2767",a6aa9e1f:"3089","2dc772c2":"3228","1df93b7f":"3237","325cf86f":"3334","957a0050":"3573","9e4087bc":"3608",f0862f9b:"3655",a0d46b54:"3682","02e69fcd":"3691","2518a329":"3952",ea90761c:"4087",df68d44b:"4367",a94703ab:"4368","8ad702f6":"4461","4f884afc":"4655","0d01d214":"4732",f7b7f548:"4835","202d6f24":"5147",bbf0b0c6:"5269",cde22a48:"5535",dc016e2d:"5635",d29174f6:"5914",ccc49370:"6103",fce71488:"6283",ff78ae8b:"6372","06cb05cb":"6492","4ff4677f":"6567",fc9a440c:"6594","25517a24":"6621",c046c6d8:"6921","3fc261aa":"7256","7de4e94d":"7547","4b98dbff":"7888","0df5a4e0":"8332",c87b078f:"8374",a7bd4aaa:"8518","13576bc4":"8568",common:"8592",c8e40d44:"8714","02605378":"8752","2c8a7579":"8817","58229b23":"9057",e0464cb3:"9066",c901ad87:"9210","49dbd26f":"9221","1c97758f":"9470",ac08f03f:"9473",d024088c:"9522","45dc5d25":"9605","5e95c892":"9661","6f4c3bf3":"9664","764c736e":"9697","3f7238a2":"9809","14eb3368":"9817"}[e]||e,b.p+b.u(e)},(()=>{var e={1303:0,532:0};b.f.j=(f,a)=>{var c=b.o(e,f)?e[f]:void 0;if(0!==c)if(c)a.push(c[2]);else if(/^(1303|532)$/.test(f))e[f]=0;else{var d=new Promise(((a,d)=>c=e[f]=[a,d]));a.push(c[2]=d);var t=b.p+b.u(f),r=new Error;b.l(t,(a=>{if(b.o(e,f)&&(0!==(c=e[f])&&(e[f]=void 0),c)){var d=a&&("load"===a.type?"missing":a.type),t=a&&a.target&&a.target.src;r.message="Loading chunk "+f+" failed.\n("+d+": "+t+")",r.name="ChunkLoadError",r.type=d,r.request=t,c[1](r)}}),"chunk-"+f,f)}},b.O.j=f=>0===e[f];var f=(f,a)=>{var c,d,t=a[0],r=a[1],o=a[2],n=0;if(t.some((f=>0!==e[f]))){for(c in r)b.o(r,c)&&(b.m[c]=r[c]);if(o)var i=o(b)}for(f&&f(a);n Blog | Syncpack - + -

+

\ No newline at end of file diff --git a/blog/archive.html b/blog/archive.html index 6c96dac4..8614da0e 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -5,10 +5,10 @@ Archive | Syncpack - + -

Archive

Archive

2023​

+

Archive

Archive

2023​

\ No newline at end of file diff --git a/blog/atom.xml b/blog/atom.xml index f53f5465..49d88490 100644 --- a/blog/atom.xml +++ b/blog/atom.xml @@ -2,7 +2,7 @@ https://jamiemason.github.io/syncpack/blog Syncpack Blog - 2023-11-06T19:50:01.000Z + 2023-11-10T15:49:57.000Z https://github.com/jpmonette/feed Syncpack Blog @@ -11,6 +11,6 @@ <![CDATA[Blog]]> https://jamiemason.github.io/syncpack/blog/index - 2023-11-06T19:50:01.000Z + 2023-11-10T15:49:57.000Z \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index 6d9a38c3..828ed3ac 100644 --- a/blog/index.html +++ b/blog/index.html @@ -3,12 +3,12 @@ -Blog | Syncpack +Blog | Syncpack - + -
+
\ No newline at end of file diff --git a/blog/rss.xml b/blog/rss.xml index 6719a4f6..0710aadf 100644 --- a/blog/rss.xml +++ b/blog/rss.xml @@ -4,7 +4,7 @@ Syncpack Blog https://jamiemason.github.io/syncpack/blog Syncpack Blog - Mon, 06 Nov 2023 19:50:01 GMT + Fri, 10 Nov 2023 15:49:57 GMT https://validator.w3.org/feed/docs/rss2.html https://github.com/jpmonette/feed en @@ -12,7 +12,7 @@ <![CDATA[Blog]]> https://jamiemason.github.io/syncpack/blog/index https://jamiemason.github.io/syncpack/blog/index - Mon, 06 Nov 2023 19:50:01 GMT + Fri, 10 Nov 2023 15:49:57 GMT \ No newline at end of file diff --git a/command/fix-mismatches.html b/command/fix-mismatches.html index 66a99d82..8927679c 100644 --- a/command/fix-mismatches.html +++ b/command/fix-mismatches.html @@ -5,7 +5,7 @@ fix-mismatches | Syncpack - + @@ -57,6 +57,6 @@

help
syncpack fix-mismatches --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack fix-mismatches
+
SYNCPACK_VERBOSE=true syncpack fix-mismatches
\ No newline at end of file diff --git a/command/format.html b/command/format.html index abad49a1..f959287b 100644 --- a/command/format.html +++ b/command/format.html @@ -5,7 +5,7 @@ format | Syncpack - + @@ -43,6 +43,6 @@

help
syncpack format --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack format
+
SYNCPACK_VERBOSE=true syncpack format
\ No newline at end of file diff --git a/command/lint-semver-ranges.html b/command/lint-semver-ranges.html index 15e579ed..4198843f 100644 --- a/command/lint-semver-ranges.html +++ b/command/lint-semver-ranges.html @@ -5,7 +5,7 @@ lint-semver-ranges | Syncpack - + @@ -57,6 +57,6 @@

help
syncpack lint-semver-ranges --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack lint-semver-ranges
+
SYNCPACK_VERBOSE=true syncpack lint-semver-ranges
\ No newline at end of file diff --git a/command/lint.html b/command/lint.html index 95dc2cea..4b015f21 100644 --- a/command/lint.html +++ b/command/lint.html @@ -5,7 +5,7 @@ lint | Syncpack - + @@ -27,6 +27,6 @@

help
syncpack lint --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack lint
+
SYNCPACK_VERBOSE=true syncpack lint
\ No newline at end of file diff --git a/command/list-mismatches.html b/command/list-mismatches.html index 3211b4ca..2659e901 100644 --- a/command/list-mismatches.html +++ b/command/list-mismatches.html @@ -5,7 +5,7 @@ list-mismatches | Syncpack - + @@ -50,6 +50,6 @@

help
syncpack list-mismatches --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack list-mismatches
+
SYNCPACK_VERBOSE=true syncpack list-mismatches
\ No newline at end of file diff --git a/command/list.html b/command/list.html index 39490162..993415cd 100644 --- a/command/list.html +++ b/command/list.html @@ -5,7 +5,7 @@ list | Syncpack - + @@ -50,6 +50,6 @@

help
syncpack list --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack list
+
SYNCPACK_VERBOSE=true syncpack list
\ No newline at end of file diff --git a/command/prompt.html b/command/prompt.html index c4df51f4..6d0b61ef 100644 --- a/command/prompt.html +++ b/command/prompt.html @@ -5,7 +5,7 @@ prompt | Syncpack - + @@ -50,6 +50,6 @@

help
syncpack prompt --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack prompt
+
SYNCPACK_VERBOSE=true syncpack prompt
\ No newline at end of file diff --git a/command/set-semver-ranges.html b/command/set-semver-ranges.html index 10e8c1d7..a640b7ea 100644 --- a/command/set-semver-ranges.html +++ b/command/set-semver-ranges.html @@ -5,7 +5,7 @@ set-semver-ranges | Syncpack - + @@ -57,6 +57,6 @@

help
syncpack set-semver-ranges --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack set-semver-ranges
+
SYNCPACK_VERBOSE=true syncpack set-semver-ranges
\ No newline at end of file diff --git a/command/update.html b/command/update.html index de6612b5..2c91e6fe 100644 --- a/command/update.html +++ b/command/update.html @@ -5,7 +5,7 @@ update | Syncpack - + @@ -50,6 +50,6 @@

help
syncpack update --help

Troubleshooting​

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

-
SYNCPACK_VERBOSE=true syncpack update
+
SYNCPACK_VERBOSE=true syncpack update
\ No newline at end of file diff --git a/config/custom-types.html b/config/custom-types.html index 89029b61..18349d10 100644 --- a/config/custom-types.html +++ b/config/custom-types.html @@ -5,7 +5,7 @@ customTypes | Syncpack - + @@ -67,6 +67,6 @@

[name].path[name].strategy​

Required

A strategy defines how syncpack needs to read and write dependency names and versions, there are 3 to choose from:

-
NameExample
name@versionpnpm@7.27.0
version12.4.2
versionsByName{"pnpm":"7.27.0", "semver": "7.3.8"}
+
NameExample
name@versionpnpm@7.27.0
version12.4.2
versionsByName{"pnpm":"7.27.0", "semver": "7.3.8"}
\ No newline at end of file diff --git a/config/dependency-types.html b/config/dependency-types.html index 7918d011..ce24a227 100644 --- a/config/dependency-types.html +++ b/config/dependency-types.html @@ -5,7 +5,7 @@ dependencyTypes | Syncpack - + @@ -18,6 +18,6 @@

Default dependency types​

All are enabled by default.

ValueProperty in package.json
devdevDependencies
localversion
overridesoverrides
peerpeerDependencies
pnpmOverridespnpm.overrides
proddependencies
resolutionsresolutions
-
tip

Learn more about the local dependency type.

+
tip

Learn more about the local dependency type.

\ No newline at end of file diff --git a/config/indent.html b/config/indent.html index b011ff31..5fb00923 100644 --- a/config/indent.html +++ b/config/indent.html @@ -5,12 +5,12 @@ indent | Syncpack - +

indent

When syncpack writes to package.json files, determines which characters to indent the JSON with.

-
.syncpackrc

{
"indent": " "
}

+
.syncpackrc

{
"indent": " "
}

\ No newline at end of file diff --git a/config/semver-groups/ignored.html b/config/semver-groups/ignored.html index b97e0a21..ab895991 100644 --- a/config/semver-groups/ignored.html +++ b/config/semver-groups/ignored.html @@ -5,7 +5,7 @@ Ignored | Syncpack - + @@ -56,6 +56,6 @@

packagesminimatch glob patterns:
of

// ✅ match any package name
packages: ["**"]
// ✅ match any package name with this scope
packages: ["@my-repo/**"]
// ✅ match specific packages by name
packages: ["my-server", "my-client"]
// ❌ not file system paths, name properties of package.json files
packages: ["packages/my-client"]
// ❌ not file system globs, name properties of package.json files
packages: ["packages/**"]

-
this

{
"name": "HERE",
"version": "1.0.2"
}

+
this

{
"name": "HERE",
"version": "1.0.2"
}

\ No newline at end of file diff --git a/config/semver-groups/with-range.html b/config/semver-groups/with-range.html index 0b650f8e..958aa0a8 100644 --- a/config/semver-groups/with-range.html +++ b/config/semver-groups/with-range.html @@ -5,7 +5,7 @@ With Range | Syncpack - + @@ -57,6 +57,6 @@

packagesminimatch glob patterns:
of

// ✅ match any package name
packages: ["**"]
// ✅ match any package name with this scope
packages: ["@my-repo/**"]
// ✅ match specific packages by name
packages: ["my-server", "my-client"]
// ❌ not file system paths, name properties of package.json files
packages: ["packages/my-client"]
// ❌ not file system globs, name properties of package.json files
packages: ["packages/**"]

-
this

{
"name": "HERE",
"version": "1.0.2"
}

+
this

{
"name": "HERE",
"version": "1.0.2"
}

\ No newline at end of file diff --git a/config/sort-az.html b/config/sort-az.html index f1118a2c..2ffe88be 100644 --- a/config/sort-az.html +++ b/config/sort-az.html @@ -5,10 +5,10 @@ sortAz | Syncpack - + -

sortAz

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 alphabetically. There is no equivalent CLI Option for this configuration.

+

sortAz

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 alphabetically. There is no equivalent CLI Option for this configuration.

\ No newline at end of file diff --git a/config/sort-first.html b/config/sort-first.html index 2ece0584..cf5bf259 100644 --- a/config/sort-first.html +++ b/config/sort-first.html @@ -5,10 +5,10 @@ sortFirst | Syncpack - + -

sortFirst

When using the format command, determines which fields within package.json files should appear at the top, and in what order.

+

sortFirst

When using the format command, determines which fields within package.json files should appear at the top, and in what order.

\ No newline at end of file diff --git a/config/source.html b/config/source.html index c98215c3..addfa1ec 100644 --- a/config/source.html +++ b/config/source.html @@ -5,7 +5,7 @@ source | Syncpack - + @@ -22,6 +22,6 @@

Resolving
  • If using Lerna, read packages from ./lerna.json.
  • If using Pnpm, read packages from ./pnpm-workspace.yaml.
  • Default to 'package.json' and 'packages/*/package.json'.
    • -
    +
    \ No newline at end of file diff --git a/config/syncpackrc.html b/config/syncpackrc.html index 70dd5df4..5c3f4d55 100644 --- a/config/syncpackrc.html +++ b/config/syncpackrc.html @@ -5,7 +5,7 @@ .syncpackrc | Syncpack - + @@ -23,6 +23,6 @@

    Configura

    syncpack list --config ./config/syncpack.json

    Defaults​

    Your config file only needs to define values for those you want to change from the defaults below.

    -

    // @ts-check
    /** @type {import("syncpack").RcFile} */
    const config = {
    customTypes: [],
    dependencyTypes: ['dev', 'local', 'overrides', 'peer', 'pnpmOverrides', 'prod', 'resolutions'],
    filter: '.',
    indent: ' ',
    semverGroups: [],
    semverRange: '',
    sortAz: ['contributors', 'dependencies', 'devDependencies', 'keywords', 'peerDependencies', 'resolutions', 'scripts'],
    sortFirst: ['name', 'description', 'version', 'author'],
    source: ['package.json', 'packages/*/package.json'],
    versionGroups: [],
    };
    module.exports = config;

    +

    // @ts-check
    /** @type {import("syncpack").RcFile} */
    const config = {
    customTypes: [],
    dependencyTypes: ['dev', 'local', 'overrides', 'peer', 'pnpmOverrides', 'prod', 'resolutions'],
    filter: '.',
    indent: ' ',
    semverGroups: [],
    semverRange: '',
    sortAz: ['contributors', 'dependencies', 'devDependencies', 'keywords', 'peerDependencies', 'resolutions', 'scripts'],
    sortFirst: ['name', 'description', 'version', 'author'],
    source: ['package.json', 'packages/*/package.json'],
    versionGroups: [],
    };
    module.exports = config;

    \ No newline at end of file diff --git a/config/version-groups/banned.html b/config/version-groups/banned.html index e2cdf082..146e1717 100644 --- a/config/version-groups/banned.html +++ b/config/version-groups/banned.html @@ -5,7 +5,7 @@ Banned | Syncpack - + @@ -86,6 +86,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/config/version-groups/ignored.html b/config/version-groups/ignored.html index 5986a2dc..4aae883a 100644 --- a/config/version-groups/ignored.html +++ b/config/version-groups/ignored.html @@ -5,7 +5,7 @@ Ignored | Syncpack - + @@ -71,6 +71,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/config/version-groups/lowest-version.html b/config/version-groups/lowest-version.html index 64e475ca..8abcf06c 100644 --- a/config/version-groups/lowest-version.html +++ b/config/version-groups/lowest-version.html @@ -5,7 +5,7 @@ Lowest Version | Syncpack - + @@ -58,6 +58,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/config/version-groups/pinned.html b/config/version-groups/pinned.html index c8dc9621..70980d1c 100644 --- a/config/version-groups/pinned.html +++ b/config/version-groups/pinned.html @@ -5,7 +5,7 @@ Pinned | Syncpack - + @@ -75,6 +75,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/config/version-groups/same-range.html b/config/version-groups/same-range.html index 8b4a10f0..d27e873b 100644 --- a/config/version-groups/same-range.html +++ b/config/version-groups/same-range.html @@ -5,7 +5,7 @@ Same Range | Syncpack - + @@ -71,6 +71,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/config/version-groups/snapped-to.html b/config/version-groups/snapped-to.html index f022c220..023309e8 100644 --- a/config/version-groups/snapped-to.html +++ b/config/version-groups/snapped-to.html @@ -5,7 +5,7 @@ Snapped To | Syncpack - + @@ -74,6 +74,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/config/version-groups/standard.html b/config/version-groups/standard.html index 4c376b87..eb04741b 100644 --- a/config/version-groups/standard.html +++ b/config/version-groups/standard.html @@ -5,7 +5,7 @@ Standard | Syncpack - + @@ -57,6 +57,6 @@

    packagesminimatch glob patterns:
    of

    // ✅ match any package name
    packages: ["**"]
    // ✅ match any package name with this scope
    packages: ["@my-repo/**"]
    // ✅ match specific packages by name
    packages: ["my-server", "my-client"]
    // ❌ not file system paths, name properties of package.json files
    packages: ["packages/my-client"]
    // ❌ not file system globs, name properties of package.json files
    packages: ["packages/**"]

    -
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    +
    this

    {
    "name": "HERE",
    "version": "1.0.2"
    }

    \ No newline at end of file diff --git a/examples.html b/examples.html index 426689f1..3e3357fc 100644 --- a/examples.html +++ b/examples.html @@ -5,7 +5,7 @@ Examples | Syncpack - + diff --git a/examples/ban-dependency-from-monorepo.html b/examples/ban-dependency-from-monorepo.html index 9483be35..7358d241 100644 --- a/examples/ban-dependency-from-monorepo.html +++ b/examples/ban-dependency-from-monorepo.html @@ -5,7 +5,7 @@ Ban dependency from monorepo | Syncpack - + @@ -20,6 +20,6 @@

    2. Look for mismatches

    Now when you run any syncpack command, banned dependencies will be listed:


    syncpack list

    And can be removed:

    -

    syncpack fix-mismatches

    +

    syncpack fix-mismatches

    \ No newline at end of file diff --git a/examples/ensure-versions-satisfy-same-range.html b/examples/ensure-versions-satisfy-same-range.html index acc27925..7f3037bb 100644 --- a/examples/ensure-versions-satisfy-same-range.html +++ b/examples/ensure-versions-satisfy-same-range.html @@ -5,7 +5,7 @@ Ensure that semver ranges for a dependency all match each other | Syncpack - + @@ -21,6 +21,6 @@
  • The policy of sameRange states that these dependencies are considered valid if every range matches the others.

    • {
    "versionGroups": [
    {
    "label": "Ensure semver ranges for locally developed packages satisfy the local version",
    "dependencies": ["@your-repo/node-client-plugin-retry", "@your-repo/node-client", "dashboard-ui"],
    "dependencyTypes": ["dev", "peer"],
    "policy": "sameRange"
    }
    ]
    }

    -
    tip

    The above example can be shortened: The $LOCAL keyword is a helper to avoid writing out the names of every local package.


    "dependencies": [
    + "$LOCAL"
    - "@your-repo/node-client-plugin-retry",
    - "@your-repo/node-client",
    - "dashboard-ui"
    ],

    +
    tip

    The above example can be shortened: The $LOCAL keyword is a helper to avoid writing out the names of every local package.


    "dependencies": [
    + "$LOCAL"
    - "@your-repo/node-client-plugin-retry",
    - "@your-repo/node-client",
    - "dashboard-ui"
    ],

    \ No newline at end of file diff --git a/examples/fix-aws-sdk-version-mismatch.html b/examples/fix-aws-sdk-version-mismatch.html index 7b79c59c..804286b1 100644 --- a/examples/fix-aws-sdk-version-mismatch.html +++ b/examples/fix-aws-sdk-version-mismatch.html @@ -5,7 +5,7 @@ Ensure AWS SDK dependencies always have the same version | Syncpack - + @@ -25,6 +25,6 @@

    2. Look for mismatches

    Any @aws-sdk packages which do not have the expected version can then be found:


    syncpack list-mismatches

    And fixed:

    -

    syncpack fix-mismatches

    +

    syncpack fix-mismatches

    \ No newline at end of file diff --git a/examples/fix-react-native-version-mismatch.html b/examples/fix-react-native-version-mismatch.html index b86600b4..64b145b2 100644 --- a/examples/fix-react-native-version-mismatch.html +++ b/examples/fix-react-native-version-mismatch.html @@ -5,7 +5,7 @@ Fix React Native version mismatch | Syncpack - + @@ -21,6 +21,6 @@
  • The dependencies array defines the names of the dependencies we want to target.
  • The snapTo array lists the name properties of the locally developed package.json files which should be searched for a version of react or react-native.
    • -

    {
    "versionGroups": [
    {
    "label": "Always use the versions of react brought in by the Mobile App",
    "dependencies": ["react", "react-native"],
    "snapTo": ["mobile-app"]
    }
    ]
    }

    +

    {
    "versionGroups": [
    {
    "label": "Always use the versions of react brought in by the Mobile App",
    "dependencies": ["react", "react-native"],
    "snapTo": ["mobile-app"]
    }
    ]
    }

    \ No newline at end of file diff --git a/examples/ignore-dependencies-in-syncpack.html b/examples/ignore-dependencies-in-syncpack.html index 9fa87d2c..0eb6f96a 100644 --- a/examples/ignore-dependencies-in-syncpack.html +++ b/examples/ignore-dependencies-in-syncpack.html @@ -5,7 +5,7 @@ Hide dependencies from syncpack | Syncpack - + @@ -21,6 +21,6 @@

    1. Add an ignored version group

  • Add a label to document the decision/expectation.

    • {
    "versionGroups": [
    {
    "label": "Nothing to see here, will fix soon",
    "packages": ["oops-moment", "workaround"],
    "dependencyTypes": ["peer"],
    "isIgnored": true
    }
    ]
    }

    -

    With this configuration in place, syncpack will now completely ignore every dependency listed under peerDependencies in the two named packages oops-moment and workaround only.

    +

    With this configuration in place, syncpack will now completely ignore every dependency listed under peerDependencies in the two named packages oops-moment and workaround only.

    \ No newline at end of file diff --git a/examples/only-allow-types-in-dev-dependencies.html b/examples/only-allow-types-in-dev-dependencies.html index 81937bc8..b03d27b1 100644 --- a/examples/only-allow-types-in-dev-dependencies.html +++ b/examples/only-allow-types-in-dev-dependencies.html @@ -5,7 +5,7 @@ Only allow @types packages in devDependencies | Syncpack - + @@ -24,6 +24,6 @@

    1. Add a version group


    {
    "versionGroups": [
    {
    "dependencies": ["@types/**"],
    "dependencyTypes": ["!dev"],
    "isBanned": true,
    "label": "@types packages should only be under devDependencies"
    }
    ]
    }

    2. Look for mismatches

    Any @types packages which are in the wrong location can then be found and manually moved:

    -

    syncpack list-mismatches

    +

    syncpack list-mismatches

    \ No newline at end of file diff --git a/examples/pnpm-workspace-protocol.html b/examples/pnpm-workspace-protocol.html index f2daf59e..50a42dc4 100644 --- a/examples/pnpm-workspace-protocol.html +++ b/examples/pnpm-workspace-protocol.html @@ -5,7 +5,7 @@ Pin local versions to pnpm workspace:* | Syncpack - + @@ -21,6 +21,6 @@
  • pinVersion states that these dependencies must always use workspace:*.

    • {
    "versionGroups": [
    {
    "label": "Use workspace protocol when developing local packages",
    "dependencies": ["@your-repo/node-client-plugin-retry", "@your-repo/node-client", "dashboard-ui"],
    "dependencyTypes": ["dev"],
    "pinVersion": "workspace:*"
    }
    ]
    }

    -
    tip

    The above example can be shortened: The $LOCAL keyword is a helper to avoid writing out the names of every local package.


    "dependencies": [
    + "$LOCAL"
    - "@your-repo/node-client-plugin-retry",
    - "@your-repo/node-client",
    - "dashboard-ui"
    ],

    +
    tip

    The above example can be shortened: The $LOCAL keyword is a helper to avoid writing out the names of every local package.


    "dependencies": [
    + "$LOCAL"
    - "@your-repo/node-client-plugin-retry",
    - "@your-repo/node-client",
    - "dashboard-ui"
    ],

    \ No newline at end of file diff --git a/examples/sync-engines-in-monorepo.html b/examples/sync-engines-in-monorepo.html index bccf4798..0f4e3a4e 100644 --- a/examples/sync-engines-in-monorepo.html +++ b/examples/sync-engines-in-monorepo.html @@ -5,7 +5,7 @@ Manage npm engines throughout monorepo | Syncpack - + @@ -29,6 +29,6 @@

    3. Track them in future


    syncpack list

    4. Relax the rules (optional)

    If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a Same Range Version Group. This defines an exception which only applies to Node.js, leaving anything else found under engines unaffected.

    -

    {
    "dependencyTypes": [
    "dev"
    "engines"
    "peer"
    "prod"
    ],
    "versionGroups": [
    {
    "dependencies": ["node"],
    "dependencyTypes": ["engines"],
    "policy": "sameRange"
    }
    ]
    }

    +

    {
    "dependencyTypes": [
    "dev"
    "engines"
    "peer"
    "prod"
    ],
    "versionGroups": [
    {
    "dependencies": ["node"],
    "dependencyTypes": ["engines"],
    "policy": "sameRange"
    }
    ]
    }

    \ No newline at end of file diff --git a/examples/sync-nodejs-version-in-monorepo.html b/examples/sync-nodejs-version-in-monorepo.html index 271510ec..222849c1 100644 --- a/examples/sync-nodejs-version-in-monorepo.html +++ b/examples/sync-nodejs-version-in-monorepo.html @@ -5,7 +5,7 @@ Synchronise Node.js version in monorepo | Syncpack - + @@ -29,6 +29,6 @@

    3. Track them in future


    syncpack list

    4. Relax the rules (optional)

    If you don't want the Node.js version to be identical in every package but do want them all to be compatible with each other, you can use a Same Range Version Group.

    -

    {
    "dependencyTypes": [
    "dev"
    "nodeEngine"
    "peer"
    "prod"
    ],
    "versionGroups": [
    {
    "dependencyTypes": ["nodeEngine"],
    "policy": "sameRange"
    }
    ]
    }

    +

    {
    "dependencyTypes": [
    "dev"
    "nodeEngine"
    "peer"
    "prod"
    ],
    "versionGroups": [
    {
    "dependencyTypes": ["nodeEngine"],
    "policy": "sameRange"
    }
    ]
    }

    \ No newline at end of file diff --git a/examples/sync-package-manager-version.html b/examples/sync-package-manager-version.html index efb468ed..ff3eb1f9 100644 --- a/examples/sync-package-manager-version.html +++ b/examples/sync-package-manager-version.html @@ -5,7 +5,7 @@ Manage monorepo packageManager version | Syncpack - + @@ -13,6 +13,6 @@

    Add support for managing versions in engines and packageManager properties of your package.json files.

    -

    {
    "customTypes": {
    "engines": {
    "path": "engines",
    "strategy": "versionsByName"
    },
    "packageManager": {
    "path": "packageManager",
    "strategy": "name@version"
    }
    }
    }

    +

    {
    "customTypes": {
    "engines": {
    "path": "engines",
    "strategy": "versionsByName"
    },
    "packageManager": {
    "path": "packageManager",
    "strategy": "name@version"
    }
    }
    }

    \ No newline at end of file diff --git a/guide/getting-started.html b/guide/getting-started.html index 015be236..e829c2dd 100644 --- a/guide/getting-started.html +++ b/guide/getting-started.html @@ -5,7 +5,7 @@ Getting Started | Syncpack - + @@ -140,6 +140,6 @@

    Next StepsSee what other functionality is provided by Version Groups Banned, Ignored, Lowest Version, Pinned, Same Range, Snapped To, and Standard.
  • Read the guide on Local Package Versions, which is an advanced topic.
  • If you like Syncpack, tell people about it. Syncpack is a single person project done in what spare time I can find, has been an absolute ton of work, and is completely free.
    • -
    +
    \ No newline at end of file diff --git a/guide/local-package-versions.html b/guide/local-package-versions.html index 0ee4b211..5c6d3a37 100644 --- a/guide/local-package-versions.html +++ b/guide/local-package-versions.html @@ -5,7 +5,7 @@ Local Package Versions | Syncpack - + @@ -69,6 +69,6 @@

    Possible
  • The policy of sameRange states that these dependencies are considered valid if every range matches the others.

    • {
    "versionGroups": [
    {
    "label": "Ensure semver ranges for locally developed packages satisfy the local version",
    "dependencies": ["@your-repo/node-client-plugin-retry", "@your-repo/node-client", "dashboard-ui"],
    "dependencyTypes": ["dev", "peer"],
    "policy": "sameRange"
    }
    ]
    }

    -
    tip

    The above example can be shortened: The $LOCAL keyword is a helper to avoid writing out the names of every local package.


    "dependencies": [
    + "$LOCAL"
    - "@your-repo/node-client-plugin-retry",
    - "@your-repo/node-client",
    - "dashboard-ui"
    ],

    +
    tip

    The above example can be shortened: The $LOCAL keyword is a helper to avoid writing out the names of every local package.


    "dependencies": [
    + "$LOCAL"
    - "@your-repo/node-client-plugin-retry",
    - "@your-repo/node-client",
    - "dashboard-ui"
    ],

    \ No newline at end of file diff --git a/guide/semver-groups.html b/guide/semver-groups.html index de8553b0..57f1ff50 100644 --- a/guide/semver-groups.html +++ b/guide/semver-groups.html @@ -5,7 +5,7 @@ Semver Groups | Syncpack - + @@ -22,6 +22,6 @@

    Examples

    {
    "semverGroups": [
    {
    "range": "~",
    "dependencies": ["@alpha/**"],
    "packages": ["**"]
    }
    ]
    }

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

    -

    {
    "semverGroups": [
    {
    "range": "",
    "dependencyTypes": ["prod", "resolutions", "overrides", "pnpmOverrides", "local"],
    "dependencies": ["**"],
    "packages": ["**"]
    },
    {
    "range": "~",
    "dependencyTypes": ["dev"],
    "dependencies": ["**"],
    "packages": ["**"]
    },
    {
    "range": "^",
    "dependencyTypes": ["peer"],
    "dependencies": ["**"],
    "packages": ["**"]
    }
    ]
    }

    +

    {
    "semverGroups": [
    {
    "range": "",
    "dependencyTypes": ["prod", "resolutions", "overrides", "pnpmOverrides", "local"],
    "dependencies": ["**"],
    "packages": ["**"]
    },
    {
    "range": "~",
    "dependencyTypes": ["dev"],
    "dependencies": ["**"],
    "packages": ["**"]
    },
    {
    "range": "^",
    "dependencyTypes": ["peer"],
    "dependencies": ["**"],
    "packages": ["**"]
    }
    ]
    }

    \ No newline at end of file diff --git a/guide/version-groups.html b/guide/version-groups.html index 43d5c4b7..a492a8cd 100644 --- a/guide/version-groups.html +++ b/guide/version-groups.html @@ -5,7 +5,7 @@ Version Groups | Syncpack - + @@ -22,6 +22,6 @@

    Examples

    {
    "versionGroups": [
    {
    // Pinned
    "label": "Ensure AWS SDK dependencies always use the same version",
    "packages": ["**"],
    "dependencies": ["@aws-sdk/**"],
    "pinVersion": "3.272.0"
    },
    {
    // Banned
    "label": "Please use lodash instead of underscore",
    "packages": ["**"],
    "dependencies": ["underscore"],
    "isBanned": true
    },
    {
    // Ignored
    "label": "Ignore issues in these dodgy packages",
    "packages": ["oops-moment", "workaround"],
    "dependencies": ["**"],
    "isIgnored": true
    },
    {
    // Snapped
    "label": "Ensure all packages use whatever version the mobile-core package is using",
    "dependencies": ["react", "react-native"],
    "packages": ["**"],
    "snapTo": ["mobile-core"]
    },
    {
    // Pinned
    "label": "Use '*' under 'peerDependencies' everywhere",
    "packages": ["**"],
    "dependencies": ["**"],
    "dependencyTypes": ["peer"],
    "pinVersion": "*"
    },
    {
    // Standard
    "label": "Resolve mismatches here with the oldest version instead of the newest",
    "dependencies": ["@vintage/**"],
    "packages": ["**"],
    "preferVersion": "lowestSemver"
    }
    ]
    }

    +

    {
    "versionGroups": [
    {
    // Pinned
    "label": "Ensure AWS SDK dependencies always use the same version",
    "packages": ["**"],
    "dependencies": ["@aws-sdk/**"],
    "pinVersion": "3.272.0"
    },
    {
    // Banned
    "label": "Please use lodash instead of underscore",
    "packages": ["**"],
    "dependencies": ["underscore"],
    "isBanned": true
    },
    {
    // Ignored
    "label": "Ignore issues in these dodgy packages",
    "packages": ["oops-moment", "workaround"],
    "dependencies": ["**"],
    "isIgnored": true
    },
    {
    // Snapped
    "label": "Ensure all packages use whatever version the mobile-core package is using",
    "dependencies": ["react", "react-native"],
    "packages": ["**"],
    "snapTo": ["mobile-core"]
    },
    {
    // Pinned
    "label": "Use '*' under 'peerDependencies' everywhere",
    "packages": ["**"],
    "dependencies": ["**"],
    "dependencyTypes": ["peer"],
    "pinVersion": "*"
    },
    {
    // Standard
    "label": "Resolve mismatches here with the oldest version instead of the newest",
    "dependencies": ["@vintage/**"],
    "packages": ["**"],
    "preferVersion": "lowestSemver"
    }
    ]
    }

    \ No newline at end of file diff --git a/index.html b/index.html index 093684ff..4b13e113 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Consistent dependency versions in large JavaScript Monorepos | Syncpack - + diff --git a/integrations/github-actions.html b/integrations/github-actions.html index 0c840b0f..13f78045 100644 --- a/integrations/github-actions.html +++ b/integrations/github-actions.html @@ -5,11 +5,11 @@ Github Actions | Syncpack - +
    +

    It is new and less stable than syncpack itself, but please give it a try and give your feedback.

    \ No newline at end of file diff --git a/integrations/intellisense.html b/integrations/intellisense.html index 498d19b5..b8df0435 100644 --- a/integrations/intellisense.html +++ b/integrations/intellisense.html @@ -5,7 +5,7 @@ TypeScript Intellisense | Syncpack - + @@ -14,6 +14,6 @@

    To enable validation and autocompletion for your configuration file, you must use a JavaScript config file and annotate in keeping with the below example:


    // @ts-check
    /** @type {import("syncpack").RcFile} */
    const config = {
    versionGroups: [
    {
    dependencies: ['@types/node'],
    packages: ['**'],
    pinVersion: '14.18.36',
    },
    {
    dependencies: ['chalk'],
    packages: ['**'],
    pinVersion: '4.1.2',
    },
    ],
    };
    module.exports = config;

    -
    note

    Ensure that "javascript.validate.enable": false is not set in VS Code.

    +
    note

    Ensure that "javascript.validate.enable": false is not set in VS Code.

    \ No newline at end of file diff --git a/integrations/json-schema.html b/integrations/json-schema.html index 583fab8d..f5d5f27e 100644 --- a/integrations/json-schema.html +++ b/integrations/json-schema.html @@ -5,12 +5,12 @@ JSON Schema | Syncpack - +

    JSON Schema

    From syncpack 11.2.1 and up, a JSON Schema file is available. Ironically, you will need to manually ensure that the version number in the URL you reference matches the version of syncpack you have installed, at least for the time being.

    -

    {
    "$schema": "https://unpkg.com/syncpack@11.2.1/dist/schema.json",
    "versionGroups": [
    {
    "dependencies": ["@types/node"],
    "packages": ["**"],
    "pinVersion": "14.18.36"
    },
    {
    "dependencies": ["chalk"],
    "packages": ["**"],
    "pinVersion": "4.1.2"
    }
    ]
    }

    +

    {
    "$schema": "https://unpkg.com/syncpack@11.2.1/dist/schema.json",
    "versionGroups": [
    {
    "dependencies": ["@types/node"],
    "packages": ["**"],
    "pinVersion": "14.18.36"
    },
    {
    "dependencies": ["chalk"],
    "packages": ["**"],
    "pinVersion": "4.1.2"
    }
    ]
    }

    \ No newline at end of file diff --git a/integrations/lerna.html b/integrations/lerna.html index f27e2208..b7f07d2d 100644 --- a/integrations/lerna.html +++ b/integrations/lerna.html @@ -5,10 +5,10 @@ Lerna | Syncpack - + -

    Lerna

    When using Lerna, syncpack will use its configuration to discover where your package.json files are.

    +

    Lerna

    When using Lerna, syncpack will use its configuration to discover where your package.json files are.

    \ No newline at end of file diff --git a/integrations/npm.html b/integrations/npm.html index e5fe7b61..eb643d16 100644 --- a/integrations/npm.html +++ b/integrations/npm.html @@ -5,10 +5,10 @@ npm | Syncpack - + -

    npm

    When using npm Workspaces, syncpack will use its configuration to discover where your package.json files are.

    +

    npm

    When using npm Workspaces, syncpack will use its configuration to discover where your package.json files are.

    \ No newline at end of file diff --git a/integrations/pnpm.html b/integrations/pnpm.html index f2c7ae5d..c60d6f4c 100644 --- a/integrations/pnpm.html +++ b/integrations/pnpm.html @@ -5,10 +5,10 @@ pnpm | Syncpack - + -

    pnpm

    When using Pnpm Workspaces, syncpack will use its configuration to discover where your package.json files are.

    +

    pnpm

    When using Pnpm Workspaces, syncpack will use its configuration to discover where your package.json files are.

    \ No newline at end of file diff --git a/integrations/yarn.html b/integrations/yarn.html index 4a5d028c..5ce701c0 100644 --- a/integrations/yarn.html +++ b/integrations/yarn.html @@ -5,10 +5,10 @@ Yarn | Syncpack - + -

    Yarn

    When using Yarn Workspaces, syncpack will use its configuration to discover where your package.json files are.

    +

    Yarn

    When using Yarn Workspaces, syncpack will use its configuration to discover where your package.json files are.

    \ No newline at end of file diff --git a/status-codes.html b/status-codes.html index e613e3e0..513d8138 100644 --- a/status-codes.html +++ b/status-codes.html @@ -5,7 +5,7 @@ Status Codes | Syncpack - + @@ -39,6 +39,6 @@

    Unsuppor

    One or more of the instances of this dependency features a version specifier which syncpack does not support. As such, syncpack can't know what to do and this will need to be manually resolved.

    This can also occur if the name of the package is not supported. A common case of this is pnpm overrides.

    Valid​

    -

    These instances fully meet the rules of their Version and Semver Group.

    +

    These instances fully meet the rules of their Version and Semver Group.

    \ No newline at end of file