هل يمكن التعامل مع الأسماء المستعارة للمسار العالمي للمسارات النسبية في project.json بواسطة Nx أو Angular Schematics؟

تبسيط تكوين المسار في Nx Monorepos

قد يكون من الصعب إدارة المسارات في Nx monorepo واسع النطاق، خاصة عند العمل مع المسارات النسبية في project.json ملف. تتوسع الفرق وتتغير هياكل الدليل، مما يؤدي في كثير من الأحيان إلى تكلفة صيانة كبيرة. المسارات النسبية في المفاتيح مثل مخطط $والتي تؤدي إلى المخططات والتكوينات داخل المشروع، هي أحد الأمثلة على ذلك.

يتعين على المطورين حاليًا تحديث هذه المسارات النسبية بشكل شاق ومعرض للخطأ في كل مرة تتغير فيها بنية المجلد. ينطبق هذا بشكل خاص على المشاريع التي تقوم بإنشاء أو تكوين تطبيقات Angular جديدة باستخدام الأدوات الآلية أو مكونات VSCode الإضافية. يمكن أن تتعطل العملية ويمكن أن تنتج التكوينات الخاطئة المحتملة عن المتطلبات المستمرة للترقيات.

إضافة اسم مستعار للمسار العالمي، مثل @مساحة العمل، يمكن أن يحل هذه المشكلة عن طريق استبدال كافة المسارات النسبية وتبسيط إدارة الدليل. يمكن للمطورين تقليل احتمالية حدوث أخطاء في التكوين والتخلص من متطلبات التحديثات اليدوية عن طريق استخدام الأسماء المستعارة.

هذه المقالة سوف تحقق إذا نإكس أو المخططات الزاوية يدعم حاليًا هذه الأسماء المستعارة للمسار العالمي ويستكشف البدائل أو الحلول المحتملة لإدارة المسار بشكل أكثر فعالية في monorepos.

أتمتة إدارة الاسم المستعار للمسار في Nx Monorepo

يركز المثال النصي الأول المقدم على أتمتة عملية استبدال الأسماء المستعارة للمسار العالمي، مثل @مساحة العمل، مع المسارات النسبية في project.json ملفات. استخدام Node.jsهذا هو الحل الخلفي حيث يبحث البرنامج النصي في بنية الدليل عن ملفات تكوين المشروع. يمكن للمطورين تعديل المسارات دون الحاجة إلى التدخل اليدوي باستخدام الأوامر الأساسية في هذا البرنامج النصي، مثل readFileSync و writeFileSync، والتي تم تصميمها خصيصًا لتغيير ملفات التكوين هذه. باستخدام هذه الطريقة، يصبح التكوين أقل عرضة للأخطاء في بيئة التطوير ويتطلب تعديلات يدوية أقل بسبب التغييرات في تخطيط الدليل.

من أجل القيام بذلك، يقوم البرنامج النصي أولاً باجتياز المجلدات باستخدام readdirSync للعثور على كل حدوث project.json في مساحة العمل Nx. ال lstatSync يحدد الأمر ما إذا كان أ project.json file هو ملف أو دليل بمجرد العثور عليه، مما يتيح للبرنامج النصي تحرير الملفات ذات الصلة فقط. فهو يستبدل الاسم المستعار العام لأية مسارات نسبية تشير إلى "node_modules" بعد تحديد موقع المفتاح "$schema" بتنسيق JSON. في نهاية المطاف، يمكن للمطورين الاعتماد على إجراء سلس وآلي writeFileSync يضمن إعادة كتابة المسارات المعدلة إلى الملف وتنفيذ التعديلات.

يعالج مثال البرنامج النصي الثاني نفس المشكلة باستخدام المخططات الزاوية، ولكنه يفعل ذلك في مرحلة بناء التطبيق أو تعديله. في Angular، يتم استخدام المخططات بشكل متكرر لإنشاء التعليمات البرمجية، و يزور الأمر ضروري في هذه العملية. المهمة المخصصة لهذه الوظيفة هي البحث في شجرة الملفات الافتراضية، وتحديد موقع ملفات تكوين المشروع، ثم تغيير مسار "$schema" في تلك الملفات للاستفادة من الاسم المستعار العام. من أجل ضمان قراءة الملفات وتحريرها وكتابتها مرة أخرى إلى مساحة العمل باستخدام تكوين المسار الصحيح، JSON.parse و الكتابة فوق تستخدم.

الهدف من هاتين الاستراتيجيتين هو إنتاج كميات كبيرة من Nx monorepos. الأسماء المستعارة للمسار أسهل للصيانة. في حين أن حل 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;
  };
}

تحسين إدارة المسار في Monorepos الكبيرة Nx

يعد الحفاظ على المسارات النسبية عبر ملفات تكوين المشروع المختلفة أحد أكبر المشكلات في الإدارة على نطاق واسع نإكس مونوريبو. مع تغير بنية الدليل، فإن هذه المسارات - مثل تلك التي تشير إلى المخططات في ملف project.json الملف - قد يصبح من الصعب إدارته. تصبح عمليات التطوير أقل فعالية عندما تواجه الفرق مشكلات عندما تتغير الدلائل وتفتقر إلى نهج موحد للتعامل مع المسارات. إضافة الأسماء المستعارة للمسار العالمي، يحب @مساحة العمل، يمكن أن يقلل بشكل كبير من الجهد المبذول في الحفاظ على هذه المسارات.

بالإضافة إلى تقليل الحاجة إلى التحديثات اليدوية المتكررة، فإن استخدام الاسم المستعار للمسار العالمي يعزز قوة تكوين المشروع. قد تركز الفرق على أعمال التطوير الخاصة بها دون الحاجة إلى القلق بشأن تعديلات المسار عن طريق تجريد تفاصيل المسار النسبي. يعد هذا مفيدًا جدًا عند إنشاء تطبيقات Angular وتكوينها باستخدام أدوات التشغيل الآلي مثل ملحقات VSCode. عند وجود نظام الاسم المستعار للمسار الموحد، يمكن أن تعمل هذه الامتدادات بشكل أكثر سلاسة وتجنب التكوينات الخاطئة الناتجة عن دقة المسار غير الصحيحة.

الأسماء المستعارة للمسار العالمي عبر كافة المفاتيح في project.json غير مدعومة أصلاً بواسطة أدوات Nx وAngular المتوفرة حاليًا، ولكن هذا سيكون إضافة مفيدة للنظام البيئي. إن إضافة دعم الاسم المستعار للمسار العالمي من شأنه تبسيط إدارة التكوين وزيادة القدرة على التكيف في هيكل المشروع. قد يؤدي إرسال طلب ميزة إلى فرق Nx أو Angular إلى تمكين تضمين هذه الميزة في الإصدارات القادمة، وهو ما سيكون مفيدًا للعديد من المؤسسات التي تتعامل مع monorepos المعقدة.