Fix/one spawn per project

[cgalvarez]

This PR has the following goals:

• [x] Massive refactor of the code.
• [x] Analyze the whole project, not only the currently open file, so allowing for any engine and including previously missing issues like duplicated code.
• [x] Debounce the linting process, so multiple files from the same project can merge into one unique analysis.
• [x] Remove some code that doesn't make sense or it's outdated.
• [x] Fix all currently reported issues on CodeClimate. I've managed to comply with the cognitive complexity. Hope @Arcanemagus likes the final refactor :wink:
• [x] Proper docblocks for each function.

And still waiting for the following bugs to be fixed in their respective repos:

• phpmd/phpmd: duplicated issues
• steelbrain/exec: bug when exitCode is null

There are some issues left that are very annoying, but I don't have any clue on how to fix them, and can be the subject of future PRs:

• On the first Atom run (right after opening Atom for the first time or reloading it with control + shift + F5), the CLI is ran multiple times (typically two). The debounced linting cannot address this issue because the time between the executions exceeds 2s, and setting the debounce timeout to that feels overkilling, and make the whole point of this PR useless.
• When starting Atom with multiple files open, changing from one to another still triggers a new analysis. This could be addressed to improve performance.
• When starting Atom with multiple files open, the CodeClimate issues are generated correctly for AtomLinter, but they never get added. User need to manually re-trigger analysis by saving a file to get the issues included in AtomLinter pane.

Also, this PR...

Fixes #75 Fixes #76 Closes #77 with a temporary workaround Fixes #81 Closes #69, since it should be supported by CodeClimate CLI in first place, and it should miss some issues (like duplicated code), which this PR aims to solve. Closes #74 Closes #77 Closes #78

Edited by @Arcanemagus to automatically close issues/PRs.

[cgalvarez]

The tests seem to hang, cannot make them even print any error.

Anyone that could lend me a hand on this? This PR can be installed and tested locally with:

git clone -b 'fix/one-spawn-per-project' https://github.com/cgalvarez/linter-codeclimate.git linter-codeclimate-pr
cd ./linter-codeclimate-pr
apm link --dev
apm install
atom -d .

[cgalvarez]

Wow, I was about to give up, but the tests take ~273s on CI to finish!! Locally ~20s. What an amazing difference... but finally get it working and passing!! :tada: :tada: :tada:

[EugeneGrigorenko]

Is it gonna be merged?

[Arcanemagus]

Looks like the Code Climate people aren't maintaining this 😆😢.

Taking a look over this now, that diff summary looks daunting 😮.

[cgalvarez]

@Arcanemagus Thank you very much for detailed review. I'll take a look at all your reported issues ASAP and make a new commit to fix them all.

[cgalvarez]

I've just fixed all your reported issues. Let me know If I've missed something or you want me to make a rebase or something :wink:

I think it would be desirable to disable some Code Climate engines run in CI to make tests run faster.

[Arcanemagus]

Since CI is passing, and I can't run this locally (Windows), I'll go ahead and merge this. 😆

[Arcanemagus]

@cgalvarez Assuming @AtomLinter/linter-codeclimate has no issues with it, if you want to be brought on as a maintainer for this project I would be fine with that 😉.

[Arcanemagus]

Published in v0.3.0 🎉.

[cgalvarez]

@Arcanemagus Great! I will be glad to help anytime I can.