-
-
Notifications
You must be signed in to change notification settings - Fork 822
Ignore 3rd party libraries in docs for ESLint #2509
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
schalkms
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
www.codeac.io
That's a nice project on which you are working on!
Thanks for describing your use case! It's always interesting to hear how detekt is applied in real world projects. I'm okay with this PR.
|
@michal-simon I have a question. Does Codeac also comment on PRs if there are issues in the changed code? |
|
Thank you very much for the review and nice words @schalkms. :) We are still doing some last QA testing on the Detekt integration before we release it publicly soon but we would love to send another PR to your section once we roll it fully out. Anyway, we would appreciate any feedback from you and the whole community. Also, if you'd like you can add our little custom badge to this repository: We are investing heavily in tight integration with GitHub and Commenting PRs is very high on our roadmap. Is that something you guys would be interested to use in here? We are also happy to slightly adjust our priorities if that would help you. |
|
We have codefactor.io in use which does something similar, but is on the first glance not so powerful as Codenarc. With codefactor.io there's the problem that you couldn't use the custom issue: LineEndsWithWhitespace - println("Hello World")
+ println("Hello World")I hope I could provide some feedback. CC @arturbosch suggesting code fixes could be a nice add-on for detekt and its users/integrators. I know that we decided (with good reasoning) to not mess with user code. |
|
I don't get the point of this PR. We don't run ESLint in this project and I don't see why we should run it. Your product seems really nice btw.
MAN! That would be awesome!
We could move this to an issue if it gets long. Could this be done by a third party? If it is not, what could we change to allow it? I'm not against it but how big do we want this project? |
|
Thank you for the feedback guys, those are awesome ideas!
At Codeac.io we believe that these days only few projects contain single language and our telemetry strongly supports us in it. Because of that, we decided to analyze all languages found in repository we support so far to give our users the big picture of technical debt. In other words, if a developer has JS file in the project it should be good JavaScript and we want to help them achieve it. According to @schalkms's comment with auto fixing, we are definitely adding more features to help our users fix their technical debt. One example of this is going out this week called Quick Fixes. Here is a little sneak peek relevant to this pull-request:
All tools we integrate have some sort of configuration files. We are committed to supporting them in their original format with minimum breaking changes. In the case of Detekt we check if there is a |
|
Thanks for the PR Michal! I've looked through some issues on codeac. The continuous analysis somehow stopped. It worked only for three timepoints (23-24.03). We have a convenient What I miss is an option to turn off specific analyzers without adding files/commits What I noticed is that the open source plan integration needs permission to read @BraisGabin @schalkms suggest fixes sounds like a lot of fun to implement :). |
Motivation:
One of the main goals of this project is measuring code quality and visibility of technical debt for Kotlin projects. A similar approach can be taken for other languages contained in this project:
Despite JavaScript does not have a significant representation, it is good to keep any other analysis, such as ESLint, on top of this repository clean and transparent.
Problem:
We want to keep the documentation generation process as simple as possible so it was decided to store a few 3rd party dependencies directly into the repository in
docs/jswithout proper dependency management such as NPM or YARN. However, that causes ~288 extra issues in ESLint analysis from vendor libraries.Solution:
Because this is not in a critical path of this tool and the process is not changing very frequently, it's OK to not invest significant amount of work to optimize it. On the other hand, we want to keep the ESLint results valuable without false-positive results. The fastest and easiest solution to this problem is to ignore the folder with the libraries from the ESLint analysis by
.eslintignorefile.