Могут ли псевдонимы глобальных путей для относительных путей в project.json обрабатываться Nx или Angular Schematics?

Оптимизация настройки путей в монорепозиториях Nx

Управлять маршрутами в крупномасштабном монорепозитории Nx может быть сложно, особенно при работе с относительными путями в хранилище. проект.json файл. Группы расширяются, а структуры каталогов меняются, что часто приводит к большим затратам на обслуживание. Относительные пути в ключах, например $схема, которые приводят к схемам и конфигурациям внутри проекта, являются одним из примеров этого.

В настоящее время разработчикам приходится кропотливо и с высокой вероятностью ошибок обновлять эти относительные пути каждый раз, когда меняется структура папок. Это особенно актуально для проектов, которые создают или настраивают новые приложения Angular с использованием автоматизированных инструментов или плагинов VSCode. Процесс может быть нарушен, а возможные неправильные конфигурации могут возникнуть из-за постоянной необходимости обновлений.

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

В этой статье будет исследовано, если Нкс или Угловые схемы в настоящее время поддерживает такие псевдонимы глобальных путей и изучает потенциальные альтернативы или обходные пути для более эффективного управления путями в монорепозиториях.

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

Первый предлагаемый пример сценария концентрируется на автоматизации процесса замены псевдонимов глобальных путей, таких как @workspace, с относительными путями в проект.json файлы. С использованием Node.js, это серверное решение, в котором сценарий ищет в структуре каталогов файлы конфигурации проекта. Разработчики могут изменять пути без необходимости ручного вмешательства, используя основные команды этого сценария, такие как чтениефайлесинк и записьфилесинк, которые специально созданы для изменения этих файлов конфигурации. Используя этот метод, конфигурация становится менее подверженной ошибкам в среде разработки и требует меньше ручных модификаций из-за изменений в структуре каталога.

Для этого скрипт сначала обходит папки, используя readdirSync найти каждое вхождение проект.json в рабочей области Nx. lstatSync команда определяет, есть ли проект.json file — это файл или каталог после его обнаружения, что позволяет сценарию редактировать только соответствующие файлы. Он заменяет глобальным псевдонимом все относительные маршруты, указывающие на «node_modules», после нахождения ключа «$schema» в формате JSON. В конечном счете, разработчики могут рассчитывать на плавную и автоматизированную процедуру, поскольку записьфилесинк гарантирует, что измененные пути будут записаны обратно в файл и изменения будут зафиксированы.

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

Цель обеих этих стратегий — создать большие монорепозитории Nx. псевдонимы путей легче поддерживать. Хотя решение Angular Schematics идеально подходит для разработчиков, которые хотят быть уверены, что новые проекты или версии автоматически используют глобальный псевдоним, метод Node.js можно использовать независимо для сканирования и обновления существующих проектов. Поскольку эти сценарии являются модульными и допускают многократное использование, их можно расширить, включив в них больше проект.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

Поддержание относительных путей к различным файлам конфигурации проекта — одна из самых больших проблем при администрировании крупномасштабного проекта. Nx монорепо. По мере изменения структуры каталогов эти пути, подобно тем, которые указывают на схемы в проект.json файл — управление может оказаться затруднительным. Процессы разработки становятся менее эффективными, когда команды сталкиваются с проблемами при изменении каталогов и не имеют единого подхода к обработке путей. Добавление псевдонимы глобального пути, нравиться @workspace, может значительно уменьшить усилия, необходимые для поддержания этих маршрутов в рабочем состоянии.

Помимо уменьшения необходимости частого обновления вручную, использование псевдонима глобального маршрута повышает надежность конфигурации проекта. Команды могут сконцентрироваться на своей работе по разработке, не беспокоясь об изменениях пути, абстрагируясь от относительных особенностей пути. Это очень полезно при создании и настройке приложений Angular с помощью таких инструментов автоматизации, как Расширения VSCode. При наличии единой системы псевдонимов путей эти расширения могут работать более плавно и избегать неправильных конфигураций, вызванных неправильным разрешением пути.

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