document workflow for local plugin development #317

TomasTomecek · 2018-03-23T09:22:09Z

Fixes #316

bfredl · 2018-03-24T11:24:08Z

This should probably be in docs/usage/remote-plugins.rst

Though I wonder if recommending a dedicated vimrc is a bit overblown. Most plugin managers can add a explicit path, or one could just

set rtp+=~/dev/nvim-myplugin/

in the normal init.vim

justinmk · 2018-03-24T14:05:21Z

Though I do think the readme should have a self-contained quick start sample.

TomasTomecek · 2018-03-25T08:25:43Z

This should probably be in docs/usage/remote-plugins.rst

Moved.

Though I wonder if recommending a dedicated vimrc is a bit overblown. Most plugin managers can add a > explicit path, or one could just

set rtp+=~/dev/nvim-myplugin/

in the normal init.vim

I think that you don't understand my use case: I want to invoke my plugin while being in my upstream git repository using nvim ... without the need of crippling my global vimrc or committing real paths anywhere in the plugin. The proposed solution by @Shougo does it very nice. If you have a better idea, I would like to hear it.

Also please advise me on what I should do in order to get this PR merged.

justinmk · 2018-03-25T19:52:43Z

docs/usage/remote-plugins.rst

+symlinking it.
+The easiest way to do this is to create a dedicated vimrc file just for sake of
+development of your plugin. If you are in a root of the git repo with the
+plugin, consider creating this vimrc file:


This is rather verbose, it could be 1 sentence.

For local plugin development, it's a good idea to use an isolated vimrc:

That's true, I wanted to be precise. Will shorten.

justinmk · 2018-03-25T19:54:20Z

docs/usage/remote-plugins.rst

+    let &runtimepath.=','.escape(expand('<sfile>:p:h'), '\,')
+
+It will append your current work directory to the runtime path so neovim is
+able to find and load your plugin. You can now invoke neovim:


"neovim" is spell "Nvim" in technical resources (i.e., almost everywhere except the website).

Good catch. I did s/neovim/Neovim/g to match rest of the doc.

bfredl · 2018-03-25T20:06:41Z

I want to invoke my plugin while being in my upstream git repository using nvim ... without the need of crippling my global vimrc or committing real paths anywhere in the plugin.

I fail to see what is "crippling" with adding the main repository directly to the runtime paths. This is how I manage all developed plugins, and instead use branches to switch between "stable" and "development" if needed, just as with all other vcs managed projects. I even "cripple" my rtp with a pure test rplugin which does crazy stuff in methods, because if a method is not called, a remote plugin by design does nothing.

To be clear I'm not against adding any text for this usecase, but is shouldn't be worded as the "desirable" or "easiest" for local development.

TomasTomecek · 2018-03-26T10:06:14Z

I fail to see what is "crippling" with adding the main repository directly to
the runtime paths. This is how I manage all developed plugins, and instead use
branches to switch between "stable" and "development" if needed, just as with
all other vcs managed projects. I even "cripple" my rtp with a pure test
rplugin which does crazy stuff in methods, because if a method is not called, a
remote plugin by design does nothing.

Sounds like a good idea to describe in detail in the document (or maybe
write a blog post).

To be clear I'm not against adding any text for this usecase, but is shouldn't
be worded as the "desirable" or "easiest" for local development.

I agree this an easier approach. Personally I don't work like this - I instead
prefer to sandbox projects I'm working on.

TomasTomecek · 2018-03-30T06:32:09Z

The CI failure is unrelated:

The build phase is set to "MSBuild" mode (default), but no Visual Studio project or solution files were found in the root directory. If you are not building Visual Studio project switch build mode to "Script" and provide your custom build command.

ping, what do I have to do in order to get this merged?

stsewd · 2018-03-30T07:11:22Z

docs/conf.py

@@ -98,7 +98,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []


Just curious, why did you delete the _static dir?

Because you are not using it and is causing warnings during build of documentation:

9e8a9d0

WARNING: html_static_path entry u'docs/_static' does not exist

stsewd · 2018-03-30T07:13:30Z

docs/usage/remote-plugins.rst

+.. code-block:: console
+
+    :scriptnames
+      1: ~/path/tp/your/plugin-git-repo/vimrc


This should be ~/path/to/... I guess, right?

good catch!

Fixes neovim#316 Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

``` WARNING: html_static_path entry u'docs/_static' does not exist docs/usage/remote-plugins.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. ``` Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

TomasTomecek · 2018-04-04T06:01:48Z

Updated.

justinmk · 2018-04-05T23:14:15Z

docs/usage/remote-plugins.rst

+
+If you are working on your plugin locally, it may be desirable to run the
+plugin from a git repository directly without the need of installing or
+symlinking it.


