Jump to content

Vim (text editor)

From Wikipedia, the free encyclopedia
(Redirected from Vimscript)

Vim
Original author(s)Bram Moolenaar
Initial release2 November 1991; 33 years ago (2 November 1991)
Stable release
9.1.0[1] Edit this on Wikidata / 2 January 2024; 10 months ago (2 January 2024)
Repository
Written inC, Vim script
Operating systemUnix, Linux, Windows NT, MS-DOS, macOS, iOS, Android, Haiku, AmigaOS, MorphOS
TypeText editor
LicenseVim[2][3][4]
Websitewww.vim.org Edit this on Wikidata

Vim (/vɪm/ ;[5] vi improved) is a free and open-source, screen-based text editor program. It is an improved clone of Bill Joy's vi. Vim's author, Bram Moolenaar, derived Vim from a port of the Stevie editor for Amiga[6] and released a version to the public in 1991. Vim is designed for use both from a command-line interface and as a standalone application in a graphical user interface.[7] Since its release for the Amiga, cross-platform development has made it available on many other systems. In 2018, it was voted the most popular editor amongst Linux Journal readers;[8] in 2015 the Stack Overflow developer survey found it to be the third most popular text editor,[9] and in 2019 the fifth most popular development environment.[10]

History

[edit]

Vim's forerunner, Stevie (ST Editor for VI Enthusiasts), was created by Tim Thompson for the Atari ST in 1987[11][12] and further developed by Tony Andrews[11][13] and G.R. (Fred) Walter.[14][15] It was one of the first popularized clones of Vi, and did not use Vi's source code. The source code for Vi used the Ed text editor developed under AT&T, and therefore Vi could only be used by those with an AT&T source license.[citation needed] Basing Vim on the source code for Stevie meant the program could be distributed without requiring the AT&T source license.

Basing his work on Stevie, Bram Moolenaar began working on Vim for the Amiga computer in 1988, with the first public release (Vim v1.14) in 1991.[16][17][better source needed]

At the time of its first release, the name "Vim" was an acronym for "Vi IMitation", but this changed to "'Vi IMproved" late in 1993.[18]

Release history

[edit]
Date Version Changes and additions
June, 1987 N/A Tim Thompson releases Stevie (ST editor for VI enthusiasts), a limited vi clone for the Atari ST, posting the source on Usenet.[11][12]
June, 1988 N/A Tony Andrews improves Stevie, and ports it to Unix and OS/2, releasing version 3.10 on Usenet.[11][13]
1988 1.0 Bram Moolenaar creates Vi IMitation for the Amiga, based on Stevie, never publicly released
2 November 1991 1.14[19] First public release for the Amiga on Fred Fish disk #591[20]
1992 1.22[19] Port to Unix, never publicly released.[18] Vim now competes with vi.
14 December 1993 2.0[21] This is the first release using the name Vi IMproved.[18]
12 August 1994 3.0[19] Support for multiple windows
29 May 1996 4.0[19][22] Graphical user interface
19 February 1998 5.0[19][23] Syntax highlighting, basic scripting (user defined functions, commands, etc.)
6 April 1998 5.1 Bug fixes, various improvements
27 April 1998 5.2 Long line support, file browser, dialogs, popup menu, select mode, session files, user defined functions and commands, Tcl interface, etc.
31 August 1998 5.3 Bug fixes, etc.
25 July 1999 5.4 Basic file encryption, various improvements
19 September 1999 5.5 Bug fixes, various improvements
16 January 2000 5.6 New syntax files, bug fixes, etc.
24 June 2000 5.7 New syntax files, bug fixes, etc.
31 May 2001 5.8 New syntax files, bug fixes, etc.
26 September 2001 6.0[19][24] Folding, plugins, multi-language, etc.
24 March 2002 6.1 Bug fixes
1 June 2003 6.2 GTK2 and libgnome2 support, Arabic language support, :try command, minor features, bug fixes
7 June 2004 6.3 Bug fixes, translation updates, mark improvements
15 October 2005 6.4 Bug fixes, updates to Perl, Python, and Ruby support
7 May 2006 7.0[25] Spell checking, code completion, tab pages (multiple viewports/window layouts), current line and column highlighting, undo branches, and more
12 May 2007 7.1 Bug fixes, new syntax and runtime files, etc.
9 August 2008 7.2[26] Floating point support in scripts, refactored screen drawing code, bug fixes, new syntax files, etc.
15 August 2010 7.3 Lua support, Python3 support, Blowfish encryption, persistent undo/redo
10 August 2013 7.4[27] A new, faster regular expression engine.
12 September 2016 8.0[28] Asynchronous I/O support, jobs, lambdas, etc.
18 May 2018 8.1[29] Terminal window support and terminal gdb plugin.
13 December 2019 8.2[30] Popup windows, text properties.
28 June 2022 9.0[31] Vim9 script
2 January 2024 9.1[32] Classes and objects support for Vim9 script, smooth scrolling, virtual text

