{"id":13130,"date":"2019-04-01T02:26:18","date_gmt":"2019-04-01T02:26:18","guid":{"rendered":"http:\/\/www.appservgrid.com\/paw92\/?p=13130"},"modified":"2019-04-01T02:26:18","modified_gmt":"2019-04-01T02:26:18","slug":"how-to-make-vim-editor-as-bash-ide-using-bash-support-plugin-in-linux","status":"publish","type":"post","link":"https:\/\/www.appservgrid.com\/paw92\/index.php\/2019\/04\/01\/how-to-make-vim-editor-as-bash-ide-using-bash-support-plugin-in-linux\/","title":{"rendered":"How to Make \u2018Vim Editor\u2019 as Bash-IDE Using \u2018bash-support\u2019 Plugin in Linux"},"content":{"rendered":"

An\u00a0IDE<\/strong>\u00a0(Integrated Development Environment<\/a>) is simply a software that offers much needed programming facilities and components in a single program, to maximize programmer productivity. IDEs put forward a single program in which all development can be done, enabling a programmer to write, modify, compile, deploy and debug programs.<\/p>\n

In this article, we will describe how to\u00a0install and configure Vim editor<\/a>\u00a0as a\u00a0Bash-IDE<\/strong>\u00a0using\u00a0bash-support<\/strong>\u00a0vim plug-in.<\/p>\n

What is bash-support.vim plug-in?<\/h4>\n

bash-support<\/strong>\u00a0is a highly-customizable vim plug-in, which allows you to insert: file headers, complete statements, comments, functions, and code snippets. It also enables you to perform syntax checking, make a script executable, start a debugger simply with a keystroke; do all this without closing the editor.<\/p>\n

It generally makes bash scripting fun and enjoyable through organized and consistent writing\/insertion of file content using shortcut keys (mappings).<\/p>\n

The current version plug-in is\u00a04.3<\/strong>, version\u00a04.0<\/strong>\u00a0was a rewriting of version\u00a03.12.1<\/strong>; versions 4.0 or better, are based on a comprehensively new and more powerful template system, with changed template syntax unlike previous versions.<\/p>\n

How To Install Bash-support Plug-in in Linux<\/h3>\n

Start by downloading the latest version of\u00a0bash-support plug-in<\/a>\u00a0using the command below:<\/p>\n

$ cd Downloads\r\n$ curl http:\/\/www.vim.org\/scripts\/download_script.php?src_id=24452 >bash-support.zip\r\n<\/pre>\n
Then install it as follows; create the\u00a0.vim<\/code>\u00a0directory in your home folder (in case it doesn\u2019t exist), move into it and extract the contents of\u00a0bash-support.zip<\/strong>\u00a0there:<\/p>\n
$ mkdir ~\/.vim\r\n$ cd .vim\r\n$ unzip ~\/Downloads\/bash-support.zip\r\n<\/pre>\n
Next, activate it from the\u00a0.vimrc<\/code>\u00a0file:<\/p>\n
$ vi ~\/.vimrc\r\n<\/pre>\n
By inserting the line below:<\/p>\n
filetype plug-in on   \r\nset number   #optionally add this to show line numbers in vim\r\n<\/pre>\n
How To Use Bash-support plug-in with Vim Editor<\/h3>\n
To simplify its usage, the frequently used constructs as well as certain operations can be inserted\/performed with key mappings respectively. The mappings are described in\u00a0~\/.vim\/doc\/bashsupport.txt<\/strong>\u00a0and\u00a0~\/.vim\/bash-support\/doc\/bash-hotkeys.pdf<\/strong>\u00a0or\u00a0~\/.vim\/bash-support\/doc\/bash-hotkeys.tex<\/strong>\u00a0files.<\/p>\n
Important:<\/h5>\n
    \n
  1. All mappings ((\\)+charater(s)<\/code>\u00a0combination) are filetype specific: they are only work with\u00a0\u2018sh\u2019<\/strong>\u00a0files, in order to avoid conflicts with mappings from other plug-ins.<\/li>\n
  2. Typing speed matters-when using key mapping, the combination of a leader\u00a0('\\')<\/code>\u00a0and the following character(s) will only be recognized for a short time (possibly less than\u00a03<\/strong>\u00a0seconds \u2013 based on assumption).<\/li>\n<\/ol>\n
    Below are certain remarkable features of this plug-in that we will explain and learn how to use:<\/p>\n
    How To Generate an Automatic Header for New Scripts<\/h4>\n
    Look at the sample header below, to have this header created automatically in all your new bash scripts, follow the steps below.<\/p>\n
    \n
    \"Script<\/a><\/p>\n
    Script Sample Header Options<\/p>\n<\/div>\n
    Start by setting your personal details (author name, author reference, organization, company etc). Use the map\u00a0\\ntw<\/code>\u00a0inside a Bash buffer (open a test script as the one below) to start the template setup wizard.<\/p>\n
    Select option\u00a0(1)<\/strong>\u00a0to setup the personalization file, then press\u00a0[Enter]<\/strong>.<\/p>\n
    $ vi test.sh\r\n<\/pre>\n
    \n
    \"Set<\/a><\/p>\n
    Set Personalizations in Scripts File<\/p>\n<\/div>\n
    Afterwards, hit\u00a0[Enter]<\/strong>\u00a0again. Then select the option\u00a0(1)<\/strong>\u00a0one more time to set the location of the personalization file and hit\u00a0[Enter]<\/strong>.<\/p>\n
    \n
    \"Set<\/a><\/p>\n
    Set Personalization File Location<\/p>\n<\/div>\n
    The wizard will copy the template file\u00a0.vim\/bash-support\/rc\/personal.templates<\/strong>\u00a0to\u00a0.vim\/templates\/personal.templates<\/strong>\u00a0and open it for editing, where you can insert your details.<\/p>\n
    Press\u00a0i<\/code>\u00a0to insert the appropriate values within the single quotes as shown in the screenshot.<\/p>\n
    \n
    \"Add<\/a><\/p>\n
    Add Info in Script Header<\/p>\n<\/div>\n
    Once you have set the correct values, type\u00a0:wq<\/code>\u00a0to save and exit the file. Close the Bash test script, open another script to check the new configuration. The file header should now have your personal details similar to that in the screen shot below:<\/p>\n
    $ test2.sh\r\n<\/pre>\n
    \n
    \"Auto<\/a><\/p>\n
    Auto Adds Header to Script<\/p>\n<\/div>\n
    Make Bash-support Plug-in Help Accessible<\/h4>\n
    To do this, type the command below on the\u00a0Vim<\/strong>\u00a0command line and press [Enter<\/strong>], it will create a file\u00a0.vim\/doc\/tags<\/strong>:<\/p>\n
    :helptags $HOME\/.vim\/doc\/\r\n<\/pre>\n
    \n
    \"Add<\/a><\/p>\n
    Add Plugin Help in Vi Editor<\/p>\n<\/div>\n
    How To Insert Comments in Shell Scripts<\/h4>\n
    To insert a framed comment, type\u00a0\\cfr<\/code>\u00a0in normal mode:<\/p>\n
    \n
    \"Add<\/a><\/p>\n
    Add Comments to Scripts<\/p>\n<\/div>\n
    How To Insert Statements in a Shell Script<\/h4>\n
    The following are key mappings for inserting statements (n<\/code>\u00a0\u2013 normal mode,\u00a0i<\/code>\u00a0\u2013 insert mode):<\/p>\n
      \n
    1. \\sc<\/code>\u00a0\u2013 case in \u2026 esac\u00a0(n, I)<\/strong><\/li>\n
    2. \\sei<\/code>\u00a0\u2013 elif then\u00a0(n, I)<\/strong><\/li>\n
    3. \\sf<\/code>\u00a0\u2013 for in do done\u00a0(n, i, v)<\/strong><\/li>\n
    4. \\sfo<\/code>\u00a0\u2013 for ((\u2026)) do done\u00a0(n, i, v)<\/strong><\/li>\n
    5. \\si<\/code>\u00a0\u2013 if then fi\u00a0(n, i, v)<\/strong><\/li>\n
    6. \\sie<\/code>\u00a0\u2013 if then else fi\u00a0(n, i, v)<\/strong><\/li>\n
    7. \\ss<\/code>\u00a0\u2013 select in do done\u00a0(n, i, v)<\/strong><\/li>\n
    8. \\su<\/code>\u00a0\u2013 until do done\u00a0(n, i, v)<\/strong><\/li>\n
    9. \\sw<\/code>\u00a0\u2013 while do done\u00a0(n, i, v)<\/strong><\/li>\n
    10. \\sfu<\/code>\u00a0\u2013 function\u00a0(n, i, v)<\/strong><\/li>\n
    11. \\se<\/code>\u00a0\u2013 echo -e \u201c\u2026\u201d\u00a0(n, i, v)<\/strong><\/li>\n
    12. \\sp<\/code>\u00a0\u2013 printf \u201c\u2026\u201d\u00a0(n, i, v)<\/strong><\/li>\n
    13. \\sa<\/code>\u00a0\u2013 array element, ${.[.]}\u00a0(n, i, v)<\/strong>\u00a0and many more array features.<\/li>\n<\/ol>\n
      Insert a Function and Function Header<\/h4>\n
      Type\u00a0\\sfu<\/code>\u00a0to add a new empty function, then add the function name and press\u00a0[Enter]<\/strong>\u00a0to create it. Afterwards, add your function code.<\/p>\n
      \n
      \"Insert<\/a><\/p>\n
      Insert New Function in Script<\/p>\n<\/div>\n
      To create a header for the function above, type\u00a0\\cfu<\/code>, enter name of the function, click\u00a0[Enter]<\/strong>\u00a0and fill in the appropriate values (name, description, parameters and returns):<\/p>\n
      \n
      \"Create<\/a><\/p>\n
      Create Header Function in Script<\/p>\n<\/div>\n
      More Examples of Adding Bash Statements<\/h4>\n
      Below is an example showing insertion of an if statement using\u00a0\\si<\/code>:<\/p>\n
      \n
      \"Add<\/a><\/p>\n
      Add Insert Statement to Script<\/p>\n<\/div>\n
      Next example showing addition of an\u00a0echo<\/strong>\u00a0statement using\u00a0\\se<\/code>:<\/p>\n
      \n
      \"Add<\/a><\/p>\n
      Add echo Statement to Script<\/p>\n<\/div>\n
      How To Use Run Operation in Vi Editor<\/h4>\n
      The following is a list of some run operations key mappings:<\/p>\n
        \n
      1. \\rr<\/code>\u00a0\u2013 update file, run script\u00a0(n, I)<\/strong><\/li>\n
      2. \\ra<\/code>\u00a0\u2013 set script cmd line arguments\u00a0(n, I)<\/strong><\/li>\n
      3. \\rc<\/code>\u00a0\u2013 update file, check syntax\u00a0(n, I)<\/strong><\/li>\n
      4. \\rco<\/code>\u00a0\u2013 syntax check options\u00a0(n, I)<\/strong><\/li>\n
      5. \\rd<\/code>\u00a0\u2013 start debugger\u00a0(n, I)<\/strong><\/li>\n
      6. \\re<\/code>\u00a0\u2013 make script executable\/not exec.(*) (in)<\/li>\n<\/ol>\n
        Make Script Executable<\/h4>\n
        After writing script, save it and type\u00a0\\re<\/code>\u00a0to make it executable by pressing\u00a0[Enter]<\/strong>.<\/p>\n
        \n
        \"Make<\/a><\/p>\n
        Make Script Executable<\/p>\n<\/div>\n
        How To Use Predefined Code Snippets To a Bash Script<\/h4>\n
        Predefined code snippets are files that contain already written code meant for a specific purpose. To add code snippets, type\u00a0\\nr<\/code>\u00a0and\u00a0\\nw<\/code>\u00a0to read\/write predefined code snippets. Issue the command that follows to list default code snippets:<\/p>\n
        $ .vim\/bash-support\/codesnippets\/\r\n<\/pre>\n
        \n
        \"List<\/a><\/p>\n
        List of Code Snippets<\/p>\n<\/div>\n
        To use a code snippet such as free-software-comment, type\u00a0\\nr<\/code>\u00a0and use auto-completion feature to select its name, and press\u00a0[Enter]<\/strong>:<\/p>\n
        \n
        \"Add<\/a><\/p>\n
        Add Code Snippet to Script<\/p>\n<\/div>\n
        Create Custom Predefined Code Snippets<\/h4>\n
        It is possible to write your own code snippets under\u00a0~\/.vim\/bash-support\/codesnippets\/<\/strong>. Importantly, you can also create your own code snippets from normal script code:<\/p>\n
          \n
        1. choose the section of code that you want to use as a code snippet, then press\u00a0\\nw<\/code>, and closely give it a filename.<\/li>\n
        2. to read it, type\u00a0\\nr<\/code>\u00a0and use the filename to add your custom code snippet.<\/li>\n<\/ol>\n
          View Help For the Built-in and Command Under the Cursor<\/h4>\n
          To display help, in normal mode, type:<\/p>\n
            \n
          1. \\hh<\/code>\u00a0\u2013 for built-in help<\/li>\n
          2. \\hm<\/code>\u00a0\u2013 for a command help<\/li>\n<\/ol>\n
            \n
            \"View<\/a><\/p>\n
            View Built-in Command Help<\/p>\n<\/div>\n
            For more reference, read through the file :<\/p>\n
            ~\/.vim\/doc\/bashsupport.txt  #copy of online documentation\r\n~\/.vim\/doc\/tags\r\n<\/pre>\n
            Visit the Bash-support plug-in Github repository:\u00a0https:\/\/github.com\/WolfgangMehner\/bash-support<\/a>
            \nVisit Bash-support plug-in on the Vim Website:\u00a0            http:\/\/www.vim.org\/scripts\/script.php?script_id=365<\/a><\/p>\n
            That\u2019s all for now, in this article, we described the steps of installing and configuring Vim as a Bash-IDE in Linux using bash-support plug-in. Check out the other exciting features of this plug-in, and do share them with us in the comments.<\/p>\n
            Source<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
            An\u00a0IDE\u00a0(Integrated Development Environment) is simply a software that offers much needed programming facilities and components in a single program, to maximize programmer productivity. IDEs put forward a single program in which all development can be done, enabling a programmer to write, modify, compile, deploy and debug programs. In this article, we will describe how to\u00a0install … <\/p>\n
            Continue reading “How to Make \u2018Vim Editor\u2019 as Bash-IDE Using \u2018bash-support\u2019 Plugin in Linux”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-13130","post","type-post","status-publish","format-standard","hentry","category-linux"],"_links":{"self":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts\/13130","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/comments?post=13130"}],"version-history":[{"count":1,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts\/13130\/revisions"}],"predecessor-version":[{"id":13131,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts\/13130\/revisions\/13131"}],"wp:attachment":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/media?parent=13130"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/categories?post=13130"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/tags?post=13130"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}