[feature request] Make custom tokens configuration file more descriptive

[gcwiak]

Hi! At first, thanks for the plugin! It looks really promising.

The current approach for storing custom tokens configuration, i.e. cc_defaults.json, seems not enough self-descriptive. E.g. in case this file is put into VCS with a project it might get confusing for other people who not have the plugin installed. There is no hint what this file is for or any explicit reference to the plugin.

It might be helpful to create additional field in the JSON schema for such purposes, e.g. above the current "types" root field. Or consider using a different format for this file, e.g. YAML which supports comments. Another helpful thing might be allowing to use different name than cc_defaults.json, now it doesn't work for any other name - "The file is not valid" popup appears.

[lppedd]

Hi!

different name than cc_defaults.json ... "The file is not valid" popup appears

Already solved locally, will push with 0.4.1

---

in case this file is put into VCS with a project it might get confusing

This would be solved by using another custom name. I don't plan to use any other file format, especially YAML (personal preference here).
Anyway isn't it the same as any other config file? e.g. Editorconfig, Prettier

[lppedd]

File name fixed with commit 163f4465ff1daf4d28996339a4ed52aa455fa74f

[gcwiak]

different name than cc_defaults.json ... "The file is not valid" popup appears

Already solved locally, will push with 0.4.1

👍 Great!

isn't it the same as any other config file? e.g. Editorconfig, Prettier

Yes, it is. Though without any meteadata it's not obvious what this file is meant for if you are not familiar with the plugin upfront. Both examples you mention allow comments, the editorconfig example actually contains link to it's website.

[lppedd]

I've changed the implicit/exported file name to conventionalcommit.json on 0.6.0

[gcwiak]

Thanks a lot! Ability for custom naming is really helpful.

[lppedd]

@gcwiak if your file is named conventionalcommit.json and it's on project's root, it's auto-detected too now 😄

Let me know if I can close this issue too.

[gcwiak]

👍 I like the idea with auto-detecting, worked like a charm when I added the file to another project. And it makes the configuration even simpler. I'm happy with closing the issue, thank you for doing the improvement! :)

[lppedd]

Closing then 😄