"detekt" or "Detekt"

[3flex]

Expected Behavior

Project refers to itself using a consistent name.

Observed Behavior

I believe detekt has been used from the beginning, but I see Detekt used more and more in documentation. We should be keeping this consistent.

Steps to Reproduce

N/A

Context

I believe @arturbosch named the project detekt with lowercase and would want it kept that way.

Your Environment

N/A

[VictorIreri]

I agree and perhaps it could be enforced through an automated check?
I presume the increased use of "Detekt" is because capitalizing names is the norm, and so "detekt" doesn't seem quite right. So maybe styling "detekt" in a particular way across the docs might be an option to satisfy that need to make the name "feel" different. For example by italicizing detekt as we do on the configurations page, although even here it's not consistent.
https://detekt.dev/docs/introduction/configurations/

It may help to look at an example of the lowercase approach. There's a popular tool called fastlane that have done this in their docs.

[BraisGabin]

Mixed feelings here:

• If we move to Detekt everything would be just easier
• The name of the project is detekt and that's it. I'm not sure if we should change it.

I don't know the reason behind detekt is not capitalised. But I always assumed that because it started as a cli. And as every cli it is lowercase.

So, for me, I would treat any Detekt as a typo. And, if we want to change it to Detekt we should open another issue to decide to "rename".

[BraisGabin]

The lower case sometime feels strange. Examples:

When shipping the detekt Gradle Plugin[...]

Same when it goes at the start of a sentence:

detekt can be integrated into your development workflow[...]

[cortinico]

I believe the name of the project should probably be lowercase.
This is also consistent with our logo:

When part of another project or a plugin, I think it's fine to go for titlecase:

When shipping the detekt Gradle Plugin[...]

So this would be Detekt Gradle Plugin. The Detekt Project, The Detekt IntelliJ Plugin, etc.

[3flex]

@arturbosch there are some good considerations raised above, I'm curious what you think.

I've always thought detekt was a stylistic choice that reflects the CLI command name, and this started as a CLI tool, so that made sense. However there's now an extensive list of integrations and some people are naturally gravitating towards the capitalised version anyway.

I do think that whether it's detekt or Detekt, it should be consistent everywhere it's used.

[arturbosch]

The name is a wordplay on the verb "to detect sth." and "kt" from Kotlin.
So yes, it was intended as a lowercase detekt.
Detekt alone always looked wierd to me but Detekt Gradle Plugin looks fine.
The CLI argument sounds reasonable now but wasn't intended back then as Gradle integration was always planned.

The lower case sometime feels strange. Examples:

When shipping the detekt Gradle Plugin[...]

Same when it goes at the start of a sentence:

detekt can be integrated into your development workflow[...]

These are also valid reasons. Italic as @VictorIreri mentioned could work: detekt Gradle Plugin.
Or just using uppercase Detekt next to other uppercase names.

Btw I quite recently changed to the lowercase detekt spelling in the IJ plugin (which I could change if most maintainers want the uppercase spelling :)):

[TWiStErRob]

The website then really needs a touch-up... 6 mentions on the home-page, and none of them are lowercase.

If I wanted to know which way to write it, I would stop here and conclude "Detekt" in all contexts.

Any reason why the home-home-page doesn't have the logo, @cortinico?

[cortinico]

Any reason why the home-home-page doesn't have the logo, @cortinico?

The logo is there in the first block no?

Also my bad, I love uppercase and I used it everywhere. We definitely need to clean this up :) feel free to do it.

[TWiStErRob]

The logo is there in the first block no?

Haha, you got me there, I mean this logo which has the name on it:

#5898 (comment)

I think the center-mid "Detekt" could be replaced with the named logo.

[TWiStErRob]

Raised #5953 with some "Detekt -> detekt" changes and "Detekt Gradle Plugin" unification.

[cortinico]

Haha, you got me there, I mean this logo which has the name on it:

Yeah you're right :)

[TWiStErRob]

Argh, the main "logo" didn't change. It's still a screaming "Detekt" in the middle.

[TWiStErRob]

Also the title of the page. I have a feeling these are all one occurrence.

[TWiStErRob]

Can someone please rename the org as well? https://github.com/detekt
Because this gives a mixed message:

[arturbosch]

Can someone please rename the org as well? https://github.com/detekt Because this gives a mixed message:

Done, thanks for the work!