License

[edit]

Vim is released under the Vim license, which includes some charityware clauses that encourage users who enjoy the software to consider donating to children in Uganda.[4] The Vim license is compatible with the GNU General Public License through a special clause allowing distribution of modified copies under the GNU GPL version 2.0 or later.[4]

Interface

[edit]
gVim 7.3

Like vi, Vim's interface is not based on menus or icons but on commands given in a text user interface; its GUI mode, gVim, adds menus and toolbars for commonly used commands but the full functionality is still expressed through its command line mode. Vi (and by extension Vim) tends to allow a typist to keep their fingers on the home row, which can be an advantage for a touch typist.[33]

Vim has a built-in tutorial for beginners called vimtutor, which is usually installed along with Vim, but is a separate executable and can be run with a shell command.[34] The Vim Users' Manual details Vim's features and can be read from within Vim, or found online.[35][36]

Vim also has a built-in help facility (using the :help command) which allows users to query and navigate through commands and features.

Registers

[edit]

Vim features various special memory entries called registers (not to be confused with hardware or processor registers). When cutting, deleting, copying, or pasting text the user can choose to store the manipulated text in a register. There are 36 general-purpose registers associated with letters and numbers ([a-z0-9]) and a range of special ones that either contain special values (current filename, last command, etc.) or serve a special purpose.[7]: 85 

Modes

[edit]
Vim modes

Like vi, vim supports multiple editing modes. Depending on the mode, typed characters are interpreted either as sequences of commands or are inserted as text. In Vim there are 14 editing modes, 7 basic modes and 7 variants:[37]

  • Normal mode – used for editor commands. This is generally the default mode and by default hitting ESC returns the editor to this mode.
  • Insert mode – used for typing text in a way similar to most modern editors. In this mode, opened text in buffers can be modified with the text entered from the keyboard.[38][33]: 12 
  • Visual mode – used to select areas of text. Commands can be run on the selected area – moving, editing, filtering via built-in or external command, etc.
    • Visual linewise, a subtype of visual mode which selects one or more whole lines
    • Visual blockwise, another subtype which selects a rectangular block of text across one or more lines
  • Select mode – similar to visual, but the commands are not interpreted, instead, highlighted text is directly replaced by input from the keyboard; similar to the selection mode used in editors on Microsoft Windows platforms
  • Command-line or Cmdline mode – provides a single line input at the bottom of the Vim window. Commands (beginning with :) and some other keys for specific actions (including pattern search and the filter command) activate this mode. On completion of the command, Vim returns to the previous mode.[38][33]: 12 
  • Ex mode mode – accepts a sequence of commands.
  • Terminal-Job mode - Interacting with a job in a terminal window.

Customization

[edit]

Vim is highly customizable and extensible, making it an attractive tool for users who demand a large amount of control and flexibility over their text editing environment.[39] Text input is facilitated by a variety of features designed to increase keyboard efficiency. Users can execute complex commands with "key bindings," which can be customized and extended. The "recording" feature allows for the creation of macros to automate sequences of keystrokes and call internal or user-defined functions and mappings. Abbreviations, similar to macros and key mappings, facilitate the expansion of short strings of text into longer ones and can also be used to correct mistakes. Vim also features an "easy" mode for users looking for a simpler text editing solution.[40]

There are many plugins available that extend or add new functionality to Vim. These plugins are usually written in Vim's internal scripting language, vimscript (also known as VimL),[41] but can be written in other languages as well.

