Kas projekti.jsoni suhteliste teede globaalseid tee varjunimesid saab hallata Nx või Angular Schematics abil?

Nx Monorepos tee konfiguratsiooni sujuvamaks muutmine

Suuremahulises Nx monorepos võib olla keeruline marsruute hallata, eriti kui töötate suhteliste teedega projekt.json faili. Meeskonnad laienevad ja kataloogistruktuurid muutuvad, mis põhjustab sageli suuri hoolduskulusid. Suhtelised teed võtmetes nagu $skeem, mis viivad projektisisese skeemide ja konfiguratsioonideni, on üks näide sellest.

Arendajad peavad praegu neid suhtelisi teid iga kord, kui kausta struktuur muutub, töömahukalt ja vigade eest värskendama. See kehtib eriti projektide kohta, mis loovad või konfigureerivad uusi Angular-rakendusi automatiseeritud tööriistade või VSCode'i pistikprogrammide abil. Protsess võib olla häiritud ja võimalikud väärkonfiguratsioonid võivad tuleneda pidevast uuenduste vajadusest.

Globaalse tee aliase lisamine, näiteks @tööruum, võiks selle probleemi lahendada, asendades kõik suhtelised marsruudid ja lihtsustades kataloogide haldamist. Arendajad võivad minimeerida konfiguratsioonivigade võimalust ja kaotada käsitsi värskendamise nõude, kasutades varjunimesid.

See artikkel uurib, kas Nx või Nurkskeem toetab praegu selliseid globaalseid tee varjunimesid ja uurib võimalikke alternatiive või lahendusi tõhusamaks teehalduseks monorepos.

Tee aliase haldamise automatiseerimine Nx Monorepos

Esimene pakutud skriptinäide keskendub selliste globaalsete tee varjunimede asendamise protsessi automatiseerimisele @tööruum, suhteliste teedega sisse projekt.json failid. Kasutades Node.js, see on taustalahendus, kus skript otsib kataloogistruktuurist projekti konfiguratsioonifaile. Arendajad saavad muuta teid ilma käsitsi sekkumiseta, kasutades selle skripti olulisi käske, näiteks loe FileSync ja writeFileSync, mis on spetsiaalselt loodud nende konfiguratsioonifailide muutmiseks. Seda meetodit kasutades muutub konfiguratsioon arenduskeskkonna tõrgete suhtes vähem vastuvõtlikuks ja nõuab kataloogi paigutuse muudatuste tõttu vähem käsitsi muutmist.

Selleks läbib skript esmalt kaustad kasutades readdirSync et leida iga juhtum projekt.json tööalal Nx. The lstatSync käsk määrab, kas a projekt.json fail on fail või kataloog, kui see on leitud, võimaldades skriptil redigeerida ainult asjakohaseid faile. See asendab globaalse pseudonüümi kõigi suhteliste marsruutide jaoks, mis osutavad "node_modules" pärast võtme "$schema" leidmist JSON-vormingus. Lõppkokkuvõttes saavad arendajad tugineda sujuvale ja automatiseeritud protseduurile nagu writeFileSync garanteerib, et muudetud teed kirjutatakse faili tagasi ja muudatused on tehtud.

Teine skripti näide käsitleb sama probleemi kasutades Nurkskeem, kuid see teeb seda tellingute ehitamise või rakenduse muutmise etapis. Angularis kasutatakse koodi genereerimiseks sageli skeeme ja külastada käsk on selles protsessis hädavajalik. Sellele funktsioonile määratud ülesanne on otsida virtuaalsest failipuust, leida projekti konfiguratsioonifailid ja seejärel muuta nendes failides teed "$schema", et kasutada globaalset varjunime. Failide lugemise, redigeerimise ja õige teekonfiguratsiooniga tööruumi tagasi kirjutamise tagamiseks, JSON.parse ja üle kirjutada kasutatakse.

Mõlema strateegia eesmärk on teha suuri Nx monoreposid. tee varjunimed lihtsam hooldada. Kuigi Angular Schematics lahendus sobib suurepäraselt arendajatele, kes soovivad tagada, et äsja toodetud projektid või versioonid kasutaksid automaatselt globaalset varjunime, võib Node.js-i tehnikat kasutada iseseisvalt olemasolevate projektide skannimiseks ja värskendamiseks. Kuna need skriptid on modulaarsed ja korduvkasutatavad, võidakse neid veelgi laiendada projekt.json võtmed, mis vajavad tee muutmist. See suurendab tööruumi paindlikkust ja hoolduse lihtsust, kuna see aja jooksul laieneb.

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

Suure Nx Monorepose teehalduse täiustamine

Suhteliste teede säilitamine erinevate projekti konfiguratsioonifailide vahel on suuremahulise halduse üks suuremaid probleeme Nx monorepo. Kui kataloogi struktuur muutub, muutuvad need teed, nagu need, mis osutavad skeemidele projekt.json fail – võib olla keeruline hallata. Arendusprotsessid muutuvad vähem tõhusaks, kui meeskonnad kogevad kataloogide muutumisel probleeme ja neil puudub ühtne lähenemisviis teede haldamiseks. Lisamine globaalsete tee varjunimed, nagu @tööruum, võib oluliselt vähendada nende marsruutide hooldamisega seotud pingutusi.

Lisaks sagedase käsitsi värskendamise vajaduse vähendamisele tugevdab globaalse marsruudi pseudonüümi kasutamine projekti konfiguratsiooni tugevust. Meeskonnad võivad keskenduda oma arendustööle, ilma et peaksid muretsema tee muudatuste pärast, võttes kõrvale suhtelise tee spetsiifikat. See on väga kasulik Angular-rakenduste loomisel ja konfigureerimisel automatiseerimistööriistadega, näiteks VSCode laiendused. Kui paigas on ühtne tee pseudonüümisüsteem, saavad need laiendused sujuvamalt toimida ja vältida valest teeresolutsioonist tingitud valesid konfiguratsioone.

Globaalne tee varjunimed kõigis sisestusklahvides projekt.json praegu saadaolevad Nx- ja Angular-tööriistad ei toeta neid, kuid see oleks ökosüsteemile kasulik täiendus. Globaalse tee aliase toe lisamine lihtsustaks konfiguratsioonihaldust ja suurendaks projekti struktuuri kohandatavust. Funktsioonitaotluse esitamine Nx-i või Angulari meeskondadele võib võimaldada selle funktsiooni kaasamist tulevastesse väljalasetesse, mis oleks kasulik paljudele keerukaid monoreposi käsitlevatele ettevõtetele.