Vai globālo ceļu aizstājvārdus relatīvajiem ceļiem failā project.json var apstrādāt, izmantojot Nx vai leņķiskās shēmas?

Ceļa konfigurācijas racionalizēšana Nx Monorepos

Var būt grūti pārvaldīt maršrutus liela mēroga Nx monorepo, it īpaši, strādājot ar relatīviem ceļiem project.json failu. Komandas paplašinās un direktoriju struktūras mainās, kas bieži rada lielas uzturēšanas izmaksas. Relatīvie ceļi taustiņos, piemēram $schema, kas noved pie shēmām un konfigurācijām projektā, ir viens no tā piemēriem.

Izstrādātājiem pašlaik ir smagi un kļūdaini jāatjaunina šie relatīvie ceļi katru reizi, kad mainās mapes struktūra. Tas jo īpaši attiecas uz projektiem, kas veido vai konfigurē jaunas Angular lietojumprogrammas, izmantojot automatizētus rīkus vai VSCode spraudņus. Process var tikt traucēts un iespējamas nepareizas konfigurācijas var rasties pastāvīgas prasības pēc jauninājumiem.

Pievienojot globālā ceļa aizstājvārdu, piemēram @darbvieta, varētu atrisināt šo problēmu, aizstājot visus relatīvos maršrutus un racionalizējot direktoriju administrēšanu. Izstrādātāji var samazināt konfigurācijas kļūdu iespējamību un atteikties no manuālas atjaunināšanas, izmantojot aizstājvārdus.

Šajā rakstā tiks noskaidrots, vai Nx vai Leņķiskās shēmas pašlaik atbalsta šādus globālos ceļu aizstājvārdus un izpēta iespējamās alternatīvas vai risinājumus efektīvākai ceļu pārvaldībai monorepos.

Ceļa aizstājvārdu pārvaldības automatizācija Nx Monorepo

Pirmais piedāvātais skripta piemērs koncentrējas uz globālo ceļu aizstājvārdu, piemēram, globālo ceļu aizstājvārdu aizstāšanas procesa automatizāciju @darbvieta, ar relatīvajiem ceļiem iekšā project.json failus. Izmantojot Node.js, šis ir aizmugursistēmas risinājums, kurā skripts direktoriju struktūrā meklē projekta konfigurācijas failus. Izstrādātāji var modificēt ceļus bez manuālas iejaukšanās, izmantojot šī skripta būtiskās komandas, piemēram, lasīt FileSync un writeFileSync, kas ir īpaši izveidoti, lai mainītu šos konfigurācijas failus. Izmantojot šo metodi, konfigurācija kļūst mazāk uzņēmīga pret defektiem izstrādes vidē un prasa mazāk manuālu modifikāciju direktoriju izkārtojuma izmaiņu dēļ.

Lai to izdarītu, skripts vispirms šķērso mapes, izmantojot readdirSync lai atrastu katru gadījumu project.json Nx darbvietā. The lstatSync komanda nosaka, vai a project.json Fails ir fails vai direktorijs, kad tas ir atrasts, ļaujot skriptam rediģēt tikai atbilstošos failus. Tas aizstāj globālo aizstājvārdu jebkuriem relatīviem maršrutiem, kas norāda uz "node_modules" pēc atslēgas "$schema" atrašanas JSON formātā. Galu galā izstrādātāji var paļauties uz vienmērīgu un automatizētu procedūru kā writeFileSync garantē, ka modificētie ceļi tiek ierakstīti atpakaļ failā un izmaiņas tiek veiktas.

Otrais skripta piemērs risina to pašu problēmu, izmantojot Leņķiskās shēmas, bet tas tiek darīts sastatņu veidošanas vai lietojumprogrammas modificēšanas stadijā. Programmā Angular koda ģenerēšanai bieži tiek izmantotas shēmas, un apmeklējums komanda ir būtiska šajā procesā. Šai funkcijai piešķirtais uzdevums ir meklēt virtuālajā failu kokā, atrast projekta konfigurācijas failus un pēc tam mainīt ceļu "$schema" šajos failos, lai izmantotu globālo aizstājvārdu. Lai garantētu, ka faili tiek lasīti, rediģēti un ierakstīti atpakaļ darbvietā ar pareizu ceļa konfigurāciju, JSON.parse un pārrakstīt tiek izmantoti.

Abu šo stratēģiju mērķis ir izveidot lielus Nx monorepos ceļu aizstājvārdi vieglāk uzturēt. Lai gan Angular Schematics risinājums ir lieliski piemērots izstrādātājiem, kuri vēlas pārliecināties, ka jaunizveidotie projekti vai pārskatījumi automātiski izmanto globālo aizstājvārdu, Node.js tehniku ​​​​var izmantot neatkarīgi, lai skenētu un atjauninātu esošos projektus. Tā kā šie skripti ir modulāri un atkārtoti lietojami, tos var paplašināt, iekļaujot citus project.json atslēgas, kurām nepieciešamas ceļa izmaiņas. Tas palielina darbvietas elastību un vieglu apkopi, jo laika gaitā tā paplašinās.

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

Ceļu pārvaldības uzlabošana lielajos Nx Monorepos

Relatīvo ceļu uzturēšana dažādos projekta konfigurācijas failos ir viena no lielākajām problēmām liela mēroga administrēšanā Nx monorepo. Mainoties direktoriju struktūrai, šie ceļi, piemēram, tie, kas norāda uz shēmām project.json failu — var būt grūti pārvaldīt. Izstrādes procesi kļūst mazāk efektīvi, ja komandām rodas problēmas, mainoties direktorijiem un trūkst vienotas pieejas ceļu apstrādei. Pievienošana globālo ceļu aizstājvārdi, patīk @darbvieta, var ievērojami samazināt pūles, kas saistītas ar šo maršrutu uzturēšanu.

Papildus tam, ka tiek samazināta nepieciešamība pēc biežas manuālas atjaunināšanas, globālā maršruta aizstājvārda izmantošana stiprina projekta konfigurācijas noturību. Komandas var koncentrēties uz savu izstrādes darbu, neuztraucoties par ceļa izmaiņām, abstrahējot relatīvo ceļa specifiku. Tas ir ļoti noderīgi, ģenerējot un konfigurējot Angular lietotnes ar tādiem automatizācijas rīkiem kā VSCode paplašinājumi. Ja ir izveidota vienota ceļa aizstājvārdu sistēma, šie paplašinājumi var darboties raitāk un izvairīties no nepareizas konfigurācijas, ko izraisa nepareiza ceļa izšķirtspēja.

Globālo ceļu aizstājvārdi visās ievades atslēgās project.json pašlaik pieejamie Nx un Angular rīki netiek atbalstīti, taču tas būtu noderīgs ekosistēmas papildinājums. Globālā ceļa aizstājvārda atbalsta pievienošana racionalizētu konfigurācijas pārvaldību un palielinātu projekta struktūras pielāgošanās spēju. Funkcijas pieprasījuma iesniegšana Nx vai Angular komandām var nodrošināt šīs funkcijas iekļaušanu gaidāmajos laidienos, kas būtu izdevīgi daudziem uzņēmumiem, kas apstrādā sarežģītus monorepos.