41 Commits

Author SHA1 Message Date
Peter
8e27a307ee NestedScopeFunctions - Add rule for nested scope functions (#4788) 2022-06-02 13:18:16 +01:00
schalkms
eb7c335f9e Reformat Markdown files to comply with the spec (#4891) 2022-06-02 00:00:56 +02:00
Dominic Zirbel
c54453dc8a Remove reference to contributor list (#4871)
It appears that the contributor list in the readme has been replaced by an autogenerated image of the contributors; the contribution guide should no longer suggest contributors add their name there.
2022-05-28 20:48:52 +02:00
Brais Gabín
45c3f6cc30 Update CONTRIBUTING regarding the website (#4794) 2022-05-12 18:29:48 +01:00
Nicola Corti
739415bd5f The New Detekt Website (#4755) 2022-04-24 13:23:56 +01:00
Matthew Haughton
8939aedb42 Drop Spek (#4670)
Co-authored-by: Goooler <wangzongler@gmail.com>
Co-authored-by: Nicola Corti <corti.nico@gmail.com>
2022-04-12 00:12:58 +01:00
Nicola Corti
06ef0698e3 Adding a Gradle Enterprise docs link (#4707) 2022-04-11 20:27:32 +02:00
Nicola Corti
2a513c4ef4 Add Gradle Enterprise instructions for maintainers. (#4698)
* Add Gradle Enterprise instructions for maintainers.

* Update .github/CONTRIBUTING.md

Co-authored-by: Chao Zhang <chao.zhang@instacart.com>

* Apply suggestions from code review

Co-authored-by: Matthew Haughton <3flex@users.noreply.github.com>

Co-authored-by: Chao Zhang <chao.zhang@instacart.com>
Co-authored-by: Matthew Haughton <3flex@users.noreply.github.com>
2022-04-09 22:20:50 +01:00
Dennis Pietruck
3fc2958fb0 Fix typo in CONTRIBUTING.md (#4639)
Co-authored-by: Aram Messdaghi <aram.messdaghi@otto.de>
2022-03-18 09:12:13 +01:00
Nicola Corti
74d3b6f1e3 Move the website to detekt.dev (#4544) 2022-02-04 00:50:26 +00:00
Matthew Haughton
a627da97c9 Migrate custom-checks tests to JUnit 5 (#4467)
* Setup JUnit 5

* Migrate custom-checks tests to JUnit

* Set the default JUnit 5 test instance lifecycle mode to "per_class"

* Use extension instead of base class to inject KotlinCoreEnvironment

Co-authored-by: marschwar <marschwar@users.noreply.github.com>

* Update contributor guidelines to reflect usage of JUnit 5

* Fix style issues

* Update detekt-test-utils API definition

* Update .github/CONTRIBUTING.md

Co-authored-by: marschwar <marschwar@users.noreply.github.com>
Co-authored-by: Chao Zhang <zhangchao6865@gmail.com>
2022-01-16 08:32:21 +11:00
pnq32
779f605e33 Add first draft of a rule description style guide (#4386)
* Add first draft of a rule description style guide

* Fix a typo in the style guide draft

Co-authored-by: Brais Gabín <braisgabin@gmail.com>

* Update style guide to cover the three types of descriptions

* Discourage file names in code smell messages

Co-authored-by: Brais Gabín <braisgabin@gmail.com>

* Fix two minor mistakes in the style guide

* Explain the example on usage-aware recommendations

* Reference the guide on authoing rule descriptions

* Write detekt in lowercase

* Add an empty line after every heading

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>

* Clean up the contribution guide

* Incorporate latest review comments into the style guide

* Fix a typo in the style guide

* Use consistent line breaks in the style guide

* Merge the style guide into the contribution guide

* Delete the standalone style guide

* Remove redundant space

Co-authored-by: Brais Gabín <braisgabin@gmail.com>
Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
2021-12-30 20:12:18 +01:00
marschwar
fee31b6217 Replace get_analysis_projects.groovy with kotlin script (#4033)
* replace get_analysis_projects.groovy with kotlin script

* fix violations

Co-authored-by: Markus Schwarz <post@markus-schwarz.net>
2021-10-12 14:29:01 +02:00
marschwar
cbee5e7e2e Rule Configuration using annotations (#3637)
* Create initial idea for @Configuration annotation
* Use config parameter constants again
* Generate documentation from @Configuration
* Introduce config delegate and extract default value from it
* Exclude rules configured with annotation from checks
* Remove support for factory methods in RuleSetProviderCollector
* Add support for lists that are empty by default
* Update documentation for rule contribution
* Restrict config delegate to supported types
* Update .github/CONTRIBUTING.md

Co-authored-by: Brais Gabín <braisgabin@gmail.com>
Co-authored-by: Markus Schwarz <post@markus-schwarz.net>
Co-authored-by: Chao Zhang <zhangchao6865@gmail.com>
2021-04-08 16:34:22 -07:00
marschwar
b72898bff3 Add generateDocumentation task to contribution guide (#3552)
Co-authored-by: Markus Schwarz <post@markus-schwarz.net>
2021-04-06 11:31:22 -07:00
marschwar
36edd4c528 Replace @active KDoc tag with @ActiveByDefault annotation (#3592)
* Add @ActiveByDefault annotation

* Add support for @ActiveByDefault annotation

* Use annotation for all activated in v1.2.0

* Use annotation for all activated after v1.2.0

* Use annotation for all activated in v1.0.0

* Update documentation with regard to RuleSetProvider

* Update documentation

* Remove leading 'v' from version in annotation

* Use named parameter 'since' for @ActiveByDefault

* check version matches semantic version pattern.

* Fix typo and correct version format

* Fix merge errors

Co-authored-by: Markus Schwarz <post@markus-schwarz.net>
Co-authored-by: Chao Zhang <zhangchao6865@gmail.com>
2021-03-28 11:21:09 -07:00
Chao Zhang
0d6ac64b7d General housekeeping (#3298)
* General housekeeping

- Refactor more config keys as key companion object
- Convert some KDocs from using # into using []
- Remove self-recursive function in Context
- Fix correct dokka task name in CONTRIBUTING.md

* Revert change on Context.report

* Remove MAX_ISSUES_KEY back to IssueExtension

* Update detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/config/IssueExtension.kt

Co-authored-by: Brais Gabín <braisgabin@gmail.com>

Co-authored-by: Brais Gabín <braisgabin@gmail.com>
2020-12-24 18:25:42 +01:00
Artur Bosch
fef932c20c Prepare 1.12.0-RC1 release (#2995)
* Prepare 1.12.0-RC1 release

* Extract release process to a shell script

* Update own version
2020-08-22 15:33:41 +02:00
Nicola Corti
b24851df38 Publish to Bintray using maven-publish (#2885)
* Publish to Bintray using maven-publish

* Removed unused variable
2020-07-21 17:23:59 +02:00
Artur Bosch
4e3d83abe1 Prepare 1.10.0 (#2829)
* Prepare 1.10.0 release

* Deactivate IsPropertyNaming rule for 1.10.0 release

* Update self analysis and doc version
2020-06-27 20:31:12 +02:00
Artur Bosch
bfa524a4e5 Release version 1.8.0 (#2625)
* Update release notes script to include notable changes, migration and changelog sub sections

* Update release process

* Prepare 1.8.0 release

* Fix uploading all release assets

* Update docs and self analysis detekt version

* Fix spelling
2020-04-20 19:27:30 +02:00
Sebastiano Poggi
c2a794a2b5 Check jcenter repository present in Gradle plugin (#2550)
* Emit helpful errors in Gradle plugin

Whenever the plugin is applied to a project that doesn't have
jcenter() configured, the user would get a cryptic error message
from Gradle (see issue #2549). This simple change makes sure the
plugin will provide users with clear instructions on how to fix
their build so they don't get stumped when things don't work.

* Update contributions in README

* Fix ktlint name in docs: it's all lowercase

Also update repo URL to /pinterest/ktlint through out docs

* Update Gradle getting started in index.md

* Fix ktlint name in code too

* Address detekt warnings after plugin changes

* Only check for jCenter in afterEvaluate { }

This is necessary because we need to make sure it's there _somehow_,
and it may be added by other plugins, or blocks evaluated after this
plugin is applied.

* Apply suggestions from code review

Co-Authored-By: M Schalk <30376729+schalkms@users.noreply.github.com>

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
2020-03-29 19:35:36 +02:00
Artur Bosch
61e1882d8c Prepare 1.7.2 release (#2543) 2020-03-28 14:45:48 +01:00
Artur Bosch
eb9cf274fd Make the gradle plugin a sub project again (#2493)
* Convert the gradle plugin to a sub project

This leads to:
- faster build file evaluate, no need to wait for the composite build file evaluation
- cleaner build files, less duplications
- more up-to-date tasks
- faster builds, clean build is ~30 seconds faster

* Setup for easy local gradle plugin changes
2020-03-23 19:51:33 +01:00
M Schalk
db87ebb347 Add PsiViewer plugin to Contributing guide (#2444) 2020-03-18 08:54:03 +01:00
M Schalk
7ac6cc8fdc Update Spek IntelliJ plugin link (#2439) 2020-03-16 21:46:37 +01:00
Artur Bosch
d5e5fc40da Update website ruby dependencies fixing potential security vulnerability (#2270) 2020-01-19 14:19:45 +01:00
Artur Bosch
1a2be5156a Prepare 1.1.0 release (#1919) 2019-10-05 16:24:11 +02:00
M Schalk
346c505625 Fix typo in CONTRIBUTING.md (#1892) 2019-09-03 07:31:16 +10:00
Artur Bosch
4cd092cdb8 Prepare 1.0.1 release (#1846) 2019-08-24 14:20:27 +02:00
M Schalk
f82e6550e4 Update CONTRIBUTING.md (#1775) 2019-07-21 14:03:03 +10:00
M Schalk
9e1244d227 Update CONTRIBUTING.md (#1715) 2019-06-20 14:02:48 +02:00
M Schalk
b1bac0ba85 Remove git commit message check (#1638)
Since this repository uses squash and merge as the only option to
merge PRs, the git commit message check is not necessary any more.
If the commit message in a PR is not descriptive enough, it can
be changed when using the squash and merge functionality on Github.
2019-05-07 00:09:13 +02:00
Artur Bosch
264bc9fe5b Run rules for specific paths (#1418)
* Allow to run specific rules on only specified paths by using a config property

* Rename to includes and excludes properties

* Test exclusion and inclusion patterns for rules

* Reformat KtCompiler

* Support just globbing patterns as regex patterns are not handled os independently

* Fix * removal for globing pattern by providing an additional flag for SplitPattern

* Add one more test case to prove inclusions are evaluated after exclusions
2019-04-16 21:28:17 +02:00
Matthew Haughton
220f605979 Silence dokka (#1572)
* Format default values as Markdown code spans

These are delimited with a backtick (`), and are also ignored by
dokka which is handy as otherwise [A-Za-z0-9] is treated as a link to
other documentation even though it's not a valid link. Formatting as a code
span means dokka will not throw a warning in this case.

* Don't link to documentation in KDoc that doesn't exist

KtFile, PsiElement and KtElement don't have any documentation published
online, so it does not make sense to link to those classes from KDoc.

* Remove unused import
2019-04-07 08:48:05 +02:00
marschwar
88c239d9a2 Add code formatting instructions to CONTRIBUTING.md (#1542)
* Remove idea code style to avoid confusion.

* Reformat using KtLint.

* Add formatting instructions to readme.
2019-03-26 07:33:37 +01:00
Artur Bosch
1ce5b59113 Reflect new formatting changes in the contribution guide (#1463) 2019-02-10 13:18:43 +01:00
Artur Bosch
6cfaaee721 Release rc12 (#1383)
* Add rc12 changelog

* Update release version

* Update badges

* Remove bintray publishing from gradle-plugin
2018-12-09 12:58:07 +01:00
Marvin Ramin
dcf3943d5e Hide dev flags in CLI (#1351)
* hide development cli flags

* update detekt cli documentation
2018-11-24 07:55:52 +01:00
Marvin Ramin
e7954db374 update documentation to use new detekt gradle plugin (#1095)
* update documentation to use new detekt gradle plugin

* remove reference to profiles/input path for idea DSL
2018-09-10 07:37:12 +02:00
Niklas Baudy
90c5180456 Move contributing file. 2018-09-08 16:08:01 +02:00