Run `fish_indent` on `funcsave` by kidonng · Pull Request #8603 · fish-shell/fish-shell

kidonng · 2022-01-02T11:07:29Z

Description

funced already run fish_indent when the editor is fish:

Lines 61 to 75 in f254692

    
           if test "$editor" = fish 
        
               if functions -q -- $funcname 
        
                   functions --no-details -- $funcname | fish_indent --no-indent | read -z init 
        
               end 
        
               set -l prompt 'printf "%s%s%s> " (set_color green) '$funcname' (set_color normal)' 
        
               if read -p $prompt -c "$init" --shell cmd 
        
                   echo -n $cmd | fish_indent | read -lz cmd 
        
                   eval "$cmd" 
        
               end 
        
               if set -q _flag_save 
        
                   funcsave $funcname 
        
               end 
        
               return 0 
        
           end

It makes sense to have funcsave run it as well.

Maybe we should also run fish_indent after funced finishes?

TODOs:

Changes to fish usage are reflected in user documentation/manpages.
Tests have been added for regressions fixed
User-visible changes noted in CHANGELOG.rst

floam · 2022-01-03T11:47:55Z

I'm not sure about this one. If I enter a function a certain way interactively, can see it that way with 'functions', might I be a little surprised to find something different written to disk?

kidonng · 2022-01-03T14:16:36Z

Interestingly, funcsave's manpage says:

This function will be automatically loaded by current and future fish sessions.

But the functions is clearly not autoloaded:

$ function t; end
$ functions -Dv t
stdin
n/a
0
scope-shadowing
n/a

Is the manpage wrong, or the function can be made autoloaded later via some magic I don't know? If the latter is true, then the function shown in functions will be formatted as well once fish autoloads it.

Ideally fish will automatically run fish_indent on interactively defined functions. But for this PR, there are some solutions I can think of:

Do nothing about the interactively defined function. I don't really think it's a problem, since fish_indent doesn't change anything except the format. We can mention in the manpage that if people really want to preserve the format for some reason, just run functions --no-details -- $funcname > $file themselves.
Only run fish_indent if given a -f/--format flag. Surely everything can be an option right?
source the just saved function file. This however changes the description of the function from Defined interactively to Defined in foo.fish @ line 1.
eval the formatted function and save it. That way the description of the function stays Defined interactively but eval is evil...

IlanCosman · 2022-01-05T01:57:44Z

But the functions is clearly not autoloaded:

I don't see where you ran funcsave t. You need to do so to have t be autoloaded. And it won't say autoloaded in the current shell, because it wasn't autoloaded, you defined it interactively. In future shells it will be autoloaded, and will say so correctly.

faho · 2022-02-08T19:19:40Z

Okay, it seems we don't want to do this. Sorry!

kidonng · 2022-02-09T02:22:53Z

Okay, it seems we don't want to do this. Sorry!

@faho would you be happy to accept a PR to add the functionality behind a flag (e.g. funcsave --indent), instead of doing it automatically (which may not be what the user expect), as mentioned above?

floam · 2022-02-09T03:07:59Z

Something I was not aware of until just now: functions created interactively seem not to have tabs preserved at all:

kidonng · 2022-02-09T04:07:27Z

Something I was not aware of until just now: functions created interactively seem not to have tabs preserved at all:

Right, that's the initial motivation of this PR. I got tired of having to run fish_indent manually after funcsave, because the saved function is not indented all.

krobelus · 2022-02-09T05:36:33Z

I haven't found time to think about this. As a workaround, how about teaching your editor to run fish_indent when you save a *.fish file?

kidonng · 2022-02-09T13:08:11Z

As a workaround, how about teaching your editor to run fish_indent when you save a *.fish file?

Actually my main editor (VSCode) is already configured so (via https://marketplace.visualstudio.com/items?itemName=bmalehorn.vscode-fish), however I have the issue when defining it interactively (as demonstrated by @floam above).

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes fish-shell#8603

krobelus · 2024-04-12T09:49:14Z

this should be addressed by #10437 which makes functions foo and type foo output indented code

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes #8603

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes fish-shell#8603

Run fish_indent after funcsave

76bf5df

Use pipe instead

0f9dc34

kidonng changed the title ~~Run fish_indent after funcsave~~ Run fish_indent on funcsave Jan 4, 2022

faho closed this Feb 8, 2022

github-actions bot locked as resolved and limited conversation to collaborators Feb 13, 2023

krobelus added this to the fish next-3.x milestone Apr 12, 2024

krobelus added a commit to krobelus/fish-shell that referenced this pull request Apr 12, 2024

builtins type/functions: indent interactively-defined functions

3700d6a

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes fish-shell#8603

krobelus added a commit to krobelus/fish-shell that referenced this pull request Apr 12, 2024

builtins type/functions: indent interactively-defined functions

e06675b

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes fish-shell#8603

krobelus added a commit that referenced this pull request Apr 15, 2024

builtins type/functions: indent interactively-defined functions

611a057

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes #8603

vertesians pushed a commit to vertesians/fish-shell that referenced this pull request Apr 17, 2024

builtins type/functions: indent interactively-defined functions

fe74523

This means that in case no editor is defined, "fish_indent" is now required to fix the indentation. Fixes fish-shell#8603

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Run `fish_indent` on `funcsave`#8603

Run `fish_indent` on `funcsave`#8603
kidonng wants to merge 2 commits intofish-shell:masterfrom
kidonng:patch-8

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	if test "$editor" = fish
	if functions -q -- $funcname
	functions --no-details -- $funcname \| fish_indent --no-indent \| read -z init
	end

	set -l prompt 'printf "%s%s%s> " (set_color green) '$funcname' (set_color normal)'
	if read -p $prompt -c "$init" --shell cmd
	echo -n $cmd \| fish_indent \| read -lz cmd
	eval "$cmd"
	end
	if set -q _flag_save
	funcsave $funcname
	end
	return 0
	end

Uh oh!

Conversation

Uh oh!

Description

TODOs:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants