ฉันจะตัดสินใจได้อย่างไรว่า @ type / * เข้าสู่ "dependencies" หรือ "devDependencies" ได้อย่างไร

ฉันใช้ TypeScript 2 ในโครงการของฉัน ฉันต้องการใช้ไลบรารี js บางตัว แต่ก็มีการพิมพ์สำหรับห้องสมุดนั้นด้วย npm install @types/some-libraryฉันสามารถติดตั้งประเภทด้วยง่าย ฉันไม่แน่ใจว่าฉันควร--saveหรือ--save-devพวกเขา สำหรับฉันแล้วดูเหมือนว่า DefinetelyTyped GitHub readme เป็นประเภทที่กล่าวถึงทั้งสองรุ่น แต่ไม่เคยอธิบายเลย ฉันคิดว่า @types ควรจะอยู่ในdevDependenciesเป็นประเภทที่มีความจำเป็นสำหรับการพัฒนาและไม่ได้ใช้ในการรันไทม์ แต่ผมเห็น @types dependenciesหลายครั้งในเวลาเพียง ฉันสับสน

ฉันจะตัดสินใจได้อย่างไรว่า @ type / * เข้าสู่dependenciesหรือdevDependenciesไม่? จริงๆแล้วมีคำแนะนำอย่างเป็นทางการบ้างหรือไม่?

สมมติว่าคุณกำลังพัฒนาแพ็คเกจ "A" ที่มี @ types / แพ็คเกจโมดูลบางส่วนใน devDependencies ด้วยเหตุผลบางประการที่คุณส่งออกประเภทจาก @ types / some-module

import {SomeType} from 'some-module';
export default class APackageClass {
     constructor(private config: SomeType) {

     }
}

ในตอนนี้ผู้ใช้ typescript ของแพ็คเกจ "A" ไม่สามารถเดาได้ว่า SomeType คืออะไรเนื่องจากไม่ได้ติดตั้ง devDependencies ของแพ็คเกจ "A"

ในกรณีดังกล่าวคุณต้องวาง @ types / * แพ็คเกจด้วย "การอ้างอิง" ปกติ สำหรับกรณีอื่น ๆ "การพึ่งพา" ดีพอ

หากคุณเพิ่งสร้างชุดข้อมูลอาจไม่จำเป็นต้องแยกความแตกต่างระหว่าง dependenciesdevDependenciesและ npmโดยทั่วไปคุณสมบัตินี้มีประโยชน์เมื่อเผยแพร่แพ็คเกจที่ผู้อื่นสามารถใช้งานได้และคุณไม่ต้องการสแปมพวกเขาด้วยการอ้างอิงซ้ำซ้อน

อาจมีกรณีการใช้งานอื่น ๆ ที่การพึ่งพาการแยกจะเป็นประโยชน์ แต่ถ้าคุณไม่ต้องการสิ่งนี้อย่างชัดเจนคำแนะนำของฉันคือเลือกอย่างใดอย่างหนึ่ง มันไม่ยากที่จะแยกพวกเขาหลังจากนั้นหากจำเป็นต้องเกิดขึ้น

ตัวอย่างที่รู้จักกันดีของการปฏิบัตินี้ IRL คือcreate-react-appโดยปกติแล้วแผ่นสำเร็จรูปสำเร็จรูปที่ไม่ได้ถูกปล่อยออกมามันจะสร้างสถานที่ทุกอย่างในdependenciesดูหัวข้อนี้และคำตอบนี้

ในกรณีเฉพาะของการปรับใช้แอปพลิเคชัน Node.js เพื่อการผลิตหนึ่งต้องการติดตั้งเฉพาะการอ้างอิงที่จำเป็นในการเรียกใช้แอปพลิเคชัน

npm install --production หรือ

npm ci --production หรือ

yarn --production

ในกรณีดังกล่าวประเภทควรอยู่ในdevDependenciesเพื่อป้องกันการติดตั้ง

หมายเหตุ: ฉันรู้ว่าสิ่งนี้ถูกกล่าวถึงในความคิดเห็นโดยแบรดวิลสันถึงคำตอบอื่น แม้ว่าจุดนี้น่าจะเป็นคำตอบก็ตาม