This kind of thing does not need to be spelled out in extreme detail, we have to assume some basic level of familiarity with software development. So we really need to keep the documents concise, to avoid reader fatigue.

I'll be honest, this is something I prefer myself: having documentation as clear as possible. I don't like when I have to read between the lines and figure out details myself the hard way (such as, how do I make nvim pick up my plugin from $PWD?).

I completely understand if you don't prefer this style and I have no problem adapting. That's why we do these pull requests and reviews, right?

justinmk · 2018-04-05T23:17:00Z

docs/usage/remote-plugins.rst

+
+.. code-block:: console
+
+    $ cat vimrc


The $ makes copy-pasting commands really annoying. Even if it's ambiguous, it's generally not a problem. And it confuses Windows users.

justinmk · 2018-04-05T23:20:13Z

merged, thanks. Made some edits for brevity.

TomasTomecek · 2018-04-06T07:46:04Z

Thanks Justin! I hope it will help some nvim-plugin-devs newbies (such as myself).

This release adds support for Python 3.7 which now is in beta. `async` is a keyword in python3.7, and it should be replaced with `async_` when used as a keyword argument to API methods. `async` is still supported with python 2.7 and 3.6 for the moment, but considered deprecated. Also, integration with the in-process lua interpreter in Nvim is now supported. Changes since 0.2.4: * debcde0 clean up remote object implementation (#313) * e880fe7 Guidelines for local plugin development (#317) * 1ab98e8 Update the working directory on DirChanged for legacy plugins (#296) * d53415d Fix SyntaxError in py3.7: use `async_` instead of `async` (#274) * b65f62d Use `pytest` as `nosetests` are not longer maintained (#266) * d9aed96 Support using lua functions. `buf.update_higlights` as an internal example (#325)

TomasTomecek force-pushed the document-local-dev-workflow branch from a34a3f8 to 371d549 Compare March 23, 2018 09:24

TomasTomecek force-pushed the document-local-dev-workflow branch from 371d549 to a8fdfda Compare March 25, 2018 08:20

justinmk reviewed Mar 25, 2018

View reviewed changes

TomasTomecek force-pushed the document-local-dev-workflow branch from a8fdfda to 9e8a9d0 Compare March 26, 2018 10:07

stsewd reviewed Mar 30, 2018

View reviewed changes

TomasTomecek added 2 commits April 4, 2018 07:59

document workflow for local plugin development

597ce65

Fixes neovim#316 Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

docs: fix warnings:

61af8a8

``` WARNING: html_static_path entry u'docs/_static' does not exist docs/usage/remote-plugins.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. ``` Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

TomasTomecek force-pushed the document-local-dev-workflow branch from 9e8a9d0 to 61af8a8 Compare April 4, 2018 05:59

justinmk reviewed Apr 5, 2018

View reviewed changes

justinmk closed this Apr 5, 2018

TomasTomecek deleted the document-local-dev-workflow branch April 6, 2018 07:38

This was referenced Apr 12, 2018

How do I write plugin tests which interact with neovim? #314

Closed

What's the easiest way to develop a new plugin? #316

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

document workflow for local plugin development #317

document workflow for local plugin development #317

TomasTomecek commented Mar 23, 2018

bfredl commented Mar 24, 2018

justinmk commented Mar 24, 2018

TomasTomecek commented Mar 25, 2018

justinmk Mar 25, 2018

TomasTomecek Mar 26, 2018

justinmk Mar 25, 2018

TomasTomecek Mar 26, 2018

bfredl commented Mar 25, 2018

TomasTomecek commented Mar 26, 2018

TomasTomecek commented Mar 30, 2018

stsewd Mar 30, 2018

TomasTomecek Apr 4, 2018

stsewd Mar 30, 2018

TomasTomecek Apr 4, 2018

TomasTomecek commented Apr 4, 2018

justinmk Apr 5, 2018

TomasTomecek Apr 6, 2018

justinmk Apr 5, 2018 •

edited

justinmk commented Apr 5, 2018

TomasTomecek commented Apr 6, 2018

document workflow for local plugin development #317

document workflow for local plugin development #317

Conversation

TomasTomecek commented Mar 23, 2018

bfredl commented Mar 24, 2018

justinmk commented Mar 24, 2018

TomasTomecek commented Mar 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bfredl commented Mar 25, 2018

TomasTomecek commented Mar 26, 2018

TomasTomecek commented Mar 30, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomasTomecek commented Apr 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmk Apr 5, 2018 • edited

Choose a reason for hiding this comment

justinmk commented Apr 5, 2018

TomasTomecek commented Apr 6, 2018

justinmk Apr 5, 2018 •

edited