How to unify the use of package manager in a project?

Problems found in collaborative development , Because different package managers are used , As a result, all normal code in the local development environment is pushed to git Later, it failed unexpectedly in the construction on the computer of my colleagues , Why is that ？ Let's check at the end node_module I found , Different package managers lead to the installation of different dependencies, which eventually leads to this problem .

Here we restrict the use of the same package manager through a pre installation script , Use at the same time yarn.lock or package-lock.json To lock our dependent versions .

Here are some solutions

One 、UserAgent programme

1. adopt npm_config_user_agent To get the name and version of the currently executing package manager
2. Restrict the installation of non allowed package managers by comparing names

Complete code

// preinstall.js
const allowPM = 'yarn'
const userAgent = process.env.npm_config_user_agent || ''
if (userAgent !== '') {
    
  const pmName = userAgent.substring(0, userAgent.indexOf('/'))
  if (pmName !== allowPM) {
    
    console.warn(
      `\u001b[33m This repository requires using ${
      allowPM} as the package manager for scripts to work properly.\u001b[39m\n`
    )
    process.exit(1)
  }
}

// package.json  Add command 
{
    
  "scripts": {
    
    "preinstall": "node ./preinstall.js"
  }
}

Two 、ExecPath programme

1. adopt npm_execpath To get the absolute path of the currently executing package manager
2. Restrict non allowed package managers from performing installation by regularly matching names in the path

Complete code

const allowPM = 'yarn'
const execpath = process.env.npm_execpath || ''
if (!new RegExp(`${
      allowPM}`).test(execpath)) {
    
  console.warn(
    `\u001b[33m This repository requires using ${
      allowPM} as the package manager for scripts to work properly.\u001b[39m\n`
  )
  process.exit(1)
}

// package.json  Add command 
{
    
  "scripts": {
    
    "preinstall": "node ./preinstall.js"
  }
}

3、 ... and 、only-allow programme

only-allow by pnpm The package manager organizes open source restriction schemes ,only-allow For internal use which-pm-runs To obtain the currently executed package manager, and then judge and intercept , Only after installation depends on adjustment. scripts The content of the , stay vite Used in the project .

// package.json  This is the only step to add a command 
{
    
  "scripts": {
    
    "preinstall": "npx only-allow yarn"
  }
}

But in NPM v7 In later versions , The preinstallation script runs after the dependencies are installed , This undermines the expected behavior .
Can track official issue Treatment progress of ：https://github.com/npm/cli/issues/2660