หลักการตั้งชื่อโปรเจ็กต์ Node.js สำหรับไฟล์และโฟลเดอร์

หลักการตั้งชื่อไฟล์และโฟลเดอร์ในโปรเจ็กต์ Node.js ขนาดใหญ่มีอะไรบ้าง

ฉันควรใช้ตัวพิมพ์ใหญ่ camelCase หรือ under-score?

ได้แก่ . ถือว่าใช้ได้ไหม

project-name
    app
        controllers
            someThings.js
            users.js
        models
                someThing.js
                user.js
        views
            some-things
                index.jade
            users
                logIn.jade
                signUp.jade
    ...

หลังจากใช้โหนดมาหลายปีฉันสามารถพูดได้ว่าไม่มีข้อกำหนดสำหรับโครงสร้างไดเร็กทอรี / ไฟล์ อย่างไรก็ตามแอปพลิเคชันด่วน (มืออาชีพ) ส่วนใหญ่ใช้การตั้งค่าเช่น:

/
  /bin - scripts, helpers, binaries
  /lib - your application
  /config - your configuration
  /public - your public files
  /test - your tests

ตัวอย่างที่ใช้การตั้งค่านี้เป็นnodejs เริ่มต้น

ฉันเปลี่ยนการตั้งค่านี้เป็นการส่วนตัวเป็น:

/
  /etc - contains configuration
  /app - front-end javascript files
    /config - loads config
    /models - loads models
  /bin - helper scripts
  /lib - back-end express files
    /config - loads config to app.settings
    /models - loads mongoose models
    /routes - sets up app.get('..')...
  /srv - contains public files
  /usr - contains templates
  /test - contains test files

ในความคิดของฉันส่วนหลังเข้ากันได้ดีกับโครงสร้างไดเร็กทอรีสไตล์ Unix (ในขณะที่ก่อนหน้านี้ผสมผสานกันเล็กน้อย)

ฉันชอบรูปแบบนี้ในการแยกไฟล์:

lib / index.js

var http = require('http');
var express = require('express');

var app = express();

app.server = http.createServer(app);

require('./config')(app);

require('./models')(app);

require('./routes')(app);

app.server.listen(app.settings.port);

module.exports = app;

lib / static / index.js

var express = require('express');

module.exports = function(app) {

  app.use(express.static(app.settings.static.path));

};

สิ่งนี้ช่วยให้สามารถแยกรหัสต้นฉบับทั้งหมดได้อย่างเรียบร้อยโดยไม่ต้องกังวลกับการอ้างอิง ทางออกที่ดีจริงๆสำหรับการต่อสู้กับ Javascript ที่น่ารังเกียจ ตัวอย่างในโลกแห่งความเป็นจริงอยู่ใกล้ ๆซึ่งใช้การตั้งค่านี้

อัปเดต (ชื่อไฟล์):

ชื่อไฟล์เกี่ยวกับการพบมากที่สุดคือสั้น , พิมพ์เล็กชื่อไฟล์ หากไฟล์ของคุณสามารถอธิบายด้วยคำสองคำโปรเจ็กต์ JavaScript ส่วนใหญ่จะใช้ขีดล่างเป็นตัวคั่น

อัปเดต (ตัวแปร):

สำหรับตัวแปรจะใช้ "กฎ" เดียวกันกับชื่อไฟล์ ต้นแบบหรือเรียน แต่ควรใช้CamelCase

อัปเดต (styleguides):

• https://github.com/feross/standard
• https://github.com/airbnb/javascript

ใช้kebab-caseสำหรับชื่อแพ็คเกจโฟลเดอร์และไฟล์ทั้งหมด

ทำไม?

คุณควรจินตนาการว่าอาจมีการแตกโฟลเดอร์หรือไฟล์ลงในแพ็คเกจของตัวเองในบางวัน แพ็คเกจต้องไม่มีตัวอักษรตัวพิมพ์ใหญ่

แพ็กเกจใหม่ต้องไม่มีตัวอักษรพิมพ์ใหญ่ในชื่อ https://docs.npmjs.com/files/package.json#name

