dogma

ความเชื่อ

เครื่องมือนี้เลิกใช้แล้ว

ด้วย Formatter ใหม่ใน Elixir v1.6 ฉันไม่คิดว่าจะมีการใช้ความเชื่ออีกต่อไป ขอบคุณที่ใช้ Linter นี้มันสนุก :)

อินโทร

Dogma เป็นหลักการหรือชุดของหลักการที่วางไว้โดยผู้มีอำนาจว่า เป็นจริงอย่างไม่อาจปฏิเสธได้

นอกจากนี้ยังเป็นรูปแบบรหัสสำหรับยาอายุวัฒนะขับเคลื่อนด้วยความอับอาย

• เกี่ยวกับ
• การใช้งาน
• การกำหนดค่า
• กฎ
• รูปแบบเอาท์พุท

เกี่ยวกับ

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

หากคุณสนใจเครื่องมือที่มุ่งเน้นไปที่คำแนะนำสไตล์มากกว่าการบังคับใช้คู่มือสไตล์ของคุณอย่างเคร่งครัดลองดู Credo

การใช้งาน

เพิ่มความเชื่อในการพึ่งพาการผสมผสานของคุณ

 # mix.exs
def deps do
  [
    { :dogma , "~> 0.1" , only: :dev } ,
  ]
end

รับมัน:

 mix deps.get

รันงานผสม:

 mix dogma

คุณจะได้อะไรแบบนี้:

 Inspecting 27 files.

.....X..........X..........

27 files, 2 errors!

== lib/dogma/rules.ex ==
23: TrailingBlankLines: Blank lines detected at end of file

== test/dogma/formatter_test.exs ==
9: TrailingWhitespace: Trailing whitespace detected

มีประโยชน์แค่ไหน

ติดตั้ง Dogma ทั่วโลก

เพื่อที่จะเรียกใช้ dogma จากไดเรกทอรีใด ๆ สร้าง escript:

 mix escript.build

สิ่งนี้จะสร้างการปฏิบัติการที่คุณสามารถวางไว้ในเส้นทางของคุณและเรียกใช้จากที่ใดก็ได้

ข้อมูลผู้สนับสนุน

ทดสอบ

mix test       # Run tests once
mix test.watch # Run tests on file changes
mix dogma      # Dogfooding- run the linter!

อ่านเอกสารนักพัฒนาซอฟต์แวร์

ตรวจสอบพวกเขาใน hexdocs หรือสร้างพวกเขาด้วยตัวเอง:

mix docs

ใบอนุญาต

 Dogma - A code style linter for Elixir, powered by shame.
Copyright © 2015 Louis Pilfold - MIT Licence

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.