tauri icon indicating copy to clipboard operation
tauri copied to clipboard

[feat] Consider changing tauri.conf.json to tauri.config.json

Open ghost opened this issue 1 year ago • 5 comments

Describe the problem

Hello. Tauri is doing great, I have simply a suggestion for your next major version.

JavaScript softwares tend to recognize their config files with the word "config" written on it. This is not a rule, it may only be the most frequent convention. of course there are other possibilities and all are valid,

I would not care, but to be frank to you, days have gone by before I realized that "conf" was an abbreviation for "config" in the file tauri.conf.json. I did not immediately recognized this file as the config file for Tauri. Even now, I can't put my mind to read it as "config" when I pass my eyes on it, maybe because from where I come from, "conf" is an abbreviation for "comfort". Tauri project brings many default files, it is involved in terminologies from more than 1 ecosystem, so it is easy to become overloaded when you are having your first contact. In this scenario, it would be welcome to avoid the "conf" abbreviation, especially to be more recognizable for people whose main language is not english.

Describe the solution you'd like

In order to ease comprehension, tauri.config.json (and its format variations) could be the expected file, instead of tauri.conf.json. It is easier to recognize, since there are more examples (astro.config.js, babel.config.js, capacitor.config.js, docusaurus.config.js, eleventy.config.js, eslint.config.js, farm.config.js, gatsby-config.js, iles.config.js, jest.config.js, lume.config.js, nativescript.config.js, next.config.js, nuxt.config.js, prettier.config.js, remix.config.js, stylelint.config.js, tailwind.config.js, tsconfig.json, vite.config.js, vitest.config.js, vue.config.js, webpack.config.js, ...)

All the best

Alternatives considered

No response

Additional context

No response

ghost avatar Aug 20 '24 01:08 ghost

(In case anyone wonders about the connection between "conf" and "comfort", given the N/M difference: in several languages the word is written "confort". I don't have much of an opinion on the matter, but there's a pinch of context in case it clarifies anything.)

ConnorKrammer avatar Aug 20 '24 08:08 ConnorKrammer

For what it's worth, i agree and would prefer config over conf but not sure if the team thinks it's worth to break so much tooling for 3 letters 🤔 (internally it should handle both i guess but that still breaks external tooling)

FabianLars avatar Aug 20 '24 08:08 FabianLars

Added it to the 2.0 Stabilization project to at least talk/think about it before stable so we don't regret it a month after release 🙃

FabianLars avatar Aug 20 '24 08:08 FabianLars

I think this is something we should make backward compatible in any way. So I don't think this needs/should be part of 2.0, as we will need to change tons of docs, expect places to be outdated and will have more issues with this short term. I would vote for introducing an alternative (tauri.config.json) file name in a minor 2.x release and deprecate the "old" way in one or two later majors.

Not against the change and think it would be a good thing to align with the ecosystem.

tweidinger avatar Aug 27 '24 10:08 tweidinger

The conf name was just an inheritance from quasar.conf.json - and they also changed to support both options :) I agree with tweidinger here.

lucasfernog avatar Aug 27 '24 14:08 lucasfernog