n-eq / mbed-vim Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 0.0 33 KB

Execute mbed-CLI commands from within Vim

License: MIT License

Vim Script 100.00%

vim-plugin vim mbed-vim mbed mbed-cli mbed-os vim-plugins

mbed-vim's Introduction

mbed-vim

Execute mbed-CLI commands from within Vim.

Installation

By cloning the repository

$ git clone [email protected]:marrakchino/mbed-vim.git
$ cp mbed-vim/plugin/mbed.vim ~/.vim/plugin

By downloading the plugin file to your plugin directory using wget

$ wget https://raw.githubusercontent.com/marrakchino/mbed-vim/master/plugin/mbed.vim -O ~/.vim/plugin/mbed.vim

Features

Compiling the current application with different options (clean, verbose mode, etc.) and displaying the output when the compilation is unsuccessful.
Adding/Removing a library.
Setting the application's target/toolchain.
Synchronizing the different dependencies.
Running tests and displaying the results.

Default key mappings

<leader>c:   Compile the current application.
<leader>C:   Clean the build directory and compile the current application.
<leader>cf:  Compile and flash the built firmware onto a connected target.
<leader>cv:  Compile the current application in verbose mode.
<leader>cV:  Compile the current application in very verbose mode.
<leader>n:   Create a new mbed program or library.
<leader>s:   Synchronize all library and dependency references.
<leader>t:   Find, build and run tests.
<leader>d:   Import missing dependencies.
<leader>a:   Prompt for an mbed library to add.
<leader>r:   Prompt for an mbed library to remove.
<leader>l:   Display the dependency tree.
<F9>:        Close the error buffer (when open).
<F12>:       Set the current application's target and toolchain.

Commands

Add <library_name>        Add the specified library. When no argument is given,
                            you are prompted for the name of the library.
Remove <library_name>     Remove the specified library. When no argument is given,
                            you are prompted for the name of the library.
SetToolchain <toolchain>  Set a toolchain (ARM, GCC_ARM, IAR).
SetTarget <target>        Set a target.

Contributing

Feel free to contribute to this project, either by opening issues or by forking the repository and opening pull requests.

License

This project is licensed under MIT, see LICENSE file for more.

mbed-vim's People

Contributors

Stargazers

Watchers

mbed-vim's Issues

Check for "ERROR" pattern after a compilation call

https://github.com/nelqatib/mbed-vim/blob/c42067c3880496a14576d672ccaa5c671468bd9e/plugin/mbed.vim#L179

It would be better if we could add a check for "ERROR" pattern in the output of a compile command. The MbedCompile() function would be less error-prone regarding the decision of opening or not a buffer.

Set target/toolchain of the current program when SetTarget/SetToolchain is called?

Maybe we could call, in addition to setting the w:mbed_[target|toolchain] variables, mbed target/mbed toolchain in order to permanently set the target/toolchain of the current project.

[mbed] should be deleted upon `mbed target/toolchain` call

The output of mbed target is something like:
[mbed] TARGET_NAME

The [mbed] should be deleted in order to properly use the w:mbed_target variable.

Avoid searching a pattern in the output of a function to check success

Consider using v:shell_error value after a shell function call

Transform MbedAdd* and MbedRemove* functions to take a variable number of arguments

MbedAdd and MbedRemove functions should allow the user to use them to add/remove many libraries in one call.
see vim varags (http://learnvimscriptthehardway.stevelosh.com/chapters/24.html)