dogma

Dogma

Alat ini telah sudah usang

Dengan formatter baru di Elixir v1.6 saya tidak berpikir ada penggunaan untuk dogma lagi. Terima kasih telah menggunakan linter ini, sangat menyenangkan :)

Intro

Dogma adalah prinsip atau serangkaian prinsip yang ditetapkan oleh otoritas yang benar benar .

Ini juga merupakan linter gaya kode untuk Elixir, ditenagai dengan malu.

• Tentang
• Penggunaan
• Konfigurasi
• Aturan
• Format output

Tentang

Dogma adalah alat untuk menegakkan gaya kode elixir yang konsisten dalam proyek Anda, idenya adalah bahwa jika kode Anda lebih mudah dibaca, itu juga harus lebih mudah dipahami. Ini sangat dapat dikonfigurasi sehingga Anda dapat menyesuaikannya agar sesuai dengan panduan gaya Anda, tetapi dilengkapi dengan satu set default yang waras sehingga bagi kebanyakan orang itu harus bekerja di luar kotak. Saya suka menjalankan dogma di server CI dengan suite tes, dan mempertimbangkan build yang rusak jika dogma melaporkan masalah.

Jika Anda tertarik pada alat yang lebih diarahkan untuk membuat saran gaya daripada secara ketat menegakkan panduan gaya Anda, lihat Credo.

Penggunaan

Tambahkan dogma ke dalam dependensi campuran Anda

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

Ambil:

 mix deps.get

Jalankan tugas campuran:

 mix dogma

Anda akan mendapatkan sesuatu seperti ini:

 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

Betapa berguna!

Pasang dogma secara global

Untuk menjalankan dogma dari direktori mana pun membangun escript:

 mix escript.build

Ini akan membuat executable yang dapat Anda tempatkan di jalan Anda dan memohon dari mana saja.

Informasi Kontributor

UJI

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

Baca dokumen pengembang

Lihat di Hexdocs, atau hasilkan sendiri:

mix docs

LISENSI

 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.