luk400 / vim-jukit

Jupyter-Notebook inspired Neovim/Vim Plugin
MIT License
602 stars 23 forks source link

Git workaround vim-jukit python files #89

Open MattsonCam opened 1 year ago

MattsonCam commented 1 year ago

Preface

vim-jukit is one of the best, if not the best, tool for solving and exploring data science challenges. On that note, I hope to continue using vim-jukit for a while, which is why I want to see if there is a good solution to the problem I am facing:

Background

Suffice it to say I can't include vim-jukit formatted python files in my github repo. Up to this point I have been including all python files in my .gitignore, and have specified exceptions for other specific python files I've wanted to include, such as utils. This worked for a while, but now I want to use other plugins, that respect the .gitignore, to identify my vim-jukit python files, such as nvim-telescope.

Is there any easy way to not include the vim-jukit python files in my github repo and still use plugins that respect the .gitignore file?

luk400 commented 1 year ago

You could just use the convention to name your jukit files like this: <somefilename>.jukit.py Then simply specify the rule *.jukit.py in your gitignore. Would that solve your problem, or am I misunderstanding?

MattsonCam commented 1 year ago

Thanks for the suggestion, unfortunately, this rule would prevent these jukit python files from being recognized by programs that use gitignore.

The nvim-telescope plugin, for example, can be used to jump between files in a git repo using fuzzy finder. However, nvim-telescope ignores files in the gitignore, so I wouldn't be able to find and jump to one of these jukit python files, if that makes sense?

luk400 commented 1 year ago

So you want to not include jukit files in your github repo, and you use .gitignore to accomplish that. But then you don't want other tools/plugins to ignore the jukit files based on the .gitignore, right?

That seems to be a problem that you can only solve by configuring your other tools/plugins accordingly (like telling telescope to not use the .gitignore), no?

There's really nothing I could implement in vim-jukit to fix that, or am I missing something obvious here?

MattsonCam commented 10 months ago

Thanks for the quick response, and apologies for the delay. That's correct. I don't think there is anything you could implement to fix this. I think this is a rare problem, since vim-jukit uses a format unlike the typical python or jupyter files which also seems advantageous.

One possible solution could be to modify the git commands to use a MIME type or a file extension to exclude vim-jukit python files. Another solution could be to save the vim-jukit python files in separate folder on the github repo.

When converting a vim-jukit python file to a jupyter notebook file with <leader>np is it possible to specify an alternative save location? This would be in contrast to saving the converted file in the current working directory.