feat(depsynky): allow ignoring dev dependencies (#238)

botpress · Apr 12, 2024 · fb3a6fe · fb3a6fe
1 parent e980ce8
commit fb3a6fe
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 11 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,7 +1,9 @@
 * @botpress/cloud-services
 
 const @botpress/cloud-services
+
 entities @franklevasseur
+depsynky @franklevasseur
 es-node @franklevasseur
 expresso @franklevasseur
 jex @franklevasseur

diff --git a/depsynky/package.json b/depsynky/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bpinternal/depsynky",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "CLI to synchronize dependencies accross a pnpm mono-repo",
   "main": "dist/index.js",
   "scripts": {

diff --git a/depsynky/src/commands/check-versions.ts b/depsynky/src/commands/check-versions.ts
@@ -9,16 +9,14 @@ export type CheckVersionsOpts = {
   targetVersions: Record<string, string>
 }
 
-const LOCAL_VERSION = 'workspace:*'
-
 const checker =
   (pkg: utils.pkgjson.PackageJson) => (current: Record<string, string>, target: Record<string, string>) => {
     for (const [name, version] of utils.objects.entries(target)) {
       const currentVersion = current[name]
       if (!currentVersion) {
         continue
       }
-      const isLocal = currentVersion === LOCAL_VERSION
+      const isLocal = utils.pnpm.isLocalVersion(currentVersion)
       const isPublic = !pkg.private
       if (isPublic && isLocal) {
         throw new errors.DepSynkyError(
@@ -42,6 +40,11 @@ export const checkVersions = (argv: YargsConfig<typeof config.checkSchema>, opts
 
     const check = checker(content)
     dependencies && check(dependencies, targetVersions)
+
+    if (argv.ignoreDev) {
+      continue
+    }
+
     devDependencies && check(devDependencies, targetVersions)
   }
 

diff --git a/depsynky/src/commands/sync-versions.ts b/depsynky/src/commands/sync-versions.ts
@@ -7,15 +7,14 @@ export type SyncVersionsOpts = {
   targetVersions: Record<string, string>
 }
 
-const LOCAL_VERSION = 'workspace:*'
 const updater =
   (pkg: utils.pkgjson.PackageJson) => (current: Record<string, string>, target: Record<string, string>) => {
     for (const [name, version] of utils.objects.entries(target)) {
       const currentVersion = current[name]
       if (!currentVersion) {
         continue
       }
-      const isLocal = currentVersion === LOCAL_VERSION
+      const isLocal = utils.pnpm.isLocalVersion(currentVersion)
       const isPublic = !pkg.private
       if (!isLocal) {
         current[name] = version

diff --git a/depsynky/src/config.ts b/depsynky/src/config.ts
@@ -3,20 +3,27 @@ import { YargsSchema } from '@bpinternal/yargs-extra'
 const defaultOptions = {
   rootDir: {
     type: 'string',
-    default: process.cwd(),
-  },
+    default: process.cwd()
+  }
 } satisfies YargsSchema
 
 export const bumpSchema = {
   ...defaultOptions,
   sync: {
     type: 'boolean',
-    default: true,
-  },
+    default: true
+  }
 } satisfies YargsSchema
 
 export const syncSchema = defaultOptions satisfies YargsSchema
 
-export const checkSchema = defaultOptions satisfies YargsSchema
+export const checkSchema = {
+  ...defaultOptions,
+  ignoreDev: {
+    type: 'boolean',
+    description: 'Ignore dev dependencies',
+    default: false
+  }
+} satisfies YargsSchema
 
 export const listSchema = defaultOptions satisfies YargsSchema
diff --git a/depsynky/src/index.ts b/depsynky/src/index.ts
@@ -23,6 +23,7 @@ process.on('unhandledRejection', onError)
 process.on('uncaughtException', onError)
 
 void yargs
+  .scriptName('depsynky')
   .command(
     'bump [package]',
     'Bump version of a package',

diff --git a/depsynky/src/utils/pnpm.ts b/depsynky/src/utils/pnpm.ts
@@ -48,3 +48,5 @@ export const listPublicPackages = (rootDir: string): string[] => {
   const workspaces = searchWorkspaces(rootDir)
   return workspaces.filter((w) => !w.content.private).map((w) => w.content.name)
 }
+
+export const isLocalVersion = (version: string) => version.startsWith('workspace:')