Mohou být globální aliasy cest pro relativní cesty v project.json zpracovány pomocí Nx nebo Angular Schematics?

Zjednodušení konfigurace cesty v Nx Monorepos

Může být obtížné spravovat trasy ve velkém Nx monorepo, zejména při práci s relativními cestami v project.json soubor. Týmy se rozšiřují a struktura adresářů se mění, což často vede k vysokým nákladům na údržbu. Relativní cesty v klíčích jako $ schéma, které vedou ke schématům a konfiguracím uvnitř projektu, jsou toho příkladem.

Vývojáři v současnosti musí tyto relativní cesty pracně a náchylně k chybám aktualizovat pokaždé, když se změní struktura složek. To platí zejména pro projekty, které vytvářejí nebo konfigurují nové aplikace Angular pomocí automatizovaných nástrojů nebo pluginů VSCode. Proces může být přerušen a případné nesprávné konfigurace mohou být důsledkem neustálého požadavku na upgrady.

Přidání globálního aliasu cesty, např @pracovní prostor, by mohl tento problém vyřešit nahrazením všech relativních cest a zefektivněním správy adresářů. Vývojáři mohou minimalizovat pravděpodobnost chyb konfigurace a odstranit požadavek na ruční aktualizace pomocí aliasů.

Tento článek bude zkoumat, zda Nx nebo Úhlová schémata v současné době podporuje takovéto globální aliasy cest a zkoumá potenciální alternativy nebo řešení pro efektivnější správu cest v monorepo.

Automatizace správy aliasů cest v Nx Monorepo

První nabízený příklad skriptu se soustředí na automatizaci procesu nahrazování globálních aliasů cest, např @pracovní prostor, s relativními cestami v project.json soubory. Použití Node.js, jedná se o backendové řešení, kde skript hledá v adresářové struktuře konfigurační soubory projektu. Vývojáři mohou upravovat cesty bez nutnosti ručního zásahu pomocí základních příkazů v tomto skriptu, jako je např readFileSync a writeFileSync, které jsou speciálně vytvořeny ke změně těchto konfiguračních souborů. Použitím této metody se konfigurace stane méně náchylnou k chybám ve vývojovém prostředí a vyžaduje méně ručních úprav kvůli změnám v rozložení adresářů.

Aby to bylo možné, skript nejprve projde složky pomocí readdirSync najít každý výskyt project.json v pracovním prostoru Nx. The lstatSync příkaz určuje, zda a project.json file je soubor nebo adresář, jakmile je nalezen, což umožňuje skriptu upravovat pouze příslušné soubory. Nahrazuje globální alias pro všechny relativní trasy směřující na "node_modules" po nalezení klíče "$schema" ve formátu JSON. V konečném důsledku se vývojáři mohou spolehnout na hladký a automatizovaný postup jako writeFileSync zaručuje, že upravené cesty budou zapsány zpět do souboru a změny budou potvrzeny.

Druhý příklad skriptu řeší stejný problém pomocí Úhlová schémata, ale činí tak ve fázi lešení při vytváření nebo úpravě aplikace. V Angular se schémata často používají ke generování kódu a návštěva příkaz je v tomto procesu nezbytný. Úkolem přiřazeným k této funkci je prohledat strom virtuálních souborů, najít konfigurační soubory projektu a poté změnit cestu "$schema" v těchto souborech, aby bylo možné použít globální alias. Aby bylo zaručeno, že soubory budou čteny, upravovány a zapisovány zpět do pracovního prostoru se správnou konfigurací cesty, JSON.parse a přepsat se používají.

Cílem obou těchto strategií je vytvořit velká Nx monorepos' aliasy cesty snadnější na údržbu. Zatímco řešení Angular Schematics je perfektní pro vývojáře, kteří se chtějí ujistit, že nově vytvořené projekty nebo revize automaticky používají globální alias, techniku ​​Node.js lze použít nezávisle ke skenování a aktualizaci stávajících projektů. Protože jsou tyto skripty modulární a opakovaně použitelné, lze je rozšířit o další project.json klíče, které vyžadují úpravy cesty. To zvyšuje flexibilitu pracovního prostoru a snadnou údržbu, protože se postupem času rozšiřuje.