ดังนั้นcamelCaseไม่ควรใช้ ใบนี้snake_caseและkebab-case.

kebab-caseเป็นอนุสัญญาที่พบมากที่สุดในปัจจุบัน การใช้เครื่องหมายขีดล่างมีไว้สำหรับแพ็กเกจโหนดภายในเท่านั้นและนี่เป็นเพียงข้อตกลงจากยุคแรก ๆ

ไม่มีอนุสัญญาใด ๆ มีโครงสร้างทางตรรกะบางอย่าง

สิ่งเดียวที่ฉันสามารถพูดได้: อย่าใช้ไฟล์ camelCase และชื่อไดเร็กทอรี ทำไม? ใช้งานได้ แต่บน Mac และ Windows จะไม่มีความแตกต่างระหว่าง someAction และการกระทำบางอย่าง ฉันพบปัญหานี้ไม่ใช่ครั้งเดียว ฉันต้องการไฟล์แบบนี้:

var isHidden = require('./lib/isHidden');

แต่น่าเศร้าที่ฉันสร้างไฟล์ที่เต็มไปด้วยตัวพิมพ์เล็ก: lib/ishidden.js. มันใช้ได้กับฉันบน mac มันทำงานได้ดีบน mac ของเพื่อนร่วมงานของฉัน การทดสอบดำเนินไปโดยไม่มีข้อผิดพลาด หลังจากปรับใช้แล้วเราพบข้อผิดพลาดใหญ่:

Error: Cannot find module './lib/isHidden'

โอ้ใช่. มันเป็นกล่อง linux ดังนั้นโครงสร้างไดเร็กทอรี camelCase อาจเป็นอันตราย ก็เพียงพอแล้วสำหรับเพื่อนร่วมงานที่กำลังพัฒนาบน Windows หรือ Mac

ดังนั้นใช้ตัวคั่นขีดล่าง (_) หรือเส้นประ (-) หากคุณต้องการ

อ้างอิงจาก ' Google JavaScript Style Guide '

ชื่อไฟล์ต้องเป็นตัวพิมพ์เล็กทั้งหมดและอาจมีขีดล่าง (_) หรือขีดกลาง (-) แต่ไม่มีเครื่องหมายวรรคตอนเพิ่มเติม ปฏิบัติตามแบบแผนที่โครงการของคุณใช้ นามสกุลของชื่อไฟล์ต้องเป็น. js

คนส่วนใหญ่ใช้camelCaseใน JS หากคุณต้องการโอเพ่นซอร์สฉันขอแนะนำให้คุณใช้อันนี้ :-)

Node.js ไม่บังคับใช้หลักการตั้งชื่อไฟล์ใด ๆ (ยกเว้นindex.js) และภาษา Javascript โดยทั่วไปก็ไม่มีเช่นกัน คุณสามารถค้นหาเธรดจำนวนมากได้ที่นี่ซึ่งแนะนำ camelCase ขีดกลางและขีดล่างซึ่งใด ๆ ที่ทำงานได้ดีอย่างสมบูรณ์ มันขึ้นอยู่กับคุณ เลือกหนึ่งและติดกับมัน

ตามฉัน: สำหรับไฟล์ให้ใช้ตัวพิมพ์เล็กอูฐถ้า module.exports เป็นวัตถุฉันหมายถึงโมดูลซิงเกิลตัน สิ่งนี้ใช้ได้กับไฟล์ JSON เช่นกันเนื่องจากเป็นแบบตันเดียว ใช้ตัวพิมพ์ใหญ่อูฐหาก module.exports ส่งกลับฟังก์ชันคอนสตรัคเตอร์ที่ทำหน้าที่เหมือนคลาส

สำหรับโฟลเดอร์ใช้ชื่อย่อ หากจำเป็นต้องมีหลายคำให้ใช้ตัวพิมพ์เล็กทั้งหมดคั่นด้วย "-" เพื่อให้สามารถใช้งานได้กับทุกแพลตฟอร์มอย่างสม่ำเสมอ