npmlog

npmlog

เครื่องมือบันทึกที่ npm ใช้

คนตัดไม้นี้มีพื้นฐานมาก มันทำการบันทึกเป็นเวลา npm รองรับระดับที่กำหนดเองและเอาต์พุตสี

ตามค่าเริ่มต้น บันทึกจะถูกเขียนไปที่ stderr หากคุณต้องการส่งข้อความบันทึกไปยังเอาต์พุตอื่นที่ไม่ใช่สตรีม คุณสามารถเปลี่ยนสมาชิก log.stream หรือคุณสามารถฟังเหตุการณ์ที่ปล่อยออกมา และทำทุกอย่างที่คุณต้องการกับเหตุการณ์เหล่านั้น

การติดตั้ง

 npm install npmlog --save

การใช้งานขั้นพื้นฐาน

 var log = require ( 'npmlog' )

// additional stuff ---------------------------+
// message ----------+                         |
// prefix ----+      |                         |
// level -+   |      |                         |
//        v   v      v                         v
    log . info ( 'fyi' , 'I have a kitty cat: %j' , myKittyCat ) 

เข้าสู่ระบบระดับ

• {สตริง}

ระดับที่จะแสดงบันทึกที่ บันทึกใดๆ ที่ระดับนี้หรือสูงกว่านี้จะปรากฏขึ้น silent ระดับพิเศษจะป้องกันไม่ให้สิ่งใดปรากฏขึ้นเลย

เข้าสู่ระบบบันทึก

• {อาร์เรย์}

อาร์เรย์ของข้อความบันทึกทั้งหมดที่ป้อน

log.maxRecordSize

• {ตัวเลข}

จำนวนบันทึกสูงสุดที่จะเก็บ หาก log.record มีขนาดใหญ่กว่า 10% ของค่านี้ ระบบจะลดขนาดลงเหลือ 90% ของค่านี้

สาเหตุของหน้าต่าง 10% คือเพื่อไม่ต้องปรับขนาดอาร์เรย์ขนาดใหญ่ในทุกรายการบันทึก

log.prefixStyle

• {วัตถุ}

วัตถุสไตล์ที่ระบุวิธีการจัดสไตล์คำนำหน้า (ดูด้านล่าง)

log.headingStyle

• {วัตถุ}

วัตถุสไตล์ที่ระบุวิธีการจัดสไตล์ส่วนหัว (ดูด้านล่าง)

log.หัวเรื่อง

• {สตริง} ค่าเริ่มต้น: ""

หากตั้งค่าไว้ ส่วนหัวที่จะพิมพ์ที่จุดเริ่มต้นของทุกบรรทัด

ล็อก.สตรีม

• {สตรีม} ค่าเริ่มต้น: process.stderr

สตรีมที่เอาต์พุตถูกเขียน

เข้าสู่ระบบเปิดใช้งานสี()

บังคับให้ใช้สีกับข้อความทั้งหมด โดยไม่คำนึงถึงสตรีมเอาต์พุต

เข้าสู่ระบบปิดการใช้งานสี()

ปิดการใช้งานสีในทุกข้อความ

เข้าสู่ระบบเปิดใช้งานความคืบหน้า()

เปิดใช้งานการแสดงตัวหมุนกิจกรรมบันทึกและแถบความคืบหน้า

log.disableProgress()

ปิดการใช้งานการแสดงแถบความคืบหน้า

เข้าสู่ระบบเปิดใช้งาน Unicode()

บังคับให้ใช้ธีม Unicode สำหรับแถบความคืบหน้า

เข้าสู่ระบบปิดการใช้งาน Unicode()

ปิดการใช้งาน Unicode ในแถบความคืบหน้า

log.setGaugeTemplate (เทมเพลต)

ตั้งค่าเทมเพลตสำหรับแสดงแถบความคืบหน้า ดูเอกสารประกอบเกจสำหรับรายละเอียด

log.setGaugeThemeset (ธีม)

เลือกชุดรูปแบบเพื่อเลือกธีมสำหรับแถบความคืบหน้า ดูเอกสารประกอบเกจสำหรับรายละเอียด

เข้าสู่ระบบ.หยุดชั่วคราว()

หยุดส่งข้อความไปยังสตรีม แต่อย่าทิ้ง

เข้าสู่ระบบ.ประวัติ()

ส่งข้อความบัฟเฟอร์ทั้งหมดที่เขียนขณะหยุดชั่วคราว

log.log(ระดับ, คำนำหน้า, ข้อความ, ...)

• level {String} ระดับที่จะปล่อยข้อความที่
• prefix {String} คำนำหน้าสตริง ตั้งค่าเป็น "" เพื่อข้าม
• message... อาร์กิวเมนต์ของ util.format

ส่งข้อความบันทึกในระดับที่ระบุ

log[ระดับ](คำนำหน้า, ข้อความ, ...)

ตัวอย่างเช่น,

