Central config file

[auchri]

First of all, thank you for your work!

We want that all of our projects are formatted with the same configuration, but we do not want to copy the configuration to every project (if we change something, we would have to update all the config files).

I suggest adding a field to the settings page where a path to a config file can be specified.

If a path is chosen, then this file gets used. Otherwise, the current logic should be used.

[pustekuchen91]

This relates to #11

We would be happy with searching upwards for the config file or a global field in the settings of the plugin.

@zaneduffield is there a schedule when this will be supported?

[fourls]

Hi both - the plugin currently uses pasfmt's default behaviour for finding config files, which is to start in the working directory and search upwards for a pasfmt.toml.

This means that if your projects are grouped under a common root directory, you could put a pasfmt.toml there and it would apply to all projects under that directory (provided there are no other pasfmt.tomls that are closer to each project).

For example:

projects/
  pasfmt.toml
  project1/
    foo.pas
  project2/
    bar.pas
  project3/
    baz.pas

That being said, I agree a global config file would be more convenient and a good quality of life improvement. It's definitely something we'd be happy to look into.

[pustekuchen91]

Thank you @fourls for explaining. I didnt double-checked the bahvior, but i can confirm now that it works like expected.

Maybe this behavior could be explained in the readme, because its missing atm.

[zaneduffield]

I realised today that I didn't have notifications turned on for this repository; I hadn't seen this issue or #18 yet.

@pustekuchen91

This relates to #11

We would be happy with searching upwards for the config file or a global field in the settings of the plugin.

The change in behaviour suggested in #11 was to which working directory is selected before invoking pasfmt. As @fourls explained, the active project's root directory is currently the working directory, which acts as the starting point for pasfmt's config search.

---

Maybe this behavior could be explained in the readme, because its missing atm.

We currently defer to pasfmt's documentation about how the config search works

pasfmt-rad/README.md

Lines 32 to 36 in 3c3829d

	## Configuration
	To customise the configuration, create a file called `pasfmt.toml` in the root directory of the project you are
	formatting. For more information, see the
	[Configuration section](https://github.com/integrated-application-development/pasfmt#Configuration) of `pasfmt`.

And over at https://github.com/integrated-application-development/pasfmt#Configuration it says

To customise the configuration, create a file called pasfmt.toml in the root directory of the project you are formatting. Make sure that pasfmt is being run from that directory, or a child directory.

I agree that this could be better explained, in particular pasfmt could elaborate on how the search progresses upwards from the working directory, and pasfmt-rad could explain how the working directory is selected.

---

With regards to this issue, I agree that a setting for a global config file is a good idea.

@zaneduffield is there a schedule when this will be supported?

Sorry, but there's no schedule for anything. We maintain this project and pasfmt in spare time at work, and we're focussing our priorities elsewhere at the moment.

The project is open to external contributions, though, and this would be one of the easier things to add support for because pasfmt has a --config-file option. It would be a matter of following the existing pattern for settings and plumbing the value through a couple of layers. The setting for ExecutablePath would be an ideal one to copy.

See

pasfmt-rad/Pasfmt.Settings.pas

Line 40 in 3c3829d

property ExecutablePath: string read FExecutablePath write SetExecutablePath;

pasfmt-rad/Pasfmt.Settings.pas

Lines 172 to 175 in 3c3829d

	if FRegistry.ValueExists(CExecutablePathName) then
	FExecutablePath := FRegistry.ReadString(CExecutablePathName)
	else
	FRegistry.WriteString(CExecutablePathName, FExecutablePath);

https://github.com/integrated-application-development/pasfmt-rad/blob/3c3829dececeb3022cb8308cae809c271c3c4559/Pasfmt.SettingsFrame.pas

pasfmt-rad/Pasfmt.FormatCore.pas

Lines 101 to 102 in 3c3829d

	CommandLine :=
	System.SysUtils.Format('"%s" -C encoding=utf-8 --cursor=%s', [EffectiveExe, SerializeCursors(Cursors)]);

[danno71]

I want a central config file for all Projects. So i changed the function TFormatter.Format in Pasfmt.FormatCore.pas from

CommandLine :=
System.SysUtils.Format('"%s" -C encoding=utf-8 --cursor=%s', [EffectiveExe, SerializeCursors(Cursors)]);

to

EffectiveToml := ChangeFileExt(EffectiveExe, '.toml');

if FileExists(EffectiveToml) then
begin
CommandLine :=
System.SysUtils.Format('"%s" --config-file "%s" --cursor=%s', [EffectiveExe, EffectiveToml, SerializeCursors(Cursors)]);
end
else
begin
CommandLine :=
System.SysUtils.Format('"%s" -C encoding=utf-8 --cursor=%s', [EffectiveExe, SerializeCursors(Cursors)]);
end;

Maybe it's useful for someone.

[EDIT]
Copy/Paste error fixed. Central config file for all Projects means to me .toml near by the .exe