Ar projekt.json santykinių kelių pasaulinius kelių slapyvardžius gali tvarkyti Nx arba kampinė schema?

„Nx Monorepos“ kelio konfigūracijos supaprastinimas

Gali būti sunku valdyti maršrutus didelio masto Nx monorepo, ypač dirbant su santykiniais keliais project.json failą. Komandos plečiasi ir katalogų struktūros keičiasi, o tai dažnai lemia dideles priežiūros išlaidas. Santykiniai keliai tokiais klavišais kaip $schema, kurios veda prie schemų ir konfigūracijų projekto viduje, yra vienas iš to pavyzdžių.

Šiuo metu kūrėjai turi daug pastangų ir klaidų atnaujinti šiuos santykinius kelius kiekvieną kartą, kai pasikeičia aplanko struktūra. Tai ypač pasakytina apie projektus, kurie kuria arba konfigūruoja naujas Angular programas naudojant automatizuotus įrankius arba VSCode papildinius. Procesas gali būti sutrikdytas ir galimos netinkamos konfigūracijos dėl nuolatinio atnaujinimo reikalavimo.

Pridėjus visuotinį kelio slapyvardį, pvz @darbo sritis, galėtų išspręsti šią problemą pakeitus visus santykinius maršrutus ir supaprastinus katalogų administravimą. Kūrėjai gali sumažinti konfigūracijos klaidų tikimybę ir panaikinti reikalavimą rankiniu būdu atnaujinti naudodami slapyvardžius.

Šiame straipsnyje bus nagrinėjama, ar Nx arba Kampinės schemos Šiuo metu palaiko tokius pasaulinius kelių slapyvardžius ir tiria galimas alternatyvas ar sprendimus, kaip efektyviau valdyti kelių monorepose.

Kelio slapyvardžių valdymo automatizavimas Nx Monorepo

Pirmajame siūlomame scenarijaus pavyzdyje daugiausia dėmesio skiriama pasaulinių kelių slapyvardžių, pvz., pakeitimo automatizavimui @darbo sritis, su santykiniais keliais project.json failus. Naudojant Node.js, tai yra užpakalinis sprendimas, kai scenarijus katalogų struktūroje ieško projekto konfigūracijos failų. Kūrėjai gali keisti kelius be rankinio įsikišimo, naudodami pagrindines šio scenarijaus komandas, pvz. skaitykite failų sinchronizavimą ir writeFileSync, kurie yra specialiai sukurti šiems konfigūracijos failams pakeisti. Naudojant šį metodą, konfigūracija tampa mažiau jautri kūrimo aplinkos gedimams ir reikalauja mažiau rankinių pakeitimų dėl katalogo išdėstymo pakeitimų.

Norėdami tai padaryti, scenarijus pirmiausia pereina aplankus readdirSync rasti kiekvieną įvykį project.json Nx darbo srityje. The lstatSync komanda nustato, ar a project.json Failas yra failas arba katalogas, kai jis randamas, todėl scenarijus gali redaguoti tik susijusius failus. Jis pakeičia visuotinį slapyvardį bet kokiais santykiniais maršrutais, nukreiptais į „node_modules“, JSON formatu nustačius raktą „$schema“. Galiausiai kūrėjai gali pasikliauti sklandžia ir automatizuota procedūra kaip writeFileSync garantuoja, kad modifikuoti keliai bus įrašyti atgal į failą ir modifikacijos bus įvykdytos.

Antrasis scenarijaus pavyzdys sprendžia tą pačią problemą naudojant Kampinės schemos, tačiau tai daroma pastolių kūrimo arba programos modifikavimo etape. „Angular“ kodui generuoti dažnai naudojamos schemos ir apsilankymas komanda yra būtina šiame procese. Šiai funkcijai priskirta užduotis yra ieškoti virtualiame failų medyje, rasti projekto konfigūracijos failus ir pakeisti „$schema“ kelią tuose failuose, kad būtų naudojamas visuotinis slapyvardis. Siekiant užtikrinti, kad failai būtų nuskaitomi, redaguojami ir įrašomi atgal į darbo sritį, naudojant tinkamą kelio konfigūraciją, JSON.parse ir perrašyti yra naudojami.

Abiejų šių strategijų tikslas yra padaryti didelius Nx monorepos kelių slapyvardžiai lengviau prižiūrėti. Nors „Angular Schematics“ sprendimas puikiai tinka kūrėjams, norintiems užtikrinti, kad naujai sukurti projektai arba pataisymai automatiškai naudotų visuotinį slapyvardį, Node.js technika gali būti naudojama atskirai, norint nuskaityti ir atnaujinti esamus projektus. Kadangi šie scenarijai yra moduliniai ir daugkartinio naudojimo, juos galima išplėsti įtraukiant daugiau project.json raktus, kuriems reikia keisti kelią. Tai padidina darbo vietos lankstumą ir lengvesnę priežiūrą, nes laikui bėgant ji plečiasi.

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

Kelio valdymo tobulinimas dideliuose Nx Monorepos

Santykinių kelių išlaikymas skirtinguose projektų konfigūracijos failuose yra viena didžiausių problemų administruojant didelio masto Nx monorepo. Keičiantis katalogo struktūrai, šie keliai, kaip ir tie, kurie nukreipia į schemas project.json failą – gali būti sudėtinga valdyti. Kūrimo procesai tampa mažiau veiksmingi, kai komandos patiria problemų, kai keičiasi katalogai ir trūksta vienodo požiūrio į kelius. Pridedama pasaulinio kelio slapyvardžiai, patinka @darbo sritis, gali žymiai sumažinti pastangas išlaikyti šiuos maršrutus.

Pasaulinio maršruto slapyvardžio naudojimas ne tik sumažina poreikį dažnai atnaujinti rankiniu būdu, bet ir sustiprina projekto konfigūracijos patikimumą. Komandos gali sutelkti dėmesį į savo kūrimo darbą, nesijaudindamos dėl kelio modifikacijų, abstrahuodami santykinę kelio specifiką. Tai labai naudinga kuriant ir konfigūruojant Angular programas su automatizavimo įrankiais, pvz., VSCode plėtiniai. Kai įdiegta vieninga kelio slapyvardžių sistema, šie plėtiniai gali veikti sklandžiau ir išvengti klaidingų konfigūracijų, atsirandančių dėl netinkamos kelio skyros.

Visuotinio kelio slapyvardžiai visuose raktuose project.json Nx ir Angular įrankiai, kurie šiuo metu yra prieinami, nėra palaikomi, tačiau tai būtų naudingas ekosistemos papildymas. Pridėjus visuotinio kelio slapyvardžių palaikymą, būtų supaprastintas konfigūracijos valdymas ir padidintas projekto struktūros pritaikomumas. Pateikus funkcijos užklausą Nx arba Angular komandoms, šią funkciją galima įtraukti į būsimus leidimus, o tai būtų naudinga daugeliui įmonių, kurios tvarko sudėtingus monorepozicijas.