Home Developer Monorepo with Static Code Analysis

Monorepo with Static Code Analysis

Author

Date

Category

Monorepo is short for monorepository. With it, code for many projects is stored in the same repository. I like to use monorepo for NodeJS and React projects but sometimes it’s difficult to use monorepo when performing static code analysis (SCA), particularly when it comes to code coverage and code patterns. However, Codacy’s tool helps with this. Let me show you how below:

Code Coverage

Because many projects are stored in the same repository, many coding languages co-exist. Therefore, code coverage (checking code for errors) becomes complicated.  

A tool that enables reports in multiple programming languages is helpful to address these concerns. With Codacy, I receive backend and frontend reports for each language in each repo.  The weight is also calculated.  

You can see the documentation here and an excerpt below:

Code Patterns

I also worry about code patterns when using monorepos with static code analysis. Linting tools detect code patterns. However, these tend to be specific to coding languages. With multiple projects in multiple coding languages things can get tricky.

Example with ESLint

We’ll focus on ESLint in our example as it is a top linting tool for JavaScript developers with many useful plugins.  Although ESLint alone doesn’t solve for issues of having two different projects in the same repository, there is a work around:

Solution

In the src folder of the project create a client and server folder.  This is where it makes sense to have the .eslintrs.js file. In this, common rules can be set (or left empty).  

monorepo

Then, inside each client or server folder, an additional .eslintr.js, extending the src file can be added. This overrides the previously defined rules.

Locally seems to be going as expected. Now, to Codacy. Under the “Code Patterns” tab, I chose “Configuration File” instead of the Rules from the UI.

We get the same, expected results:

As you can see, with these techniques (and some help from Codacy) monorepo should no longer be an obstacle with static code analysis.

Want more from Helio, a Solutions Engineer at Codacy? Follow him on twitter.

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

May Product Update: Repository list, performance improvements, UX improvements, and more 🚀

Here are the product updates from May! This month we bring you new features, product improvements, and more interesting news to come. 🤩 We also...

April Product Update: New features and improvements, a recorded Codacy Analysis CLI webinar and more 🚀

Here are the product updates from April! This month we bring you new features, product improvements, a recorded Codacy Analysis CLI webinar we held,...

We Did a Hackathon!

We define ourselves as a startup, and while we proudly carry such a title, we also carry extraordinary responsibilities. After all, you mean to...

7 drawbacks of linting tools

Linting tools (also known as linters or static analyzers) help automate the code review process. They perform basic static code analysis by flagging programming...

Using the API to add Codacy Grade details to the Readme

Some context Codacy has a badge mechanism that can be included in your Readme file. It gives you an idea of the grade of your repository, from...