// Import required modules
const fs = require('fs');
const path = require('path');
// Define the path alias
const workspaceAlias = '@workspace';
// Function to replace relative paths in project.json
function updateProjectJson(filePath) {
  const projectJson = JSON.parse(fs.readFileSync(filePath, 'utf8'));
  const schemaPath = projectJson['$schema'];
  // Replace relative paths with global alias
  if (schemaPath.includes('../../../node_modules')) {
    projectJson['$schema'] = schemaPath.replace('../../../node_modules', `${workspaceAlias}/node_modules`);
    fs.writeFileSync(filePath, JSON.stringify(projectJson, null, 2));
    console.log(`Updated schema path in ${filePath}`);
  }
}
// Function to traverse directories and find all project.json files
function traverseDir(dir) {
  const files = fs.readdirSync(dir);
  files.forEach(file => {
    const fullPath = path.join(dir, file);
    if (fs.lstatSync(fullPath).isDirectory()) {
      traverseDir(fullPath);
    } else if (file === 'project.json') {
      updateProjectJson(fullPath);
    }
  });
}
// Start the directory traversal from the root of the workspace
const rootDir = path.resolve(__dirname, '../../');
traverseDir(rootDir);

import { Rule, Tree } from '@angular-devkit/schematics';
import { join } from 'path';
export function updateSchemaPaths(): Rule {
  return (tree: Tree) => {
    tree.getDir('/').visit((filePath) => {
      if (filePath.endsWith('project.json')) {
        const content = tree.read(filePath)?.toString();
        if (content) {
          const json = JSON.parse(content);
          if (json['$schema']) {
            json['$schema'] = json['$schema'].replace(
              '../../../node_modules',
              '@workspace/node_modules'
            );
            tree.overwrite(filePath, JSON.stringify(json, null, 2));
          }
        }
      }
    });
    return tree;
  };
}

Zlepšení správy cest ve velkých Nx Monorepos

Udržování relativních cest napříč různými konfiguračními soubory projektu je jedním z největších problémů při správě velkého rozsahu Nx monorepo. Jak se mění adresářová struktura, tyto cesty – jako ty, které ukazují na schémata v project.json soubor — může být obtížné spravovat. Vývojové procesy jsou méně efektivní, když týmy narazí na problémy při změně adresářů a postrádají jednotný přístup ke zpracování cest. Přidávání globální aliasy cest, jako @pracovní prostor, může výrazně snížit úsilí spojené s udržováním těchto tras.

Kromě snížení potřeby častých ručních aktualizací posiluje použití globálního aliasu trasy robustnost konfigurace projektu. Týmy se mohou soustředit na svou vývojovou práci, aniž by se musely starat o modifikace cesty tím, že abstrahují relativní specifika cesty. To je velmi užitečné při generování a konfiguraci aplikací Angular s automatizačními nástroji, jako je např rozšíření VSCode. Když je zaveden jednotný systém aliasů cest, mohou tato rozšíření fungovat plynuleji a vyhnout se nesprávným konfiguracím způsobeným nesprávným rozlišením cest.

Globální aliasy cesty napříč všemi klíči v project.json nejsou nativně podporovány nástroji Nx a Angular, které jsou v současné době k dispozici, ale byl by to užitečný doplněk k ekosystému. Přidání podpory globálního aliasu cesty by zefektivnilo správu konfigurace a zvýšilo přizpůsobivost struktury projektu. Odeslání žádosti o funkci týmům Nx nebo Angular může umožnit zahrnutí této funkce do nadcházejících verzí, což by bylo výhodné pro mnoho podniků, které zpracovávají složitá monorepo.