Чи можуть псевдоніми глобального шляху для відносних шляхів у project.json оброблятися Nx або Angular Schematics?

Оптимізація конфігурації шляху в Nx Monorepos

Може бути важко керувати маршрутами у великомасштабному монорепо Nx, особливо під час роботи з відносними шляхами в project.json файл. Команди розширюються, а структура каталогів змінюється, що часто призводить до великих витрат на обслуговування. Відносні шляхи в ключах, як $схема, які ведуть до схем і конфігурацій всередині проекту, є одним із прикладів цього.

Наразі розробникам доводиться кропітко та з ризиком помилок оновлювати ці відносні шляхи кожного разу, коли змінюється структура папок. Це особливо актуально для проектів, які створюють або налаштовують нові програми Angular за допомогою автоматизованих інструментів або плагінів VSCode. Процес може бути порушений і можливі неправильні конфігурації можуть бути результатом постійної потреби в оновленнях.

Додавання псевдоніма глобального шляху, наприклад @workspace, може вирішити цю проблему, замінивши всі відносні маршрути та оптимізувавши адміністрування каталогів. Розробники можуть мінімізувати ймовірність помилок конфігурації та відмовитися від необхідності оновлюватись вручну, використовуючи псевдоніми.

У цій статті буде досліджено, якщо Nx або Кутові схеми наразі підтримує такі псевдоніми глобальних шляхів і досліджує потенційні альтернативи або обхідні шляхи для ефективнішого керування шляхами в моносховищах.

Автоматизація керування псевдонімами шляхів у Nx Monorepo

Перший запропонований приклад сценарію зосереджується на автоматизації процесу заміни псевдонімів глобальних шляхів, наприклад @workspace, з відносними шляхами в project.json файли. Використання Node.js, це серверне рішення, де сценарій шукає файли конфігурації проекту в структурі каталогів. Розробники можуть змінювати шляхи без необхідності ручного втручання за допомогою основних команд у цьому сценарії, таких як readFileSync і writeFileSync, які створені спеціально для зміни цих конфігураційних файлів. За допомогою цього методу конфігурація стає менш сприйнятливою до помилок у середовищі розробки та потребує менше змін вручну через зміни в макеті каталогу.

Щоб зробити це, сценарій спочатку проходить папки за допомогою readdirSync щоб знайти кожне входження project.json у робочій області Nx. The lstatSync команда визначає, чи a project.json файл є файлом або каталогом після того, як він знайдений, що дозволяє сценарію редагувати лише відповідні файли. Він замінює глобальний псевдонім для будь-яких відносних маршрутів, що вказують на "node_modules", після визначення ключа "$schema" у форматі JSON. Зрештою, розробники можуть розраховувати на плавну та автоматизовану процедуру writeFileSync гарантує, що змінені шляхи будуть записані назад у файл, а зміни зафіксовано.

Другий приклад сценарію вирішує ту саму проблему за допомогою Кутові схеми, але це робиться на етапі створення або модифікації програми. В Angular схеми часто використовуються для створення коду, а також відвідати Команда має важливе значення в цьому процесі. Завдання, призначене цій функції, полягає в тому, щоб шукати у віртуальному дереві файлів, знаходити файли конфігурації проекту, а потім змінювати шлях «$schema» у цих файлах, щоб використовувати глобальний псевдонім. Щоб гарантувати, що файли читаються, редагуються та записуються назад у робочу область із правильною конфігурацією шляху, JSON.parse і перезаписати використовуються.

Метою обох цих стратегій є створення великих Nx монорепо. псевдоніми шляхів легше обслуговувати. У той час як рішення Angular Schematics ідеально підходить для розробників, які хочуть переконатися, що нові створені проекти або редакції автоматично використовують глобальний псевдонім, техніку Node.js можна використовувати незалежно для сканування та оновлення існуючих проектів. Оскільки ці сценарії є модульними та придатними для повторного використання, їх можна розширити, включивши більше project.json ключі, які потребують модифікації шляху. Це збільшує гнучкість робочого простору та полегшує обслуговування, оскільки воно з часом розширюється.

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

Покращення керування шляхом у великих Nx Monorepos

Підтримка відносних шляхів у різних файлах конфігурації проекту є однією з найбільших проблем у адмініструванні великого масштабу Nx монорепо. Коли структура каталогу змінюється, ці шляхи, як і ті, що вказують на схеми в project.json може стати складним для керування. Процеси розробки стають менш ефективними, коли команди стикаються з проблемами під час зміни каталогів і відсутності єдиного підходу до обробки шляхів. Додавання глобальні псевдоніми шляхів, подобається @workspace, може значно зменшити зусилля, пов’язані з підтримкою цих маршрутів.

Окрім зменшення потреби в частих оновленнях вручну, використання псевдоніма глобального маршруту підвищує надійність конфігурації проекту. Команди можуть зосередитися на своїй розробці, не турбуючись про модифікації шляху, абстрагуючись від відносної специфіки шляху. Це дуже корисно під час створення та налаштування додатків Angular за допомогою інструментів автоматизації, таких як Розширення VSCode. Коли існує уніфікована система псевдонімів шляхів, ці розширення можуть функціонувати більш плавно та уникати неправильних конфігурацій, викликаних неправильним вирішенням шляху.

Псевдоніми глобального шляху для всіх ключів project.json не підтримуються наявними інструментами Nx і Angular, але це було б корисним доповненням до екосистеми. Додавання підтримки псевдоніма глобального шляху оптимізує керування конфігурацією та підвищить адаптивність структури проекту. Надсилання запиту на функцію командам Nx або Angular може дозволити включити цю функцію в майбутні випуски, що було б вигідно для багатьох підприємств, які обробляють складні монорепо.