There are projects bundling together complex scripts and customizations and aimed at turning Vim into a tool for a specific task or adding a major flavour to its behaviour. Examples include Cream, which makes Vim behave like a click-and-type editor, or VimOutliner, which provides a comfortable outliner for users of Unix-like systems.

Features and improvements over vi

[edit]

Vim has a vi compatibility mode, but when that mode is not used, Vim has many enhancements over vi.[42] However even in compatibility mode, Vim is not entirely compatible with vi as defined in the Single Unix Specification[43] and POSIX (e.g., Vim does not support vi's open mode, only visual mode). Vim's developers state that it is "very much compatible with Vi".[44]

Some of Vim's enhancements include completion functions, comparison and merging of files (known as vimdiff), a comprehensive integrated help system, extended regular expressions, scripting languages (both native and through alternative scripting interpreters such as Perl, Python, Ruby, Tcl, etc.) including support for plugins, a graphical user interface (gvim), limited integrated development environment-like features, mouse interaction (both with and without the GUI), folding, editing of compressed or archived files in gzip, bzip2, zip, and tar format and files over network protocols such as SSH, FTP, and HTTP, session state preservation, spell checking, split (horizontal and vertical) and tabbed windows, Unicode and other multi-language support, syntax highlighting, trans-session command, search and cursor position histories, multiple level and branching undo/redo history which can persist across editing sessions, and visual mode.[citation needed]

While running, Vim saves the user's changes in a swap file with the ".swp" extension. This file can be used to recover after a crash. If a user tries to open a file and a swap file already exists, Vim will warn the user, and if the user proceeds, Vim will use a swap file with the extension ".swo" (or, if there is already more than one swap file, ".swn", ".swm", etc.).[45][46] The feature can be disabled.[47]

Vim script

[edit]

Vim script (also called Vimscript or VimL)[48] is the scripting language built into Vim.[49] Based on the ex editor language of the original vi editor, early versions of Vim added commands for control flow and function definitions. Since version 7, Vim script also supports more advanced data types such as lists and dictionaries and a simple form of object-oriented programming. Built-in functions such as map() and filter() allow a basic form of functional programming, and Vim script has lambda since version 8.0. Vim script is mostly written in an imperative programming style.

Vim macros can contain a sequence of normal-mode commands, but can also invoke ex commands or functions written in Vim script for more complex tasks. Almost all extensions (called plugins or more commonly scripts) of the core Vim functionality are written in Vim script, but plugins can also utilize other languages like Perl,[50] Python,[51] Lua,[52] Ruby,[53] Tcl,[54] or Racket.[55] These plugins can be installed manually, or through a plugin manager such as Vundle, Pathogen, or Vim-Plug.

Vim script files are stored as plain text, similarly to other code, and the filename extension is usually .vim. One notable exception to that is Vim's config file, .vimrc.

Examples

[edit]
" This is the Hello World program in Vim script.
echo "Hello, world!"

" This is a simple while loop in Vim script.
let i = 1
while i < 5
  echo "count is" i
  let i += 1
endwhile
unlet i

Availability

[edit]

While vi was originally available only on Unix operating systems, Vim has been ported to many operating systems including AmigaOS (the initial target platform), Atari MiNT, BeOS, DOS, Windows starting from Windows NT 3.1, OS/2, OS/390, MorphOS, OpenVMS, QNX, RISC OS, Linux, BSD, and Classic Mac OS.[56] Also, Vim is shipped with Apple macOS.[57]

Independent ports of Vim are available for Android[58][59] and iOS.[60]

Neovim

[edit]
Neovim
Other namesNVim
Initial release1 November 2015; 9 years ago (1 November 2015)
Stable release
0.10.2[61] Edit this on Wikidata / 3 October 2024; 52 days ago (3 October 2024)
Repositoryhttps://github.com/neovim/neovim Edit this on Wikidata
Written inC, Vim script, Lua
Operating systemMicrosoft Windows and Unix-like
LicenseApache-2.0
Websitehttps://neovim.io/ Edit this on Wikidata

Neovim[62] is a fork of Vim that strives to improve the extensibility and maintainability of Vim.[63] Some features of the fork include built-in Language Server Protocol (LSP) support, support for asynchronous I/O, and support for Lua scripting using luaJIT language interpreter.[64][a] The project is free software and its source code is available on GitHub.[65]

Neovim has the same configuration syntax as Vim prior to vim9script; thus the same configuration file can be used with both editors, although there are minor differences in details of options.[66] If the added features of Neovim are not used, Neovim is compatible with almost all of Vim's features.[67]

The Neovim project was started in 2014, after a patch to Vim supporting multi-threading was rejected.[68] Neovim had a successful fundraising in March 2014, supporting at least one full-time developer.[69][70]

Several frontends are under development which make use of Neovim's capabilities.[71][72][73]

With the 0.5 release of Neovim on 2 July 2021, it gained built-in support for the LSP, Tree-sitter, and more complete Lua support – including the support for configuration scripts written in Lua instead of VimL.[74]

[edit]

See also

[edit]

Notes

[edit]
  1. ^ LuaJIT is directly listed as a third-party dependency for the program build.

References

[edit]
  1. ^ "Vim 9.1 is available". 2 January 2024. Retrieved 3 January 2024.
  2. ^ "vim/LICENSE". github.com. 20 October 2021. Archived from the original on 16 August 2021. Retrieved 5 July 2021.
  3. ^ "Vim License". spdx.org. Archived from the original on 29 July 2021. Retrieved 5 July 2021.
  4. ^ a b c "Vim: uganda.txt". vimhelp.org. Archived from the original on 13 January 2019. Retrieved 13 January 2019.
  5. ^ Vim documentation: intro Archived 13 January 2019 at the Wayback Machine: "Vim is pronounced as one word, like Jim, not vi-ai-em. It's written with a capital, since it's a name, again like Jim."
  6. ^
  7. ^ a b McDonnell, Mark (2014). Pro vim. [Berkeley]. ISBN 978-1-4842-0250-0. OCLC 897466496.{{cite book}}: CS1 maint: location missing publisher (link)
  8. ^ "Best Editor | Linux Journal". www.linuxjournal.com. Retrieved 20 April 2023.
  9. ^ "Stack Overflow Developer Survey 2015 § IV. Text Editor". Stack Overflow. Archived from the original on 4 May 2019. Retrieved 25 July 2016.
  10. ^ "Stack Overflow Developer Survey 2019 Results". Stack Overflow § VII. Development Environments. Archived from the original on 7 March 2020. Retrieved 20 July 2019.
  11. ^ a b c d Thompson, Tim (26 March 2000). "Stevie". Archived from the original on 4 January 2016. Retrieved 27 December 2010.
  12. ^ a b Tim Thompson (28 June 1987). "A mini-vi for the ST". Newsgroupcomp.sys.atari.st. Usenet: 129@glimmer.UUCP. Archived from the original on 9 November 2012. Retrieved 27 December 2010.
  13. ^ a b Tony Andrews (6 June 1988). "v15i037: Stevie, an "aspiring" VI clone for Unix, OS/2, Amiga". Newsgroupcomp.sources.unix. Usenet: 893@fig.bbn.com. Archived from the original on 9 November 2012. Retrieved 27 December 2010.
  14. ^ Vim (20 January 2015). "intro.txt". Vim Help. Vim. Archived from the original on 9 July 2016. Retrieved 9 July 2016.
  15. ^ "vim(1)". die.net. Vim. 11 April 2006. Archived from the original on 9 July 2016. Retrieved 9 July 2016. Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and G.R. (Fred) Walter. Although hardly any of the original code remains.
  16. ^ Moolenaar, Bram (10 October 2000). "The continuing story of Vim" (PDF). moolenaar.net. Archived (PDF) from the original on 18 April 2012. Retrieved 19 September 2011.
  17. ^ "The history of Vim – Jovica Ilic". 5 June 2014. Archived from the original on 25 January 2020. Retrieved 25 January 2020.
  18. ^ a b c "VILE (Vi Like Emacs) – Frequently Asked Questions (FAQ)". Archived from the original on 31 August 2019. Retrieved 7 September 2019.
  19. ^ a b c d e f Moolenaar, Bram (15 January 2002). "Vim, an open-source text editor". Archived from the original on 7 August 2011. Retrieved 24 October 2005.
  20. ^ "Textfiles.com". Archived from the original on 16 July 2011. Retrieved 2 October 2009.
  21. ^ "Filewatcher". Archived from the original on July 11, 2011. Retrieved February 26, 2011.
  22. ^ "Official Vim Manual, Version 4 summary". 12 March 2004. Archived from the original on 18 August 2008. Retrieved 6 August 2008.
  23. ^ "Official Vim Manual, Version 5 summary". 17 January 2004. Archived from the original on 21 August 2008. Retrieved 6 August 2008.
  24. ^ "Official Vim Manual, Version 6 summary". 12 March 2004. Archived from the original on 11 June 2008. Retrieved 6 August 2008.
  25. ^ "Vim Reference Manual, Version 7". 17 July 2016. Archived from the original on 13 January 2019. Retrieved 13 January 2019.
  26. ^ "Google Groups". groups.google.com. Archived from the original on 6 November 2012. Retrieved 11 August 2008.
  27. ^ Google Discussiegroepen Archived 22 January 2011 at the Portuguese Web Archive. Groups.google.com. Retrieved on 2013-12-09.
  28. ^ Bram Moolenaar. "Vim 8.0 released!". Archived from the original on 22 January 2011. Retrieved 12 September 2016.
  29. ^ Bram Moolenaar. "Vim 8.1 is released!". Archived from the original on 17 May 2018. Retrieved 18 May 2018.
  30. ^ Bram Moolenaar. "Vim 8.2 is released!". Archived from the original on 12 December 2019. Retrieved 13 December 2019.
  31. ^ Bram Moolenaar. "Vim 9.0 is released!". Archived from the original on 2 July 2022. Retrieved 30 June 2022.
  32. ^ Christian Brabandt. "Vim 9.1 is released!". Archived from the original on 2 January 2024. Retrieved 4 January 2024.
  33. ^ a b c Lamb, Linda; Robbins, Arnold (1998). Learning the Vi Editor. O'Reilly Media, Inc. p. 305. ISBN 9781565924260.
  34. ^ Moolenaar, Bram (3 November 2010). "Vim documentation: usr_01". Archived from the original on 29 July 2020. Retrieved 28 August 2019.
  35. ^ Vim help files Archived 13 January 2019 at the Wayback Machine at vimhelp.org
  36. ^ Oualline, Steve (April 2001). Vi IMproved (VIM) (PDF). New Riders Publishers. ISBN 0-7357-1001-5. Archived (PDF) from the original on 19 November 2021. Retrieved 11 October 2021.
  37. ^ Moolenaar, Bram. "Vim: intro.txt". vimhelp.org. Retrieved 1 September 2023.
  38. ^ a b "CS107 The Vim Editor". web.stanford.edu. Archived from the original on 27 January 2023. Retrieved 27 January 2023.
  39. ^ Melendez, Steven (28 October 2014). "Why Vim, An '80s Text Editor, Is Still The UI Of Choice For Power Users". FastCompany. Archived from the original on 6 May 2019. Retrieved 5 May 2019.
  40. ^ "Tips: Making Vim easy". Linux.com. 10 April 2007. Archived from the original on 6 May 2019. Retrieved 6 May 2019.
  41. ^ "Vim documentation: usr_41". vimhelp.org. Archived from the original on 13 January 2019. Retrieved 13 January 2019.
  42. ^ Vim help system (type ":help" within Vim)
  43. ^ The Open Group (2008), "vi — screen-oriented (visual) display editor", Single Unix Specification, Version 4 (IEEE Std 1003.1–2008), archived from the original on 22 January 2011, retrieved 27 December 2010
  44. ^ Peppe; Benji; Campbell, Charles (2 January 2004). "Vim FAQ". Archived from the original on 13 January 2019. Retrieved 27 December 2010. (question 1.3)
  45. ^ "Vim documentation: recover". vimdoc.sourceforge.net. Archived from the original on 13 December 2020. Retrieved 17 December 2020.
  46. ^ "How to handle swapfiles in Vim". cs.longwood.edu. Archived from the original on 7 May 2021. Retrieved 17 December 2020.
  47. ^ "'swapfile' option". vimhelp.org. 10 October 2020. Archived from the original on 14 December 2020. Retrieved 18 December 2020.
  48. ^ Klein, Benjamin. "The VimL Primer: Edit Like a Pro with Vim Plugins and Scripts by Benjamin Klein | The Pragmatic Bookshelf". Archived from the original on 25 January 2020. Retrieved 25 January 2020.
  49. ^ "Vim documentation: usr_41". vimhelp.org. Archived from the original on 13 January 2019. Retrieved 13 January 2019.
  50. ^ Verdoolaege, Sven; Gerassimof, Matt. "Vim documentation: if_perl". Archived from the original on 8 February 2012. Retrieved 27 August 2019.
  51. ^ Moore, Paul. "Vim documentation: if_pyth". Archived from the original on 22 August 2012. Retrieved 27 August 2019.
  52. ^ Carvalho, Luis. "Vim documentation: if_lua". Archived from the original on 30 March 2012. Retrieved 27 August 2019.
  53. ^ Maeda, Shugo. "Vim documentation: if_ruby". Archived from the original on 14 February 2012. Retrieved 27 August 2019.
  54. ^ Wilken, Ingo. "Vim documentation: if_tcl". Archived from the original on 24 August 2012. Retrieved 27 August 2019.
  55. ^ Khorev, Sergey. "Vim documentation: if_mzsch". Archived from the original on 14 April 2012. Retrieved 27 August 2019.
  56. ^ ":help sys-file-list"
    "Vim Online: Downloads". Archived from the original on 8 January 2007. Retrieved 7 January 2007.
  57. ^ "Mac OS X Manual Page For vim(1)". developer.apple.com. Apple Inc. Archived from the original on 9 June 2012. Retrieved 12 January 2010.
  58. ^ "VimTouch, the development has stalled on this app". GitHub. Archived from the original on 29 December 2015. Retrieved 9 August 2015.
  59. ^ "DroidVim, under active development". GitHub. Archived from the original on 27 June 2018. Retrieved 5 March 2017.
  60. ^ "Vim – Applidium, mobile agency in Paris". Archived from the original on 20 January 2012. Retrieved 11 August 2015.
  61. ^ "Release 0.10.2". 3 October 2024. Retrieved 22 October 2024.
  62. ^ "Neovim: vim, out of the box". neovim.io. Archived from the original on 16 May 2022. Retrieved 2 May 2024.
  63. ^ "Neovim Vision". Archived from the original on 26 April 2022. Retrieved 18 February 2016.
  64. ^ "Nvim documentation: vim_diff". Archived from the original on 25 August 2019. Retrieved 2 October 2019.
  65. ^ "GitHub – neovim/neovim: Vim-fork focused on extensibility and usability". GitHub. 29 August 2019. Archived from the original on 10 February 2016. Retrieved 18 February 2016.
  66. ^ "Switching to NeoVim". 31 March 2015. Archived from the original on 16 February 2016. Retrieved 18 February 2016.
  67. ^ "How to start using Neovim instead of Vim". Archived from the original on 4 June 2017. Retrieved 18 February 2016.
  68. ^ Eddie Kovsky (1 February 2017). "Vim's 25th anniversary and the release of Vim 8 [LWN.net]". lwn.net. Retrieved 13 June 2023.
  69. ^ "Vimcasts.org blog post". Archived from the original on 17 August 2021. Retrieved 18 February 2016.
  70. ^ "Neovim". Bountysource. 23 March 2014. Archived from the original on 5 January 2021. Retrieved 20 March 2021.
  71. ^ "NyaoVim frontend". GitHub. 29 August 2019. Archived from the original on 30 April 2022. Retrieved 18 February 2016.
  72. ^ "Mac OS X frontend". GitHub. 29 August 2019. Archived from the original on 17 April 2022. Retrieved 18 February 2016.
  73. ^ "Neovim-Qt frontend". GitHub. 21 July 2020. Archived from the original on 16 September 2019. Retrieved 17 July 2019.
  74. ^ Ayooluwa Isaiah (3 August 2021). "New features in Neovim 0.5 [LWN.net]". lwn.net. Retrieved 13 June 2023.
[edit]