• log.silly(คำนำหน้า, ข้อความ, ...)
• log.verbose(คำนำหน้า, ข้อความ, ...)
• log.info(คำนำหน้า, ข้อความ, ...)
• log.http(คำนำหน้า, ข้อความ, ...)
• log.warn (คำนำหน้า, ข้อความ, ...)
• log.error(คำนำหน้า, ข้อความ, ...)

ชอบ log.log(level, prefix, message, ...) ด้วยวิธีนี้ แต่ละระดับจะได้รับการจดชวเลข ดังนั้นคุณจึงสามารถทำ log.info(prefix, message) ได้

log.addLevel (ระดับ, n, สไตล์, disp)

• level {String} ตัวบ่งชี้ระดับ
• n {Number} ระดับตัวเลข
• style {Object} วัตถุที่มี fg, bg, ผกผัน ฯลฯ
• disp {String} การแทนที่ทางเลือกสำหรับ level ในเอาต์พุต

ตั้งค่าระดับใหม่ด้วยฟังก์ชันชวเลขเป็นต้น

โปรดทราบว่าหากตัวเลขเป็น Infinity การตั้งค่าระดับจะทำให้ข้อความบันทึกทั้งหมดถูกระงับ หากตัวเลขคือ -Infinity วิธีเดียวที่จะแสดงคือเปิดใช้งานข้อความบันทึกทั้งหมด

log.newItem (ชื่อ, สิ่งที่ต้องทำ, น้ำหนัก)

• name {String} ไม่จำเป็น; ชื่อรายการความคืบหน้า
• todo ที่ต้องทำ {Number} ไม่บังคับ; จำนวนงานที่ต้องทำทั้งหมด ค่าเริ่มต้น 0
• weight {จำนวน} ไม่จำเป็น; น้ำหนักของรายการนี้สัมพันธ์กับรายการอื่น ค่าเริ่มต้น 1

สิ่งนี้จะเพิ่มตัวติดตาม are-we-there-yet ใหม่ให้กับตัวติดตามความคืบหน้า วัตถุที่ส่งคืนมีเมธอด log[level] แต่อย่างอื่นเป็นวัตถุ Tracker are-we-there-yet

log.newStream (ชื่อ, สิ่งที่ต้องทำ, น้ำหนัก)

นี่เป็นการเพิ่มตัวติดตามสตรี are-we-there-yet ใหม่ให้กับตัวติดตามความคืบหน้า วัตถุที่ส่งคืนมีเมธอด log[level] แต่เป็นอย่างอื่นที่เป็นวัตถุ TrackerStream are-we-there-yet

log.newGroup(ชื่อ น้ำหนัก)

นี่เป็นการเพิ่มกลุ่มตัวติดตาม are-we-there-yet ให้กับตัวติดตามความคืบหน้า วัตถุที่ส่งคืนมีเมธอด log[level] แต่อย่างอื่นเป็นวัตถุ TrackerGroup are-we-there-yet

กิจกรรม

เหตุการณ์ทั้งหมดจะถูกปล่อยออกมาพร้อมกับวัตถุข้อความ

• log ที่ปล่อยออกมาสำหรับข้อความทั้งหมด
• log. ปล่อยออกมาสำหรับข้อความทั้งหมดที่มีระดับ
• ข้อความที่มีคำนำหน้าจะแสดงคำนำหน้าเป็นกิจกรรมด้วย

วัตถุสไตล์

วัตถุสไตล์สามารถมีฟิลด์ต่อไปนี้:

• fg {String} สีสำหรับข้อความเบื้องหน้า
• bg {String} สีสำหรับพื้นหลัง
• bold inverse underline {Boolean} ตั้งค่าคุณสมบัติที่เกี่ยวข้อง
• bell {Boolean} ส่งเสียงดัง (นี่อาจจะน่ารำคาญมาก)

วัตถุข้อความ

ทุกเหตุการณ์บันทึกจะถูกปล่อยออกมาพร้อมกับออบเจ็กต์ข้อความ และรายการ log.record จะมีเหตุการณ์ทั้งหมดที่ถูกสร้างขึ้น พวกเขามีฟิลด์ต่อไปนี้:

• id {หมายเลข}
• level {สตริง}
• prefix {สตริง}
• message {String} ผลลัพธ์ของ util.format()
• messageRaw {Array} อาร์กิวเมนต์เป็น util.format()

การบล็อก TTY

เราใช้ set-blocking เพื่อตั้งค่าการบล็อก stderr และ stdout หากเป็นของ tty และมีการเรียก setBlocking นี่เป็นวิธีแก้ปัญหาใน Node.js 6.x เวอร์ชันแรกๆ ซึ่งทำให้ stderr และ stdout ไม่มีการบล็อกบน OSX (พวกมันบล็อก Windows อยู่เสมอและไม่เคยบล็อกบน Linux) npmlog ต้องการให้พวกมันบล็อกเพื่อให้สามารถอนุญาตให้เอาต์พุตไปยัง stdout และ stderr อินเตอร์เลซได้