Home Developer Effective Scala Guide To Apply To Open Source Projects

Effective Scala Guide To Apply To Open Source Projects

Author

Date

Category

After allowing our users to simply enforce the Official Scala Style Guide on their projects, we are now very pleased to announce that we released the Effective Scala Standard on Codacy.

Effective Scala was created by Marius Eriksen and comes from Twitter’s experience with developing their whole infrastructure in Scala.

To enforce the Effective Scala rules on your project go to “Code Patterns” and select “Code Standards”.

Look at the results on this public Finagle project

But of course you can also only enable the rules that matter to your project.
Here are the rules that the Effective Scala is comprised of:

  • Avoid using reserved keywords
  • Call-by-name as last Arguments
  • Enforce class naming convention
  • Enforce curly braces
  • Enforce cyclomatic complexity
  • Enforce equals hashCode contract
  • Enforce grouping imports
  • Enforce imports at the top of the package
  • Enforce line max length
  • Enforce max method length
  • Enforce max number of methods
  • Enforce max number of parameters
  • Enforce method naming convention
  • Enforce minimum visibility in module values
  • Enforce object naming convention
  • Enforce package object naming convention
  • Enforce pattern matching over else-if nesting
  • Enforce return type of public methods
  • Enforce simplification of boolean expressions
  • Enforce sorting Imports alphabetically
  • Enforce usage of the Try object
  • Prohibit lowercase L in Long literals
  • Prohibit method names that contain their object name
  • Prohibit overriding clone() method
  • Prohibit overriding finalize() method
  • Prohibit standalone covariant equals
  • Prohibit structural types
  • Prohibit unnamed values on intermediate results and parameters
  • Prohibit whitespace after left bracket
  • Prohibit whitespace before left bracket

As Marius wrote “This is not the law, but deviation should be well justified”.

Happy Scala Coding!


For more Codacy resource on Scala see here.

Edit: We just published an ebook: “The Ultimate Guide to Code Review” based on a survey of 680+ developers. Enjoy!


About Codacy

Codacy is used by thousands of developers to analyze billions of lines of code every day!

Getting started is easy – and free! Just use your  GitHub, Bitbucket or Google account to sign up.

GET STARTED

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Subscribe to our newsletter

To be updated with all the latest news, offers and special announcements.

Recent posts

Free Codacy Pro account to fight COVID-19

Our hearts go out to everyone who has been directly or indirectly impacted by the global coronavirus (COVID-19) pandemic. We are committed...

Introducing GitHub Apps for improved user access control

We are very excited to announce our recent migration to GitHub Apps to improve the experience of GitHub Cloud users. Now, you...

How Agile & Container Technology led to the rise of enterprise DevSecOps

New development processes and open-source technologies have shifted the technology security landscape for enterprises. Previously a separate security department often dealt with...

Spring tech events with Codacy: Coverage & what's next

Although many Spring tech events are being canceled or turning virtual due to coronavirus we are fortunate to have already participated in...

Top 6 items for your code review checklist

At Codacy we set high standards, and care about the quality of the code we produce. In order to provide optimal experiences...