كيفية تحسين خدمة API الخاصة بك على node.js. الجزء الأول

هيكل ملف المشروع

src/
    controllers/
         users/
             index.js
         index.js
    db/
         mongo/
             index.js
         index.js
    helpers/
    middlewares/
         auth.js
    models/
         users.js
    routes/
        users/
             index.js
        index.js
    index.js

.eslintrc
.gitignore
README.md
...
package.json

1. يجب أن تكون جميع الملفات القابلة للتنفيذ موجودة في .src.
   سيسمح لك هذا بفصل الملفات المصدر عن نسخة مطبوعة مجمعة أو babel ، والتي ستكون موجودة في .dist أو ./build.
   كما أنه سيسهل تكوين linters والأدوات الأخرى القابلة للتكوين ، حيث توجد الملفات الهدف في دليل منفصل.
   
2. 
   ضع جميع كيانات وحدة التحكم والتوجيه في أدلة منفصلة. سيؤدي ذلك إلى فتح ملف ./routes أو ./controller والاطلاع على ملف index.js واحد فقط يقوم باستيراد وتصدير كيانات الدليل الفرعي.
   سيسمح لك ذلك بالتنقل بسرعة في الوظائف الحالية ، لأنه يصف فقط واجهة وحدات التحكم أو أجهزة التوجيه دون الخوض في تنفيذها.
   

حول تجميع جافا سكريبت

1. لا يتوفر أحدث إصدار من Node.js للإنتاج دائمًا.
2. لا تزال Node.js (الإصدار 13) تواجه مشكلات في دعم وحدات ECMAScript ، على الرغم من أنها ظهرت وتركت العلم ، إلا أنها لا تزال تجريبية. للبيع في وقت مبكر.

npm install @babel/core @babel/node @babel/preset-env --save-dev

{
    "presets": [
      "@babel/preset-env"
    ]
}

"start": "nodemon --exec babel-node src/index.js",

1. عند تثبيت التبعيات ، لا تنس أن تضع مفتاح -save-dev (-D) فقط أثناء مرحلة التطوير. من الضروري على الأقل لدلالات.

حول الحاجة إلى اللنت

npm install eslint --save-dev

{
    "env": {
        "node": true,
        "es6": true,
    },
    "extends": "eslint:recommended"
}

 ,  
...
    "extends": "eslint:recommended",
    "rules": {
        "quotes": ["error", "single"]
    }
}

• جوجل
  
  

   npm install --save-dev eslint-config-google
  

• Airbnb
  
  

   npm install --save-dev eslint-config-airbnb-base eslint-plugin-import
  

• اصطلاحي
  

   npm install --save-dev eslint-config-idiomatic
  

{
    "env": {
        "node": true,
        "es6": true,
    },
    "extends": "google" | "airbnb-base" | "idiomatic"
}

"lint": "eslint ./src --cache && echo \"eslint: no lint errors\"",
"lint:fix": "eslint ./src --fix && echo \"eslint: no lint errors\""

حول تشغيل التطبيق

"start": "npm run dev",
"dev": "nodemon --exec babel-node ./src/index.js",
"build": "babel ./src --out-dir ./build",
"prod": "NODE_ENV=production node ./build/index.js",
"lint": "eslint ./src --cache && echo \"eslint: no lint errors\"",

npm install --save-dev @babel/cli nodemon babel-node

1. حتى إذا أضفت الأوامر الأساسية إلى package.json ، فلا يزال يصف عملية بدء التشغيل في README.md.

استنتاج