Ali lahko vzdevke globalnih poti za relativne poti v project.json obravnava Nx ali Angular Schematics?

Poenostavitev konfiguracije poti v Nx Monorepos

Lahko je težko upravljati poti v obsežnem monorepu Nx, zlasti pri delu z relativnimi potmi v project.json datoteka. Ekipe se širijo in strukture imenikov spreminjajo, kar pogosto povzroči visoke stroške vzdrževanja. Relativne poti v ključih, kot je $shema, ki vodijo do shem in konfiguracij znotraj projekta, so en primer tega.

Razvijalci morajo trenutno te relativne poti te relativne poti naporno in pogosto posodabljati vsakič, ko se spremeni struktura mape. To še posebej velja za projekte, ki gradijo ali konfigurirajo nove aplikacije Angular z uporabo avtomatiziranih orodij ali vtičnikov VSCode. Postopek je lahko moten in morebitne napačne konfiguracije so lahko posledica stalnih zahtev po nadgradnjah.

Dodajanje vzdevka globalne poti, npr @delovni prostor, bi lahko to težavo rešil z zamenjavo vseh relativnih poti in poenostavitvijo administracije imenikov. Razvijalci lahko z uporabo vzdevkov zmanjšajo možnost konfiguracijskih napak in odpravijo zahtevo po ročnih posodobitvah.

Ta članek bo raziskal, ali Nx oz Kotne sheme trenutno podpira takšne globalne vzdevke poti in raziskuje možne alternative ali rešitve za učinkovitejše upravljanje poti v monorepojih.

Avtomatiziranje upravljanja vzdevkov poti v Nx Monorepo

Prvi ponujeni primer skripta se osredotoča na avtomatizacijo postopka zamenjave vzdevkov globalnih poti, kot je npr @delovni prostor, z relativnimi potmi v project.json datoteke. Uporaba Node.js, je to zaledna rešitev, kjer skript išče konfiguracijske datoteke projekta v strukturi imenika. Razvijalci lahko spremenijo poti brez potrebe po ročnem posredovanju z uporabo bistvenih ukazov v tem skriptu, kot je npr. readFileSync in writeFileSync, ki so narejene posebej za spreminjanje teh konfiguracijskih datotek. Z uporabo te metode postane konfiguracija manj dovzetna za napake v razvojnem okolju in zahteva manj ročnih sprememb zaradi sprememb v postavitvi imenika.

Da bi to naredil, skript najprej prečka mape z uporabo readdirSync najti vsak pojav project.json v delovnem prostoru Nx. The lstatSync ukaz določa, ali a project.json datoteka je datoteka ali imenik, ko je najdena, kar skriptu omogoča urejanje samo ustreznih datotek. Nadomesti globalni vzdevek za vse relativne poti, ki kažejo na "node_modules", potem ko najde ključ "$schema" v formatu JSON. Konec koncev se razvijalci lahko zanesejo na nemoten in avtomatiziran postopek kot writeFileSync zagotavlja, da so spremenjene poti zapisane nazaj v datoteko in da so spremembe potrjene.

Drugi primer skripta obravnava isto težavo z uporabo Kotne sheme, vendar to počne na stopnji gradnje ali spreminjanja aplikacije. V Angularju se sheme pogosto uporabljajo za ustvarjanje kode in obisk ukaz je bistvenega pomena v tem procesu. Naloga, dodeljena tej funkciji, je iskanje po navideznem datotečnem drevesu, iskanje konfiguracijskih datotek projekta in nato sprememba poti »$schema« v teh datotekah, da se uporabi globalni vzdevek. Da bi zagotovili, da se datoteke berejo, urejajo in zapisujejo nazaj v delovni prostor s pravilno konfiguracijo poti, JSON.parse in prepisati se uporabljajo.

Cilj obeh strategij je ustvariti velike monorepo Nx. vzdevki poti lažje vzdrževati. Medtem ko je rešitev Angular Schematics popolna za razvijalce, ki se želijo prepričati, da na novo proizvedeni projekti ali revizije samodejno uporabljajo globalni vzdevek, se lahko tehnika Node.js uporablja samostojno za skeniranje in posodabljanje obstoječih projektov. Ker so ti skripti modularni in jih je mogoče ponovno uporabiti, jih je mogoče razširiti in vključiti več project.json ključi, ki potrebujejo spremembe poti. To poveča fleksibilnost delovnega prostora in enostavnost vzdrževanja, saj se sčasoma širi.

// 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;
  };
}

Izboljšanje upravljanja poti v velikih Nx Monoreposih

Ohranjanje relativnih poti v različnih projektnih konfiguracijskih datotekah je ena največjih težav pri upravljanju velikega obsega Nx monorepo. Ko se struktura imenika spreminja, se te poti – tako kot tiste, ki kažejo na sheme v project.json datoteko—upravljanje lahko postane zahtevno. Razvojni procesi postanejo manj učinkoviti, ko se ekipe srečujejo s težavami, ko se imeniki spremenijo in nimajo enotnega pristopa za obravnavo poti. Dodajanje vzdevki globalnih poti, všeč @delovni prostor, lahko bistveno zmanjša trud, ki je vložen pri vzdrževanju teh poti.

Poleg zmanjšanja potrebe po pogostih ročnih posodobitvah uporaba vzdevka globalne poti krepi robustnost konfiguracije projekta. Ekipe se lahko osredotočijo na svoje razvojno delo, ne da bi jim bilo treba skrbeti za spremembe poti, tako da abstrahirajo relativne posebnosti poti. To je zelo uporabno pri ustvarjanju in konfiguriranju aplikacij Angular z orodji za avtomatizacijo, kot je npr Razširitve VSCode. Ko je vzpostavljen sistem poenotenih vzdevkov poti, lahko te razširitve delujejo bolj gladko in se izognejo napačnim konfiguracijam, ki jih povzročajo neustrezne ločljivosti poti.

Globalni vzdevki poti v vseh ključih project.json niso izvorno podprta z orodji Nx in Angular, ki sta trenutno na voljo, vendar bi bil to koristen dodatek k ekosistemu. Dodajanje podpore za vzdevek globalne poti bi poenostavilo upravljanje konfiguracije in povečalo prilagodljivost strukture projekta. Predložitev zahteve za funkcijo ekipam Nx ali Angular lahko omogoči vključitev te funkcije v prihajajoče izdaje, kar bi bilo koristno za številna podjetja, ki se ukvarjajo z zapletenimi monoreposi.