Skip to content

feat(startup): add v:argf for startup file arguments #35889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat(startup): add v:argf for startup file arguments #35889

wants to merge 1 commit into from
+51 −0

Conversation

SanzharKuandyk
Copy link

@SanzharKuandyk SanzharKuandyk commented Sep 23, 2025 •
edited by justinmk
Loading

Note: descriptions are AI-generated

Add v:argf to track original startup file arguments #35847

Problem

  • :args and argv() can change after startup.
  • v:arg includes options/commands, not just files.
  • Plugins (e.g. Oil) may rewrite directory args.

Solution

  • New read-only var v:argf: snapshot of file/dir args at startup.
  • Unaffected by :args or plugins.
  • Unlike v:argv, excludes options/commands.

Example

nvim file1.txt dir1 file2.txt
echo v:argf
" ['file1.txt', 'dir1', 'file2.txt']

fix #35847

@SanzharKuandyk SanzharKuandyk mentioned this pull request Sep 23, 2025
Open
@justinmk
Copy link
Member

justinmk commented Sep 23, 2025 •
edited
Loading

Looks ok to me, but the verbosity indicates that this was AI generated. Always mention that, and also please prune the irrelevant details where possible. The PR, and its description, should be complete yet concise.

And as the issue label indicates, I would prefer if I heard whether people actually want this feature, or if I missed some other possible way to achieve it already.

@SanzharKuandyk
Copy link
Author

Thank u for the feedback!

And as the issue label indicates, I would prefer if I heard whether people actually want this feature, or if I missed some other possible way to achieve it already.

Yeah, keeping this as a draft

@SanzharKuandyk
feat(startup): add v:argf for startup file arguments
5958d60 
Introduce the read-only Vim variable v:argf that stores the original
file arguments passed at startup. Unlike v:argv, v:argf contains only
raw file arguments and remains unchanged by :args commands or plugins.

This is implemented via set_argf_var() called at startup, and documented
in runtime/doc/vvars.txt. VV_ARGF is registered as a VAR_LIST and VAR_RO.
justinmk
justinmk reviewed Oct 7, 2025
View reviewed changes
runtime/doc/vvars.txt
See |v:progpath| for the command with full path.

*v:argf* *argf-variable*
v:argf
Copy link
Member

Choose a reason for hiding this comment

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

alphanumeric order. this should go before v:argv

justinmk
justinmk reviewed Oct 7, 2025
View reviewed changes
src/nvim/eval.c
VV(VV_VERSIONLONG, "versionlong", VAR_NUMBER, VV_RO),
VV(VV_ECHOSPACE, "echospace", VAR_NUMBER, VV_RO),
VV(VV_ARGV, "argv", VAR_LIST, VV_RO),
VV(VV_ARGF, "argf", VAR_LIST, VV_RO),
Copy link
Member

@justinmk justinmk Oct 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

should go before ARGV

justinmk
justinmk reviewed Oct 7, 2025
View reviewed changes
src/nvim/eval_defs.h
VV_VERSIONLONG,
VV_ECHOSPACE,
VV_ARGV,
VV_ARGF,
Copy link
Member

Choose a reason for hiding this comment

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

should go before ARGV

justinmk
justinmk reviewed Oct 7, 2025
View reviewed changes
src/nvim/vvars.lua
See |v:progpath| for the command with full path.
]=],
},
argf = {
Copy link
Member

Choose a reason for hiding this comment

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

before argv

justinmk
justinmk reviewed Oct 7, 2025
View reviewed changes
src/nvim/main.c
list_T *list = tv_list_alloc(kListLenMayKnow);

for (int i = 0; i < GARGCOUNT; i++) {
char *fname = alist_name(&GARGLIST[i]);
Copy link
Member

Choose a reason for hiding this comment

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

We probably should expand the filename to an absolute path, since CWD can change after startup, which would make v:argf not very useful thereafter.

And need a test for that scenario.

Also need tests for the -- case:

nvim ... -- file1 file2

And need tests that check what happens if the user calls :argadd in a -c or --cmd option:

nvim --cmd "argadd file1.txt" -c "argadd file2.txt"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justinmk justinmk justinmk left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

v:argf gets file/directory args passed at startup
2 participants
@SanzharKuandyk @justinmk