dogma

عقيدة

تم إهمال هذه الأداة

مع التنسيق الجديد في Elixir v1.6 ، لا أعتقد أن هناك فائدة للعقيدة بعد الآن. شكرا لاستخدام هذا linter ، لقد كان ممتعا :)

مقدمة

العقيدة هي مبدأ أو مجموعة من المبادئ التي وضعتها السلطة على أنها صحيحة بشكل لا يمكن الالتهاب .

إنه أيضًا مخطط على نمط الكود لـ Elixir ، مدعوم من العار.

• عن
• الاستخدام
• إعدادات
• قواعد
• تنسيقات الإخراج

عن

تعتبر Dogma أداة لفرض نمط رمز Elixir ثابت ضمن مشروعك ، وهي أن الفكرة هي أنه إذا كان الكود أسهل في القراءة ، فيجب أن يكون من الأسهل أيضًا فهمه. إنه قابل للتكوين للغاية بحيث يمكنك ضبطه لتناسب دليل أسلوبك ، ولكنه يأتي مع مجموعة عاقلة من الإعدادات الافتراضية ، لذلك يجب أن تعمل في الخارج. أرغب في تشغيل Dogma على خادم CI باستخدام مجموعة الاختبار ، والنظر في Build Broken إذا أبلغت العقيدة عن مشكلة.

إذا كنت مهتمًا بأداة أكثر توجدًا نحو تقديم اقتراحات للأناقة بدلاً من إنفاذ دليل أسلوبك بشكل صارم ، تحقق من 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

كيف مفيد!

تثبيت العقيدة على مستوى العالم

من أجل تشغيل العقيدة من أي دليل بناء 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.