feat(lockfile-check): change default behavior to auto-install dependencies and add skip option (#47)

- Change lockfile-check to automatically install dependencies by default when lockfile changes are detected
- Add `--skip-install` option to allow users to skip automatic installation
- Update documentation and test cases to reflect this behavior change

Author: a145789

README.md

@@ -297,11 +297,11 @@ commitLint({
 
 ### lockfile-check
 
-**Description**: Detect and visually output in the console whether the lockfile of frontend dependencies has been modified.
+**Description**: Detect and visually output in the console whether the lockfile of frontend dependencies has been modified, and automatically install dependencies by default to keep in sync.
 
-**Use cases**: Recommended to use after Git operations such as pulling updates (`git pull`), switching branches (`git checkout`), or merging code. It helps detect if upstream dependency lockfiles (like `pnpm-lock.yaml`) have changed. If a change is detected, you can invoke a package manager's installation command through specific options to synchronize the local environment with upstream instantly, preventing obscure bugs caused by outdated dependencies.
+**Use cases**: Recommended to use after Git operations such as pulling updates (`git pull`), switching branches (`git checkout`), or merging code. It helps detect if upstream dependency lockfiles (like `pnpm-lock.yaml`) have changed. If a change is detected, it will automatically invoke a package manager's installation command to synchronize the local environment with upstream instantly, preventing obscure bugs caused by outdated dependencies.
 
-**Core Workflow**: Execute a Git diff comparing the project's lockfile (e.g. `pnpm-lock.yaml` or corresponding environment lockfile) from the original HEAD. Print its modification status in the console. Furthermore, trigger the package manager to reinstall dependencies to sync with upstream if directed by the command options.
+**Core Workflow**: Execute a Git diff comparing the project's lockfile (e.g. `pnpm-lock.yaml` or corresponding environment lockfile) from the original HEAD. Print its modification status in the console. Furthermore, trigger the package manager to reinstall dependencies to sync with upstream by default, or skip installation if directed by the command options.
 
 **CLI Commands**:
 
@@ -312,17 +312,17 @@ Usage: vr lockfile-check [flags...]
 
 Flags:
       --package-manager string        Package manager (npm, yarn, pnpm)  # default: 'pnpm'
-      --install                       Auto install dependencies if lockfile changed
+      --skip-install                  Skip install dependencies when lockfile changed
 ```
 
 _Example_:
 
 ```shell
-# Check the synchronization status of the current lockfile
+# Check the synchronization status of the current lockfile and install dependencies if changed
 pnpm exec vr lockfile-check
 
-# Check current status, forcefully run installation to sync dependencies if updates exist
-pnpm exec vr lockfile-check --install
+# Check current status but skip installation even if updates exist
+pnpm exec vr lockfile-check --skip-install
 
 # Specify other package managers for checking
 pnpm exec vr lockfile-check --package-manager npm
@@ -333,7 +333,7 @@ _It is also recommended to integrate with `simple-git-hooks` or `husky` in `pack
 ```json
 {
   "simple-git-hooks": {
-    "post-merge": "pnpm exec vr lockfile-check --install"
+    "post-merge": "pnpm exec vr lockfile-check"
   }
 }
 ```
@@ -345,7 +345,7 @@ import { lockfileCheck } from '@varlet/release'
 
 lockfileCheck({
   packageManager?: 'npm' | 'yarn' | 'pnpm' // Choose package manager, defaults to 'pnpm'
-  install?: boolean                        // Whether to automatically run install if lockfile is out of sync
+  skipInstall?: boolean                    // Whether to skip installation if lockfile is out of sync
 })
 ```
 

README.zh-CN.md

@@ -297,11 +297,11 @@ commitLint({
 
 ### lockfile-check
 
-**作用**：检测并在控制台直观地输出前端依赖包的 lockfile 文件是否发生变更。
+**作用**：检测并在控制台直观地输出前端依赖包的 lockfile 文件是否发生变更，并默认自动安装依赖以保持同步。
 
-**使用场景**：通常在进行 `git 操作` (如 `git pull`拉取最新代码、`git checkout`切换分支、或合并代码) 之后使用。它能帮助你检测上游的依赖锁文件（如 `pnpm-lock.yaml`）是否发生了变动。如果检测到有变更，可以通过可选操作直接执行 install 安装命令，从而确保本地环境快速与上游依赖保持一致，避免因依赖版本陈旧导致的疑难 bug。
+**使用场景**：通常在进行 `git 操作` (如 `git pull`拉取最新代码、`git checkout`切换分支、或合并代码) 之后使用。它能帮助你检测上游的依赖锁文件（如 `pnpm-lock.yaml`）是否发生了变动。如果检测到有变更，默认会自动执行 install 安装命令，从而确保本地环境快速与上游依赖保持一致，避免因依赖版本陈旧导致的疑难 bug。
 
-**核心流程**：比对项目原始游标的锁文件（如 pnpm-lock.yaml 或对应环境的 lockfile）的 Git diff，在控制台输出其是否存在变动；并根据指令决定是否随后触发包管理器的依赖重装程序以同步上游。
+**核心流程**：比对项目原始游标的锁文件（如 pnpm-lock.yaml 或对应环境的 lockfile）的 Git diff，在控制台输出其是否存在变动；默认会触发包管理器的依赖重装程序以同步上游，也可以通过指令跳过安装。
 
 **CMD 命令**：
 
@@ -312,17 +312,17 @@ _标志参考_：
 
 标志:
       --package-manager string        包管理器 (npm, yarn, pnpm)  # 默认: 'pnpm'
-      --install                       如果 lockfile 发生变化则自动安装依赖
+      --skip-install                  当 lockfile 发生变化时跳过安装依赖
 ```
 
 _使用示例_：
 
 ```shell
-# 检查当前 lockfile 的同步状态
+# 检查当前 lockfile 的同步状态，若有变化则自动安装依赖
 pnpm exec vr lockfile-check
 
-# 检查当前状态，若存在更新则强制运行安装命令同步依赖
-pnpm exec vr lockfile-check --install
+# 检查当前状态，即使有更新也跳过安装
+pnpm exec vr lockfile-check --skip-install
 
 # 指定其他包管理器进行检查
 pnpm exec vr lockfile-check --package-manager npm
@@ -333,7 +333,7 @@ _建议配合并在 `package.json` 中的 `simple-git-hooks` 或 `husky` 一同
 ```json
 {
   "simple-git-hooks": {
-    "post-merge": "pnpm exec vr lockfile-check --install"
+    "post-merge": "pnpm exec vr lockfile-check"
   }
 }
 ```
@@ -345,7 +345,7 @@ import { lockfileCheck } from '@varlet/release'
 
 lockfileCheck({
   packageManager?: 'npm' | 'yarn' | 'pnpm' // 选择包管理器，默认为 'pnpm'
-  install?: boolean                        // 检测到 lock 不同步时是否自动运行对应的 install 重新安装
+  skipInstall?: boolean                    // 检测到 lock 不同步时是否跳过安装
 })
 ```
 

src/cli.ts

@@ -79,7 +79,7 @@ cli({
             default: 'pnpm',
             description: 'Package manager (npm, yarn, pnpm), default pnpm',
           },
-          install: { type: Boolean, alias: 'i', description: 'Auto install dependencies if lockfile changed' },
+          skipInstall: { type: Boolean, alias: 's', description: 'Skip install dependencies when lockfile changed' },
         },
         help: {
           description: 'Check if lockfile has been updated and optionally install dependencies',

src/lockfileCheck.ts

@@ -6,7 +6,7 @@ export type PackageManager = 'npm' | 'yarn' | 'pnpm'
 
 export interface LockfileCheckOptions {
   packageManager?: PackageManager
-  install?: boolean
+  skipInstall?: boolean
 }
 
 export function getLockfilePath(packageManager: PackageManager): string {
@@ -56,7 +56,7 @@ export async function installDependencies(packageManager: PackageManager): Promi
 export async function lockfileCheck(options: LockfileCheckOptions = {}): Promise<void> {
   try {
     const pkgManager = (options.packageManager || 'pnpm') as PackageManager
-    const installFlag = options.install || false
+    const skipInstallFlag = options.skipInstall || false
 
     if (!['npm', 'yarn', 'pnpm'].includes(pkgManager)) {
       logger.error(`Unsupported package manager: ${pkgManager}`)
@@ -67,7 +67,7 @@ export async function lockfileCheck(options: LockfileCheckOptions = {}): Promise
 
     if (needSync) {
       logger.warn('Lockfile has been updated!')
-      if (installFlag) {
+      if (!skipInstallFlag) {
         await installDependencies(pkgManager)
       }
     }

test/cli.test.ts

@@ -155,23 +155,23 @@ describe('cli', () => {
   })
 
   it('runs lockfile-check command with options', async () => {
-    await runCli(['lockfile-check', '--packageManager', 'npm', '--install'])
+    await runCli(['lockfile-check', '--packageManager', 'npm', '--skip-install'])
 
     expect(indexMock.lockfileCheck).toHaveBeenCalledWith(
       expect.objectContaining({
         packageManager: 'npm',
-        install: true,
+        skipInstall: true,
       }),
     )
   })
 
   it('supports short flags for lockfile-check', async () => {
-    await runCli(['lockfile-check', '-m', 'yarn', '-i'])
+    await runCli(['lockfile-check', '-m', 'yarn', '-s'])
 
     expect(indexMock.lockfileCheck).toHaveBeenCalledWith(
       expect.objectContaining({
         packageManager: 'yarn',
-        install: true,
+        skipInstall: true,
       }),
     )
   })

test/lockfileCheck.test.ts

@@ -131,22 +131,40 @@ describe('lockfileCheck', () => {
       await expect(lockfileCheck({ packageManager: 'yarn' })).resolves.toBeUndefined()
     })
 
-    it('should install dependencies when install flag is true and lockfile updated', async () => {
+    it('should install dependencies by default when lockfile updated', async () => {
       const { x: mockExec } = await import('tinyexec')
       vi.mocked(mockExec)
         .mockResolvedValueOnce({ stdout: 'pnpm-lock.yaml\n' } as any)
         .mockResolvedValueOnce(undefined as any)
 
-      await lockfileCheck({ install: true })
+      await lockfileCheck()
 
       expect(mockExec).toHaveBeenCalledWith('pnpm', ['install'], { throwOnError: true })
     })
 
+    it('should not install when skipInstall flag is true and lockfile updated', async () => {
+      const { x: mockExec } = await import('tinyexec')
+      vi.mocked(mockExec).mockResolvedValue({ stdout: 'pnpm-lock.yaml\n' } as any)
+
+      const loggerMock = await import('rslog')
+      const mockWarn = vi.spyOn(loggerMock.logger, 'warn')
+
+      const lockfileModule = await import('../src/lockfileCheck')
+      const spyInstall = vi.spyOn(lockfileModule, 'installDependencies')
+
+      await lockfileCheck({ skipInstall: true })
+
+      expect(mockExec).toHaveBeenCalledWith('git', ['diff', '--name-only', 'ORIG_HEAD', 'HEAD'], { throwOnError: true })
+      expect(mockExec).not.toHaveBeenCalledWith('pnpm', ['install'], { throwOnError: true })
+      expect(spyInstall).not.toHaveBeenCalled()
+      expect(mockWarn).toHaveBeenCalledWith('Lockfile has been updated!')
+    })
+
     it('should not install when lockfile is not updated', async () => {
       const { x: mockExec } = await import('tinyexec')
       vi.mocked(mockExec).mockResolvedValue({ stdout: 'test.txt\n' } as any)
 
-      await lockfileCheck({ install: true })
+      await lockfileCheck()
 
       expect(mockExec).toHaveBeenCalledWith('git', ['diff', '--name-only', 'ORIG_HEAD', 'HEAD'], { throwOnError: true })
       expect(mockExec).not.toHaveBeenCalledWith('pnpm', ['install'], { throwOnError: true })
@@ -161,7 +179,7 @@ describe('lockfileCheck', () => {
       const loggerMock = await import('rslog')
       const mockError = vi.spyOn(loggerMock.logger, 'error')
 
-      await expect(lockfileCheck({ install: true })).resolves.toBeUndefined()
+      await expect(lockfileCheck()).resolves.toBeUndefined()
       expect(mockError).toHaveBeenCalledWith('Error checking lockfile sync:', expect.any(Error))
     })
   })