Průvodce ignorováním uzamčení balíčku pro závislosti Git

Řešení problémů se závislostí Git:

Při práci se závislostmi npm vyřešenými z úložiště Git se můžete setkat s problémy souvisejícími s přítomností souboru package-lock.json v repozitáři Git. To může vést k problémům, zejména pokud soubor zámku obsahuje odkazy vyřešené z registru, ke kterému nemáte přístup.

V takových případech má npm tendenci klonovat úložiště a spouštět npm install uvnitř závislosti, což může způsobit komplikace. Tento článek se zabývá tím, jak přepsat chování npm tak, aby ignoroval soubory uzamčení balíčků v rámci závislostí Git a zajistil hladkou instalaci prostřednictvím registru npmjs.

Řešení problémů s Package-lock.json v závislostech Git

Poskytnuté skripty jsou navrženy tak, aby řešily problém nechtěného package-lock.json soubory v závislostech Git během npm install. První skript je bash skript, který spustí příkaz po klonování, aby našel a odstranil vše package-lock.json soubory v node_modules adresář. Toho je dosaženo pomocí find příkaz v kombinaci s -name a -type f možnosti, za nimiž následuje -delete možnost odstranit soubory. Tento skript zajišťuje, že všechny soubory zámku v rámci závislostí budou předtím odstraněny npm install je spuštěn, což umožňuje, aby byly balíčky vyřešeny z registru npmjs namísto soukromého registru.

Druhý skript upravuje .npmrc přepíše výchozí nastavení registru a zajistí, že balíčky budou vždy načteny z registru npmjs. Třetí skript je předinstalační skript Node.js, který programově vyhledává a odstraňuje package-lock.json soubory v rámci node_modules adresář. Tento skript používá metody Node.js jako unlinkSync a lstatSync pro manipulaci se soubory. Implementací těchto řešení mohou vývojáři předejít problémům způsobeným zamykacími soubory v závislostech Git a zajistit hladkou instalaci balíčků ze správného registru.

#!/bin/bash
# Post-clone script to remove package-lock.json from dependencies
find node_modules -name "package-lock.json" -type f -delete
npm install

// .npmrc file in the project root
registry=https://registry.npmjs.org/
@your-scope:registry=https://registry.npmjs.org/
always-auth=false
strict-ssl=true

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

// ./scripts/preinstall.js
const fs = require('fs');
const path = require('path');
const nodeModulesPath = path.join(__dirname, '../node_modules');

function deletePackageLock(dir) {
  fs.readdirSync(dir).forEach(file => {
    const fullPath = path.join(dir, file);
    if (fs.lstatSync(fullPath).isDirectory()) {
      deletePackageLock(fullPath);
    } else if (file === 'package-lock.json') {
      fs.unlinkSync(fullPath);
      console.log(`Deleted: ${fullPath}`);
    }
  });
}

deletePackageLock(nodeModulesPath);

// package.json
"scripts": {
  "preinstall": "find ./node_modules -type f -name package-lock.json -delete"
}

Strategie pro správu závislostí Git v npm

Další aspekt, který je třeba vzít v úvahu při práci se závislostmi Git npm je použití vlastních skriptů a háčků pro správu instalačního procesu. Místo toho, abyste se spoléhali pouze na npm konfigurace, integrační nástroje jako Husky může automatizovat proces úpravy závislostí před jejich instalací. To může zahrnovat skripty k odstranění nebo úpravě package-lock.json soubory, což zajistí, že závislosti jsou správně vyřešeny z požadovaného registru.

Navíc využití CI/CD potrubí může být účinným přístupem. Nakonfigurováním kanálu tak, aby spouštěl specifické předinstalační skripty, můžete zajistit, že úložiště package-lock.json soubor nezasahuje do procesu instalace. Tato metoda může poskytnout robustnější a automatizované řešení, které redukuje manuální kroky, které musí vývojáři podniknout, aby mohli efektivně spravovat závislosti.