feat: add external-editor-command#2219

Open

trim21 wants to merge 14 commits into

beancount:main from

trim21:external-editor-command

Open

feat: add external-editor-command #2219
trim21 wants to merge 14 commits into
beancount:main from
trim21:external-editor-command

Conversation

@trim21

@trim21 trim21 commented Feb 11, 2026 •

edited

Loading

Copy link

Copy Markdown

Latex have a feature that called "synctex", when you click the pdf, the viewer will know the source code location and execute a command and let you get forcus on your editor and your cursor jump to the lino.

This pr add a new option called "external-editor-command" and replace the new link with a command executed in fava server.

For vscode, the command would look like "code -r -g $file:$lino".

#2197 (comment)

@trim21 trim21 force-pushed the external-editor-command branch from 43a33dd to 0af5145 Compare

February 11, 2026 03:22

@trim21 trim21 marked this pull request as ready for review

February 11, 2026 08:45

@trim21

trim21 commented Feb 11, 2026

Copy link

Copy Markdown

Author

@pinacle2000 I tested this with vscode and it works as I expect, fell free to test it with Emacs

@pinacle2000

pinacle2000 commented Feb 11, 2026

Copy link

Copy Markdown

@pinacle2000 I tested this with vscode and it works as I expect, fell free to test it with Emacs

Great! It works 😄

2024年12月25日 custom "fava-option" "use-external-editor" "true"
2026年02月11日 custom "fava-option" "external-editor-command" "emacsclientw.exe -n +${line} ${file}"

@yagebu

yagebu commented Feb 13, 2026

Copy link

Copy Markdown

Member

Can you remove the option use-external-editor if it's broken, I don't see the point of keeping it around and also rebase this PR a bit?

@trim21

trim21 commented Feb 14, 2026

Copy link

Copy Markdown

Author

Can you remove the option use-external-editor if it's broken, I don't see the point of keeping it around and also rebase this PR a bit?

not all browser has same security limit I think?

But I don't use it so I'm ok to remove it.

Do you want me to sequash the commits?

@trim21 trim21 force-pushed the external-editor-command branch from 54079f0 to c66e44a Compare

February 14, 2026 16:32

yagebu

yagebu requested changes

Feb 15, 2026

View reviewed changes

frontend/src/modals/EntryContextLocation.svelte Outdated

{entry.meta.filename}:{entry.meta.lineno}

</a>

{#if link.mode === "command"}

@yagebu yagebu Feb 15, 2026

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should not be a link but a button

@trim21 trim21 Feb 16, 2026 •

edited

Loading

Copy link

Copy Markdown

Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it will have a different outlook if we use button here, the button and link has differnt style. I don't want to fix it. and using link here won't cause any trouble I think?

src/fava/json_api.py

class ExternalEditorCommandTemplateError(FavaJSONAPIError):

"""External editor command template invalid."""

@yagebu yagebu Feb 15, 2026

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This validation should already happen when the option is set and lead to an error there.

@trim21 trim21 Feb 16, 2026

Copy link

Copy Markdown

Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not really, if the command need more template than ${file} and ${line}, it will failed at api call time but it won't failed when parsing the options

src/fava/core/fava_options.py Outdated

@trim21 trim21 requested a review from yagebu

February 17, 2026 21:27

@trim21

trim21 commented Feb 24, 2026

Copy link

Copy Markdown

Author

@yagebu would you mind take a look?

@yagebu

yagebu commented Mar 1, 2026

Copy link

Copy Markdown

Member

I thought some more about this and am pretty certain that adding this as a fava-option is not a good idea. This makes it way to simple to have a RCE. I think this needs to be configured at a higher layer (similar to e.g. incognito mode).

@trim21

trim21 commented Mar 1, 2026 •

edited

Loading

Copy link

Copy Markdown

Author

I thought some more about this and am pretty certain that adding this as a fava-option is not a good idea. This makes it way to simple to have a RCE. I think this needs to be configured at a higher layer (similar to e.g. incognito mode).

do you want a flag like --unsafe or --private or some else to enable this unsafe feature?

@yagebu

yagebu commented Mar 1, 2026

Copy link

Copy Markdown

Member

do you want a flag like --unsafe or --private or some else to enable this unsafe feature?

No, that's not going to happen, this just needs to be configured elsewhere (was thinking of using configuration in pyproject.toml)

@trim21

trim21 commented Mar 1, 2026

Copy link

Copy Markdown

Author

do you want a flag like --unsafe or --private or some else to enable this unsafe feature?

No, that's not going to happen, this just needs to be configured elsewhere (was thinking of using configuration in pyproject.toml)

tool.fava.trusted = true would be a good idea

@yagebu

yagebu commented Mar 1, 2026

Copy link

Copy Markdown

Member

tool.fava.trusted = true would be a good idea

No, I'm not talking about having some unsafe configuration, but the editor command would have to be configured there

@trim21


 allow read pyproject.toml as config to support external editor command

635e58a

@trim21 trim21 force-pushed the external-editor-command branch from 84c78c9 to 635e58a Compare

March 1, 2026 10:23

trim21 added 9 commits

March 1, 2026 18:32

@trim21


 compute use_external_editor from config

d5e8d02

@trim21


 revert some diff

9f62453

@trim21


 revert some diff

f2cb895

@trim21


 relax tomli

fe6fafa

@trim21


 re-compile pip

072b690

@trim21


 fix svelet syntax

f840e45

@trim21


 fix tests

5704a13

@trim21


 fix: update external_editor_command type to Optional[List[str]]

6173b6d

@trim21


 fix coverage

db40c7b

@trim21

trim21 commented Mar 1, 2026

Copy link

Copy Markdown

Author

@yagebu done, it current read tool.fava.external-editor-command = ["code", '-r', '-g', "${file}:${line}"] from pyproject.toml

trim21 added 3 commits

March 1, 2026 19:10

@trim21


 fix: remove unused urlForSource derived function

d2c7f75

@trim21


 Merge remote-tracking branch 'upstream/main' into external-editor-com...

774082f

...mand
# Conflicts:
#	tests/test_json_api.py
#	uv.lock

@trim21


 Merge remote-tracking branch 'upstream/main' into external-editor-com...

2c6926c

...mand

@trim21

trim21 commented May 3, 2026 •

edited

Loading

Copy link

Copy Markdown

Author

@yagebu anything block this?

@trim21


 use old uv.lock

93d4d5d

Labels

None yet

3 participants

@trim21 @pinacle2000 @yagebu

Conversation

@trim21 trim21 commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trim21 commented Feb 11, 2026

Uh oh!

pinacle2000 commented Feb 11, 2026

Uh oh!

yagebu commented Feb 13, 2026

Uh oh!

trim21 commented Feb 14, 2026

Uh oh!

Uh oh!

@yagebu yagebu Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

@trim21 trim21 Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@yagebu yagebu Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

@trim21 trim21 Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trim21 commented Feb 24, 2026

Uh oh!

yagebu commented Mar 1, 2026

Uh oh!

trim21 commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yagebu commented Mar 1, 2026

Uh oh!

trim21 commented Mar 1, 2026

Uh oh!

yagebu commented Mar 1, 2026

Uh oh!

trim21 commented Mar 1, 2026

Uh oh!

trim21 commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

@trim21 trim21 commented Feb 11, 2026 •

edited

Loading

@trim21 trim21 Feb 16, 2026 •

edited

Loading

trim21 commented Mar 1, 2026 •

edited

Loading

trim21 commented May 3, 2026 •

edited

Loading