2505 changed files with 1381870 additions and 17207 deletions
@ -0,0 +1,20 @@
@@ -0,0 +1,20 @@
|
||||
License: MIT License |
||||
Copyright (c) 2003-2021 Yegappan Lakshmanan |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to |
||||
deal in the Software without restriction, including without limitation the |
||||
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
||||
sell copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
||||
IN THE SOFTWARE. |
@ -0,0 +1,61 @@
@@ -0,0 +1,61 @@
|
||||
  |
||||
|
||||
# Most Recently Used (MRU) Vim plugin |
||||
|
||||
The Most Recently Used (MRU) plugin provides an easy access to a list of |
||||
recently opened/edited files in Vim. This plugin automatically stores the |
||||
file names as you open/edit them in Vim. |
||||
|
||||
This plugin works with both Vim and Neovim and will work on all the platforms |
||||
where Vim/Neovim are supported. This plugin will work in both console and GUI |
||||
Vim. This version of the MRU plugin needs Vim 7.0 and above. |
||||
|
||||
## Installation |
||||
|
||||
You can install this plugin by downloading the .zip or the .tar.gz file for the latest MRU release from the following page: |
||||
|
||||
https://github.com/yegappan/mru/releases/latest |
||||
|
||||
For Vim 8.0 and above, you can expand the .zip file in the following directory (on Unix/Linux/MacOS systems): |
||||
|
||||
$ mkdir -p $HOME/.vim/pack/downloads/start/mru |
||||
$ cd $HOME/.vim/pack/downloads/start/mru |
||||
$ unzip <downloaded_mru_file.zip> |
||||
|
||||
For Vim 7.4 and before, you can use the following steps (on Unix/Linux/MacOS systems): |
||||
|
||||
$ mkdir $HOME/.vim |
||||
$ cd $HOME/.vim |
||||
$ unzip <downloaded_mru_file.zip> |
||||
|
||||
You can also install this plugin directly from github using the following steps (for Vim 8.0 and above): |
||||
|
||||
$ mkdir -p $HOME/.vim/pack/downloads/start/mru |
||||
$ cd $HOME/.vim/pack/downloads/start/mru |
||||
$ git clone https://github.com/yegappan/mru |
||||
|
||||
For NeoVim: |
||||
|
||||
$ mkdir -p $HOME/.config/nvim/pack/downloads/start/mru |
||||
$ cd $HOME/.config/nvim/pack/downloads/start/mru |
||||
$ git clone https://github.com/yegappan/mru |
||||
|
||||
or you can use any one of the Vim plugin managers ([vim-plug](https://github.com/junegunn/vim-plug), [dein.vim](https://github.com/Shougo/dein.vim), [pathogen](https://github.com/tpope/vim-pathogen), [minpac](https://github.com/k-takata/minpac), [vam](https://github.com/MarcWeber/vim-addon-manager), [volt](https://github.com/vim-volt/volt), [Vundle](https://github.com/VundleVim/Vundle.vim), etc.) to install and manage this plugin. |
||||
|
||||
## Usage |
||||
After the plugin is installed, it will automatically start to record all the recently used files in the `$HOME/.vim_mru_files` text file. |
||||
|
||||
To open a file from the recently used file list, enter the following command: |
||||
|
||||
:MRU |
||||
|
||||
This will open a temporary window with the MRU list where you can press `<Enter>` to open a file. |
||||
|
||||
You can fuzzy search a text in the list of file names, by passing a search text to the `:MRU` command: |
||||
|
||||
:MRU <search_text> |
||||
|
||||
This will open the MRU window with only the file names fuzzy matching the supplied search string. |
||||
|
||||
The user manual is available at: |
||||
https://github.com/yegappan/mru/wiki/User-Manual |
@ -0,0 +1,420 @@
@@ -0,0 +1,420 @@
|
||||
*mru.txt* Plugin for accessing most recently used files |
||||
|
||||
Author: Yegappan Lakshmanan (yegappan AT yahoo DOT com) |
||||
For Vim version 7.0 and above |
||||
Last change: Feb 10, 2021 |
||||
|
||||
============================================================================== |
||||
*mru-license* |
||||
License: MIT License |
||||
Copyright (c) 2003-2021 Yegappan Lakshmanan |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to |
||||
deal in the Software without restriction, including without limitation the |
||||
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
||||
sell copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
||||
IN THE SOFTWARE. |
||||
============================================================================== |
||||
CONTENTS~ |
||||
|
||||
1. Overview |mru-overview| |
||||
2. Installation |mru-installation| |
||||
3. Usage |mru-usage| |
||||
4. Configuration |mru-configuration| |
||||
5. FZF Integration |mru-fzf| |
||||
|
||||
============================================================================== |
||||
1. Overview *mru-overview* |
||||
|
||||
The Most Recently Used (MRU) plugin provides an easy access to a list of |
||||
recently opened/edited files in Vim. This plugin automatically stores the |
||||
file names as you open/edit them in Vim. |
||||
|
||||
This plugin works with both Vim and Neovim and will work on all the platforms |
||||
where Vim/Neovim are supported. This plugin will work in both console and GUI |
||||
Vim. This version of the MRU plugin needs Vim 7.0 and above. |
||||
|
||||
The recently used filenames are stored in a file specified by the Vim |
||||
MRU_File variable. |
||||
|
||||
The Github repository for the MRU plugin is available at: |
||||
|
||||
https://github.com/yegappan/mru |
||||
|
||||
============================================================================== |
||||
2. Installation *mru-installation* |
||||
|
||||
You can use any one of the Vim plugin managers (dein.vim, pathogen, vam, |
||||
vim-plug, volt, Vundle, etc.) to install and manage this plugin. |
||||
|
||||
Alternatively, you can also manually download and install the plugin |
||||
using the following steps. |
||||
|
||||
1. Download the mru.zip file from https://github.com/yegappan/mru/releases |
||||
2. Unzip the mru.zip file into the $HOME/.vim directory for Linux/MacOS/Unix |
||||
systems or the $HOMEPATH/vimfiles directory for MS-Windows. After this |
||||
step, you should have the following files (the directory structure should |
||||
be preserved): |
||||
|
||||
plugin/mru.vim - MRU plugin |
||||
doc/mru.txt - documentation (help) file |
||||
|
||||
3. Change to the $HOME/.vim/doc or $HOME/vimfiles/doc directory, start Vim and |
||||
run the ":helptags ." command to process the help file. Without this step, |
||||
you cannot jump to the MRU help topics. |
||||
4. Restart Vim. |
||||
5. You can use the |:MRU| command to list and edit the recently used files. |
||||
In GUI Vim, you can use the 'File->Recent Files' menu to access the |
||||
recently used files. |
||||
|
||||
To uninstall the MRU plugin, either use the uninstall command provided by the |
||||
plugin manager or manually remove the plugin/mru.vim, and doc/mru.txt |
||||
files from either the $HOME/.vim or $HOME/vimfiles directory. |
||||
|
||||
You can also install the latest version of the plugin directly from github |
||||
using the following steps (in Vim 8.0 and above): > |
||||
|
||||
$ mkdir -p $HOME/.vim/pack/downloads/start/mru |
||||
$ cd $HOME/.vim/pack/downloads/start/mru |
||||
$ git clone https://github.com/yegappan/mru |
||||
< |
||||
For Neovim: > |
||||
|
||||
$ mkdir -p $HOME/.config/nvim/pack/downloads/start/mru |
||||
$ cd $HOME/.config/nvim/pack/downloads/start/mru |
||||
$ git clone https://github.com/yegappan/mru |
||||
< |
||||
============================================================================== |
||||
3. Usage *mru-usage* |
||||
|
||||
*:MRU* |
||||
To list and edit files from the Most Recently Used (MRU) list, you can use the |
||||
":MRU" command. The |:MRU| command displays the list of recently used files |
||||
in a temporary Vim window. If the MRU window is already opened, then the MRU |
||||
list currently displayed in the window is refreshed. |
||||
|
||||
If you are using GUI Vim, then the names of the recently edited files are |
||||
added to the "File->Recent Files" menu. You can select the name of a file |
||||
from this sub-menu to edit the file. |
||||
|
||||
You can use the normal Vim commands to move around in the MRU window. You |
||||
cannot make changes in the MRU window. |
||||
|
||||
In the MRU window, the following keys can be used: |
||||
|
||||
<Enter> - open the file under cursor |
||||
o - open the file under cursor in a horizontally split window |
||||
<S-Enter> - idem |
||||
O - open the file under cursor in a vertically split window |
||||
v - open the file under cursor in read-only mode |
||||
t - open the file under cursor in a tab page |
||||
p - open the file under cursor in the preview window |
||||
u - update (refresh) the MRU list |
||||
d - delete the file name under cursor from the MRU list |
||||
q - close the MRU window |
||||
<Esc> - idem |
||||
|
||||
You can select a file name to edit by pressing the <Enter> key or by double |
||||
clicking the left mouse button on a file name. The selected file will be |
||||
opened. If the file is already opened in a window, the cursor will be moved |
||||
to that window. Otherwise, the file is opened in the previous window. If the |
||||
previous window has a modified buffer or is the preview window or is used by |
||||
some other plugin, then the file is opened in a new window. |
||||
|
||||
You can press the 'o' key to open the file name under the cursor in the |
||||
MRU window in a new window. You can also press <Shift-Enter> instead of 'o' |
||||
to open the file in a new window. |
||||
|
||||
To open a file from the MRU window in read-only mode (view), press the 'v' |
||||
key. |
||||
|
||||
To open a file from the MRU window in a new tab, press the 't' key. If the |
||||
file is already opened in a window in the current or in another tab, then |
||||
the cursor is moved to that tab. Otherwise, a new tab is opened. |
||||
|
||||
You can open multiple files from the MRU window by specifying a count before |
||||
pressing '<Enter>' or 'v' or 'o' or 't'. You can also visually (using |
||||
linewise visual mode) select multiple filenames and invoke the commands to |
||||
open the files. Each selected file will be opened in a separate window or |
||||
tab. |
||||
|
||||
You can press the 'u' key in the MRU window to update/refresh the file list. |
||||
This is useful if you keep the MRU window open always. |
||||
|
||||
You can press the 'd' key to remove the entry under the cursor in the MRU |
||||
window from the MRU list. |
||||
|
||||
You can close the MRU window by pressing the 'q' key or the <Esc> key or |
||||
using one of the Vim window commands. |
||||
|
||||
By default, the MRU window is opened as the bottom-most window. If you are |
||||
using Vim version 8.0 and above, then you can use command modifiers like |
||||
|:topleft| or |:botright| or |:vertical| with the :MRU command to control |
||||
where the window is opened. Example: > |
||||
|
||||
:topleft MRU " horizontally split topmost window |
||||
:botright MRU " horizontally split bottommost window |
||||
:vertical topleft MRU " vertically split far-left window |
||||
:vertical botright MRU " vertically split far-right window |
||||
< |
||||
By default, the height of the MRU window is 8 or the value specified by the |
||||
g:MRU_Window_Height variable. You can pass a count to the :MRU command to use |
||||
a different height. Example: > |
||||
|
||||
:15MRU |
||||
:vertical topleft 20MRU |
||||
< |
||||
To display only files matching a pattern from the MRU list in the MRU window, |
||||
you can specify a pattern to the |:MRU| command. Example: > |
||||
|
||||
:MRU mystr |
||||
< |
||||
The above command displays only the file names containing the string "mystr" |
||||
in them. When you specify a partial file name and only one matching filename |
||||
is found, then the |:MRU| command will edit that file. |
||||
|
||||
The |:MRU| command supports command-line completion of file names from |
||||
the MRU list. You can enter a partial file name and then press <Tab> |
||||
or <Ctrl-D> to complete or list all the matching file names. Note that |
||||
after typing the |:MRU| command, you have to enter a space before completing |
||||
the file names with <Tab>. |
||||
|
||||
When a file supplied to the |:MRU| command is not present in the MRU list, |
||||
but it is a readable file, then the file will be opened (even though it is |
||||
not present in the MRU list). This is useful if you want to open a file |
||||
present in the same directory as a file in the MRU list. You can use the |
||||
command-line completion of the |:MRU| command to complete the full path of a |
||||
file and then modify the path to open another file present in the same path. |
||||
|
||||
Whenever the MRU list changes, the MRU file is updated with the latest MRU |
||||
list. When you have multiple instances of Vim running at the same time, the |
||||
latest MRU list will show up in all the instances of Vim. |
||||
|
||||
The MRUFilename syntax group is used to highlight the file names in the MRU |
||||
window. By default, this syntax group is linked to the Identifier highlight |
||||
group. You can change the highlight group by adding the following line in |
||||
your .vimrc: |
||||
> |
||||
highlight link MRUFileName LineNr |
||||
< |
||||
The MRU buffer uses the 'mru file type. You can use this file type to add |
||||
custom auto commands, syntax highlighting, etc. |
||||
|
||||
*:MruRefresh* |
||||
After using the MRU plugin for a period of time, the MRU list may contain |
||||
files which are no longer present in the system. The |:MruRefresh| command can |
||||
be used to remove non-existing files from the MRU list. |
||||
|
||||
*MruGetFiles()* |
||||
The MruGetFiles() function can be used to get the current list of file names |
||||
in the MRU list as a |List|. This can be used with Ex commands that accept one |
||||
or more file names as argument. Some example uses for this function are below: |
||||
> |
||||
" search for 'my_text' in all the files in the MRU list |
||||
:vimgrep my_text `=MruGetFiles()` |
||||
" search for 'my_text' in the files ending in .java in the MRU list |
||||
:vimgrep my_text `=MruGetFiles('.java')` |
||||
" add all the .py files in the MRU list to the argument list |
||||
:n `=MruGetFiles('.py')` |
||||
" Add the files in MRU list to a quickfix list |
||||
:call setqflist([], ' ', {'efm' : '%f', 'lines' : MruGetFiles()}) |
||||
< |
||||
============================================================================== |
||||
4. Configuration *mru-configuration* |
||||
|
||||
The MRU plugin supports many configurable features. These can be enabled or |
||||
disabled by setting one or more variables in your .vimrc file using the |:let| |
||||
command. For Neovim, set these variables in the $HOME/.config/nvim/init.vim |
||||
file. A summary of these variables is below: |
||||
|
||||
|MRU_File| name of the file containing the MRU list |
||||
|MRU_Max_Entries| size of the MRU list |
||||
|MRU_Exclude_Files| pattern to exclude files from MRU list |
||||
|MRU_Include_Files| pattern to include files in the MRU list |
||||
|MRU_Window_Height| height of the MRU window |
||||
|MRU_Use_Current_Window| use current window to display MRU list |
||||
|MRU_Auto_Close| close the MRU window when a file is selected |
||||
|MRU_Window_Open_Always| open the MRU window even for a single file |
||||
|MRU_Open_File_Use_Tabs| open files in separate tab pages |
||||
|MRU_FuzzyMatch| use fuzzy match for filtering file names |
||||
|MRU_Add_Menu| add MRU files to the "Recent Files" menu |
||||
|MRU_Max_Menu_Entries| maximum number of entries in the MRU menu |
||||
|MRU_Max_Submenu_Entries| maximum number of entries in the MRU submenu |
||||
|MRU_Filename_Format| patterns to populate and parse file names in |
||||
the MRU window |
||||
|
||||
These variables are described in more detail below. |
||||
|
||||
*MRU_File* |
||||
The list of recently edited file names is stored in the file specified by the |
||||
MRU_File variable. The default setting for this variable is |
||||
$HOME/.vim_mru_files for Unix-like systems and $USERPROFILE/_vim_mru_files |
||||
for MS-Windows systems. You can change this variable to point to a file by |
||||
adding the following line to the .vimrc file: |
||||
> |
||||
let MRU_File = 'd:\myhome\_vim_mru_files' |
||||
< |
||||
*MRU_Max_Entries* |
||||
By default, the plugin will remember the names of the last 100 used files. |
||||
As you edit more files, old file names will be removed from the MRU list. |
||||
You can set the 'MRU_Max_Entries' variable to remember more file names. For |
||||
example, to remember 1000 most recently used file names, you can use |
||||
> |
||||
let MRU_Max_Entries = 1000 |
||||
< |
||||
*MRU_Exclude_Files* |
||||
By default, all the edited file names are added to the MRU list. If you want |
||||
to exclude file names matching a pattern, then you can set the |
||||
MRU_Exclude_Files variable to a Vim regular expression. If any part of a |
||||
file name matches the regular expression, then it is not added to the MRU |
||||
list. By default, this variable is set to an empty string. For example, to |
||||
not include files in the temporary (/tmp, /var/tmp and D:\temp) directories, |
||||
you can set the MRU_Exclude_Files variable to |
||||
> |
||||
let MRU_Exclude_Files = '^/tmp/.*\|^/var/tmp/.*' " For Unix |
||||
let MRU_Exclude_Files = '^D:\\temp\\.*' " For MS-Windows |
||||
< |
||||
The specified pattern should be a Vim regular expression pattern. Note that |
||||
you can specify multiple patterns using '\|'. |
||||
|
||||
*MRU_Include_Files* |
||||
If you want to add only file names matching a pattern to the MRU list, then |
||||
you can set the MRU_Include_Files variable. This variable should be set to a |
||||
Vim regular expression pattern. If the regular expression matches any part |
||||
of a file name, then it is added to the MRU list. For example, to add only |
||||
.c and .h files to the MRU list, you can set this variable as below: |
||||
> |
||||
let MRU_Include_Files = '\.c$\|\.h$' |
||||
< |
||||
By default, MRU_Include_Files is set to an empty string and all the edited |
||||
filenames are added to the MRU list. Note that you can specify multiple |
||||
patterns using '\|'. |
||||
|
||||
*MRU_Window_Height* |
||||
The default height of the MRU window is 8. You can set the MRU_Window_Height |
||||
variable to change the window height. You can also set the height of the MRU |
||||
window by passing a count to the :MRU command. |
||||
> |
||||
let MRU_Window_Height = 15 |
||||
< |
||||
*MRU_Use_Current_Window* |
||||
By default, when the |:MRU| command is invoked, the MRU list will be displayed |
||||
in a new window. Instead, if you want the MRU plugin to reuse the current |
||||
window, then you can set the 'MRU_Use_Current_Window' variable to one. |
||||
> |
||||
let MRU_Use_Current_Window = 1 |
||||
< |
||||
The MRU plugin will reuse the current window. When a file name is selected, |
||||
the file is also opened in the current window. |
||||
|
||||
*MRU_Auto_Close* |
||||
When you select a file from the MRU window, the MRU window will be |
||||
automatically closed and the selected file will be opened in the previous |
||||
window. You can set the 'MRU_Auto_Close' variable to zero to keep the MRU |
||||
window open. |
||||
> |
||||
let MRU_Auto_Close = 0 |
||||
< |
||||
*MRU_Window_Open_Always* |
||||
When a search pattern is supplied to the :MRU command, the MRU window is |
||||
opened if multiple files matching the pattern are found in the MRU list. If |
||||
only one matching file is found, instead of opening the MRU window the file is |
||||
directly opened. To force open the MRU window always, you can set the |
||||
MRU_Window_Open_Always variable to 1. By default this variable is set to 0. |
||||
> |
||||
let MRU_Window_Open_Always = 1 |
||||
< |
||||
*MRU_Open_File_Use_Tabs* |
||||
When opening a file from the MRU list, the file is opened in the current |
||||
tab. If the selected file has to be opened in a tab always, then set the |
||||
following variable to 1. If the file is already opened in a tab, then the |
||||
cursor will be moved to that tab. |
||||
> |
||||
let MRU_Open_File_Use_Tabs = 1 |
||||
< |
||||
*MRU_FuzzyMatch* |
||||
The :MRU command accepts a string that is used to filter the file names |
||||
displayed in the MRU window. The MRU command also supports command-line |
||||
completion using the supplied string. If Vim supports fuzzy matching |
||||
(supported from Vim 8.2.1665), then the :MRU command will fuzzy match the |
||||
supplied string against the file names. Otherwise it will use regular |
||||
expression matching. To always use regular expression matching, you can set |
||||
the MRU_FuzzyMatch variable to 0: |
||||
> |
||||
let MRU_FuzzyMatch = 0 |
||||
< |
||||
*MRU_Add_Menu* |
||||
If you don't use the "File->Recent Files" menu and want to disable it, |
||||
then you can set the 'MRU_Add_Menu' variable to zero. By default, the |
||||
menu is enabled. |
||||
> |
||||
let MRU_Add_Menu = 0 |
||||
< |
||||
*MRU_Max_Menu_Entries* |
||||
If too many file names are present in the MRU list, then updating the MRU |
||||
menu to list all the file names makes Vim slow. To avoid this, the |
||||
MRU_Max_Menu_Entries variable controls the number of file names to show in |
||||
the MRU menu. By default, this is set to 10. You can change this to show |
||||
more entries in the menu. |
||||
> |
||||
let MRU_Max_Menu_Entries = 20 |
||||
< |
||||
*MRU_Max_Submenu_Entries* |
||||
If many file names are present in the MRU list, then the MRU menu is split |
||||
into sub-menus. Each sub-menu contains MRU_Max_Submenu_Entries file names. |
||||
The default setting for this is 10. You can change this to increase the |
||||
number of file names displayed in a single sub-menu: |
||||
> |
||||
let MRU_Max_Submenu_Entries = 15 |
||||
< |
||||
*MRU_Filename_Format* |
||||
In the MRU window, the filenames are displayed in two parts. The first part |
||||
contains the file name without the path and the second part contains the |
||||
full path to the file in parenthesis. This format is controlled by the |
||||
MRU_Filename_Format variable. If you prefer to change this to some other |
||||
format, then you can modify the MRU_Filename_Format variable. |
||||
|
||||
The MRU_Filename_Format variable contains a |Dict| with the following keys: |
||||
formatter: a string value containing an expression that specifies how to |
||||
split/format the filename. In the expression v:val refers to the |
||||
complete path to a file in the MRU list. |
||||
parser : a string value containing an regular expression that specifies |
||||
how to read the filename back from a line in the MRU window. |
||||
syntax : a string value with a regular expression that matches the part to |
||||
be highlighted in the MRU window. |
||||
|
||||
For example, to display the full path of the files without splitting it, you |
||||
can set this variable as shown below: |
||||
> |
||||
let MRU_Filename_Format = { |
||||
\ 'formatter':'v:val', |
||||
\ 'parser':'.*', |
||||
\ 'syntax': '[^/\\]\+$'} |
||||
< |
||||
============================================================================== |
||||
5. FZF Integration *mru-fzf* |
||||
|
||||
You can use the MRU plugin with FZF (command-line fuzzy finder). You can |
||||
download and install FZF from https://github.com/junegunn/fzf. |
||||
|
||||
To select a file from the MRU file list using FZF, run the following command: |
||||
> |
||||
:FZFMru |
||||
< |
||||
This will invoke FZF to select a file from the MRU list. |
||||
|
||||
============================================================================== |
||||
|
||||
vim:tw=78:ts=8:noet:ft=help: |
File diff suppressed because it is too large
Load Diff
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
https://github.com/yegappan/mru |
@ -0,0 +1,3 @@
@@ -0,0 +1,3 @@
|
||||
[run] |
||||
plugins = covimerage |
||||
data_file = .coverage_covimerage |
@ -0,0 +1,18 @@
@@ -0,0 +1,18 @@
|
||||
@echo off |
||||
|
||||
REM Script to run the unit-tests for the MRU Vim plugin on MS-Windows |
||||
|
||||
SETLOCAL |
||||
SET VIMPRG="vim.exe" |
||||
REM SET VIMPRG="C:\Program Files (x86)\vim\vim82\vim.exe" |
||||
REM SET VIMPRG="C:\Program Files (x86)\vim\vim73\vim.exe" |
||||
SET VIM_CMD=%VIMPRG% -N -u NONE -U NONE -i NONE |
||||
|
||||
%VIM_CMD% -S unit_tests.vim |
||||
|
||||
echo MRU unit test results |
||||
type results.txt |
||||
|
||||
findstr /I FAIL results.txt > nul 2>&1 |
||||
if %ERRORLEVEL% EQU 0 echo ERROR: Some test failed. |
||||
if %ERRORLEVEL% NEQ 0 echo SUCCESS: All the tests passed. |
@ -0,0 +1,22 @@
@@ -0,0 +1,22 @@
|
||||
#!/bin/bash |
||||
|
||||
# Script to run the unit-tests for the MRU Vim plugin |
||||
|
||||
VIMPRG=${VIMPRG:=/usr/bin/vim} |
||||
VIM_CMD="$VIMPRG -N -u NONE -U NONE -i NONE" |
||||
|
||||
$VIM_CMD -S unit_tests.vim |
||||
|
||||
echo "MRU unit test results" |
||||
cat results.txt |
||||
|
||||
echo |
||||
grep FAIL results.txt > /dev/null 2>&1 |
||||
if [ $? -eq 0 ] |
||||
then |
||||
echo "ERROR: Some test(s) failed." |
||||
exit 1 |
||||
fi |
||||
|
||||
echo "SUCCESS: All the tests passed." |
||||
exit 0 |
File diff suppressed because it is too large
Load Diff
@ -1,21 +0,0 @@
@@ -1,21 +0,0 @@
|
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2015 Dave Honneffer |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
@ -1,135 +0,0 @@
@@ -1,135 +0,0 @@
|
||||
## introduction |
||||
|
||||
This is a vim syntax plugin for Ansible 2.x, it supports YAML playbooks, Jinja2 templates, and Ansible's `hosts` files. |
||||
|
||||
- YAML playbooks are detected if: |
||||
- they are in the `group_vars` or `host_vars` folder |
||||
- they are in the `tasks`, `roles`, or `handlers` folder and have either a *.yml* or *.yaml* suffix |
||||
- they are named `playbook.y(a)ml`, `site.y(a)ml`, or `main.y(a)ml` |
||||
- Jinja2 templates are detected if they have a *.j2* suffix |
||||
- Files named `hosts` will be treated as Ansible hosts files |
||||
|
||||
You can also set the filetype to `yaml.ansible`, `*.jinja2`, or `ansible_hosts` if auto-detection does not work (e.g. `:set ft=yaml.ansible` or `:set ft=ruby.jinja2`). **Note**: If you want to detect a custom pattern of your own, you can easily add this in your `.vimrc` using something like this: |
||||
|
||||
```vim |
||||
au BufRead,BufNewFile */playbooks/*.yml set filetype=yaml.ansible |
||||
``` |
||||
|
||||
If you want to override the default file type detection you can easily do this in your `.vimrc`. For example if you use YAML syntax for `hosts` include something like this: |
||||
|
||||
```vim |
||||
augroup ansible_vim_fthosts |
||||
autocmd! |
||||
autocmd BufNewFile,BufRead hosts setfiletype yaml.ansible |
||||
augroup END |
||||
``` |
||||
|
||||
This plugin should be quite reliable, as it sources the original formats and simply modifies the highlights as appropriate. This also enables a focus on simplicity and configurability instead of patching bad syntax detection. |
||||
|
||||
##### examples (with [solarized](https://github.com/altercation/vim-colors-solarized) colorscheme) |
||||
|
||||
Bright (and selective highlight) | Dim |
||||
:-----------------------------------:|:-------------------------: |
||||
 |  |
||||
|
||||
##### installation |
||||
|
||||
Use your favorite plugin manager, or try [vim-plug](https://github.com/junegunn/vim-plug) if you're looking for a really nice one! |
||||
|
||||
**vim-plug:** `Plug 'pearofducks/ansible-vim'` |
||||
|
||||
**vim-plug with post-update hook:** `Plug 'pearofducks/ansible-vim', { 'do': |
||||
'cd ./UltiSnips; ./generate.py' }` |
||||
|
||||
*Note: `generate.py` requires Ansible 2.4 or later.* |
||||
|
||||
**vundle:** `Plugin 'pearofducks/ansible-vim'` |
||||
|
||||
**pathogen:** `git clone https://github.com/pearofducks/ansible-vim ~/.vim/bundle/ansible-vim` |
||||
|
||||
**Arch Linux:** Package [ansible-vim-git](https://aur.archlinux.org/packages/ansible-vim-git/) available on AUR |
||||
|
||||
## options |
||||
|
||||
##### g:ansible_unindent_after_newline |
||||
|
||||
`let g:ansible_unindent_after_newline = 1` |
||||
|
||||
When this variable is set, indentation will completely reset (unindent to column 0) after two newlines in insert-mode. The normal behavior of YAML is to always keep the previous indentation, even across multiple newlines with no content. |
||||
|
||||
##### g:ansible_yamlKeyName |
||||
|
||||
`let g:ansible_yamlKeyName = 'yamlKey'` |
||||
|
||||
This option exists to provide additional compatibility with [stephpy/vim-yaml](https://github.com/stephpy/vim-yaml). |
||||
|
||||
##### g:ansible_attribute_highlight |
||||
`let g:ansible_attribute_highlight = "ob"` |
||||
|
||||
Ansible modules use a `key=value` format for specifying module-attributes in playbooks. This highlights those as specified. This highlight option is also used when highlighting key/value pairs in `hosts` files. |
||||
|
||||
Available flags (bold are defaults): |
||||
|
||||
- **a**: highlight *all* instances of `key=` |
||||
- o: highlight *only* instances of `key=` found on newlines |
||||
- **d**: *dim* the instances of `key=` found |
||||
- b: *brighten* the instances of `key=` found |
||||
- n: turn this highlight off completely |
||||
|
||||
##### g:ansible_name_highlight |
||||
`let g:ansible_name_highlight = 'd'` |
||||
|
||||
Ansible modules commonly start with a `name:` key for self-documentation of playbooks. This option enables/changes highlight of this. |
||||
|
||||
Available flags (this feature is off by default): |
||||
|
||||
- d: *dim* the instances of `name:` found |
||||
- b: *brighten* the instances of `name:` found |
||||
|
||||
##### g:ansible_extra_keywords_highlight |
||||
`let g:ansible_extra_keywords_highlight = 1` |
||||
|
||||
*Note:* This option is enabled when set, and disabled when not set. |
||||
|
||||
Highlight the following additional keywords in playbooks: `register always_run changed_when failed_when no_log args vars delegate_to ignore_errors` |
||||
|
||||
By default we only highlight: `include until retries delay when only_if become become_user block rescue always notify` |
||||
|
||||
##### g:ansible_normal_keywords_highlight |
||||
`let g:ansible_normal_keywords_highlight = 'Constant'` |
||||
|
||||
Accepts any syntax group name from `:help E669` - e.g. _Comment_, _Constant_, and _Identifier_ |
||||
|
||||
*Note:* Defaults to 'Statement' when not set. |
||||
|
||||
This option change the highlight of the following common keywords in playbooks: `include until retries delay when only_if become become_user block rescue always notify` |
||||
|
||||
##### g:ansible_with_keywords_highlight |
||||
`let g:ansible_with_keywords_highlight = 'Constant'` |
||||
|
||||
Accepts any syntax group-name from `:help E669` - e.g. _Comment_, _Constant_, and _Identifier_ |
||||
|
||||
*Note:* Defaults to 'Statement' when not set. |
||||
|
||||
This option changes the highlight of all `with_.+` keywords in playbooks. |
||||
|
||||
##### g:ansible_template_syntaxes |
||||
`let g:ansible_template_syntaxes = { '*.rb.j2': 'ruby' }` |
||||
|
||||
Accepts a dictionary in the form of `'regex-for-file': 'filetype'`. |
||||
- _regex-for-file_ will receive the full filepath, so directory matching can be done. |
||||
- _filetype_ is the root filetype to be applied, `jinja2` will be automatically appended |
||||
|
||||
All files ending in `*.j2` that aren't matched will simply get the `jinja2` filetype. |
||||
|
||||
## bugs, suggestions/requests, & contributions |
||||
|
||||
##### bugs |
||||
|
||||
It's unlikely that there will be bugs in highlighting that don't exist in the core format. Where appropriate these will be fixed in this plugin, but if the problem is with the original syntax we should probably focus on fixing that instead. |
||||
|
||||
Indenting a full document - e.g with `gg=G` - will not be supported and is not a goal of this plugin (unless someone else develops it!). Please do not file a bug report on this. |
||||
|
||||
##### suggestions/requests |
||||
|
||||
Suggestions for improvements are welcome, pull-requests with completed features even more so. :) |
@ -1 +0,0 @@
@@ -1 +0,0 @@
|
||||
ansible.snippets |
@ -1,35 +0,0 @@
@@ -1,35 +0,0 @@
|
||||
Generate Snippets Based on Ansible Modules |
||||
========================================== |
||||
|
||||
A script to generate `UltiSnips` based on ansible code on the fly. |
||||
|
||||
**Note:** Requires Ansible 2.4 or later. |
||||
|
||||
Script parameters |
||||
----------------- |
||||
There are a couple of optional arguments for the script. |
||||
|
||||
* --output: Output filename (Default: ansible.snippets) |
||||
* --style: YAML formatting style for snippets |
||||
Choices: multiline (default), dictionary |
||||
* --sort: Whether to sort module arguments (default: no) |
||||
|
||||
For Users |
||||
--------- |
||||
We display option description somewhere, however, there are some special formatters in it. |
||||
For your reference, we list them here and you can find them under `/ansible/repo/hacking/module_formatter.py`: |
||||
|
||||
* I: Italic |
||||
* B: Bold |
||||
* M: Module |
||||
* U: URL |
||||
* C: Const |
||||
|
||||
For Developers |
||||
-------------- |
||||
* `pip install ansible` first |
||||
|
||||
Thanks |
||||
------ |
||||
* Based on (ansible)[https://github.com/ansible/ansible] Awesome Documentation |
||||
* Inspired by [bleader/ansible_snippet_generator](https://github.com/bleader/ansible_snippet_generator) |
@ -1,109 +0,0 @@
@@ -1,109 +0,0 @@
|
||||
#!/usr/bin/env python |
||||
# -*- coding: utf-8 -*- |
||||
from __future__ import unicode_literals |
||||
|
||||
import argparse |
||||
import os |
||||
import os.path |
||||
import ansible.modules |
||||
from ansible.utils.plugin_docs import get_docstring |
||||
from ansible.plugins.loader import fragment_loader |
||||
|
||||
|
||||
def get_documents(): |
||||
for root, dirs, files in os.walk(os.path.dirname(ansible.modules.__file__)): |
||||
for f in files: |
||||
if f == '__init__.py' or not f.endswith('py'): |
||||
continue |
||||
documentation = get_docstring(os.path.join(root, f), fragment_loader)[0] |
||||
if documentation is None: |
||||
continue |
||||
yield documentation |
||||
|
||||
|
||||
def to_snippet(document): |
||||
snippet = [] |
||||
if 'options' in document: |
||||
options = document['options'].items() |
||||
if args.sort: |
||||
options = sorted(options, key=lambda x: x[0]) |
||||
|
||||
options = sorted(options, key=lambda x: x[1].get('required', False), reverse=True) |
||||
|
||||
for index, (name, option) in enumerate(options, 1): |
||||
if 'choices' in option: |
||||
default = option.get('default') |
||||
if isinstance(default, list): |
||||
prefix = lambda x: '#' if x in default else '' |
||||
suffix = lambda x: "'%s'" % x if isinstance(x, str) else x |
||||
value = '[' + ', '.join("%s%s" % (prefix(choice), suffix(choice)) for choice in option['choices']) |
||||
else: |
||||
prefix = lambda x: '#' if x == default else '' |
||||
value = '|'.join('%s%s' % (prefix(choice), choice) for choice in option['choices']) |
||||
elif option.get('default') is not None and option['default'] != 'None': |
||||
value = option['default'] |
||||
if isinstance(value, bool): |
||||
value = 'yes' if value else 'no' |
||||
else: |
||||
value = "# " + option.get('description', [''])[0] |
||||
if args.style == 'dictionary': |
||||
delim = ': ' |
||||
else: |
||||
delim = '=' |
||||
|
||||
if name == 'free_form': # special for command/shell |
||||
snippet.append('\t${%d:%s%s%s}' % (index, name, delim, value)) |
||||
else: |
||||
snippet.append('\t%s%s${%d:%s}' % (name, delim, index, value)) |
||||
|
||||
# insert a line to seperate required/non-required fields |
||||
for index, (_, option) in enumerate(options): |
||||
if not option.get("required"): |
||||
if index != 0: |
||||
snippet.insert(index, '') |
||||
break |
||||
|
||||
if args.style == 'dictionary': |
||||
snippet.insert(0, '%s:' % (document['module'])) |
||||
else: |
||||
snippet.insert(0, '%s:%s' % (document['module'], ' >' if len(snippet) else '')) |
||||
snippet.insert(0, 'snippet %s "%s" b' % (document['module'], document['short_description'])) |
||||
snippet.append('') |
||||
snippet.append('endsnippet') |
||||
return "\n".join(snippet) |
||||
|
||||
|
||||
if __name__ == "__main__": |
||||
|
||||
parser = argparse.ArgumentParser() |
||||
parser.add_argument( |
||||
'--output', |
||||
help='output filename', |
||||
default='ansible.snippets' |
||||
) |
||||
parser.add_argument( |
||||
'--style', |
||||
help='yaml format to use for snippets', |
||||
choices=['multiline', 'dictionary'], |
||||
default='multiline' |
||||
) |
||||
parser.add_argument( |
||||
'--sort', |
||||
help='sort module arguments', |
||||
action='store_true', |
||||
default=False |
||||
) |
||||
|
||||
args = parser.parse_args() |
||||
|
||||
with open(args.output, "w") as f: |
||||
f.writelines(["priority -50\n", "\n", "# THIS FILE IS AUTOMATED GENERATED, PLEASE DON'T MODIFY BY HAND\n", "\n"]) |
||||
for document in get_documents(): |
||||
if 'deprecated' in document: |
||||
continue |
||||
snippet = to_snippet(document) |
||||
if not isinstance(snippet, str): |
||||
# python2 compatibility |
||||
snippet = snippet.encode('utf-8') |
||||
f.write(snippet) |
||||
f.write("\n\n") |
@ -1,40 +0,0 @@
@@ -1,40 +0,0 @@
|
||||
function! s:isAnsible() |
||||
let filepath = expand("%:p") |
||||
let filename = expand("%:t") |
||||
if filepath =~ '\v/(defaults|tasks|roles|handlers|meta|vars)/.*\.ya?ml$' | return 1 | en |
||||
if filepath =~ '\v/(group|host)_vars/' | return 1 | en |
||||
if filename =~ '\v(playbook|site|main|local)\.ya?ml$' | return 1 | en |
||||
|
||||
let shebang = getline(1) |
||||
if shebang =~# '^#!.*/bin/env\s\+ansible-playbook\>' | return 1 | en |
||||
if shebang =~# '^#!.*/bin/ansible-playbook\>' | return 1 | en |
||||
|
||||
return 0 |
||||
endfunction |
||||
|
||||
function! s:setupTemplate() |
||||
if exists("g:ansible_template_syntaxes") |
||||
let filepath = expand("%:p") |
||||
for syntax_name in items(g:ansible_template_syntaxes) |
||||
let s:syntax_string = '\v/'.syntax_name[0] |
||||
if filepath =~ s:syntax_string |
||||
execute 'set ft='.syntax_name[1].'.jinja2' |
||||
return |
||||
endif |
||||
endfor |
||||
endif |
||||
set ft=jinja2 |
||||
endfunction |
||||
|
||||
augroup ansible_vim_ftyaml_ansible |
||||
au! |
||||
au BufNewFile,BufRead * if s:isAnsible() | set ft=yaml.ansible | en |
||||
augroup END |
||||
augroup ansible_vim_ftjinja2 |
||||
au! |
||||
au BufNewFile,BufRead *.j2 call s:setupTemplate() |
||||
augroup END |
||||
augroup ansible_vim_fthosts |
||||
au! |
||||
au BufNewFile,BufRead inventory* set ft=ansible_hosts |
||||
augroup END |
@ -1,6 +0,0 @@
@@ -1,6 +0,0 @@
|
||||
" Slow yaml highlighting workaround |
||||
if exists('+regexpengine') && ('®expengine' == 0) |
||||
setlocal regexpengine=1 |
||||
endif |
||||
set isfname+=@-@ |
||||
set path+=./../templates,./../files,templates,files |
@ -1,9 +0,0 @@
@@ -1,9 +0,0 @@
|
||||
if exists("b:did_ftplugin") |
||||
finish |
||||
else |
||||
let b:did_ftplugin = 1 |
||||
endif |
||||
|
||||
setlocal comments=:# commentstring=#\ %s formatoptions-=t formatoptions-=c |
||||
|
||||
let b:undo_ftplugin = "setl comments< commentstring< formatoptions<" |
@ -1,59 +0,0 @@
@@ -1,59 +0,0 @@
|
||||
let s:save_cpo = &cpo |
||||
set cpo&vim |
||||
|
||||
setlocal indentexpr=GetAnsibleIndent(v:lnum) |
||||
setlocal indentkeys=!^F,o,O,0#,0},0],<:>,-,*<Return> |
||||
setlocal nosmartindent |
||||
setlocal expandtab |
||||
setlocal softtabstop=2 |
||||
setlocal shiftwidth=2 |
||||
setlocal commentstring=#%s |
||||
setlocal formatoptions+=cl |
||||
" c -> wrap long comments, including # |
||||
" l -> do not wrap long lines |
||||
|
||||
let s:comment = '\v^\s*#' " # comment |
||||
let s:array_entry = '\v^\s*-\s' " - foo |
||||
let s:named_module_entry = '\v^\s*-\s*(name|hosts|role):\s*\S' " - name: 'do stuff' |
||||
let s:dictionary_entry = '\v^\s*[^:-]+:\s*$' " with_items: |
||||
let s:key_value = '\v^\s*[^:-]+:\s*\S' " apt: name=package |
||||
let s:scalar_value = '\v:\s*[>|\|]\s*$' " shell: > |
||||
|
||||
if exists('*GetAnsibleIndent') |
||||
finish |
||||
endif |
||||
|
||||
function GetAnsibleIndent(lnum) |
||||
if a:lnum == 1 || !prevnonblank(a:lnum-1) |
||||
return 0 |
||||
endif |
||||
if exists("g:ansible_unindent_after_newline") |
||||
if (a:lnum -1) != prevnonblank(a:lnum - 1) |
||||
return 0 |
||||
endif |
||||
endif |
||||
let prevlnum = prevnonblank(a:lnum - 1) |
||||
let maintain = indent(prevlnum) |
||||
let increase = maintain + &sw |
||||
|
||||
let line = getline(prevlnum) |
||||
if line =~ s:array_entry |
||||
if line =~ s:named_module_entry |
||||
return increase |
||||
else |
||||
return maintain |
||||
endif |
||||
elseif line =~ s:dictionary_entry |
||||
return increase |
||||
elseif line =~ s:key_value |
||||
if line =~ s:scalar_value |
||||
return increase |
||||
else |
||||
return maintain |
||||
endif |
||||
else |
||||
return maintain |
||||
endif |
||||
endfunction |
||||
|
||||
let &cpo = s:save_cpo |
@ -1,104 +0,0 @@
@@ -1,104 +0,0 @@
|
||||
" Vim syntax file |
||||
" Language: Ansible YAML/Jinja templates |
||||
" Maintainer: Dave Honneffer <pearofducks@gmail.com> |
||||
" Last Change: 2018.02.08 |
||||
|
||||
if !exists("main_syntax") |
||||
let main_syntax = 'yaml' |
||||
endif |
||||
|
||||
if exists('b:current_syntax') |
||||
let s:current_syntax=b:current_syntax |
||||
unlet b:current_syntax |
||||
endif |
||||
|
||||
syntax include @Jinja syntax/jinja2.vim |
||||
|
||||
if exists('s:current_syntax') |
||||
let b:current_syntax=s:current_syntax |
||||
endif |
||||
|
||||
" Jinja |
||||
" ================================ |
||||
|
||||
syn cluster jinjaSLSBlocks add=jinjaTagBlock,jinjaVarBlock,jinjaComment |
||||
" https://github.com/mitsuhiko/jinja2/blob/6b7c0c23/ext/Vim/jinja.vim |
||||
syn region jinjaTagBlock matchgroup=jinjaTagDelim start=/{%-\?/ end=/-\?%}/ containedin=ALLBUT,jinjaTagBlock,jinjaVarBlock,jinjaRaw,jinjaString,jinjaNested,jinjaComment,@jinjaSLSBlocks |
||||
syn region jinjaVarBlock matchgroup=jinjaVarDelim start=/{{-\?/ end=/-\?}}/ containedin=ALLBUT,yamlComment,jinjaTagBlock,jinjaVarBlock,jinjaRaw,jinjaString,jinjaNested,jinjaComment,@jinjaSLSBlocks |
||||
syn region jinjaComment matchgroup=jinjaCommentDelim start="{#" end="#}" containedin=ALLBUT,jinjaTagBlock,jinjaVarBlock,jinjaString,@jinjaSLSBlocks |
||||
highlight link jinjaVariable Constant |
||||
highlight link jinjaVarDelim Delimiter |
||||
|
||||
" YAML |
||||
" ================================ |
||||
|
||||
if exists("g:ansible_yamlKeyName") |
||||
let s:yamlKey = g:ansible_yamlKeyName |
||||
else |
||||
let s:yamlKey = "yamlBlockMappingKey" |
||||
endif |
||||
|
||||
" Reset some YAML to plain styling |
||||
" the number 80 in Ansible isn't any more important than the word root |
||||
highlight link yamlInteger NONE |
||||
highlight link yamlBool NONE |
||||
highlight link yamlFlowString NONE |
||||
" but it does make sense we visualize quotes easily |
||||
highlight link yamlFlowStringDelimiter Delimiter |
||||
" This is only found in stephypy/vim-yaml, since it's one line it isn't worth |
||||
" making conditional |
||||
highlight link yamlConstant NONE |
||||
|
||||
fun! s:attribute_highlight(attributes) |
||||
if a:attributes =~ 'a' |
||||
syn match ansible_attributes "\v\w+\=" containedin=yamlPlainScalar |
||||
else |
||||
syn match ansible_attributes "\v^\s*\w+\=" containedin=yamlPlainScalar |
||||
endif |
||||
if a:attributes =~ 'n' |
||||
highlight link ansible_attributes NONE |
||||
elseif a:attributes =~ 'd' |
||||
highlight link ansible_attributes Comment |
||||
else |
||||
highlight link ansible_attributes Structure |
||||
endif |
||||
endfun |
||||
|
||||
if exists("g:ansible_attribute_highlight") |
||||
call s:attribute_highlight(g:ansible_attribute_highlight) |
||||
else |
||||
call s:attribute_highlight('ad') |
||||
endif |
||||
|
||||
if exists("g:ansible_name_highlight") |
||||
execute 'syn keyword ansible_name name containedin='.s:yamlKey.' contained' |
||||
if g:ansible_name_highlight =~ 'd' |
||||
highlight link ansible_name Comment |
||||
else |
||||
highlight link ansible_name Underlined |
||||
endif |
||||
endif |
||||
|
||||
execute 'syn keyword ansible_debug_keywords debug containedin='.s:yamlKey.' contained' |
||||
highlight link ansible_debug_keywords Debug |
||||
|
||||
if exists("g:ansible_extra_keywords_highlight") |
||||
execute 'syn keyword ansible_extra_special_keywords register always_run changed_when failed_when no_log args vars delegate_to ignore_errors containedin='.s:yamlKey.' contained' |
||||
highlight link ansible_extra_special_keywords Statement |
||||
endif |
||||
|
||||
execute 'syn keyword ansible_normal_keywords include include_tasks import_tasks until retries delay when only_if become become_user block rescue always notify containedin='.s:yamlKey.' contained' |
||||
if exists("g:ansible_normal_keywords_highlight") |
||||
execute 'highlight link ansible_normal_keywords '.g:ansible_normal_keywords_highlight |
||||
else |
||||
highlight link ansible_normal_keywords Statement |
||||
endif |
||||
|
||||
execute 'syn match ansible_with_keywords "\vwith_.+" containedin='.s:yamlKey.' contained' |
||||
if exists("g:ansible_with_keywords_highlight") |
||||
execute 'highlight link ansible_with_keywords '.g:ansible_with_keywords_highlight |
||||
else |
||||
highlight link ansible_with_keywords Statement |
||||
endif |
||||
|
||||
let b:current_syntax = "ansible" |
@ -1,31 +0,0 @@
@@ -1,31 +0,0 @@
|
||||
" Vim syntax file |
||||
" Language: Ansible hosts files |
||||
" Maintainer: Dave Honneffer <pearofducks@gmail.com> |
||||
" Last Change: 2015.09.23 |
||||
|
||||
if exists("b:current_syntax") |
||||
finish |
||||
endif |
||||
|
||||
syn case ignore |
||||
syn match hostsFirstWord "\v^\S+" |
||||
syn match hostsAttributes "\v\S*\=" |
||||
syn region hostsHeader start="\v^\s*\[" end="\v\]" |
||||
syn keyword hostsHeaderSpecials children vars containedin=hostsHeader contained |
||||
syn match hostsComment "\v^[#;].*$" |
||||
|
||||
highlight link hostsFirstWord Label |
||||
highlight link hostsHeader Define |
||||
highlight link hostsComment Comment |
||||
highlight link hostsHeaderSpecials Identifier |
||||
highlight link hostsAttributes Structure |
||||
|
||||
if exists("g:ansible_attribute_highlight") |
||||
if g:ansible_attribute_highlight =~ 'n' |
||||
highlight link hostsAttributes NONE |
||||
elseif g:ansible_attribute_highlight =~ 'd' |
||||
highlight link hostsAttributes Comment |
||||
endif |
||||
endif |
||||
|
||||
let b:current_syntax = "ansible_hosts" |
@ -1,97 +0,0 @@
@@ -1,97 +0,0 @@
|
||||
" Vim syntax file |
||||
" Language: Jinja2 - with special modifications for compound-filetype |
||||
" compatibility |
||||
" Maintainer: Dave Honneffer <pearofducks@gmail.com> |
||||
" Last Change: 2018.02.11 |
||||
|
||||
if !exists("main_syntax") |
||||
let main_syntax = 'jinja2' |
||||
endif |
||||
|
||||
let b:current_syntax = '' |
||||
unlet b:current_syntax |
||||
|
||||
syntax case match |
||||
|
||||
" Jinja template built-in tags and parameters (without filter, macro, is and raw, they |
||||
" have special threatment) |
||||
syn keyword jinjaStatement containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained and if else in not or recursive as import |
||||
|
||||
syn keyword jinjaStatement containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained is filter skipwhite nextgroup=jinjaFilter |
||||
syn keyword jinjaStatement containedin=jinjaTagBlock contained macro skipwhite nextgroup=jinjaFunction |
||||
syn keyword jinjaStatement containedin=jinjaTagBlock contained block skipwhite nextgroup=jinjaBlockName |
||||
|
||||
" Variable Names |
||||
syn match jinjaVariable containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained /[a-zA-Z_][a-zA-Z0-9_]*/ |
||||
syn keyword jinjaSpecial containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained false true none False True None loop super caller varargs kwargs |
||||
|
||||
" Filters |
||||
syn match jinjaOperator "|" containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained skipwhite nextgroup=jinjaFilter |
||||
syn match jinjaFilter contained /[a-zA-Z_][a-zA-Z0-9_]*/ |
||||
syn match jinjaFunction contained /[a-zA-Z_][a-zA-Z0-9_]*/ |
||||
syn match jinjaBlockName contained /[a-zA-Z_][a-zA-Z0-9_]*/ |
||||
|
||||
" Jinja template constants |
||||
syn region jinjaString containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained start=/"/ skip=/\(\\\)\@<!\(\(\\\\\)\@>\)*\\"/ end=/"/ |
||||
syn region jinjaString containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained start=/'/ skip=/\(\\\)\@<!\(\(\\\\\)\@>\)*\\'/ end=/'/ |
||||
syn match jinjaNumber containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained /[0-9]\+\(\.[0-9]\+\)\?/ |
||||
|
||||
" Operators |
||||
syn match jinjaOperator containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained /[+\-*\/<>=!,:]/ |
||||
syn match jinjaPunctuation containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained /[()\[\]]/ |
||||
syn match jinjaOperator containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained /\./ nextgroup=jinjaAttribute |
||||
syn match jinjaAttribute contained /[a-zA-Z_][a-zA-Z0-9_]*/ |
||||
|
||||
" Jinja template tag and variable blocks |
||||
syn region jinjaNested matchgroup=jinjaOperator start="(" end=")" transparent display containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained |
||||
syn region jinjaNested matchgroup=jinjaOperator start="\[" end="\]" transparent display containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained |
||||
syn region jinjaNested matchgroup=jinjaOperator start="{" end="}" transparent display containedin=jinjaVarBlock,jinjaTagBlock,jinjaNested contained |
||||
syn region jinjaTagBlock matchgroup=jinjaTagDelim start=/{%-\?/ end=/-\?%}/ containedin=ALLBUT,jinjaTagBlock,jinjaVarBlock,jinjaRaw,jinjaString,jinjaNested,jinjaComment |
||||
|
||||
syn region jinjaVarBlock matchgroup=jinjaVarDelim start=/{{-\?/ end=/-\?}}/ containedin=ALLBUT,yamlComment,jinjaTagBlock,jinjaVarBlock,jinjaRaw,jinjaString,jinjaNested,jinjaComment |
||||
|
||||
" Jinja template 'raw' tag |
||||
syn region jinjaRaw matchgroup=jinjaRawDelim start="{%\s*raw\s*%}" end="{%\s*endraw\s*%}" containedin=ALLBUT,jinjaTagBlock,jinjaVarBlock,jinjaString,jinjaComment |
||||
|
||||
" Jinja comments |
||||
syn region jinjaComment matchgroup=jinjaCommentDelim start="{#" end="#}" containedin=ALLBUT,jinjaTagBlock,jinjaVarBlock,jinjaString |
||||
|
||||
" Block start keywords. A bit tricker. We only highlight at the start of a |
||||
" tag block and only if the name is not followed by a comma or equals sign |
||||
" which usually means that we have to deal with an assignment. |
||||
syn match jinjaStatement containedin=jinjaTagBlock contained /\({%-\?\s*\)\@<=\<[a-zA-Z_][a-zA-Z0-9_]*\>\(\s*[,=]\)\@!/ |
||||
|
||||
" and context modifiers |
||||
syn match jinjaStatement containedin=jinjaTagBlock contained /\<with\(out\)\?\s\+context\>/ |
||||
|
||||
|
||||
" Define the default highlighting. |
||||
if !exists("did_jinja_syn_inits") |
||||
command -nargs=+ HiLink hi def link <args> |
||||
|
||||
HiLink jinjaPunctuation jinjaOperator |
||||
HiLink jinjaAttribute jinjaVariable |
||||
HiLink jinjaFunction jinjaFilter |
||||
|
||||
HiLink jinjaTagDelim jinjaTagBlock |
||||
HiLink jinjaVarDelim jinjaVarBlock |
||||
HiLink jinjaCommentDelim jinjaComment |
||||
HiLink jinjaRawDelim jinja |
||||
|
||||
HiLink jinjaSpecial Special |
||||
HiLink jinjaOperator Normal |
||||
HiLink jinjaRaw Normal |
||||
HiLink jinjaTagBlock PreProc |
||||
HiLink jinjaVarBlock PreProc |
||||
HiLink jinjaStatement Statement |
||||
HiLink jinjaFilter Function |
||||
HiLink jinjaBlockName Function |
||||
HiLink jinjaVariable Identifier |
||||
HiLink jinjaString Constant |
||||
HiLink jinjaNumber Constant |
||||
HiLink jinjaComment Comment |
||||
|
||||
delcommand HiLink |
||||
endif |
||||
|
||||
let b:current_syntax = "jinja2" |
@ -1,31 +0,0 @@
@@ -1,31 +0,0 @@
|
||||
Copyright (c) 2009 by the Jinja Team, see AUTHORS for more details. |
||||
|
||||
Some rights reserved. |
||||
|
||||
Redistribution and use in source and binary forms, with or without |
||||
modification, are permitted provided that the following conditions are |
||||
met: |
||||
|
||||
* Redistributions of source code must retain the above copyright |
||||
notice, this list of conditions and the following disclaimer. |
||||
|
||||
* Redistributions in binary form must reproduce the above |
||||
copyright notice, this list of conditions and the following |
||||
disclaimer in the documentation and/or other materials provided |
||||
with the distribution. |
||||
|
||||
* The names of the contributors may not be used to endorse or |
||||
promote products derived from this software without specific |
||||
prior written permission. |
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
@ -0,0 +1,411 @@
@@ -0,0 +1,411 @@
|
||||
Auto Pairs |
||||
========== |
||||
Insert or delete brackets, parens, quotes in pair. |
||||
|
||||
Installation |
||||
------------ |
||||
|
||||
* Manual |
||||
* Copy `plugin/auto-pairs.vim` to `~/.vim/plugin` |
||||
* [Pathogen](https://github.com/tpope/vim-pathogen) |
||||
* `git clone git://github.com/jiangmiao/auto-pairs.git ~/.vim/bundle/auto-pairs` |
||||
* [Vundle](https://github.com/VundleVim/Vundle.vim) |
||||
* `Plugin 'jiangmiao/auto-pairs'` |
||||
|
||||
Features |
||||
-------- |
||||
* Insert in pair |
||||
|
||||
input: [ |
||||
output: [|] |
||||
|
||||
* Delete in pair |
||||
|
||||
input: foo[<BS>] |
||||
output: foo |
||||
|
||||
* Insert new indented line after Return |
||||
|
||||
input: {|} (press <CR> at |) |
||||
output: { |
||||
| |
||||
} (press } to close the pair) |
||||
output: { |
||||
}| (the inserted blank line will be deleted) |
||||
|
||||
|
||||
* Insert spaces before closing characters, only for [], (), {} |
||||
|
||||
input: {|} (press <SPACE> at |) |
||||
output: { | } |
||||
|
||||
input: {|} (press <SPACE>foo} at |) |
||||
output: { foo }| |
||||
|
||||
input: '|' (press <SPACE> at |) |
||||
output: ' |' |
||||
|
||||
* Skip ' when inside a word |
||||
|
||||
input: foo| (press ' at |) |
||||
output: foo' |
||||
|
||||
* Skip closed bracket. |
||||
|
||||
input: [] |
||||
output: [] |
||||
|
||||
* Ignore auto pair when previous character is \ |
||||
|
||||
input: "\' |
||||
output: "\'" |
||||
|
||||
* Fast Wrap |
||||
|
||||
input: |[foo, bar()] (press (<M-e> at |) |
||||
output: ([foo, bar()]) |
||||
|
||||
* Quick move char to closed pair |
||||
|
||||
input: (|){["foo"]} (press <M-}> at |) |
||||
output: ({["foo"]}|) |
||||
|
||||
input: |[foo, bar()] (press (<M-]> at |) |
||||
output: ([foo, bar()]|) |
||||
|
||||
* Quick jump to closed pair. |
||||
|
||||
input: |
||||
{ |
||||
something;| |
||||
} |
||||
|
||||
(press } at |) |
||||
|
||||
output: |
||||
{ |
||||
|
||||
}| |
||||
|
||||
* Fly Mode |
||||
|
||||
input: if(a[3) |
||||
output: if(a[3])| (In Fly Mode) |
||||
output: if(a[3)]) (Without Fly Mode) |
||||
|
||||
input: |
||||
{ |
||||
hello();| |
||||
world(); |
||||
} |
||||
|
||||
(press } at |) |
||||
|
||||
output: |
||||
{ |
||||
hello(); |
||||
world(); |
||||
}| |
||||
|
||||
(then press <M-b> at | to do backinsert) |
||||
output: |
||||
{ |
||||
hello();}| |
||||
world(); |
||||
} |
||||
|
||||
See Fly Mode section for details |
||||
|
||||
* Multibyte Pairs |
||||
|
||||
Support any multibyte pairs such as <!-- -->, <% %>, """ """ |
||||
See multibyte pairs section for details |
||||
|
||||
Fly Mode |
||||
-------- |
||||
Fly Mode will always force closed-pair jumping instead of inserting. only for ")", "}", "]" |
||||
|
||||
If jumps in mistake, could use AutoPairsBackInsert(Default Key: `<M-b>`) to jump back and insert closed pair. |
||||
|
||||
the most situation maybe want to insert single closed pair in the string, eg ")" |
||||
|
||||
Fly Mode is DISABLED by default. |
||||
|
||||
add **let g:AutoPairsFlyMode = 1** .vimrc to turn it on |
||||
|
||||
Default Options: |
||||
|
||||
let g:AutoPairsFlyMode = 0 |
||||
let g:AutoPairsShortcutBackInsert = '<M-b>' |
||||
|
||||
Shortcuts |
||||
--------- |
||||
|
||||
System Shortcuts: |
||||
<CR> : Insert new indented line after return if cursor in blank brackets or quotes. |
||||
<BS> : Delete brackets in pair |
||||
<M-p> : Toggle Autopairs (g:AutoPairsShortcutToggle) |
||||
<M-e> : Fast Wrap (g:AutoPairsShortcutFastWrap) |
||||
<M-n> : Jump to next closed pair (g:AutoPairsShortcutJump) |
||||
<M-b> : BackInsert (g:AutoPairsShortcutBackInsert) |
||||
|
||||
If <M-p> <M-e> or <M-n> conflict with another keys or want to bind to another keys, add |
||||
|
||||
let g:AutoPairsShortcutToggle = '<another key>' |
||||
|
||||
to .vimrc, if the key is empty string '', then the shortcut will be disabled. |
||||
|
||||
Options |
||||
------- |
||||
* g:AutoPairs |
||||
|
||||
Default: {'(':')', '[':']', '{':'}',"'":"'",'"':'"', "`":"`", '```':'```', '"""':'"""', "'''":"'''"} |
||||
|
||||
* b:AutoPairs |
||||
|
||||
Default: g:AutoPairs |
||||
|
||||
Buffer level pairs set. |
||||
|
||||
* g:AutoPairsShortcutToggle |
||||
|
||||
Default: '<M-p>' |
||||
|
||||
The shortcut to toggle autopairs. |
||||
|
||||
* g:AutoPairsShortcutFastWrap |
||||
|
||||
Default: '<M-e>' |
||||
|
||||
Fast wrap the word. all pairs will be consider as a block (include <>). |
||||
(|)'hello' after fast wrap at |, the word will be ('hello') |
||||
(|)<hello> after fast wrap at |, the word will be (<hello>) |
||||
|
||||
* g:AutoPairsShortcutJump |
||||
|
||||
Default: '<M-n>' |
||||
|
||||
Jump to the next closed pair |
||||
|
||||
* g:AutoPairsMapBS |
||||
|
||||
Default : 1 |
||||
|
||||
Map <BS> to delete brackets, quotes in pair |
||||
execute 'inoremap <buffer> <silent> <BS> <C-R>=AutoPairsDelete()<CR>' |
||||
|
||||
* g:AutoPairsMapCh |
||||
|
||||
Default : 1 |
||||
|
||||
Map <C-h> to delete brackets, quotes in pair |
||||
|
||||
* g:AutoPairsMapCR |
||||
|
||||
Default : 1 |
||||
|
||||
Map <CR> to insert a new indented line if cursor in (|), {|} [|], '|', "|" |
||||
execute 'inoremap <buffer> <silent> <CR> <C-R>=AutoPairsReturn()<CR>' |
||||
|
||||
* g:AutoPairsCenterLine |
||||
|
||||
Default : 1 |
||||
|
||||
When g:AutoPairsMapCR is on, center current line after return if the line is at the bottom 1/3 of the window. |
||||
|
||||
* g:AutoPairsMapSpace |
||||
|
||||
Default : 1 |
||||
|
||||
Map <space> to insert a space after the opening character and before the closing one. |
||||
execute 'inoremap <buffer> <silent> <CR> <C-R>=AutoPairsSpace()<CR>' |
||||
|
||||
* g:AutoPairsFlyMode |
||||
|
||||
Default : 0 |
||||
|
||||
set it to 1 to enable FlyMode. |
||||
see FlyMode section for details. |
||||
|
||||
* g:AutoPairsMultilineClose |
||||
|
||||
Default : 1 |
||||
|
||||
When you press the key for the closing pair (e.g. `)`) it jumps past it. |
||||
If set to 1, then it'll jump to the next line, if there is only whitespace. |
||||
If set to 0, then it'll only jump to a closing pair on the same line. |
||||
|
||||
* g:AutoPairsShortcutBackInsert |
||||
|
||||
Default : <M-b> |
||||
|
||||
Work with FlyMode, insert the key at the Fly Mode jumped postion |
||||
|
||||
* g:AutoPairsMoveCharacter |
||||
|
||||
Default: "()[]{}\"'" |
||||
|
||||
Map <M-(> <M-)> <M-[> <M-]> <M-{> <M-}> <M-"> <M-'> to |
||||
move character under the cursor to the pair. |
||||
|
||||
Buffer Level Pairs Setting |
||||
-------------------------- |
||||
|
||||
Set b:AutoPairs before BufEnter |
||||
|
||||
eg: |
||||
|
||||
" When the filetype is FILETYPE then make AutoPairs only match for parenthesis |
||||
au Filetype FILETYPE let b:AutoPairs = {"(": ")"} |
||||
au FileType php let b:AutoPairs = AutoPairsDefine({'<?' : '?>', '<?php': '?>'}) |
||||
|
||||
Multibyte Pairs |
||||
--------------- |
||||
|
||||
The default pairs is {'(':')', '[':']', '{':'}',"'":"'",'"':'"', '`':'`'} |
||||
You could also define multibyte pairs such as <!-- -->, <% %> and so on |
||||
|
||||
* Function AutoPairsDefine(addPairs:dict[, removeOpenPairList:list]) |
||||
|
||||
add or delete pairs base on g:AutoPairs |
||||
|
||||
eg: |
||||
au FileType html let b:AutoPairs = AutoPairsDefine({'<!--' : '-->'}, ['{']) |
||||
add <!-- --> pair and remove '{' for html file |
||||
|
||||
the pair implict start with \V, so if want to match start of line ^ should be write in \^ vim comment {'\^"': ''} |
||||
|
||||
* General usage |
||||
|
||||
au FileType php let b:AutoPairs = AutoPairsDefine({'<?' : '?>', '<?php': '?>'}) |
||||
|
||||
the first key of closed pair ? will be mapped |
||||
|
||||
pairs: '<?' : '?>', '<?php': '?>' |
||||
input: <? |
||||
output: <?|?> |
||||
|
||||
input: <?php |
||||
output: <?php|?> |
||||
|
||||
input: he<?php|?> (press <BS> at|) |
||||
output: he| |
||||
|
||||
input: <?php|?> (press ? at|) |
||||
output: <?php?>| |
||||
|
||||
pair: '[[':']]' |
||||
input: [[|]] (press <BS>) |
||||
output: | ([[ and ]] will be deleted the [['s priority is higher than [ for it's longer) |
||||
|
||||
* Modifier |
||||
|
||||
The text after // in close pair is modifiers |
||||
|
||||
n - do not map the first charactor of closed pair to close key |
||||
m - close key jumps through multi line |
||||
s - close key jumps only in the same line |
||||
k[KEY] - map the close key to [KEY] |
||||
|
||||
by default if open key equals close key the multi line is turn off |
||||
|
||||
"<?": "?>" ? jumps only in the same line |
||||
"<?": "?>//m" force ? jumping through multi line |
||||
"<?php":"?>" ? will jump through multi line |
||||
"<?php":"?>//s" force ? only jumping in the same line |
||||
"<?": "?>//n" do not jump totally |
||||
"<?": "?>//k]" use key ] to jump through ?> |
||||
|
||||
for 'begin' 'end' pair, e is a charactor, if map e to jump will be annoy, so use modifier 'n' to skip key map |
||||
|
||||
au FileType ruby let b:AutoPairs = AutoPairsDefine({'begin': 'end//n]'}) |
||||
|
||||
|
||||
input: begin |
||||
output: begin|end |
||||
|
||||
input: begin|end (press <BS> on |) |
||||
output: | |
||||
|
||||
input: begin|end (press e on |) |
||||
output: begineend (will not jump for e is not mapped) |
||||
|
||||
* Advanced usage |
||||
|
||||
au FileType rust let b:AutoPairs = AutoPairsDefine({'\w\zs<': '>'}) |
||||
|
||||
if press < after a word will generate the pair |
||||
|
||||
when use regexp MUST use \zs to prevent catching |
||||
if use '\w<' without \zs, for text hello<|> press <BS> on | will output 'hell', the 'o' has been deleted |
||||
|
||||
pair: '\w\zs<': '>' |
||||
input: h < |
||||
output: h < |
||||
|
||||
input: h< |
||||
output: h<|> |
||||
|
||||
input: h<|> press <BS> |
||||
output: h| |
||||
|
||||
pair: '\w<': '>' (WRONG pair which missed \zs) |
||||
input: h<|> press <BS> |
||||
output: | (charactor 'h' is deleted) |
||||
|
||||
|
||||
the 'begin' 'end' pair write in |
||||
|
||||
au FileType ruby let b:AutoPairs = AutoPairsDefine({'\v(^|\W)\zsbegin': 'end//n'}) |
||||
|
||||
will be better, only auto pair when at start of line or follow non-word text |
||||
|
||||
TroubleShooting |
||||
--------------- |
||||
The script will remap keys ([{'"}]) <BS>, |
||||
If auto pairs cannot work, use :imap ( to check if the map is corrected. |
||||
The correct map should be <C-R>=AutoPairsInsert("\(")<CR> |
||||
Or the plugin conflict with some other plugins. |
||||
use command :call AutoPairsInit() to remap the keys. |
||||
|
||||
|
||||
* How to insert parens purely |
||||
|
||||
There are 3 ways |
||||
|
||||
1. use Ctrl-V ) to insert paren without trigger the plugin. |
||||
|
||||
2. use Alt-P to turn off the plugin. |
||||
|
||||
3. use DEL or <C-O>x to delete the character insert by plugin. |
||||
|
||||
* Swedish Character Conflict |
||||
|
||||
Because AutoPairs uses Meta(Alt) key as shortcut, it is conflict with some Swedish character such as å. |
||||
To fix the issue, you need remap or disable the related shortcut. |
||||
|
||||
Known Issues |
||||
------------ |
||||
Breaks '.' - [issue #3](https://github.com/jiangmiao/auto-pairs/issues/3) |
||||
|
||||
Description: After entering insert mode and inputing `[hello` then leave insert |
||||
mode by `<ESC>`. press '.' will insert 'hello' instead of '[hello]'. |
||||
Reason: `[` actually equals `[]\<LEFT>` and \<LEFT> will break '.'. |
||||
After version 7.4.849, Vim implements new keyword <C-G>U to avoid the break |
||||
Solution: Update Vim to 7.4.849+ |
||||
|
||||
Contributors |
||||
------------ |
||||
* [camthompson](https://github.com/camthompson) |
||||
|
||||
|
||||
License |
||||
------- |
||||
|
||||
Copyright (C) 2011-2013 Miao Jiang |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
@ -0,0 +1,356 @@
@@ -0,0 +1,356 @@
|
||||
*AutoPairs.txt* Insert or delete brackets, parens, quotes in pair |
||||
|
||||
Author: jiangmiao |
||||
License: MIT |
||||
URL: https://github.com/jiangmiao/auto-pairs |
||||
|
||||
============================================================================== |
||||
CONTENTS *autopairs-contents* |
||||
|
||||
1. Installation ............................. |autopairs-installation| |
||||
2. Features ..................................... |autopairs-features| |
||||
3. Fly Mode ..................................... |autopairs-fly-mode| |
||||
4. Shortcuts ................................... |autopairs-shortcuts| |
||||
5. Options ....................................... |autopairs-options| |
||||
6. Troubleshooting ...................... |autopairs-troubleshooting| |
||||
|
||||
============================================================================== |
||||
1. Introduction *autopairs-installation* |
||||
|
||||
Copy `plugin/auto-pairs.vim` to `~/.vim/plugin`. |
||||
|
||||
Or if you are using `pathogen`: > |
||||
|
||||
git clone git://github.com/jiangmiao/auto-pairs.git ~/.vim/bundle/auto-pairs |
||||
|
||||
============================================================================== |
||||
2. Features *autopairs-features* |
||||
|
||||
Insert in pair: > |
||||
|
||||
input: [ |
||||
output: [|] |
||||
|
||||
Delete in pair: > |
||||
|
||||
input: foo[<BS>] |
||||
output: foo |
||||
|
||||
Insert new indented line after Return: > |
||||
|
||||
input: {|} (press <CR> at |) |
||||
output: { |
||||
| |
||||
} |
||||
|
||||
Insert spaces before closing characters, only for [], (), {}: > |
||||
|
||||
input: {|} (press <SPACE> at |) |
||||
output: { | } |
||||
|
||||
input: {|} (press <SPACE>foo} at |) |
||||
output: { foo }| |
||||
|
||||
input: '|' (press <SPACE> at |) |
||||
output: ' |' |
||||
|
||||
Skip ' when inside a word: > |
||||
|
||||
input: foo| (press ' at |) |
||||
output: foo' |
||||
|
||||
Skip closed bracket: > |
||||
|
||||
input: [] |
||||
output: [] |
||||
|
||||
Ignore auto pair when previous character is '\': > |
||||
|
||||
input: "\' |
||||
output: "\'" |
||||
|
||||
Fast Wrap: > |
||||
|
||||
input: |'hello' (press (<M-e> at |) |
||||
output: ('hello') |
||||
|
||||
Wrap string, only support c style string. |
||||
input: |'h\\el\'lo' (press (<M-e> at |) |
||||
output ('h\\ello\'') |
||||
|
||||
input: |[foo, bar()] (press (<M-e> at |) |
||||
output: ([foo, bar()]) |
||||
|
||||
Quick jump to closed pair: > |
||||
|
||||
input: |
||||
{ |
||||
something;| |
||||
} |
||||
|
||||
(press } at |) |
||||
|
||||
output: |
||||
{ |
||||
|
||||
}| |
||||
|
||||
Support ```, ''' and """: > |
||||
|
||||
input: |
||||
''' |
||||
|
||||
output: |
||||
'''|''' |
||||
|
||||
Delete Repeated Pairs in one time: > |
||||
|
||||
input: """|""" (press <BS> at |) |
||||
output: | |
||||
|
||||
input: {{|}} (press <BS> at |) |
||||
output: | |
||||
|
||||
input: [[[[[[|]]]]]] (press <BS> at |) |
||||
output: | |
||||
|
||||
Fly Mode (|autopairs-flymode|): > |
||||
|
||||
input: if(a[3) |
||||
output: if(a[3])| (In Fly Mode) |
||||
output: if(a[3)]) (Without Fly Mode) |
||||
|
||||
input: |
||||
{ |
||||
hello();| |
||||
world(); |
||||
} |
||||
|
||||
(press } at |) |
||||
|
||||
output: |
||||
{ |
||||
hello(); |
||||
world(); |
||||
}| |
||||
|
||||
(then press <M-b> at | to do backinsert) |
||||
output: |
||||
{ |
||||
hello();}| |
||||
world(); |
||||
} |
||||
|
||||
See |Fly Mode| section for details |
||||
|
||||
============================================================================== |
||||
3. Fly Mode *autopairs-flymode* |
||||
|
||||
Fly Mode will always force closed-pair jumping instead of inserting. Only for |
||||
")", "}", "]". If jumps in mistake, you can use |g:AutoPairsBackInsert| (default |
||||
Key: <M-b>) to jump back and insert closed pair. |
||||
|
||||
The most situation maybe you want to insert single closed pair in the string, |
||||
eg: > |
||||
|
||||
")" |
||||
|
||||
Fly Mode is DISABLED by default. To enable Fly Mode add following to your |
||||
'.vimrc': > |
||||
|
||||
let g:AutoPairsFlyMode = 1 |
||||
|
||||
Default Options: > |
||||
|
||||
let g:AutoPairsFlyMode = 0 |
||||
let g:AutoPairsShortcutBackInsert = '<M-b>' |
||||
|
||||
============================================================================== |
||||
4. Shortcuts *autopairs-shortcuts* |
||||
|
||||
System Shortcuts: |
||||
<CR> : Insert new indented line after return if cursor in blank brackets |
||||
or quotes. |
||||
<BS> : Delete brackets in pair |
||||
<M-p>: Toggle Autopairs (|g:AutoPairsShortcutToggle|) |
||||
<M-e>: Fast Wrap (|g:AutoPairsShortcutFastWrap|) |
||||
<M-n>: Jump to next closed pair (|g:AutoPairsShortcutJump|) |
||||
<M-b>: BackInsert (|g:AutoPairsShortcutBackInsert|) |
||||
|
||||
|
||||
To rebind keys <M-p>, <M-e> or <M-n> or in case of conflicts with |
||||
another keys: |
||||
|
||||
let g:AutoPairsShortcutToggle = '<another key>' |
||||
|
||||
If the key is empty string '', then the shortcut will be disabled. |
||||
|
||||
============================================================================== |
||||
5. Options *autopairs-options* |
||||
|
||||
*g:AutoPairs* |
||||
|g:AutoPairs| dict |
||||
|
||||
Default: > |
||||
{'(':')', '[':']', '{':'}',"'":"'",'"':'"', '`':'`'} |
||||
|
||||
Specifies which symbols should be automatically paired. |
||||
|
||||
To append new pairs without overwriting defaults, add values in your `.vimrc`.: |
||||
|
||||
let g:AutoPairs['<']='>' |
||||
|
||||
This example will enable matching of `<` with `>`. |
||||
|
||||
|
||||
*b:AutoPairs* |
||||
|b:AutoPairs| dict |
||||
|
||||
Default: |g:AutoPairs| |
||||
|
||||
Buffer level pairs set. |
||||
|
||||
You can set |b:AutoPairs| before |BufEnter|: > |
||||
|
||||
au Filetype FILETYPE let b:AutoPairs = {"(": ")"} |
||||
|
||||
This sets |AutoPairs| to only match for parenthesis for 'FILETYPE'. |
||||
|
||||
|
||||
|
||||
*g:AutoPairsShortcutToggle* |
||||
|g:AutoPairsShortcutToggle| string |
||||
|
||||
Default: <M-p> |
||||
|
||||
The shortcut to toggle autopairs. |
||||
|
||||
|
||||
|
||||
*g:AutoPairsShortcutFastWrap* |
||||
|g:AutoPairsShortcutFastWrap| string |
||||
|
||||
Default: <M-e> |
||||
|
||||
Fast wrap the word. All pairs will be considered as a block (including <>). |
||||
|
||||
(|)'hello' after fast wrap at |, the word will be ('hello') |
||||
(|)<hello> after fast wrap at |, the word will be (<hello>) |
||||
|
||||
|
||||
|
||||
*g:AutoPairsShortcutJump* |
||||
|g:AutoPairsShortcutJump| string |
||||
|
||||
Default: <M-n> |
||||
|
||||
Jump to the next closed pair. |
||||
|
||||
|
||||
*g:AutoPairsShortcutBackInsert* |
||||
|g:AutoPairsShortcutBackInsert| string |
||||
|
||||
Default: <M-b> |
||||
|
||||
Work with |autopairs-flymode|, insert the key at the Fly Mode jumped position. |
||||
|
||||
|
||||
|
||||
*g:AutoPairsMapBS* |
||||
|g:AutoPairsMapBS| int |
||||
|
||||
Default: 1 |
||||
|
||||
Map <BS> to delete brackets and quotes in pair, executes: |
||||
|
||||
inoremap <buffer> <silent> <BS> <C-R>=AutoPairsDelete()<CR> |
||||
|
||||
|
||||
*g:AutoPairsMapCh* |
||||
|g:AutoPairsMapCh| int |
||||
|
||||
Default: 1 |
||||
|
||||
Map <C-h> to delete brackets and quotes in pair. |
||||
|
||||
|
||||
*g:AutoPairsMapCR* |
||||
|g:AutoPairsMapCR| int |
||||
|
||||
Default: 1 |
||||
|
||||
Map <CR> to insert a new indented line if cursor in (|), {|} [|], '|', "|". |
||||
Executes: |
||||
|
||||
inoremap <buffer> <silent> <CR> <C-R>=AutoPairsReturn()<CR> |
||||
|
||||
|
||||
*g:AutoPairsCenterLine* |
||||
|g:AutoPairsCenterLine| int |
||||
|
||||
Default: 1 |
||||
|
||||
When |g:AutoPairsMapCR| is on, center current line after return if the line |
||||
is at the bottom 1/3 of the window. |
||||
|
||||
|
||||
*g:AutoPairsMapSpace* |
||||
|g:AutoPairsMapSpace| int |
||||
|
||||
Default: 1 |
||||
|
||||
Map <space> to insert a space after the opening character and before the |
||||
closing one. |
||||
|
||||
Executes: |
||||
|
||||
inoremap <buffer> <silent> <CR> <C-R>=AutoPairsSpace()<CR> |
||||
|
||||
|
||||
*g:AutoPairsFlyMode* |
||||
|g:AutoPairsFlyMode| int |
||||
|
||||
Default: 0 |
||||
|
||||
Set it to 1 to enable |autopairs-flymode|. |
||||
|
||||
|
||||
*g:AutoPairsMultilineClose* |
||||
|g:AutoPairsMultilineClose| int |
||||
|
||||
Default: 1 |
||||
|
||||
When you press the key for the closing pair (e.g. `)`) it jumps past it. |
||||
If set to 1, then it'll jump to the next line, if there is only 'whitespace'. |
||||
If set to 0, then it'll only jump to a closing pair on the same line. |
||||
|
||||
============================================================================== |
||||
6. Troubleshooting *autopairs-troubleshooting* |
||||
|
||||
This plugin remaps keys `([{'"}]) <BS>` |
||||
|
||||
If auto pairs cannot work, use |:imap| to check if the map is corrected. |
||||
|
||||
The correct map should be: > |
||||
|
||||
<C-R>=AutoPairsInsert("\(")<CR> |
||||
|
||||
Or the plugin conflicts with some other plugins. Use command: > |
||||
|
||||
:call AutoPairsInit() to remap the keys. |
||||
|
||||
--- How to insert parens purely? --- |
||||
|
||||
There are 3 ways: |
||||
|
||||
1. Use Ctrl-V ) to insert paren without trigger the plugin. |
||||
|
||||
2. Use Alt-P to turn off the plugin. |
||||
|
||||
3. Use DEL or <C-O>x to delete the character insert by plugin. |
||||
|
||||
--- Swedish Character Conflict --- |
||||
|
||||
Because AutoPairs uses Meta(Alt) key as a shortcut, it conflicts with some |
||||
Swedish character such as å. To fix the issue, you need remap or disable the |
||||
related shortcut. |
@ -0,0 +1,673 @@
@@ -0,0 +1,673 @@
|
||||
" Insert or delete brackets, parens, quotes in pairs. |
||||
" Maintainer: JiangMiao <jiangfriend@gmail.com> |
||||
" Contributor: camthompson |
||||
" Last Change: 2019-02-02 |
||||
" Version: 2.0.0 |
||||
" Homepage: http://www.vim.org/scripts/script.php?script_id=3599 |
||||
" Repository: https://github.com/jiangmiao/auto-pairs |
||||
" License: MIT |
||||
|
||||
if exists('g:AutoPairsLoaded') || &cp |
||||
finish |
||||
end |
||||
let g:AutoPairsLoaded = 1 |
||||
|
||||
if !exists('g:AutoPairs') |
||||
let g:AutoPairs = {'(':')', '[':']', '{':'}',"'":"'",'"':'"', '```':'```', '"""':'"""', "'''":"'''", "`":"`"} |
||||
end |
||||
|
||||
" default pairs base on filetype |
||||
func! AutoPairsDefaultPairs() |
||||
if exists('b:autopairs_defaultpairs') |
||||
return b:autopairs_defaultpairs |
||||
end |
||||
let r = copy(g:AutoPairs) |
||||
let allPairs = { |
||||
\ 'vim': {'\v^\s*\zs"': ''}, |
||||
\ 'rust': {'\w\zs<': '>', '&\zs''': ''}, |
||||
\ 'php': {'<?': '?>//k]', '<?php': '?>//k]'} |
||||
\ } |
||||
for [filetype, pairs] in items(allPairs) |
||||
if &filetype == filetype |
||||
for [open, close] in items(pairs) |
||||
let r[open] = close |
||||
endfor |
||||
end |
||||
endfor |
||||
let b:autopairs_defaultpairs = r |
||||
return r |
||||
endf |
||||
|
||||
if !exists('g:AutoPairsMapBS') |
||||
let g:AutoPairsMapBS = 1 |
||||
end |
||||
|
||||
" Map <C-h> as the same BS |
||||
if !exists('g:AutoPairsMapCh') |
||||
let g:AutoPairsMapCh = 1 |
||||
end |
||||
|
||||
if !exists('g:AutoPairsMapCR') |
||||
let g:AutoPairsMapCR = 1 |
||||
end |
||||
|
||||
if !exists('g:AutoPairsWildClosedPair') |
||||
let g:AutoPairsWildClosedPair = '' |
||||
end |
||||
|
||||
if !exists('g:AutoPairsMapSpace') |
||||
let g:AutoPairsMapSpace = 1 |
||||
end |
||||
|
||||
if !exists('g:AutoPairsCenterLine') |
||||
let g:AutoPairsCenterLine = 1 |
||||
end |
||||
|
||||
if !exists('g:AutoPairsShortcutToggle') |
||||
let g:AutoPairsShortcutToggle = '<M-p>' |
||||
end |
||||
|
||||
if !exists('g:AutoPairsShortcutFastWrap') |
||||
let g:AutoPairsShortcutFastWrap = '<M-e>' |
||||
end |
||||
|
||||
if !exists('g:AutoPairsMoveCharacter') |
||||
let g:AutoPairsMoveCharacter = "()[]{}\"'" |
||||
end |
||||
|
||||
if !exists('g:AutoPairsShortcutJump') |
||||
let g:AutoPairsShortcutJump = '<M-n>' |
||||
endif |
||||
|
||||
" Fly mode will for closed pair to jump to closed pair instead of insert. |
||||
" also support AutoPairsBackInsert to insert pairs where jumped. |
||||
if !exists('g:AutoPairsFlyMode') |
||||
let g:AutoPairsFlyMode = 0 |
||||
endif |
||||
|
||||
" When skipping the closed pair, look at the current and |
||||
" next line as well. |
||||
if !exists('g:AutoPairsMultilineClose') |
||||
let g:AutoPairsMultilineClose = 1 |
||||
endif |
||||
|
||||
" Work with Fly Mode, insert pair where jumped |
||||
if !exists('g:AutoPairsShortcutBackInsert') |
||||
let g:AutoPairsShortcutBackInsert = '<M-b>' |
||||
endif |
||||
|
||||
if !exists('g:AutoPairsSmartQuotes') |
||||
let g:AutoPairsSmartQuotes = 1 |
||||
endif |
||||
|
||||
" 7.4.849 support <C-G>U to avoid breaking '.' |
||||
" Issue talk: https://github.com/jiangmiao/auto-pairs/issues/3 |
||||
" Vim note: https://github.com/vim/vim/releases/tag/v7.4.849 |
||||
if v:version > 704 || v:version == 704 && has("patch849") |
||||
let s:Go = "\<C-G>U" |
||||
else |
||||
let s:Go = "" |
||||
endif |
||||
|
||||
let s:Left = s:Go."\<LEFT>" |
||||
let s:Right = s:Go."\<RIGHT>" |
||||
|
||||
|
||||
|
||||
|
||||
" unicode len |
||||
func! s:ulen(s) |
||||
return len(split(a:s, '\zs')) |
||||
endf |
||||
|
||||
func! s:left(s) |
||||
return repeat(s:Left, s:ulen(a:s)) |
||||
endf |
||||
|
||||
func! s:right(s) |
||||
return repeat(s:Right, s:ulen(a:s)) |
||||
endf |
||||
|
||||
func! s:delete(s) |
||||
return repeat("\<DEL>", s:ulen(a:s)) |
||||
endf |
||||
|
||||
func! s:backspace(s) |
||||
return repeat("\<BS>", s:ulen(a:s)) |
||||
endf |
||||
|
||||
func! s:getline() |
||||
let line = getline('.') |
||||
let pos = col('.') - 1 |
||||
let before = strpart(line, 0, pos) |
||||
let after = strpart(line, pos) |
||||
let afterline = after |
||||
if g:AutoPairsMultilineClose |
||||
let n = line('$') |
||||
let i = line('.')+1 |
||||
while i <= n |
||||
let line = getline(i) |
||||
let after = after.' '.line |
||||
if !(line =~ '\v^\s*$') |
||||
break |
||||
end |
||||
let i = i+1 |
||||
endwhile |
||||
end |
||||
return [before, after, afterline] |
||||
endf |
||||
|
||||
" split text to two part |
||||
" returns [orig, text_before_open, open] |
||||
func! s:matchend(text, open) |
||||
let m = matchstr(a:text, '\V'.a:open.'\v$') |
||||
if m == "" |
||||
return [] |
||||
end |
||||
return [a:text, strpart(a:text, 0, len(a:text)-len(m)), m] |
||||
endf |
||||
|
||||
" returns [orig, close, text_after_close] |
||||
func! s:matchbegin(text, close) |
||||
let m = matchstr(a:text, '^\V'.a:close) |
||||
if m == "" |
||||
return [] |
||||
end |
||||
return [a:text, m, strpart(a:text, len(m), len(a:text)-len(m))] |
||||
endf |
||||
|
||||
" add or delete pairs base on g:AutoPairs |
||||
" AutoPairsDefine(addPairs:dict[, removeOpenPairList:list]) |
||||
" |
||||
" eg: |
||||
" au FileType html let b:AutoPairs = AutoPairsDefine({'<!--' : '-->'}, ['{']) |
||||
" add <!-- --> pair and remove '{' for html file |
||||
func! AutoPairsDefine(pairs, ...) |
||||
let r = AutoPairsDefaultPairs() |
||||
if a:0 > 0 |
||||
for open in a:1 |
||||
unlet r[open] |
||||
endfor |
||||
end |
||||
for [open, close] in items(a:pairs) |
||||
let r[open] = close |
||||
endfor |
||||
return r |
||||
endf |
||||
|
||||
func! AutoPairsInsert(key) |
||||
if !b:autopairs_enabled |
||||
return a:key |
||||
end |
||||
|
||||
let b:autopairs_saved_pair = [a:key, getpos('.')] |
||||
|
||||
let [before, after, afterline] = s:getline() |
||||
|
||||
" Ignore auto close if prev character is \ |
||||
if before[-1:-1] == '\' |
||||
return a:key |
||||
end |
||||
|
||||
" check open pairs |
||||
for [open, close, opt] in b:AutoPairsList |
||||
let ms = s:matchend(before.a:key, open) |
||||
let m = matchstr(afterline, '^\v\s*\zs\V'.close) |
||||
if len(ms) > 0 |
||||
" process the open pair |
||||
|
||||
" remove inserted pair |
||||
" eg: if the pairs include < > and <!-- --> |
||||
" when <!-- is detected the inserted pair < > should be clean up |
||||
let target = ms[1] |
||||
let openPair = ms[2] |
||||
if len(openPair) == 1 && m == openPair |
||||
break |
||||
end |
||||
let bs = '' |
||||
let del = '' |
||||
while len(before) > len(target) |
||||
let found = 0 |
||||
" delete pair |
||||
for [o, c, opt] in b:AutoPairsList |
||||
let os = s:matchend(before, o) |
||||
if len(os) && len(os[1]) < len(target) |
||||
" any text before openPair should not be deleted |
||||
continue |
||||
end |
||||
let cs = s:matchbegin(afterline, c) |
||||
if len(os) && len(cs) |
||||
let found = 1 |
||||
let before = os[1] |
||||
let afterline = cs[2] |
||||
let bs = bs.s:backspace(os[2]) |
||||
let del = del.s:delete(cs[1]) |
||||
break |
||||
end |
||||
endfor |
||||
if !found |
||||
" delete charactor |
||||
let ms = s:matchend(before, '\v.') |
||||
if len(ms) |
||||
let before = ms[1] |
||||
let bs = bs.s:backspace(ms[2]) |
||||
end |
||||
end |
||||
endwhile |
||||
return bs.del.openPair.close.s:left(close) |
||||
end |
||||
endfor |
||||
|
||||
" check close pairs |
||||
for [open, close, opt] in b:AutoPairsList |
||||
if close == '' |
||||
continue |
||||
end |
||||
if a:key == g:AutoPairsWildClosedPair || opt['mapclose'] && opt['key'] == a:key |
||||
" the close pair is in the same line |
||||
let m = matchstr(afterline, '^\v\s*\V'.close) |
||||
if m != '' |
||||
if before =~ '\V'.open.'\v\s*$' && m[0] =~ '\v\s' |
||||
" remove the space we inserted if the text in pairs is blank |
||||
return "\<DEL>".s:right(m[1:]) |
||||
else |
||||
return s:right(m) |
||||
end |
||||
end |
||||
let m = matchstr(after, '^\v\s*\zs\V'.close) |
||||
if m != '' |
||||
if a:key == g:AutoPairsWildClosedPair || opt['multiline'] |
||||
if b:autopairs_return_pos == line('.') && getline('.') =~ '\v^\s*$' |
||||
normal! ddk$ |
||||
end |
||||
call search(m, 'We') |
||||
return "\<Right>" |
||||
else |
||||
break |
||||
end |
||||
end |
||||
end |
||||
endfor |
||||
|
||||
|
||||
" Fly Mode, and the key is closed-pairs, search closed-pair and jump |
||||
if g:AutoPairsFlyMode && a:key =~ '\v[\}\]\)]' |
||||
if search(a:key, 'We') |
||||
return "\<Right>" |
||||
endif |
||||
endif |
||||
|
||||
return a:key |
||||
endf |
||||
|
||||
func! AutoPairsDelete() |
||||
if !b:autopairs_enabled |
||||
return "\<BS>" |
||||
end |
||||
|
||||
let [before, after, ig] = s:getline() |
||||
for [open, close, opt] in b:AutoPairsList |
||||
let b = matchstr(before, '\V'.open.'\v\s?$') |
||||
let a = matchstr(after, '^\v\s*\V'.close) |
||||
if b != '' && a != '' |
||||
if b[-1:-1] == ' ' |
||||
if a[0] == ' ' |
||||
return "\<BS>\<DELETE>" |
||||
else |
||||
return "\<BS>" |
||||
end |
||||
end |
||||
return s:backspace(b).s:delete(a) |
||||
end |
||||
endfor |
||||
|
||||
return "\<BS>" |
||||
" delete the pair foo[]| <BS> to foo |
||||
for [open, close, opt] in b:AutoPairsList |
||||
let m = s:matchend(before, '\V'.open.'\v\s*'.'\V'.close.'\v$') |
||||
if len(m) > 0 |
||||
return s:backspace(m[2]) |
||||
end |
||||
endfor |
||||
return "\<BS>" |
||||
endf |
||||
|
||||
|
||||
" Fast wrap the word in brackets |
||||
func! AutoPairsFastWrap() |
||||
let c = @" |
||||
normal! x |
||||
let [before, after, ig] = s:getline() |
||||
if after[0] =~ '\v[\{\[\(\<]' |
||||
normal! % |
||||
normal! p |
||||
else |
||||
for [open, close, opt] in b:AutoPairsList |
||||
if close == '' |
||||
continue |
||||
end |
||||
if after =~ '^\s*\V'.open |
||||
call search(close, 'We') |
||||
normal! p |
||||
let @" = c |
||||
return "" |
||||
end |
||||
endfor |
||||
if after[1:1] =~ '\v\w' |
||||
normal! e |
||||
normal! p |
||||
else |
||||
normal! p |
||||
end |
||||
end |
||||
let @" = c |
||||
return "" |
||||
endf |
||||
|
||||
func! AutoPairsJump() |
||||
call search('["\]'')}]','W') |
||||
endf |
||||
|
||||
func! AutoPairsMoveCharacter(key) |
||||
let c = getline(".")[col(".")-1] |
||||
let escaped_key = substitute(a:key, "'", "''", 'g') |
||||
return "\<DEL>\<ESC>:call search("."'".escaped_key."'".")\<CR>a".c."\<LEFT>" |
||||
endf |
||||
|
||||
func! AutoPairsBackInsert() |
||||
let pair = b:autopairs_saved_pair[0] |
||||
let pos = b:autopairs_saved_pair[1] |
||||
call setpos('.', pos) |
||||
return pair |
||||
endf |
||||
|
||||
func! AutoPairsReturn() |
||||
if b:autopairs_enabled == 0 |
||||
return '' |
||||
end |
||||
let b:autopairs_return_pos = 0 |
||||
let before = getline(line('.')-1) |
||||
let [ig, ig, afterline] = s:getline() |
||||
let cmd = '' |
||||
for [open, close, opt] in b:AutoPairsList |
||||
if close == '' |
||||
continue |
||||
end |
||||
|
||||
if before =~ '\V'.open.'\v\s*$' && afterline =~ '^\s*\V'.close |
||||
let b:autopairs_return_pos = line('.') |
||||
if g:AutoPairsCenterLine && winline() * 3 >= winheight(0) * 2 |
||||
" Recenter before adding new line to avoid replacing line content |
||||
let cmd = "zz" |
||||
end |
||||
|
||||
" If equalprg has been set, then avoid call = |
||||
" https://github.com/jiangmiao/auto-pairs/issues/24 |
||||
if &equalprg != '' |
||||
return "\<ESC>".cmd."O" |
||||
endif |
||||
|
||||
" conflict with javascript and coffee |
||||
" javascript need indent new line |
||||
" coffeescript forbid indent new line |
||||
if &filetype == 'coffeescript' || &filetype == 'coffee' |
||||
return "\<ESC>".cmd."k==o" |
||||
else |
||||
return "\<ESC>".cmd."=ko" |
||||
endif |
||||
end |
||||
endfor |
||||
return '' |
||||
endf |
||||
|
||||
func! AutoPairsSpace() |
||||
if !b:autopairs_enabled |
||||
return "\<SPACE>" |
||||
end |
||||
|
||||
let [before, after, ig] = s:getline() |
||||
|
||||
for [open, close, opt] in b:AutoPairsList |
||||
if close == '' |
||||
continue |
||||
end |
||||
if before =~ '\V'.open.'\v$' && after =~ '^\V'.close |
||||
if close =~ '\v^[''"`]$' |
||||
return "\<SPACE>" |
||||
else |
||||
return "\<SPACE>\<SPACE>".s:Left |
||||
end |
||||
end |
||||
endfor |
||||
return "\<SPACE>" |
||||
endf |
||||
|
||||
func! AutoPairsMap(key) |
||||
" | is special key which separate map command from text |
||||
let key = a:key |
||||
if key == '|' |
||||
let key = '<BAR>' |
||||
end |
||||
let escaped_key = substitute(key, "'", "''", 'g') |
||||
" use expr will cause search() doesn't work |
||||
execute 'inoremap <buffer> <silent> '.key." <C-R>=AutoPairsInsert('".escaped_key."')<CR>" |
||||
endf |
||||
|
||||
func! AutoPairsToggle() |
||||
if b:autopairs_enabled |
||||
let b:autopairs_enabled = 0 |
||||
echo 'AutoPairs Disabled.' |
||||
else |
||||
let b:autopairs_enabled = 1 |
||||
echo 'AutoPairs Enabled.' |
||||
end |
||||
return '' |
||||
endf |
||||
|
||||
func! s:sortByLength(i1, i2) |
||||
return len(a:i2[0])-len(a:i1[0]) |
||||
endf |
||||
|
||||
func! AutoPairsInit() |
||||
let b:autopairs_loaded = 1 |
||||
if !exists('b:autopairs_enabled') |
||||
let b:autopairs_enabled = 1 |
||||
end |
||||
|
||||
if !exists('b:AutoPairs') |
||||
let b:AutoPairs = AutoPairsDefaultPairs() |
||||
end |
||||
|
||||
if !exists('b:AutoPairsMoveCharacter') |
||||
let b:AutoPairsMoveCharacter = g:AutoPairsMoveCharacter |
||||
end |
||||
|
||||
let b:autopairs_return_pos = 0 |
||||
let b:autopairs_saved_pair = [0, 0] |
||||
let b:AutoPairsList = [] |
||||
|
||||
" buffer level map pairs keys |
||||
" n - do not map the first charactor of closed pair to close key |
||||
" m - close key jumps through multi line |
||||
" s - close key jumps only in the same line |
||||
for [open, close] in items(b:AutoPairs) |
||||
let o = open[-1:-1] |
||||
let c = close[0] |
||||
let opt = {'mapclose': 1, 'multiline':1} |
||||
let opt['key'] = c |
||||
if o == c |
||||
let opt['multiline'] = 0 |
||||
end |
||||
let m = matchlist(close, '\v(.*)//(.*)$') |
||||
if len(m) > 0 |
||||
if m[2] =~ 'n' |
||||
let opt['mapclose'] = 0 |
||||
end |
||||
if m[2] =~ 'm' |
||||
let opt['multiline'] = 1 |
||||
end |
||||
if m[2] =~ 's' |
||||
let opt['multiline'] = 0 |
||||
end |
||||
let ks = matchlist(m[2], '\vk(.)') |
||||
if len(ks) > 0 |
||||
let opt['key'] = ks[1] |
||||
let c = opt['key'] |
||||
end |
||||
let close = m[1] |
||||
end |
||||
call AutoPairsMap(o) |
||||
if o != c && c != '' && opt['mapclose'] |
||||
call AutoPairsMap(c) |
||||
end |
||||
let b:AutoPairsList += [[open, close, opt]] |
||||
endfor |
||||
|
||||
" sort pairs by length, longer pair should have higher priority |
||||
let b:AutoPairsList = sort(b:AutoPairsList, "s:sortByLength") |
||||
|
||||
for item in b:AutoPairsList |
||||
let [open, close, opt] = item |
||||
if open == "'" && open == close |
||||
let item[0] = '\v(^|\W)\zs''' |
||||
end |
||||
endfor |
||||
|
||||
|
||||
for key in split(b:AutoPairsMoveCharacter, '\s*') |
||||
let escaped_key = substitute(key, "'", "''", 'g') |
||||
execute 'inoremap <silent> <buffer> <M-'.key."> <C-R>=AutoPairsMoveCharacter('".escaped_key."')<CR>" |
||||
endfor |
||||
|
||||
" Still use <buffer> level mapping for <BS> <SPACE> |
||||
if g:AutoPairsMapBS |
||||
" Use <C-R> instead of <expr> for issue #14 sometimes press BS output strange words |
||||
execute 'inoremap <buffer> <silent> <BS> <C-R>=AutoPairsDelete()<CR>' |
||||
end |
||||
|
||||
if g:AutoPairsMapCh |
||||
execute 'inoremap <buffer> <silent> <C-h> <C-R>=AutoPairsDelete()<CR>' |
||||
endif |
||||
|
||||
if g:AutoPairsMapSpace |
||||
" Try to respect abbreviations on a <SPACE> |
||||
let do_abbrev = "" |
||||
if v:version == 703 && has("patch489") || v:version > 703 |
||||
let do_abbrev = "<C-]>" |
||||
endif |
||||
execute 'inoremap <buffer> <silent> <SPACE> '.do_abbrev.'<C-R>=AutoPairsSpace()<CR>' |
||||
end |
||||
|
||||
if g:AutoPairsShortcutFastWrap != '' |
||||
execute 'inoremap <buffer> <silent> '.g:AutoPairsShortcutFastWrap.' <C-R>=AutoPairsFastWrap()<CR>' |
||||
end |
||||
|
||||
if g:AutoPairsShortcutBackInsert != '' |
||||
execute 'inoremap <buffer> <silent> '.g:AutoPairsShortcutBackInsert.' <C-R>=AutoPairsBackInsert()<CR>' |
||||
end |
||||
|
||||
if g:AutoPairsShortcutToggle != '' |
||||
" use <expr> to ensure showing the status when toggle |
||||
execute 'inoremap <buffer> <silent> <expr> '.g:AutoPairsShortcutToggle.' AutoPairsToggle()' |
||||
execute 'noremap <buffer> <silent> '.g:AutoPairsShortcutToggle.' :call AutoPairsToggle()<CR>' |
||||
end |
||||
|
||||
if g:AutoPairsShortcutJump != '' |
||||
execute 'inoremap <buffer> <silent> ' . g:AutoPairsShortcutJump. ' <ESC>:call AutoPairsJump()<CR>a' |
||||
execute 'noremap <buffer> <silent> ' . g:AutoPairsShortcutJump. ' :call AutoPairsJump()<CR>' |
||||
end |
||||
|
||||
if &keymap != '' |
||||
let l:imsearch = &imsearch |
||||
let l:iminsert = &iminsert |
||||
let l:imdisable = &imdisable |
||||
execute 'setlocal keymap=' . &keymap |
||||
execute 'setlocal imsearch=' . l:imsearch |
||||
execute 'setlocal iminsert=' . l:iminsert |
||||
if l:imdisable |
||||
execute 'setlocal imdisable' |
||||
else |
||||
execute 'setlocal noimdisable' |
||||
end |
||||
end |
||||
|
||||
endf |
||||
|
||||
func! s:ExpandMap(map) |
||||
let map = a:map |
||||
let map = substitute(map, '\(<Plug>\w\+\)', '\=maparg(submatch(1), "i")', 'g') |
||||
let map = substitute(map, '\(<Plug>([^)]*)\)', '\=maparg(submatch(1), "i")', 'g') |
||||
return map |
||||
endf |
||||
|
||||
func! AutoPairsTryInit() |
||||
if exists('b:autopairs_loaded') |
||||
return |
||||
end |
||||
|
||||
" for auto-pairs starts with 'a', so the priority is higher than supertab and vim-endwise |
||||
" |
||||
" vim-endwise doesn't support <Plug>AutoPairsReturn |
||||
" when use <Plug>AutoPairsReturn will cause <Plug> isn't expanded |
||||
" |
||||
" supertab doesn't support <SID>AutoPairsReturn |
||||
" when use <SID>AutoPairsReturn will cause Duplicated <CR> |
||||
" |
||||
" and when load after vim-endwise will cause unexpected endwise inserted. |
||||
" so always load AutoPairs at last |
||||
|
||||
" Buffer level keys mapping |
||||
" comptible with other plugin |
||||
if g:AutoPairsMapCR |
||||
if v:version == 703 && has('patch32') || v:version > 703 |
||||
" VIM 7.3 supports advancer maparg which could get <expr> info |
||||
" then auto-pairs could remap <CR> in any case. |
||||
let info = maparg('<CR>', 'i', 0, 1) |
||||
if empty(info) |
||||
let old_cr = '<CR>' |
||||
let is_expr = 0 |
||||
else |
||||
let old_cr = info['rhs'] |
||||
let old_cr = s:ExpandMap(old_cr) |
||||
let old_cr = substitute(old_cr, '<SID>', '<SNR>' . info['sid'] . '_', 'g') |
||||
let is_expr = info['expr'] |
||||
let wrapper_name = '<SID>AutoPairsOldCRWrapper73' |
||||
endif |
||||
else |
||||
" VIM version less than 7.3 |
||||
" the mapping's <expr> info is lost, so guess it is expr or not, it's |
||||
" not accurate. |
||||
let old_cr = maparg('<CR>', 'i') |
||||
if old_cr == '' |
||||
let old_cr = '<CR>' |
||||
let is_expr = 0 |
||||
else |
||||
let old_cr = s:ExpandMap(old_cr) |
||||
" old_cr contain (, I guess the old cr is in expr mode |
||||
let is_expr = old_cr =~ '\V(' && toupper(old_cr) !~ '\V<C-R>' |
||||
|
||||
" The old_cr start with " it must be in expr mode |
||||
let is_expr = is_expr || old_cr =~ '\v^"' |
||||
let wrapper_name = '<SID>AutoPairsOldCRWrapper' |
||||
end |
||||
end |
||||
|
||||
if old_cr !~ 'AutoPairsReturn' |
||||
if is_expr |
||||
" remap <expr> to `name` to avoid mix expr and non-expr mode |
||||
execute 'inoremap <buffer> <expr> <script> '. wrapper_name . ' ' . old_cr |
||||
let old_cr = wrapper_name |
||||
end |
||||
" Always silent mapping |
||||
execute 'inoremap <script> <buffer> <silent> <CR> '.old_cr.'<SID>AutoPairsReturn' |
||||
end |
||||
endif |
||||
call AutoPairsInit() |
||||
endf |
||||
|
||||
" Always silent the command |
||||
inoremap <silent> <SID>AutoPairsReturn <C-R>=AutoPairsReturn()<CR> |
||||
imap <script> <Plug>AutoPairsReturn <SID>AutoPairsReturn |
||||
|
||||
|
||||
au BufEnter * :call AutoPairsTryInit() |
@ -1,62 +0,0 @@
@@ -1,62 +0,0 @@
|
||||
" {{{1 Documentation |
||||
" Version: $Id: autoloadTemplate.vim,v 1.2 2007/02/06 05:22:55 alanc Exp $ |
||||
" File: autoloadTemplate.vim |
||||
" Maintainer: Alan Che <alan.che@hotmail.com> |
||||
" Last Change:2007/02/06 |
||||
" |
||||
" {{{2 Decription: |
||||
" |
||||
" Load template file from a specific directory according their filetype while |
||||
" starting to edit a new file. if the file does not exist, skip it! |
||||
" |
||||
" |
||||
" {{{2 INSTALL: |
||||
" Here is the way to install this script to your site: |
||||
" 1. extract this file to ~/.vim/plugin |
||||
" 2. create a directory ~/.vim/template |
||||
" 3. create your template files in that directory, where the file name follow |
||||
" th rule: |
||||
" <filetype>.vim |
||||
" where <filetype> is the filetype of this template will apply to, such |
||||
" as: verilog.vim, tcl.vim and so on. |
||||
" |
||||
" |
||||
" {{{1 Source code |
||||
|
||||
|
||||
|
||||
let g:TemplatePath="~/.config/nvim/template" |
||||
|
||||
augroup loadTemplate |
||||
autocmd! |
||||
au FileType * call Template() |
||||
|
||||
function! Template() |
||||
if ! exists("b:IsNewFile") |
||||
return |
||||
endif |
||||
|
||||
if exists("b:Template_loaded") |
||||
return |
||||
endif |
||||
let b:Template_loaded=1 |
||||
|
||||
let b:ThisFileType=expand("<amatch>") |
||||
let b:TemplatePath=g:TemplatePath ."/". b:ThisFileType . ".vim" |
||||
let TemplateFullName = expand(b:TemplatePath) |
||||
|
||||
if filereadable(TemplateFullName) |
||||
let $TemplateFullName=TemplateFullName |
||||
0r $TemplateFullName |
||||
unlet TemplateFullName |
||||
normal G |
||||
endif |
||||
endfunction |
||||
|
||||
augroup END |
||||
|
||||
au BufNewFile * execute "let b:IsNewFile=1" |
||||
au BufNewFile * execute "doau loadTemplate FileType" |
||||
|
||||
|
||||
" vim: set ft=vim foldmethod=marker sw=4 ts=8: |
@ -1,988 +0,0 @@
@@ -1,988 +0,0 @@
|
||||
if !exists("g:calendar_action") |
||||
let g:calendar_action = "calendar#diary" |
||||
endif |
||||
if !exists("g:calendar_sign") |
||||
let g:calendar_sign = "calendar#sign" |
||||
endif |
||||
if !exists("g:calendar_mark") |
||||
\|| (g:calendar_mark != 'left' |
||||
\&& g:calendar_mark != 'left-fit' |
||||
\&& g:calendar_mark != 'right') |
||||
let g:calendar_mark = 'left' |
||||
endif |
||||
if !exists("g:calendar_navi") |
||||
\|| (g:calendar_navi != 'top' |
||||
\&& g:calendar_navi != 'bottom' |
||||
\&& g:calendar_navi != 'both' |
||||
\&& g:calendar_navi != '') |
||||
let g:calendar_navi = 'top' |
||||
endif |
||||
if !exists("g:calendar_navi_label") |
||||
let g:calendar_navi_label = "Prev,Today,Next" |
||||
endif |
||||
if !exists("g:calendar_diary") |
||||
let g:calendar_diary = "~/diary" |
||||
endif |
||||
if !exists("g:calendar_focus_today") |
||||
let g:calendar_focus_today = 0 |
||||
endif |
||||
if !exists("g:calendar_datetime") |
||||
\|| (g:calendar_datetime != '' |
||||
\&& g:calendar_datetime != 'title' |
||||
\&& g:calendar_datetime != 'statusline') |
||||
let g:calendar_datetime = 'title' |
||||
endif |
||||
if !exists("g:calendar_options") |
||||
let g:calendar_options = "fdc=0 nonu" |
||||
if has("+relativenumber") |
||||
let g:calendar_options .= " nornu" |
||||
endif |
||||
endif |
||||
|
||||
"***************************************************************** |
||||
"* Default Calendar key bindings |
||||
"***************************************************************** |
||||
let s:calendar_keys = { |
||||
\ 'close' : 'q', |
||||
\ 'do_action' : '<CR>', |
||||
\ 'goto_today' : 't', |
||||
\ 'show_help' : '?', |
||||
\ 'redisplay' : 'r', |
||||
\ 'goto_next_month' : '<RIGHT>', |
||||
\ 'goto_prev_month' : '<LEFT>', |
||||
\ 'goto_next_year' : '<UP>', |
||||
\ 'goto_prev_year' : '<DOWN>', |
||||
\} |
||||
|
||||
if exists("g:calendar_keys") && type(g:calendar_keys) == 4 |
||||
let s:calendar_keys = extend(s:calendar_keys, g:calendar_keys) |
||||
end |
||||
|
||||
"***************************************************************** |
||||
"* CalendarDoAction : call the action handler function |
||||
"*---------------------------------------------------------------- |
||||
"***************************************************************** |
||||
function! calendar#action(...) |
||||
" for navi |
||||
if exists('g:calendar_navi') |
||||
let navi = (a:0 > 0)? a:1 : expand("<cWORD>") |
||||
let curl = line(".") |
||||
if navi == '<' . get(split(g:calendar_navi_label, ','), 0, '') |
||||
if b:CalendarMonth > 1 |
||||
call calendar#show(b:CalendarDir, b:CalendarYear, b:CalendarMonth-1) |
||||
else |
||||
call calendar#show(b:CalendarDir, b:CalendarYear-1, 12) |
||||
endif |
||||
elseif navi == get(split(g:calendar_navi_label, ','), 2, '') . '>' |
||||
if b:CalendarMonth < 12 |
||||
call calendar#show(b:CalendarDir, b:CalendarYear, b:CalendarMonth+1) |
||||
else |
||||
call calendar#show(b:CalendarDir, b:CalendarYear+1, 1) |
||||
endif |
||||
elseif navi == get(split(g:calendar_navi_label, ','), 1, '') |
||||
call calendar#show(b:CalendarDir) |
||||
if exists('g:calendar_today') |
||||
exe "call " . g:calendar_today . "()" |
||||
endif |
||||
else |
||||
let navi = '' |
||||
endif |
||||
if navi != '' |
||||
if g:calendar_focus_today == 1 && search("\*","w") > 0 |
||||
silent execute "normal! gg/\*\<cr>" |
||||
return |
||||
else |
||||
if curl < line('$')/2 |
||||
silent execute "normal! gg0/".navi."\<cr>" |
||||
else |
||||
silent execute "normal! G$?".navi."\<cr>" |
||||
endif |
||||
return |
||||
endif |
||||
endif |
||||
endif |
||||
|
||||
" if no action defined return |
||||
if !exists("g:calendar_action") || g:calendar_action == "" |
||||
return |
||||
endif |
||||
|
||||
if b:CalendarDir |
||||
let dir = 'H' |
||||
if exists('g:calendar_weeknm') |
||||
let cnr = col('.') - (col('.')%(24+5)) + 1 |
||||
else |
||||
let cnr = col('.') - (col('.')%(24)) + 1 |
||||
endif |
||||
let week = ((col(".") - cnr - 1 + cnr/49) / 3) |
||||
else |
||||
let dir = 'V' |
||||
let cnr = 1 |
||||
let week = ((col(".")+1) / 3) - 1 |
||||
endif |
||||
let lnr = 1 |
||||
let hdr = 1 |
||||
while 1 |
||||
if lnr > line('.') |
||||
break |
||||
endif |
||||
let sline = getline(lnr) |
||||
if sline =~ '^\s*$' |
||||
let hdr = lnr + 1 |
||||
endif |
||||
let lnr = lnr + 1 |
||||
endwhile |
||||
let lnr = line('.') |
||||
if(exists('g:calendar_monday')) |
||||
let week = week + 1 |
||||
elseif(week == 0) |
||||
let week = 7 |
||||
endif |
||||
if lnr-hdr < 2 |
||||
return |
||||
endif |
||||
let sline = substitute(strpart(getline(hdr),cnr,21),'\s*\(.*\)\s*','\1','') |
||||
if (col(".")-cnr) > 21 |
||||
return |
||||
endif |
||||
|
||||
" extract day |
||||
if g:calendar_mark == 'right' && col('.') > 1 |
||||
normal! h |
||||
let day = matchstr(expand("<cword>"), '[^0].*') |
||||
normal! l |
||||
else |
||||
let day = matchstr(expand("<cword>"), '[^0].*') |
||||
endif |
||||
if day == 0 |
||||
return |
||||
endif |
||||
" extract year and month |
||||
if exists('g:calendar_erafmt') && g:calendar_erafmt !~ "^\s*$" |
||||
let year = matchstr(substitute(sline, '/.*', '', ''), '\d\+') |
||||
let month = matchstr(substitute(sline, '.*/\(\d\d\=\).*', '\1', ""), '[^0].*') |
||||
if g:calendar_erafmt =~ '.*,[+-]*\d\+' |
||||
let veranum = substitute(g:calendar_erafmt,'.*,\([+-]*\d\+\)','\1','') |
||||
if year-veranum > 0 |
||||
let year = year-veranum |
||||
endif |
||||
endif |
||||
else |
||||
let year = matchstr(substitute(sline, '/.*', '', ''), '[^0].*') |
||||
let month = matchstr(substitute(sline, '\d*/\(\d\d\=\).*', '\1', ""), '[^0].*') |
||||
endif |
||||
" call the action function |
||||
exe "call " . g:calendar_action . "(day, month, year, week, dir)" |
||||
endfunc |
||||
|
||||
"***************************************************************** |
||||
"* Calendar : build calendar |
||||
"*---------------------------------------------------------------- |
||||
"* a1 : direction |
||||
"* a2 : month(if given a3, it's year) |
||||
"* a3 : if given, it's month |
||||
"***************************************************************** |
||||
function! calendar#show(...) |
||||
|
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
"+++ ready for build |
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
" remember today |
||||
" divide strftime('%d') by 1 so as to get "1,2,3 .. 9" instead of "01, 02, 03 .. 09" |
||||
let vtoday = strftime('%Y').strftime('%m').strftime('%d') |
||||
|
||||
" get arguments |
||||
if a:0 == 0 |
||||
let dir = 0 |
||||
let vyear = strftime('%Y') |
||||
let vmnth = matchstr(strftime('%m'), '[^0].*') |
||||
elseif a:0 == 1 |
||||
let dir = a:1 |
||||
let vyear = strftime('%Y') |
||||
let vmnth = matchstr(strftime('%m'), '[^0].*') |
||||
elseif a:0 == 2 |
||||
let dir = a:1 |
||||
let vyear = strftime('%Y') |
||||
let vmnth = matchstr(a:2, '^[^0].*') |
||||
else |
||||
let dir = a:1 |
||||
let vyear = a:2 |
||||
let vmnth = matchstr(a:3, '^[^0].*') |
||||
endif |
||||
|
||||
" remember constant |
||||
let vmnth_org = vmnth |
||||
let vyear_org = vyear |
||||
|
||||
" start with last month |
||||
let vmnth = vmnth - 1 |
||||
if vmnth < 1 |
||||
let vmnth = 12 |
||||
let vyear = vyear - 1 |
||||
endif |
||||
|
||||
" reset display variables |
||||
let vdisplay1 = '' |
||||
let vheight = 1 |
||||
let vmcnt = 0 |
||||
|
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
"+++ build display |
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
if exists("g:calendar_begin") |
||||
exe "call " . g:calendar_begin . "()" |
||||
endif |
||||
while vmcnt < 3 |
||||
let vcolumn = 22 |
||||
let vnweek = -1 |
||||
"-------------------------------------------------------------- |
||||
"--- calculating |
||||
"-------------------------------------------------------------- |
||||
" set boundary of the month |
||||
if vmnth == 1 |
||||
let vmdays = 31 |
||||
let vparam = 1 |
||||
let vsmnth = 'Jan' |
||||
elseif vmnth == 2 |
||||
let vmdays = 28 |
||||
let vparam = 32 |
||||
let vsmnth = 'Feb' |
||||
elseif vmnth == 3 |
||||
let vmdays = 31 |
||||
let vparam = 60 |
||||
let vsmnth = 'Mar' |
||||
elseif vmnth == 4 |
||||
let vmdays = 30 |
||||
let vparam = 91 |
||||
let vsmnth = 'Apr' |
||||
elseif vmnth == 5 |
||||
let vmdays = 31 |
||||
let vparam = 121 |
||||
let vsmnth = 'May' |
||||
elseif vmnth == 6 |
||||
let vmdays = 30 |
||||
let vparam = 152 |
||||
let vsmnth = 'Jun' |
||||
elseif vmnth == 7 |
||||
let vmdays = 31 |
||||
let vparam = 182 |
||||
let vsmnth = 'Jul' |
||||
elseif vmnth == 8 |
||||
let vmdays = 31 |
||||
let vparam = 213 |
||||
let vsmnth = 'Aug' |
||||
elseif vmnth == 9 |
||||
let vmdays = 30 |
||||
let vparam = 244 |
||||
let vsmnth = 'Sep' |
||||
elseif vmnth == 10 |
||||
let vmdays = 31 |
||||
let vparam = 274 |
||||
let vsmnth = 'Oct' |
||||
elseif vmnth == 11 |
||||
let vmdays = 30 |
||||
let vparam = 305 |
||||
let vsmnth = 'Nov' |
||||
elseif vmnth == 12 |
||||
let vmdays = 31 |
||||
let vparam = 335 |
||||
let vsmnth = 'Dec' |
||||
else |
||||
echo 'Invalid Year or Month' |
||||
return |
||||
endif |
||||
if vyear % 400 == 0 |
||||
if vmnth == 2 |
||||
let vmdays = 29 |
||||
elseif vmnth >= 3 |
||||
let vparam = vparam + 1 |
||||
endif |
||||
elseif vyear % 100 == 0 |
||||
if vmnth == 2 |
||||
let vmdays = 28 |
||||
endif |
||||
elseif vyear % 4 == 0 |
||||
if vmnth == 2 |
||||
let vmdays = 29 |
||||
elseif vmnth >= 3 |
||||
let vparam = vparam + 1 |
||||
endif |
||||
endif |
||||
|
||||
" calc vnweek of the day |
||||
if vnweek == -1 |
||||
let vnweek = ( vyear * 365 ) + vparam |
||||
let vnweek = vnweek + ( vyear/4 ) - ( vyear/100 ) + ( vyear/400 ) |
||||
if vyear % 4 == 0 |
||||
if vyear % 100 != 0 || vyear % 400 == 0 |
||||
let vnweek = vnweek - 1 |
||||
endif |
||||
endif |
||||
let vnweek = vnweek - 1 |
||||
endif |
||||
|
||||
" fix Gregorian |
||||
if vyear <= 1752 |
||||
let vnweek = vnweek - 3 |
||||
endif |
||||
|
||||
let vnweek = vnweek % 7 |
||||
|
||||
if exists('g:calendar_monday') |
||||
" if given g:calendar_monday, the week start with monday |
||||
if vnweek == 0 |
||||
let vnweek = 7 |
||||
endif |
||||
let vnweek = vnweek - 1 |
||||
endif |
||||
|
||||
if exists('g:calendar_weeknm') |
||||
" if given g:calendar_weeknm, show week number(ref:ISO8601) |
||||
|
||||
"vparam <= 1. day of month |
||||
"vnweek <= 1. weekday of month (0-6) |
||||
"viweek <= number of week |
||||
"vfweek <= 1. day of year |
||||
|
||||
" mo di mi do fr sa so |
||||
" 6 5 4 3 2 1 0 vfweek |
||||
" 0 1 2 3 4 5 6 vnweek |
||||
|
||||
let vfweek =((vparam % 7) -vnweek+ 14-2) % 7 |
||||
let viweek = (vparam - vfweek-2+7 ) / 7 +1 |
||||
|
||||
if vfweek < 3 |
||||
let viweek = viweek - 1 |
||||
endif |
||||
|
||||
"vfweekl <=year length |
||||
let vfweekl = 52 |
||||
if (vfweek == 3) |
||||
let vfweekl = 53 |
||||
endif |
||||
|
||||
if viweek == 0 |
||||
let viweek = 52 |
||||
if ((vfweek == 2) && (((vyear-1) % 4) != 0)) |
||||
\ || ((vfweek == 1) && (((vyear-1) % 4) == 0)) |
||||
let viweek = 53 |
||||
endif |
||||
endif |
||||
|
||||
let vcolumn = vcolumn + 5 |
||||
if g:calendar_weeknm == 5 |
||||
let vcolumn = vcolumn - 2 |
||||
endif |
||||
endif |
||||
|
||||
"-------------------------------------------------------------- |
||||
"--- displaying |
||||
"-------------------------------------------------------------- |
||||
" build header |
||||
if exists('g:calendar_erafmt') && g:calendar_erafmt !~ "^\s*$" |
||||
if g:calendar_erafmt =~ '.*,[+-]*\d\+' |
||||
let veranum = substitute(g:calendar_erafmt,'.*,\([+-]*\d\+\)','\1','') |
||||
if vyear+veranum > 0 |
||||
let vdisplay2 = substitute(g:calendar_erafmt,'\(.*\),.*','\1','') |
||||
let vdisplay2 = vdisplay2.(vyear+veranum).'/'.vmnth.'(' |
||||
else |
||||
let vdisplay2 = vyear.'/'.vmnth.'(' |
||||
endif |
||||
else |
||||
let vdisplay2 = vyear.'/'.vmnth.'(' |
||||
endif |
||||
let vdisplay2 = strpart(" ", |
||||
\ 1,(vcolumn-strlen(vdisplay2))/2-2).vdisplay2 |
||||
else |
||||
let vdisplay2 = vyear.'/'.vmnth.'(' |
||||
let vdisplay2 = strpart(" ", |
||||
\ 1,(vcolumn-strlen(vdisplay2))/2-2).vdisplay2 |
||||
endif |
||||
if exists('g:calendar_mruler') && g:calendar_mruler !~ "^\s*$" |
||||
let vdisplay2 = vdisplay2 . get(split(g:calendar_mruler, ','), vmnth-1, '').')'."\n" |
||||
else |
||||
let vdisplay2 = vdisplay2 . vsmnth.')'."\n" |
||||
endif |
||||
let vwruler = "Su Mo Tu We Th Fr Sa" |
||||
if exists('g:calendar_wruler') && g:calendar_wruler !~ "^\s*$" |
||||
let vwruler = g:calendar_wruler |
||||
endif |
||||
if exists('g:calendar_monday') |
||||
let vwruler = strpart(vwruler,stridx(vwruler, ' ') + 1).' '.strpart(vwruler,0,stridx(vwruler, ' ')) |
||||
endif |
||||
let vdisplay2 = vdisplay2.' '.vwruler."\n" |
||||
if g:calendar_mark == 'right' |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
|
||||
" build calendar |
||||
let vinpcur = 0 |
||||
while (vinpcur < vnweek) |
||||
let vdisplay2 = vdisplay2.' ' |
||||
let vinpcur = vinpcur + 1 |
||||
endwhile |
||||
let vdaycur = 1 |
||||
while (vdaycur <= vmdays) |
||||
if vmnth < 10 |
||||
let vtarget = vyear."0".vmnth |
||||
else |
||||
let vtarget = vyear.vmnth |
||||
endif |
||||
if vdaycur < 10 |
||||
let vtarget = vtarget."0".vdaycur |
||||
else |
||||
let vtarget = vtarget.vdaycur |
||||
endif |
||||
if exists("g:calendar_sign") && g:calendar_sign != "" |
||||
exe "let vsign = " . g:calendar_sign . "(vdaycur, vmnth, vyear)" |
||||
if vsign != "" |
||||
let vsign = vsign[0] |
||||
if vsign !~ "[+!#$%&@?]" |
||||
let vsign = "+" |
||||
endif |
||||
endif |
||||
else |
||||
let vsign = '' |
||||
endif |
||||
|
||||
" show mark |
||||
if g:calendar_mark == 'right' |
||||
if vdaycur < 10 |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
let vdisplay2 = vdisplay2.vdaycur |
||||
elseif g:calendar_mark == 'left-fit' |
||||
if vdaycur < 10 |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
endif |
||||
if vtarget == vtoday |
||||
let vdisplay2 = vdisplay2.'*' |
||||
elseif vsign != '' |
||||
let vdisplay2 = vdisplay2.vsign |
||||
else |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
if g:calendar_mark == 'left' |
||||
if vdaycur < 10 |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
let vdisplay2 = vdisplay2.vdaycur |
||||
endif |
||||
if g:calendar_mark == 'left-fit' |
||||
let vdisplay2 = vdisplay2.vdaycur |
||||
endif |
||||
let vdaycur = vdaycur + 1 |
||||
|
||||
" fix Gregorian |
||||
if vyear == 1752 && vmnth == 9 && vdaycur == 3 |
||||
let vdaycur = 14 |
||||
endif |
||||
|
||||
let vinpcur = vinpcur + 1 |
||||
if vinpcur % 7 == 0 |
||||
if exists('g:calendar_weeknm') |
||||
if g:calendar_mark != 'right' |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
" if given g:calendar_weeknm, show week number |
||||
if viweek < 10 |
||||
if g:calendar_weeknm == 1 |
||||
let vdisplay2 = vdisplay2.'WK0'.viweek |
||||
elseif g:calendar_weeknm == 2 |
||||
let vdisplay2 = vdisplay2.'WK '.viweek |
||||
elseif g:calendar_weeknm == 3 |
||||
let vdisplay2 = vdisplay2.'KW0'.viweek |
||||
elseif g:calendar_weeknm == 4 |
||||
let vdisplay2 = vdisplay2.'KW '.viweek |
||||
elseif g:calendar_weeknm == 5 |
||||
let vdisplay2 = vdisplay2.' '.viweek |
||||
endif |
||||
else |
||||
if g:calendar_weeknm <= 2 |
||||
let vdisplay2 = vdisplay2.'WK'.viweek |
||||
elseif g:calendar_weeknm == 3 || g:calendar_weeknm == 4 |
||||
let vdisplay2 = vdisplay2.'KW'.viweek |
||||
elseif g:calendar_weeknm == 5 |
||||
let vdisplay2 = vdisplay2.viweek |
||||
endif |
||||
endif |
||||
let viweek = viweek + 1 |
||||
|
||||
if viweek > vfweekl |
||||
let viweek = 1 |
||||
endif |
||||
|
||||
endif |
||||
let vdisplay2 = vdisplay2."\n" |
||||
if g:calendar_mark == 'right' |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
endif |
||||
endwhile |
||||
|
||||
" if it is needed, fill with space |
||||
if vinpcur % 7 |
||||
while (vinpcur % 7 != 0) |
||||
let vdisplay2 = vdisplay2.' ' |
||||
let vinpcur = vinpcur + 1 |
||||
endwhile |
||||
if exists('g:calendar_weeknm') |
||||
if g:calendar_mark != 'right' |
||||
let vdisplay2 = vdisplay2.' ' |
||||
endif |
||||
if viweek < 10 |
||||
if g:calendar_weeknm == 1 |
||||
let vdisplay2 = vdisplay2.'WK0'.viweek |
||||
elseif g:calendar_weeknm == 2 |
||||
let vdisplay2 = vdisplay2.'WK '.viweek |
||||
elseif g:calendar_weeknm == 3 |
||||
let vdisplay2 = vdisplay2.'KW0'.viweek |
||||
elseif g:calendar_weeknm == 4 |
||||
let vdisplay2 = vdisplay2.'KW '.viweek |
||||
elseif g:calendar_weeknm == 5 |
||||
let vdisplay2 = vdisplay2.' '.viweek |
||||
endif |
||||
else |
||||
if g:calendar_weeknm <= 2 |
||||
let vdisplay2 = vdisplay2.'WK'.viweek |
||||
elseif g:calendar_weeknm == 3 || g:calendar_weeknm == 4 |
||||
let vdisplay2 = vdisplay2.'KW'.viweek |
||||
elseif g:calendar_weeknm == 5 |
||||
let vdisplay2 = vdisplay2.viweek |
||||
endif |
||||
endif |
||||
endif |
||||
endif |
||||
|
||||
" build display |
||||
let vstrline = '' |
||||
if dir |
||||
" for horizontal |
||||
"-------------------------------------------------------------- |
||||
" +---+ +---+ +------+ |
||||
" | | | | | | |
||||
" | 1 | + | 2 | = | 1' | |
||||
" | | | | | | |
||||
" +---+ +---+ +------+ |
||||
"-------------------------------------------------------------- |
||||
let vtokline = 1 |
||||
while 1 |
||||
let vtoken1 = get(split(vdisplay1, "\n"), vtokline-1, '') |
||||
let vtoken2 = get(split(vdisplay2, "\n"), vtokline-1, '') |
||||
if vtoken1 == '' && vtoken2 == '' |
||||
break |
||||
endif |
||||
while strlen(vtoken1) < (vcolumn+1)*vmcnt |
||||
if strlen(vtoken1) % (vcolumn+1) == 0 |
||||
let vtoken1 = vtoken1.'|' |
||||
else |
||||
let vtoken1 = vtoken1.' ' |
||||
endif |
||||
endwhile |
||||
let vstrline = vstrline.vtoken1.'|'.vtoken2.' '."\n" |
||||
let vtokline = vtokline + 1 |
||||
endwhile |
||||
let vdisplay1 = vstrline |
||||
let vheight = vtokline-1 |
||||
else |
||||
" for virtical |
||||
"-------------------------------------------------------------- |
||||
" +---+ +---+ +---+ |
||||
" | 1 | + | 2 | = | | |
||||
" +---+ +---+ | 1'| |
||||
" | | |
||||
" +---+ |
||||
"-------------------------------------------------------------- |
||||
let vtokline = 1 |
||||
while 1 |
||||
let vtoken1 = get(split(vdisplay1, "\n"), vtokline-1, '') |
||||
if vtoken1 == '' |
||||
break |
||||
endif |
||||
let vstrline = vstrline.vtoken1."\n" |
||||
let vtokline = vtokline + 1 |
||||
let vheight = vheight + 1 |
||||
endwhile |
||||
if vstrline != '' |
||||
let vstrline = vstrline.' '."\n" |
||||
let vheight = vheight + 1 |
||||
endif |
||||
let vtokline = 1 |
||||
while 1 |
||||
let vtoken2 = get(split(vdisplay2, "\n"), vtokline-1, '') |
||||
if vtoken2 == '' |
||||
break |
||||
endif |
||||
while strlen(vtoken2) < vcolumn |
||||
let vtoken2 = vtoken2.' ' |
||||
endwhile |
||||
let vstrline = vstrline.vtoken2."\n" |
||||
let vtokline = vtokline + 1 |
||||
let vheight = vtokline + 1 |
||||
endwhile |
||||
let vdisplay1 = vstrline |
||||
endif |
||||
let vmnth = vmnth + 1 |
||||
let vmcnt = vmcnt + 1 |
||||
if vmnth > 12 |
||||
let vmnth = 1 |
||||
let vyear = vyear + 1 |
||||
endif |
||||
endwhile |
||||
if exists("g:calendar_end") |
||||
exe "call " . g:calendar_end . "()" |
||||
endif |
||||
if a:0 == 0 |
||||
return vdisplay1 |
||||
endif |
||||
|
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
"+++ build window |
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
" make window |
||||
let vwinnum = bufnr('__Calendar') |
||||
if getbufvar(vwinnum, 'Calendar') == 'Calendar' |
||||
let vwinnum = bufwinnr(vwinnum) |
||||
else |
||||
let vwinnum = -1 |
||||
endif |
||||
|
||||
if vwinnum >= 0 |
||||
" if already exist |
||||
if vwinnum != bufwinnr('%') |
||||
exe vwinnum . 'wincmd w' |
||||
endif |
||||
setlocal modifiable |
||||
silent %d _ |
||||
else |
||||
" make title |
||||
if g:calendar_datetime == "title" && (!exists('s:bufautocommandsset')) |
||||
auto BufEnter *Calendar let b:sav_titlestring = &titlestring | let &titlestring = '%{strftime("%c")}' |
||||
auto BufLeave *Calendar let &titlestring = b:sav_titlestring |
||||
let s:bufautocommandsset = 1 |
||||
endif |
||||
|
||||
if exists('g:calendar_navi') && dir |
||||
if g:calendar_navi == 'both' |
||||
let vheight = vheight + 4 |
||||
else |
||||
let vheight = vheight + 2 |
||||
endif |
||||
endif |
||||
|
||||
" or not |
||||
if dir |
||||
silent execute 'bo '.vheight.'split __Calendar' |
||||
setlocal winfixheight |
||||
else |
||||
silent execute 'to '.vcolumn.'vsplit __Calendar' |
||||
setlocal winfixwidth |
||||
endif |
||||
call s:CalendarBuildKeymap(dir, vyear, vmnth) |
||||
setlocal noswapfile |
||||
setlocal buftype=nofile |
||||
setlocal bufhidden=delete |
||||
silent! exe "setlocal " . g:calendar_options |
||||
let nontext_columns = &foldcolumn + &nu * &numberwidth |
||||
if has("+relativenumber") |
||||
let nontext_columns += &rnu * &numberwidth |
||||
endif |
||||
" Without this, the 'sidescrolloff' setting may cause the left side of the |
||||
" calendar to disappear if the last inserted element is near the right |
||||
" window border. |
||||
setlocal nowrap |
||||
setlocal norightleft |
||||
setlocal modifiable |
||||
setlocal nolist |
||||
let b:Calendar = 'Calendar' |
||||
setlocal filetype=calendar |
||||
" is this a vertical (0) or a horizontal (1) split? |
||||
exe vcolumn + nontext_columns . "wincmd |" |
||||
endif |
||||
if g:calendar_datetime == "statusline" |
||||
setlocal statusline=%{strftime('%c')} |
||||
endif |
||||
let b:CalendarDir = dir |
||||
let b:CalendarYear = vyear_org |
||||
let b:CalendarMonth = vmnth_org |
||||
|
||||
" navi |
||||
if exists('g:calendar_navi') |
||||
let navi_label = '<' |
||||
\.get(split(g:calendar_navi_label, ','), 0, '').' ' |
||||
\.get(split(g:calendar_navi_label, ','), 1, '').' ' |
||||
\.get(split(g:calendar_navi_label, ','), 2, '').'>' |
||||
if dir |
||||
let navcol = vcolumn + (vcolumn-strlen(navi_label)+2)/2 |
||||
else |
||||
let navcol = (vcolumn-strlen(navi_label)+2)/2 |
||||
endif |
||||
if navcol < 3 |
||||
let navcol = 3 |
||||
endif |
||||
|
||||
if g:calendar_navi == 'top' |
||||
execute "normal gg".navcol."i " |
||||
silent exec "normal! a".navi_label."\<cr>\<cr>" |
||||
silent put! =vdisplay1 |
||||
endif |
||||
if g:calendar_navi == 'bottom' |
||||
silent put! =vdisplay1 |
||||
silent exec "normal! Gi\<cr>" |
||||
execute "normal ".navcol."i " |
||||
silent exec "normal! a".navi_label |
||||
endif |
||||
if g:calendar_navi == 'both' |
||||
execute "normal gg".navcol."i " |
||||
silent exec "normal! a".navi_label."\<cr>\<cr>" |
||||
silent put! =vdisplay1 |
||||
silent exec "normal! Gi\<cr>" |
||||
execute "normal ".navcol."i " |
||||
silent exec "normal! a".navi_label |
||||
endif |
||||
else |
||||
silent put! =vdisplay1 |
||||
endif |
||||
|
||||
setlocal nomodifiable |
||||
" In case we've gotten here from insert mode (via <C-O>:Calendar<CR>)... |
||||
stopinsert |
||||
|
||||
let vyear = vyear_org |
||||
let vmnth = vmnth_org |
||||
|
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
"+++ build highlight |
||||
"++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
||||
" today |
||||
syn clear |
||||
if g:calendar_mark =~ 'left-fit' |
||||
syn match CalToday display "\s*\*\d*" |
||||
syn match CalMemo display "\s*[+!#$%&@?]\d*" |
||||
elseif g:calendar_mark =~ 'right' |
||||
syn match CalToday display "\d*\*\s*" |
||||
syn match CalMemo display "\d*[+!#$%&@?]\s*" |
||||
else |
||||
syn match CalToday display "\*\s*\d*" |
||||
syn match CalMemo display "[+!#$%&@?]\s*\d*" |
||||
endif |
||||
" header |
||||
syn match CalHeader display "[^ ]*\d\+\/\d\+([^)]*)" |
||||
|
||||
" navi |
||||
if exists('g:calendar_navi') |
||||
exec "silent! syn match CalNavi display \"\\(<" |
||||
\.get(split(g:calendar_navi_label, ','), 0, '')."\\|" |
||||
\.get(split(g:calendar_navi_label, ','), 2, '').">\\)\"" |
||||
exec "silent! syn match CalNavi display \"\\s" |
||||
\.get(split(g:calendar_navi_label, ','), 1, '')."\\s\"hs=s+1,he=e-1" |
||||
endif |
||||
|
||||
" saturday, sunday |
||||
|
||||
if exists('g:calendar_monday') |
||||
if dir |
||||
syn match CalSaturday display /|.\{15}\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
syn match CalSunday display /|.\{18}\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
else |
||||
syn match CalSaturday display /^.\{15}\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
syn match CalSunday display /^.\{18}\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
endif |
||||
else |
||||
if dir |
||||
syn match CalSaturday display /|.\{18}\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
syn match CalSunday display /|\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
else |
||||
syn match CalSaturday display /^.\{18}\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
syn match CalSunday display /^\s\([0-9\ ]\d\)/hs=e-1 contains=ALL |
||||
endif |
||||
endif |
||||
|
||||
" week number |
||||
if !exists('g:calendar_weeknm') || g:calendar_weeknm <= 2 |
||||
syn match CalWeeknm display "WK[0-9\ ]\d" |
||||
else |
||||
syn match CalWeeknm display "KW[0-9\ ]\d" |
||||
endif |
||||
|
||||
" ruler |
||||
execute 'syn match CalRuler "'.vwruler.'"' |
||||
|
||||
if search("\*","w") > 0 |
||||
silent execute "normal! gg/\*\<cr>" |
||||
endif |
||||
|
||||
return '' |
||||
endfunction |
||||
|
||||
"***************************************************************** |
||||
"* make_dir : make directory |
||||
"*---------------------------------------------------------------- |
||||
"* dir : directory |
||||
"***************************************************************** |
||||
function! s:make_dir(dir) |
||||
if(has("unix")) |
||||
call system("mkdir " . a:dir) |
||||
let rc = v:shell_error |
||||
elseif(has("win16") || has("win32") || has("win95") || |
||||
\has("dos16") || has("dos32") || has("os2")) |
||||
call system("mkdir \"" . a:dir . "\"") |
||||
let rc = v:shell_error |
||||
else |
||||
let rc = 1 |
||||
endif |
||||
if rc != 0 |
||||
call confirm("can't create directory : " . a:dir, "&OK") |
||||
endif |
||||
return rc |
||||
endfunc |
||||
|
||||
"***************************************************************** |
||||
"* diary : calendar hook function |
||||
"*---------------------------------------------------------------- |
||||
"* day : day you actioned |
||||
"* month : month you actioned |
||||
"* year : year you actioned |
||||
"***************************************************************** |
||||
function! calendar#diary(day, month, year, week, dir) |
||||
" build the file name and create directories as needed |
||||
if !isdirectory(expand(g:calendar_diary)) |
||||
call confirm("please create diary directory : ".g:calendar_diary, 'OK') |
||||
return |
||||
endif |
||||
let sfile = expand(g:calendar_diary) . "/" . a:year |
||||
if isdirectory(sfile) == 0 |
||||
if s:make_dir(sfile) != 0 |
||||
return |
||||
endif |
||||
endif |
||||
let sfile = sfile . "/" . a:month |
||||
if isdirectory(sfile) == 0 |
||||
if s:make_dir(sfile) != 0 |
||||
return |
||||
endif |
||||
endif |
||||
let sfile = expand(sfile) . "/" . a:day . ".md" |
||||
let sfile = substitute(sfile, ' ', '\\ ', 'g') |
||||
let vbufnr = bufnr('__Calendar') |
||||
|
||||
" load the file |
||||
exe "wincmd w" |
||||
exe "edit " . sfile |
||||
let dir = getbufvar(vbufnr, "CalendarDir") |
||||
let vyear = getbufvar(vbufnr, "CalendarYear") |
||||
let vmnth = getbufvar(vbufnr, "CalendarMonth") |
||||
exe "auto BufDelete ".escape(sfile, ' \\')." call calendar#show(" . dir . "," . vyear . "," . vmnth . ")" |
||||
endfunc |
||||
|
||||
"***************************************************************** |
||||
"* sign : calendar sign function |
||||
"*---------------------------------------------------------------- |
||||
"* day : day of sign |
||||
"* month : month of sign |
||||
"* year : year of sign |
||||
"***************************************************************** |
||||
function! calendar#sign(day, month, year) |
||||
let sfile = g:calendar_diary."/".a:year."/".a:month."/".a:day.".md" |
||||
return filereadable(expand(sfile)) |
||||
endfunction |
||||
|
||||
"***************************************************************** |
||||
"* CalendarVar : get variable |
||||
"*---------------------------------------------------------------- |
||||
"***************************************************************** |
||||
function! s:CalendarVar(var) |
||||
if !exists(a:var) |
||||
return '' |
||||
endif |
||||
exec 'return ' . a:var |
||||
endfunction |
||||
|
||||
"***************************************************************** |
||||
"* CalendarBuildKeymap : build keymap |
||||
"*---------------------------------------------------------------- |
||||
"***************************************************************** |
||||
function! s:CalendarBuildKeymap(dir, vyear, vmnth) |
||||
" make keymap |
||||
nnoremap <silent> <buffer> <Plug>CalendarDoAction :call calendar#action()<cr> |
||||
nnoremap <silent> <buffer> <Plug>CalendarDoAction :call calendar#action()<cr> |
||||
nnoremap <silent> <buffer> <Plug>CalendarGotoToday :call calendar#show(b:CalendarDir)<cr> |
||||
nnoremap <silent> <buffer> <Plug>CalendarShowHelp :call <SID>CalendarHelp()<cr> |
||||
execute 'nnoremap <silent> <buffer> <Plug>CalendarReDisplay :call calendar#show(' . a:dir . ',' . a:vyear . ',' . a:vmnth . ')<cr>' |
||||
let pnav = get(split(g:calendar_navi_label, ','), 0, '') |
||||
let nnav = get(split(g:calendar_navi_label, ','), 2, '') |
||||
execute 'nnoremap <silent> <buffer> <Plug>CalendarGotoPrevMonth :call calendar#action("<' . pnav . '")<cr>' |
||||
execute 'nnoremap <silent> <buffer> <Plug>CalendarGotoNextMonth :call calendar#action("' . nnav . '>")<cr>' |
||||
execute 'nnoremap <silent> <buffer> <Plug>CalendarGotoPrevYear :call calendar#show('.a:dir.','.(a:vyear-1).','.a:vmnth.')<cr>' |
||||
execute 'nnoremap <silent> <buffer> <Plug>CalendarGotoNextYear :call calendar#show('.a:dir.','.(a:vyear+1).','.a:vmnth.')<cr>' |
||||
|
||||
nmap <buffer> <2-LeftMouse> <Plug>CalendarDoAction |
||||
|
||||
execute 'nmap <buffer> ' . s:calendar_keys['close'] . ' <C-w>c' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['do_action'] . ' <Plug>CalendarDoAction' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['goto_today'] . ' <Plug>CalendarGotoToday' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['show_help'] . ' <Plug>CalendarShowHelp' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['redisplay'] . ' <Plug>CalendarRedisplay' |
||||
|
||||
execute 'nmap <buffer> ' . s:calendar_keys['goto_next_month'] . ' <Plug>CalendarGotoNextMonth' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['goto_prev_month'] . ' <Plug>CalendarGotoPrevMonth' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['goto_next_year'] . ' <Plug>CalendarGotoNextYear' |
||||
execute 'nmap <buffer> ' . s:calendar_keys['goto_prev_year'] . ' <Plug>CalendarGotoPrevYear' |
||||
endfunction |
||||
|
||||
"***************************************************************** |
||||
"* CalendarHelp : show help for Calendar |
||||
"*---------------------------------------------------------------- |
||||
"***************************************************************** |
||||
function! s:CalendarHelp() |
||||
let ck = s:calendar_keys |
||||
let max_width = max(map(values(ck), 'len(v:val)')) |
||||
let offsets = map(copy(ck), '1 + max_width - len(v:val)') |
||||
|
||||
echohl SpecialKey |
||||
echo ck['goto_prev_month'] . repeat(' ', offsets['goto_prev_month']) . ': goto prev month' |
||||
echo ck['goto_next_month'] . repeat(' ', offsets['goto_next_month']) . ': goto next month' |
||||
echo ck['goto_prev_year'] . repeat(' ', offsets['goto_prev_year']) . ': goto prev year' |
||||
echo ck['goto_next_year'] . repeat(' ', offsets['goto_next_year']) . ': goto next year' |
||||
echo ck['goto_today'] . repeat(' ', offsets['goto_today']) . ': goto today' |
||||
echo ck['close'] . repeat(' ', offsets['close']) . ': close window' |
||||
echo ck['redisplay'] . repeat(' ', offsets['redisplay']) . ': re-display window' |
||||
echo ck['show_help'] . repeat(' ', offsets['show_help']) . ': show this help' |
||||
if g:calendar_action == "calendar#diary" |
||||
echo ck['do_action'] . repeat(' ', offsets['do_action']) . ': show diary' |
||||
endif |
||||
echo '' |
||||
echohl Question |
||||
|
||||
let vk = [ |
||||
\ 'calendar_erafmt', |
||||
\ 'calendar_mruler', |
||||
\ 'calendar_wruler', |
||||
\ 'calendar_weeknm', |
||||
\ 'calendar_navi_label', |
||||
\ 'calendar_diary', |
||||
\ 'calendar_mark', |
||||
\ 'calendar_navi', |
||||
\] |
||||
let max_width = max(map(copy(vk), 'len(v:val)')) |
||||
|
||||
for _ in vk |
||||
let v = get(g:, _, '') |
||||
echo _ . repeat(' ', max_width - len(_)) . ' = ' . v |
||||
endfor |
||||
echohl MoreMsg |
||||
echo "[Hit any key]" |
||||
echohl None |
||||
call getchar() |
||||
redraw! |
||||
endfunction |
||||
|
||||
hi def link CalNavi Search |
||||
hi def link CalSaturday Statement |
||||
hi def link CalSunday Type |
||||
hi def link CalRuler StatusLine |
||||
hi def link CalWeeknm Comment |
||||
hi def link CalToday Directory |
||||
hi def link CalHeader Special |
||||
hi def link CalMemo Identifier |
@ -1,195 +0,0 @@
@@ -1,195 +0,0 @@
|
||||
*calendar.txt* Calendar utility for vim |
||||
|
||||
Author: Yasuhiro Matsumoto <mattn.jp@gmail.com> |
||||
|
||||
INTRODUCTION *calendar* |
||||
|
||||
This script creates a calendar window in vim. It does not rely on any |
||||
external program, such as cal, etc. |
||||
|
||||
COMMANDS *calendar-commands* |
||||
|
||||
calendar.vim makes the following commands available: |
||||
|
||||
*calendar-:Calendar* |
||||
:Calendar [[year] month] Show calendar at this year and this month in a |
||||
vertical split. When [year] is omitted, the |
||||
calendar will show the given month in the current |
||||
year. When both [year] and [month] are omitted, the |
||||
calendar will show the current month. |
||||
|
||||
*calendar-:CalendarH* |
||||
:CalendarH [[year] month] Show calendar at this year and this month in a |
||||
horizontal split. When [year] is omitted, the |
||||
calendar will show the given month in the current |
||||
year. When both [year] and [month] are omitted, the |
||||
calendar will show the current month. |
||||
|
||||
MAPPINGS *calendar-mappings* |
||||
|
||||
calendar.vim makes the following normal mode mappings available: |
||||
|
||||
*calendar-cal* |
||||
<LocalLeader>cal Brings up the calendar in a vertical split. |
||||
Equivalent to calling |:Calendar|. |
||||
|
||||
*calendar-caL* |
||||
<LocalLeader>caL Brings up the calendar in a horizontal split. |
||||
Equivalent to calling |:CalendarH|. |
||||
|
||||
SETTINGS *calendar-settings* |
||||
|
||||
calendar.vim can be configured using the following settings: |
||||
|
||||
*g:calendar_focus_today* |
||||
Keeps focus when moving to next or previous calendar: > |
||||
let g:calendar_focus_today = 1 |
||||
< |
||||
|
||||
*g:calendar_keys* |
||||
To change the key bindings in the calendar window, add entries to this |
||||
dictionary. Possible keys, the action bound to the keycode given in the |
||||
respective value for this key and the default binding are listed below. |
||||
'close' Closes calendar window. 'q' |
||||
'do_action' Executes |calendar_action|. '<CR>' |
||||
'goto_today' Executes |calendar_today|. 't' |
||||
'show_help' Displays a short help message. '?' |
||||
'redisplay' Redraws calendar window. 'r' |
||||
'goto_next_month' Jumps to the next month. '<Right>' |
||||
'goto_prev_month' Jumps to the previous month. '<Left>' |
||||
'goto_next_year' Jumps to the next month. '<Up>' |
||||
'goto_prev_year' Jumps to the previous month. '<Down>' |
||||
An example in your .vimrc might look like this: > |
||||
let g:calendar_keys = { 'goto_next_month':'<C-Right>, 'goto_prev_month':'<C-Left>'} |
||||
< |
||||
|
||||
*g:calendar_mark* |
||||
Place a '*' or '+' mark after the day. Acceptable values are 'left', |
||||
'left-fit', and 'right': > |
||||
let g:calendar_mark = 'right' |
||||
< |
||||
|
||||
*g:calendar_navi* |
||||
To control the calendar navigator, set this variable. Acceptable values are |
||||
'top', 'bottom', or 'both'. > |
||||
let g:calendar_navi = '' |
||||
< |
||||
|
||||
*g:calendar_navi_label* |
||||
To set the labels for the calendar navigator, for example to change the |
||||
language, use this variable. Entries should be comma separated. > |
||||
let g:calendar_navi_label = 'Prev,Today,Next' |
||||
< |
||||
|
||||
*g:calendar_erafmt* |
||||
To change the dating system, set the following variable. Include the name of |
||||
the dating system and its offset from the Georgian calendar (A.D.). For |
||||
example, to use the current Japanese era (Heisei), you would set: > |
||||
let g:calendar_erafmt = 'Heisei,-1988' |
||||
< |
||||
|
||||
*g:calendar_mruler* |
||||
To change the month names for the calendar headings, set this variable. The |
||||
value is expected to be a comma-separated list of twelve values, starting with |
||||
Janurary: > |
||||
let g:calendar_mruler = 'Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec' |
||||
< |
||||
|
||||
*g:calendar_wruler* |
||||
To change the week names for the calendar headings, set this variable. The |
||||
value is expected to be a space-separated list of seven values, starting with |
||||
Sunday: > |
||||
let g:calendar_wruler = 'Su Mo Tu We Th Fr Sa' |
||||
< |
||||
|
||||
*g:calendar_monday* |
||||
To make the week start on Monday rather than Sunday, set this variable. Note |
||||
that the value of |g:calendar_wruler| is not affected by this; it should |
||||
always begin with Sunday: > |
||||
let g:calendar_monday = 1 |
||||
< |
||||
|
||||
*g:calendar_weeknm* |
||||
To show the week number, set this variable. There are four valid settings: > |
||||
let g:calendar_weeknm = 1 " WK01 |
||||
let g:calendar_weeknm = 2 " WK 1 |
||||
let g:calendar_weeknm = 3 " KW01 |
||||
let g:calendar_weeknm = 4 " KW 1 |
||||
let g:calendar_weeknm = 5 " 1 |
||||
< |
||||
|
||||
*g:calendar_datetime* |
||||
To control display of the current date and time, set this variable. |
||||
Acceptable values are 'title', 'statusline', and '': > |
||||
let g:calendar_datetime = 'title' |
||||
< |
||||
|
||||
HOOKS *calendar-hooks* |
||||
|
||||
calendar.vim provides a number of hooks which allow you to run custom code on |
||||
certain events. These are documented below. |
||||
|
||||
*calendar_action* |
||||
The function declared in the calendar_action variable is run when the user |
||||
presses enter on a date. Implement and set your function as follows: > |
||||
function MyCalAction(day,month,year,week,dir) |
||||
" day : day you actioned |
||||
" month : month you actioned |
||||
" year : year you actioned |
||||
" week : day of week (Mo=1 ... Su=7) |
||||
" dir : direction of calendar |
||||
endfunction |
||||
let calendar_action = 'MyCalAction' |
||||
< |
||||
|
||||
*calendar_begin* |
||||
The function declared in the calendar_begin variable is run just before the |
||||
calendar is displayed. Implement and set your function as follows: > |
||||
function MyCalActionBegin() |
||||
endfunction |
||||
let calendar_begin = 'MyCalActionBegin' |
||||
< |
||||
|
||||
*calendar_end* |
||||
The function declared in the calendar_end variable is run just after the |
||||
calendar is displayed. Implement and set your function as follows: > |
||||
function MyCalActionEnd() |
||||
endfunction |
||||
let calendar_end = 'MyCalActionEnd' |
||||
< |
||||
|
||||
*calendar_sign* |
||||
The function declared in the calendar_sign variable can be used to set a mark |
||||
next to certain dates. Implement and set your function as follows: > |
||||
function MyCalSign(day,month,year) |
||||
" day : day you actioned |
||||
" month : month you actioned |
||||
" year : year you actioned |
||||
if a:day == 1 && a:month == 1 |
||||
return 1 " happy new year |
||||
else |
||||
return 0 " or not |
||||
endif |
||||
endfunction |
||||
let calendar_sign = 'MyCalSign' |
||||
< |
||||
|
||||
*calendar_today* |
||||
The function declared in the calendar_today variable is run when the user |
||||
presses 'today'. Implement and set your function as follows: > |
||||
function MyCalToday() |
||||
endfunction |
||||
let calendar_today = 'MyCalToday' |
||||
< |
||||
|
||||
ABOUT *calendar-about* |
||||
|
||||
calendar.vim is available on GitHub: |
||||
|
||||
http://github.com/mattn/calendar.vim |
||||
|
||||
and also on VimScripts: |
||||
|
||||
http://www.vim.org/scripts/script.php?script_id=52 |
||||
|
||||
vim:tw=78:et:ft=help:norl: |
@ -1,229 +0,0 @@
@@ -1,229 +0,0 @@
|
||||
"============================================================================= |
||||
" What Is This: Calendar |
||||
" File: calendar.vim |
||||
" Author: Yasuhiro Matsumoto <mattn.jp@gmail.com> |
||||
" Last Change: 2013 Mar 19 |
||||
" Version: 2.9 |
||||
" Thanks: |
||||
" Tobias Columbus : customizable key bindings |
||||
" Daniel P. Wright : doc/calendar.txt |
||||
" SethMilliken : gave a hint for 2.4 |
||||
" bw1 : bug fix, new weeknm format |
||||
" Ingo Karkat : bug fix |
||||
" Thinca : bug report, bug fix |
||||
" Yu Pei : bug report |
||||
" Per Winkvist : bug fix |
||||
" Serge (gentoosiast) Koksharov : bug fix |
||||
" Vitor Antunes : bug fix |
||||
" Olivier Mengue : bug fix |
||||
" Noel Henson : today action |
||||
" Per Winkvist : bug report |
||||
" Peter Findeisen : bug fix |
||||
" Chip Campbell : gave a hint for 1.3z |
||||
" PAN Shizhu : gave a hint for 1.3y |
||||
" Eric Wald : bug fix |
||||
" Sascha Wuestemann : advise |
||||
" Linas Vasiliauskas : bug report |
||||
" Per Winkvist : bug report |
||||
" Ronald Hoelwarth : gave a hint for 1.3s |
||||
" Vikas Agnihotri : bug report |
||||
" Steve Hall : gave a hint for 1.3q |
||||
" James Devenish : bug fix |
||||
" Carl Mueller : gave a hint for 1.3o |
||||
" Klaus Fabritius : bug fix |
||||
" Stucki : gave a hint for 1.3m |
||||
" Rosta : bug report |
||||
" Richard Bair : bug report |
||||
" Yin Hao Liew : bug report |
||||
" Bill McCarthy : bug fix and gave a hint |
||||
" Srinath Avadhanula : bug fix |
||||
" Ronald Hoellwarth : few advices |
||||
" Juan Orlandini : added higlighting of days with data |
||||
" Ray : bug fix |
||||
" Ralf.Schandl : gave a hint for 1.3 |
||||
" Bhaskar Karambelkar : bug fix |
||||
" Suresh Govindachar : gave a hint for 1.2, bug fix |
||||
" Michael Geddes : bug fix |
||||
" Leif Wickland : bug fix |
||||
" ChangeLog: |
||||
" 2.8 : bug fix |
||||
" 2.7 : vim7ish, customizable key bindings |
||||
" 2.6 : new week number format |
||||
" 2.5 : bug fix, 7.2 don't have relativenumber. |
||||
" 2.4 : added g:calendar_options. |
||||
" 2.3 : week number like ISO8601 |
||||
" g:calendar_monday and g:calendar_weeknm work together |
||||
" 2.2 : http://gist.github.com/355513#file_customizable_keymap.diff |
||||
" http://gist.github.com/355513#file_winfixwidth.diff |
||||
" 2.1 : bug fix, set filetype 'calendar'. |
||||
" 2.0 : bug fix, many bug fix and enhancements. |
||||
" 1.9 : bug fix, use nnoremap. |
||||
" 1.8 : bug fix, E382 when close diary. |
||||
" 1.7 : bug fix, week number was broken on 2008. |
||||
" 1.6 : added calendar_begin action. |
||||
" added calendar_end action. |
||||
" 1.5 : bug fix, fixed ruler formating with strpart. |
||||
" bug fix, using winfixheight. |
||||
" 1.4a : bug fix, week number was broken on 2005. |
||||
" added calendar_today action. |
||||
" bug fix, about wrapscan. |
||||
" bug fix, about today mark. |
||||
" bug fix, about today navigation. |
||||
" 1.4 : bug fix, and one improvement. |
||||
" bug 1: |
||||
" when marking the current date, there is not distinguished e.g. between |
||||
" 20041103 and 20040113, both dates are marked as today |
||||
" bug 2: |
||||
" the navigation mark "today" doesn't work |
||||
" improvement: |
||||
" the mapping t worked only when today was displayed, now it works always |
||||
" and redisplays the cuurent month and today |
||||
" 1.3z : few changes |
||||
" asign <Left>, <Right> for navigation. |
||||
" set ws for search navigation. |
||||
" add tag for GetLatestVimScripts(AutoInstall) |
||||
" 1.3y : bug fix, few changes |
||||
" changed color syntax name. (ex. CalNavi, see bottom of this) |
||||
" changed a map CalendarV for <Leader>cal |
||||
" changed a map CalendarH for <Leader>caL |
||||
" (competitive map for cvscommand.vim) |
||||
" the date on the right-hand side didn't work correctoly. |
||||
" make a map to rebuild Calendar window(r). |
||||
" 1.3x : bug fix |
||||
" viweek can't refer when not set calendar_weeknm. |
||||
" 1.3w : bug fix |
||||
" on leap year, week number decreases. |
||||
" 1.3v : bug fix |
||||
" add nowrapscan |
||||
" use s:bufautocommandsset for making title |
||||
" don't focus to navi when doubleclick bottom next>. |
||||
" 1.3u : bug fix |
||||
" when enter diary first time, |
||||
" it don't warn that you don't have diary directory. |
||||
" 1.3t : bug fix |
||||
" make sure the variables for help |
||||
" 1.3s : bug fix |
||||
" make a map CalendarV for <Leader>ca |
||||
" add option calendar_navi_label |
||||
" see Additional: |
||||
" add option calendar_focus_today |
||||
" see Additional: |
||||
" add map ? for help |
||||
" 1.3r : bug fix |
||||
" if clicked navigator, cursor go to strange position. |
||||
" 1.3q : bug fix |
||||
" coundn't set calendar_navi |
||||
" in its horizontal direction |
||||
" 1.3p : bug fix |
||||
" coundn't edit diary when the calendar is |
||||
" in its horizontal direction |
||||
" 1.3o : add option calendar_mark, and delete calendar_rmark |
||||
" see Additional: |
||||
" add option calendar_navi |
||||
" see Additional: |
||||
" 1.3n : bug fix |
||||
" s:CalendarSign() should use filereadable(expand(sfile)). |
||||
" 1.3m : tuning |
||||
" using topleft or botright for opening Calendar. |
||||
" use filereadable for s:CalendarSign(). |
||||
" 1.3l : bug fix |
||||
" if set calendar_monday, it can see that Sep 1st is Sat |
||||
" as well as Aug 31st. |
||||
" 1.3k : bug fix |
||||
" it didn't escape the file name on calendar. |
||||
" 1.3j : support for fixed Gregorian |
||||
" added the part of Sep 1752. |
||||
" 1.3i : bug fix |
||||
" Calculation mistake for week number. |
||||
" 1.3h : add option for position of displaying '*' or '+'. |
||||
" see Additional: |
||||
" 1.3g : centering header |
||||
" add option for show name of era. |
||||
" see Additional: |
||||
" bug fix |
||||
" <Leader>ca didn't show current month. |
||||
" 1.3f : bug fix |
||||
" there was yet another bug of today's sign. |
||||
" 1.3e : added usage for <Leader> |
||||
" support handler for sign. |
||||
" see Additional: |
||||
" 1.3d : added higlighting of days that have calendar data associated |
||||
" with it. |
||||
" bug fix for calculates date. |
||||
" 1.3c : bug fix for MakeDir() |
||||
" if CalendarMakeDir(sfile) != 0 |
||||
" v |
||||
" if s:CalendarMakeDir(sfile) != 0 |
||||
" 1.3b : bug fix for calendar_monday. |
||||
" it didn't work g:calendar_monday correctly. |
||||
" add g:calendar_version. |
||||
" add argument on action handler. |
||||
" see Additional: |
||||
" 1.3a : bug fix for MakeDir(). |
||||
" it was not able to make directory. |
||||
" 1.3 : support handler for action. |
||||
" see Additional: |
||||
" 1.2g : bug fix for today's sign. |
||||
" it could not display today's sign correctly. |
||||
" 1.2f : bug fix for current Date. |
||||
" vtoday variable calculates date as 'YYYYMMDD' |
||||
" while the loop calculates date as 'YYYYMMD' i.e just 1 digit |
||||
" for date if < 10 so if current date is < 10 , the if condiction |
||||
" to check for current date fails and current date is not |
||||
" highlighted. |
||||
" simple solution changed vtoday calculation line divide the |
||||
" current-date by 1 so as to get 1 digit date. |
||||
" 1.2e : change the way for setting title. |
||||
" auto configuration for g:calendar_wruler with g:calendar_monday |
||||
" 1.2d : add option for show week number. |
||||
" let g:calendar_weeknm = 1 |
||||
" add separator if horizontal. |
||||
" change all option's name |
||||
" g:calendar_mnth -> g:calendar_mruler |
||||
" g:calendar_week -> g:calendar_wruler |
||||
" g:calendar_smnd -> g:calendar_monday |
||||
" 1.2c : add option for that the week starts with monday. |
||||
" let g:calendar_smnd = 1 |
||||
" 1.2b : bug fix for modifiable. |
||||
" setlocal nomodifiable (was set) |
||||
" 1.2a : add default options. |
||||
" nonumber,foldcolumn=0,nowrap... as making gap |
||||
" 1.2 : support wide display. |
||||
" add a command CalendarH |
||||
" add map <s-left> <s-right> |
||||
" 1.1c : extra. |
||||
" add a titlestring for today. |
||||
" 1.1b : bug fix by Michael Geddes. |
||||
" it happend when do ':Calender' twice |
||||
" 1.1a : fix misspell. |
||||
" Calender -> Calendar |
||||
" 1.1 : bug fix. |
||||
" it"s about strftime("%m") |
||||
" 1.0a : bug fix by Leif Wickland. |
||||
" it"s about strftime("%w") |
||||
" 1.0 : first release. |
||||
" TODO: |
||||
" add the option for diary which is separate or single file. |
||||
" GetLatestVimScripts: 52 1 :AutoInstall: calendar.vim |
||||
|
||||
if &compatible |
||||
finish |
||||
endif |
||||
"***************************************************************** |
||||
"* Calendar commands |
||||
"***************************************************************** |
||||
command! -nargs=* Calendar call calendar#show(0,<f-args>) |
||||
command! -nargs=* CalendarH call calendar#show(1,<f-args>) |
||||
|
||||
if !get(g:, 'calendar_no_mappings', 0) |
||||
if !hasmapto('<Plug>CalendarV') |
||||
nmap <unique> <Leader>cal <Plug>CalendarV |
||||
endif |
||||
if !hasmapto('<Plug>CalendarH') |
||||
nmap <unique> <Leader>caL <Plug>CalendarH |
||||
endif |
||||
endif |
||||
nnoremap <silent> <Plug>CalendarV :cal calendar#show(0)<CR> |
||||
nnoremap <silent> <Plug>CalendarH :cal calendar#show(1)<CR> |
||||
|
||||
" vi: et sw=2 ts=2 |
@ -1,674 +0,0 @@
@@ -1,674 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE |
||||
Version 3, 29 June 2007 |
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
||||
Everyone is permitted to copy and distribute verbatim copies |
||||
of this license document, but changing it is not allowed. |
||||
|
||||
Preamble |
||||
|
||||
The GNU General Public License is a free, copyleft license for |
||||
software and other kinds of works. |
||||
|
||||
The licenses for most software and other practical works are designed |
||||
to take away your freedom to share and change the works. By contrast, |
||||
the GNU General Public License is intended to guarantee your freedom to |
||||
share and change all versions of a program--to make sure it remains free |
||||
software for all its users. We, the Free Software Foundation, use the |
||||
GNU General Public License for most of our software; it applies also to |
||||
any other work released this way by its authors. You can apply it to |
||||
your programs, too. |
||||
|
||||
When we speak of free software, we are referring to freedom, not |
||||
price. Our General Public Licenses are designed to make sure that you |
||||
have the freedom to distribute copies of free software (and charge for |
||||
them if you wish), that you receive source code or can get it if you |
||||
want it, that you can change the software or use pieces of it in new |
||||
free programs, and that you know you can do these things. |
||||
|
||||
To protect your rights, we need to prevent others from denying you |
||||
these rights or asking you to surrender the rights. Therefore, you have |
||||
certain responsibilities if you distribute copies of the software, or if |
||||
you modify it: responsibilities to respect the freedom of others. |
||||
|
||||
For example, if you distribute copies of such a program, whether |
||||
gratis or for a fee, you must pass on to the recipients the same |
||||
freedoms that you received. You must make sure that they, too, receive |
||||
or can get the source code. And you must show them these terms so they |
||||
know their rights. |
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: |
||||
(1) assert copyright on the software, and (2) offer you this License |
||||
giving you legal permission to copy, distribute and/or modify it. |
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains |
||||
that there is no warranty for this free software. For both users' and |
||||
authors' sake, the GPL requires that modified versions be marked as |
||||
changed, so that their problems will not be attributed erroneously to |
||||
authors of previous versions. |
||||
|
||||
Some devices are designed to deny users access to install or run |
||||
modified versions of the software inside them, although the manufacturer |
||||
can do so. This is fundamentally incompatible with the aim of |
||||
protecting users' freedom to change the software. The systematic |
||||
pattern of such abuse occurs in the area of products for individuals to |
||||
use, which is precisely where it is most unacceptable. Therefore, we |
||||
have designed this version of the GPL to prohibit the practice for those |
||||
products. If such problems arise substantially in other domains, we |
||||
stand ready to extend this provision to those domains in future versions |
||||
of the GPL, as needed to protect the freedom of users. |
||||
|
||||
Finally, every program is threatened constantly by software patents. |
||||
States should not allow patents to restrict development and use of |
||||
software on general-purpose computers, but in those that do, we wish to |
||||
avoid the special danger that patents applied to a free program could |
||||
make it effectively proprietary. To prevent this, the GPL assures that |
||||
patents cannot be used to render the program non-free. |
||||
|
||||
The precise terms and conditions for copying, distribution and |
||||
modification follow. |
||||
|
||||
TERMS AND CONDITIONS |
||||
|
||||
0. Definitions. |
||||
|
||||
"This License" refers to version 3 of the GNU General Public License. |
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of |
||||
works, such as semiconductor masks. |
||||
|
||||
"The Program" refers to any copyrightable work licensed under this |
||||
License. Each licensee is addressed as "you". "Licensees" and |
||||
"recipients" may be individuals or organizations. |
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work |
||||
in a fashion requiring copyright permission, other than the making of an |
||||
exact copy. The resulting work is called a "modified version" of the |
||||
earlier work or a work "based on" the earlier work. |
||||
|
||||
A "covered work" means either the unmodified Program or a work based |
||||
on the Program. |
||||
|
||||
To "propagate" a work means to do anything with it that, without |
||||
permission, would make you directly or secondarily liable for |
||||
infringement under applicable copyright law, except executing it on a |
||||
computer or modifying a private copy. Propagation includes copying, |
||||
distribution (with or without modification), making available to the |
||||
public, and in some countries other activities as well. |
||||
|
||||
To "convey" a work means any kind of propagation that enables other |
||||
parties to make or receive copies. Mere interaction with a user through |
||||
a computer network, with no transfer of a copy, is not conveying. |
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" |
||||
to the extent that it includes a convenient and prominently visible |
||||
feature that (1) displays an appropriate copyright notice, and (2) |
||||
tells the user that there is no warranty for the work (except to the |
||||
extent that warranties are provided), that licensees may convey the |
||||
work under this License, and how to view a copy of this License. If |
||||
the interface presents a list of user commands or options, such as a |
||||
menu, a prominent item in the list meets this criterion. |
||||
|
||||
1. Source Code. |
||||
|
||||
The "source code" for a work means the preferred form of the work |
||||
for making modifications to it. "Object code" means any non-source |
||||
form of a work. |
||||
|
||||
A "Standard Interface" means an interface that either is an official |
||||
standard defined by a recognized standards body, or, in the case of |
||||
interfaces specified for a particular programming language, one that |
||||
is widely used among developers working in that language. |
||||
|
||||
The "System Libraries" of an executable work include anything, other |
||||
than the work as a whole, that (a) is included in the normal form of |
||||
packaging a Major Component, but which is not part of that Major |
||||
Component, and (b) serves only to enable use of the work with that |
||||
Major Component, or to implement a Standard Interface for which an |
||||
implementation is available to the public in source code form. A |
||||
"Major Component", in this context, means a major essential component |
||||
(kernel, window system, and so on) of the specific operating system |
||||
(if any) on which the executable work runs, or a compiler used to |
||||
produce the work, or an object code interpreter used to run it. |
||||
|
||||
The "Corresponding Source" for a work in object code form means all |
||||
the source code needed to generate, install, and (for an executable |
||||
work) run the object code and to modify the work, including scripts to |
||||
control those activities. However, it does not include the work's |
||||
System Libraries, or general-purpose tools or generally available free |
||||
programs which are used unmodified in performing those activities but |
||||
which are not part of the work. For example, Corresponding Source |
||||
includes interface definition files associated with source files for |
||||
the work, and the source code for shared libraries and dynamically |
||||
linked subprograms that the work is specifically designed to require, |
||||
such as by intimate data communication or control flow between those |
||||
subprograms and other parts of the work. |
||||
|
||||
The Corresponding Source need not include anything that users |
||||
can regenerate automatically from other parts of the Corresponding |
||||
Source. |
||||
|
||||
The Corresponding Source for a work in source code form is that |
||||
same work. |
||||
|
||||
2. Basic Permissions. |
||||
|
||||
All rights granted under this License are granted for the term of |
||||
copyright on the Program, and are irrevocable provided the stated |
||||
conditions are met. This License explicitly affirms your unlimited |
||||
permission to run the unmodified Program. The output from running a |
||||
covered work is covered by this License only if the output, given its |
||||
content, constitutes a covered work. This License acknowledges your |
||||
rights of fair use or other equivalent, as provided by copyright law. |
||||
|
||||
You may make, run and propagate covered works that you do not |
||||
convey, without conditions so long as your license otherwise remains |
||||
in force. You may convey covered works to others for the sole purpose |
||||
of having them make modifications exclusively for you, or provide you |
||||
with facilities for running those works, provided that you comply with |
||||
the terms of this License in conveying all material for which you do |
||||
not control copyright. Those thus making or running the covered works |
||||
for you must do so exclusively on your behalf, under your direction |
||||
and control, on terms that prohibit them from making any copies of |
||||
your copyrighted material outside their relationship with you. |
||||
|
||||
Conveying under any other circumstances is permitted solely under |
||||
the conditions stated below. Sublicensing is not allowed; section 10 |
||||
makes it unnecessary. |
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
||||
|
||||
No covered work shall be deemed part of an effective technological |
||||
measure under any applicable law fulfilling obligations under article |
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
||||
similar laws prohibiting or restricting circumvention of such |
||||
measures. |
||||
|
||||
When you convey a covered work, you waive any legal power to forbid |
||||
circumvention of technological measures to the extent such circumvention |
||||
is effected by exercising rights under this License with respect to |
||||
the covered work, and you disclaim any intention to limit operation or |
||||
modification of the work as a means of enforcing, against the work's |
||||
users, your or third parties' legal rights to forbid circumvention of |
||||
technological measures. |
||||
|
||||
4. Conveying Verbatim Copies. |
||||
|
||||
You may convey verbatim copies of the Program's source code as you |
||||
receive it, in any medium, provided that you conspicuously and |
||||
appropriately publish on each copy an appropriate copyright notice; |
||||
keep intact all notices stating that this License and any |
||||
non-permissive terms added in accord with section 7 apply to the code; |
||||
keep intact all notices of the absence of any warranty; and give all |
||||
recipients a copy of this License along with the Program. |
||||
|
||||
You may charge any price or no price for each copy that you convey, |
||||
and you may offer support or warranty protection for a fee. |
||||
|
||||
5. Conveying Modified Source Versions. |
||||
|
||||
You may convey a work based on the Program, or the modifications to |
||||
produce it from the Program, in the form of source code under the |
||||
terms of section 4, provided that you also meet all of these conditions: |
||||
|
||||
a) The work must carry prominent notices stating that you modified |
||||
it, and giving a relevant date. |
||||
|
||||
b) The work must carry prominent notices stating that it is |
||||
released under this License and any conditions added under section |
||||
7. This requirement modifies the requirement in section 4 to |
||||
"keep intact all notices". |
||||
|
||||
c) You must license the entire work, as a whole, under this |
||||
License to anyone who comes into possession of a copy. This |
||||
License will therefore apply, along with any applicable section 7 |
||||
additional terms, to the whole of the work, and all its parts, |
||||
regardless of how they are packaged. This License gives no |
||||
permission to license the work in any other way, but it does not |
||||
invalidate such permission if you have separately received it. |
||||
|
||||
d) If the work has interactive user interfaces, each must display |
||||
Appropriate Legal Notices; however, if the Program has interactive |
||||
interfaces that do not display Appropriate Legal Notices, your |
||||
work need not make them do so. |
||||
|
||||
A compilation of a covered work with other separate and independent |
||||
works, which are not by their nature extensions of the covered work, |
||||
and which are not combined with it such as to form a larger program, |
||||
in or on a volume of a storage or distribution medium, is called an |
||||
"aggregate" if the compilation and its resulting copyright are not |
||||
used to limit the access or legal rights of the compilation's users |
||||
beyond what the individual works permit. Inclusion of a covered work |
||||
in an aggregate does not cause this License to apply to the other |
||||
parts of the aggregate. |
||||
|
||||
6. Conveying Non-Source Forms. |
||||
|
||||
You may convey a covered work in object code form under the terms |
||||
of sections 4 and 5, provided that you also convey the |
||||
machine-readable Corresponding Source under the terms of this License, |
||||
in one of these ways: |
||||
|
||||
a) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by the |
||||
Corresponding Source fixed on a durable physical medium |
||||
customarily used for software interchange. |
||||
|
||||
b) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by a |
||||
written offer, valid for at least three years and valid for as |
||||
long as you offer spare parts or customer support for that product |
||||
model, to give anyone who possesses the object code either (1) a |
||||
copy of the Corresponding Source for all the software in the |
||||
product that is covered by this License, on a durable physical |
||||
medium customarily used for software interchange, for a price no |
||||
more than your reasonable cost of physically performing this |
||||
conveying of source, or (2) access to copy the |
||||
Corresponding Source from a network server at no charge. |
||||
|
||||
c) Convey individual copies of the object code with a copy of the |
||||
written offer to provide the Corresponding Source. This |
||||
alternative is allowed only occasionally and noncommercially, and |
||||
only if you received the object code with such an offer, in accord |
||||
with subsection 6b. |
||||
|
||||
d) Convey the object code by offering access from a designated |
||||
place (gratis or for a charge), and offer equivalent access to the |
||||
Corresponding Source in the same way through the same place at no |
||||
further charge. You need not require recipients to copy the |
||||
Corresponding Source along with the object code. If the place to |
||||
copy the object code is a network server, the Corresponding Source |
||||
may be on a different server (operated by you or a third party) |
||||
that supports equivalent copying facilities, provided you maintain |
||||
clear directions next to the object code saying where to find the |
||||
Corresponding Source. Regardless of what server hosts the |
||||
Corresponding Source, you remain obligated to ensure that it is |
||||
available for as long as needed to satisfy these requirements. |
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided |
||||
you inform other peers where the object code and Corresponding |
||||
Source of the work are being offered to the general public at no |
||||
charge under subsection 6d. |
||||
|
||||
A separable portion of the object code, whose source code is excluded |
||||
from the Corresponding Source as a System Library, need not be |
||||
included in conveying the object code work. |
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any |
||||
tangible personal property which is normally used for personal, family, |
||||
or household purposes, or (2) anything designed or sold for incorporation |
||||
into a dwelling. In determining whether a product is a consumer product, |
||||
doubtful cases shall be resolved in favor of coverage. For a particular |
||||
product received by a particular user, "normally used" refers to a |
||||
typical or common use of that class of product, regardless of the status |
||||
of the particular user or of the way in which the particular user |
||||
actually uses, or expects or is expected to use, the product. A product |
||||
is a consumer product regardless of whether the product has substantial |
||||
commercial, industrial or non-consumer uses, unless such uses represent |
||||
the only significant mode of use of the product. |
||||
|
||||
"Installation Information" for a User Product means any methods, |
||||
procedures, authorization keys, or other information required to install |
||||
and execute modified versions of a covered work in that User Product from |
||||
a modified version of its Corresponding Source. The information must |
||||
suffice to ensure that the continued functioning of the modified object |
||||
code is in no case prevented or interfered with solely because |
||||
modification has been made. |
||||
|
||||
If you convey an object code work under this section in, or with, or |
||||
specifically for use in, a User Product, and the conveying occurs as |
||||
part of a transaction in which the right of possession and use of the |
||||
User Product is transferred to the recipient in perpetuity or for a |
||||
fixed term (regardless of how the transaction is characterized), the |
||||
Corresponding Source conveyed under this section must be accompanied |
||||
by the Installation Information. But this requirement does not apply |
||||
if neither you nor any third party retains the ability to install |
||||
modified object code on the User Product (for example, the work has |
||||
been installed in ROM). |
||||
|
||||
The requirement to provide Installation Information does not include a |
||||
requirement to continue to provide support service, warranty, or updates |
||||
for a work that has been modified or installed by the recipient, or for |
||||
the User Product in which it has been modified or installed. Access to a |
||||
network may be denied when the modification itself materially and |
||||
adversely affects the operation of the network or violates the rules and |
||||
protocols for communication across the network. |
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, |
||||
in accord with this section must be in a format that is publicly |
||||
documented (and with an implementation available to the public in |
||||
source code form), and must require no special password or key for |
||||
unpacking, reading or copying. |
||||
|
||||
7. Additional Terms. |
||||
|
||||
"Additional permissions" are terms that supplement the terms of this |
||||
License by making exceptions from one or more of its conditions. |
||||
Additional permissions that are applicable to the entire Program shall |
||||
be treated as though they were included in this License, to the extent |
||||
that they are valid under applicable law. If additional permissions |
||||
apply only to part of the Program, that part may be used separately |
||||
under those permissions, but the entire Program remains governed by |
||||
this License without regard to the additional permissions. |
||||
|
||||
When you convey a copy of a covered work, you may at your option |
||||
remove any additional permissions from that copy, or from any part of |
||||
it. (Additional permissions may be written to require their own |
||||
removal in certain cases when you modify the work.) You may place |
||||
additional permissions on material, added by you to a covered work, |
||||
for which you have or can give appropriate copyright permission. |
||||
|
||||
Notwithstanding any other provision of this License, for material you |
||||
add to a covered work, you may (if authorized by the copyright holders of |
||||
that material) supplement the terms of this License with terms: |
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the |
||||
terms of sections 15 and 16 of this License; or |
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or |
||||
author attributions in that material or in the Appropriate Legal |
||||
Notices displayed by works containing it; or |
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or |
||||
requiring that modified versions of such material be marked in |
||||
reasonable ways as different from the original version; or |
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or |
||||
authors of the material; or |
||||
|
||||
e) Declining to grant rights under trademark law for use of some |
||||
trade names, trademarks, or service marks; or |
||||
|
||||
f) Requiring indemnification of licensors and authors of that |
||||
material by anyone who conveys the material (or modified versions of |
||||
it) with contractual assumptions of liability to the recipient, for |
||||
any liability that these contractual assumptions directly impose on |
||||
those licensors and authors. |
||||
|
||||
All other non-permissive additional terms are considered "further |
||||
restrictions" within the meaning of section 10. If the Program as you |
||||
received it, or any part of it, contains a notice stating that it is |
||||
governed by this License along with a term that is a further |
||||
restriction, you may remove that term. If a license document contains |
||||
a further restriction but permits relicensing or conveying under this |
||||
License, you may add to a covered work material governed by the terms |
||||
of that license document, provided that the further restriction does |
||||
not survive such relicensing or conveying. |
||||
|
||||
If you add terms to a covered work in accord with this section, you |
||||
must place, in the relevant source files, a statement of the |
||||
additional terms that apply to those files, or a notice indicating |
||||
where to find the applicable terms. |
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the |
||||
form of a separately written license, or stated as exceptions; |
||||
the above requirements apply either way. |
||||
|
||||
8. Termination. |
||||
|
||||
You may not propagate or modify a covered work except as expressly |
||||
provided under this License. Any attempt otherwise to propagate or |
||||
modify it is void, and will automatically terminate your rights under |
||||
this License (including any patent licenses granted under the third |
||||
paragraph of section 11). |
||||
|
||||
However, if you cease all violation of this License, then your |
||||
license from a particular copyright holder is reinstated (a) |
||||
provisionally, unless and until the copyright holder explicitly and |
||||
finally terminates your license, and (b) permanently, if the copyright |
||||
holder fails to notify you of the violation by some reasonable means |
||||
prior to 60 days after the cessation. |
||||
|
||||
Moreover, your license from a particular copyright holder is |
||||
reinstated permanently if the copyright holder notifies you of the |
||||
violation by some reasonable means, this is the first time you have |
||||
received notice of violation of this License (for any work) from that |
||||
copyright holder, and you cure the violation prior to 30 days after |
||||
your receipt of the notice. |
||||
|
||||
Termination of your rights under this section does not terminate the |
||||
licenses of parties who have received copies or rights from you under |
||||
this License. If your rights have been terminated and not permanently |
||||
reinstated, you do not qualify to receive new licenses for the same |
||||
material under section 10. |
||||
|
||||
9. Acceptance Not Required for Having Copies. |
||||
|
||||
You are not required to accept this License in order to receive or |
||||
run a copy of the Program. Ancillary propagation of a covered work |
||||
occurring solely as a consequence of using peer-to-peer transmission |
||||
to receive a copy likewise does not require acceptance. However, |
||||
nothing other than this License grants you permission to propagate or |
||||
modify any covered work. These actions infringe copyright if you do |
||||
not accept this License. Therefore, by modifying or propagating a |
||||
covered work, you indicate your acceptance of this License to do so. |
||||
|
||||
10. Automatic Licensing of Downstream Recipients. |
||||
|
||||
Each time you convey a covered work, the recipient automatically |
||||
receives a license from the original licensors, to run, modify and |
||||
propagate that work, subject to this License. You are not responsible |
||||
for enforcing compliance by third parties with this License. |
||||
|
||||
An "entity transaction" is a transaction transferring control of an |
||||
organization, or substantially all assets of one, or subdividing an |
||||
organization, or merging organizations. If propagation of a covered |
||||
work results from an entity transaction, each party to that |
||||
transaction who receives a copy of the work also receives whatever |
||||
licenses to the work the party's predecessor in interest had or could |
||||
give under the previous paragraph, plus a right to possession of the |
||||
Corresponding Source of the work from the predecessor in interest, if |
||||
the predecessor has it or can get it with reasonable efforts. |
||||
|
||||
You may not impose any further restrictions on the exercise of the |
||||
rights granted or affirmed under this License. For example, you may |
||||
not impose a license fee, royalty, or other charge for exercise of |
||||
rights granted under this License, and you may not initiate litigation |
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
||||
any patent claim is infringed by making, using, selling, offering for |
||||
sale, or importing the Program or any portion of it. |
||||
|
||||
11. Patents. |
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this |
||||
License of the Program or a work on which the Program is based. The |
||||
work thus licensed is called the contributor's "contributor version". |
||||
|
||||
A contributor's "essential patent claims" are all patent claims |
||||
owned or controlled by the contributor, whether already acquired or |
||||
hereafter acquired, that would be infringed by some manner, permitted |
||||
by this License, of making, using, or selling its contributor version, |
||||
but do not include claims that would be infringed only as a |
||||
consequence of further modification of the contributor version. For |
||||
purposes of this definition, "control" includes the right to grant |
||||
patent sublicenses in a manner consistent with the requirements of |
||||
this License. |
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
||||
patent license under the contributor's essential patent claims, to |
||||
make, use, sell, offer for sale, import and otherwise run, modify and |
||||
propagate the contents of its contributor version. |
||||
|
||||
In the following three paragraphs, a "patent license" is any express |
||||
agreement or commitment, however denominated, not to enforce a patent |
||||
(such as an express permission to practice a patent or covenant not to |
||||
sue for patent infringement). To "grant" such a patent license to a |
||||
party means to make such an agreement or commitment not to enforce a |
||||
patent against the party. |
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, |
||||
and the Corresponding Source of the work is not available for anyone |
||||
to copy, free of charge and under the terms of this License, through a |
||||
publicly available network server or other readily accessible means, |
||||
then you must either (1) cause the Corresponding Source to be so |
||||
available, or (2) arrange to deprive yourself of the benefit of the |
||||
patent license for this particular work, or (3) arrange, in a manner |
||||
consistent with the requirements of this License, to extend the patent |
||||
license to downstream recipients. "Knowingly relying" means you have |
||||
actual knowledge that, but for the patent license, your conveying the |
||||
covered work in a country, or your recipient's use of the covered work |
||||
in a country, would infringe one or more identifiable patents in that |
||||
country that you have reason to believe are valid. |
||||
|
||||
If, pursuant to or in connection with a single transaction or |
||||
arrangement, you convey, or propagate by procuring conveyance of, a |
||||
covered work, and grant a patent license to some of the parties |
||||
receiving the covered work authorizing them to use, propagate, modify |
||||
or convey a specific copy of the covered work, then the patent license |
||||
you grant is automatically extended to all recipients of the covered |
||||
work and works based on it. |
||||
|
||||
A patent license is "discriminatory" if it does not include within |
||||
the scope of its coverage, prohibits the exercise of, or is |
||||
conditioned on the non-exercise of one or more of the rights that are |
||||
specifically granted under this License. You may not convey a covered |
||||
work if you are a party to an arrangement with a third party that is |
||||
in the business of distributing software, under which you make payment |
||||
to the third party based on the extent of your activity of conveying |
||||
the work, and under which the third party grants, to any of the |
||||
parties who would receive the covered work from you, a discriminatory |
||||
patent license (a) in connection with copies of the covered work |
||||
conveyed by you (or copies made from those copies), or (b) primarily |
||||
for and in connection with specific products or compilations that |
||||
contain the covered work, unless you entered into that arrangement, |
||||
or that patent license was granted, prior to 28 March 2007. |
||||
|
||||
Nothing in this License shall be construed as excluding or limiting |
||||
any implied license or other defenses to infringement that may |
||||
otherwise be available to you under applicable patent law. |
||||
|
||||
12. No Surrender of Others' Freedom. |
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or |
||||
otherwise) that contradict the conditions of this License, they do not |
||||
excuse you from the conditions of this License. If you cannot convey a |
||||
covered work so as to satisfy simultaneously your obligations under this |
||||
License and any other pertinent obligations, then as a consequence you may |
||||
not convey it at all. For example, if you agree to terms that obligate you |
||||
to collect a royalty for further conveying from those to whom you convey |
||||
the Program, the only way you could satisfy both those terms and this |
||||
License would be to refrain entirely from conveying the Program. |
||||
|
||||
13. Use with the GNU Affero General Public License. |
||||
|
||||
Notwithstanding any other provision of this License, you have |
||||
permission to link or combine any covered work with a work licensed |
||||
under version 3 of the GNU Affero General Public License into a single |
||||
combined work, and to convey the resulting work. The terms of this |
||||
License will continue to apply to the part which is the covered work, |
||||
but the special requirements of the GNU Affero General Public License, |
||||
section 13, concerning interaction through a network will apply to the |
||||
combination as such. |
||||
|
||||
14. Revised Versions of this License. |
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of |
||||
the GNU General Public License from time to time. Such new versions will |
||||
be similar in spirit to the present version, but may differ in detail to |
||||
address new problems or concerns. |
||||
|
||||
Each version is given a distinguishing version number. If the |
||||
Program specifies that a certain numbered version of the GNU General |
||||
Public License "or any later version" applies to it, you have the |
||||
option of following the terms and conditions either of that numbered |
||||
version or of any later version published by the Free Software |
||||
Foundation. If the Program does not specify a version number of the |
||||
GNU General Public License, you may choose any version ever published |
||||
by the Free Software Foundation. |
||||
|
||||
If the Program specifies that a proxy can decide which future |
||||
versions of the GNU General Public License can be used, that proxy's |
||||
public statement of acceptance of a version permanently authorizes you |
||||
to choose that version for the Program. |
||||
|
||||
Later license versions may give you additional or different |
||||
permissions. However, no additional obligations are imposed on any |
||||
author or copyright holder as a result of your choosing to follow a |
||||
later version. |
||||
|
||||
15. Disclaimer of Warranty. |
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
||||
|
||||
16. Limitation of Liability. |
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
||||
SUCH DAMAGES. |
||||
|
||||
17. Interpretation of Sections 15 and 16. |
||||
|
||||
If the disclaimer of warranty and limitation of liability provided |
||||
above cannot be given local legal effect according to their terms, |
||||
reviewing courts shall apply local law that most closely approximates |
||||
an absolute waiver of all civil liability in connection with the |
||||
Program, unless a warranty or assumption of liability accompanies a |
||||
copy of the Program in return for a fee. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
How to Apply These Terms to Your New Programs |
||||
|
||||
If you develop a new program, and you want it to be of the greatest |
||||
possible use to the public, the best way to achieve this is to make it |
||||
free software which everyone can redistribute and change under these terms. |
||||
|
||||
To do so, attach the following notices to the program. It is safest |
||||
to attach them to the start of each source file to most effectively |
||||
state the exclusion of warranty; and each file should have at least |
||||
the "copyright" line and a pointer to where the full notice is found. |
||||
|
||||
<one line to give the program's name and a brief idea of what it does.> |
||||
Copyright (C) <year> <name of author> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
||||
|
||||
Also add information on how to contact you by electronic and paper mail. |
||||
|
||||
If the program does terminal interaction, make it output a short |
||||
notice like this when it starts in an interactive mode: |
||||
|
||||
<program> Copyright (C) <year> <name of author> |
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
||||
This is free software, and you are welcome to redistribute it |
||||
under certain conditions; type `show c' for details. |
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate |
||||
parts of the General Public License. Of course, your program's commands |
||||
might be different; for a GUI interface, you would use an "about box". |
||||
|
||||
You should also get your employer (if you work as a programmer) or school, |
||||
if any, to sign a "copyright disclaimer" for the program, if necessary. |
||||
For more information on this, and how to apply and follow the GNU GPL, see |
||||
<https://www.gnu.org/licenses/>. |
||||
|
||||
The GNU General Public License does not permit incorporating your program |
||||
into proprietary programs. If your program is a subroutine library, you |
||||
may consider it more useful to permit linking proprietary applications with |
||||
the library. If this is what you want to do, use the GNU Lesser General |
||||
Public License instead of this License. But first, please read |
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>. |
@ -1,355 +0,0 @@
@@ -1,355 +0,0 @@
|
||||
*This repository is a mirror, for developpement and issues, please go to [gitlab](https://gitlab.com/dbeniamine/cheat.sh-vim/)* |
||||
|
||||
# Vim Cheat.sh |
||||
|
||||
This is a highly configurable vim plugin to browse cheat sheet from |
||||
[cheat.sh](https://github.com/chubin/cheat.sh) directly from vim. |
||||
|
||||
## Demo |
||||
|
||||
<!-- There is an asciinema showing how it works : |
||||
|
||||
[](https://asciinema.org/a/c6QRIhus7np2OOQzmQ2RNXzRZ) |
||||
--> |
||||
|
||||
There is a demo of most important features of the cheat.sh Vim plugin (5 Min), |
||||
courtesy of @chubin, CC-SA. |
||||
|
||||
** Note :** In the video, @chubin uses the `space` key as a `<leader>`, by |
||||
default vim `<leader>` is `backslash`. |
||||
|
||||
<p align="center"> |
||||
<img src='https://cheat.sh/files/vim-demo.gif'/> |
||||
</p> |
||||
|
||||
Or, if you want to scroll and/or pause, the same on YouTube: |
||||
|
||||
<p align="center"> |
||||
<a href="http://www.youtube.com/watch?feature=player_embedded&v=xyf6MJ0y-z8 |
||||
" target="_blank"><img src="http://img.youtube.com/vi/xyf6MJ0y-z8/0.jpg" |
||||
alt="cheat.sh-vim: Using cheat.sh from vim" width="700" height="490" border="10" /></a> |
||||
</p> |
||||
|
||||
## Features |
||||
|
||||
+ Browse existing cheat sheets from cheat.sh directly from vim |
||||
+ Get answers on any programming question directly on your vim with simple mappings |
||||
+ Answers depends of your current filetype or framework |
||||
+ Send compilation / syntax error to cht.sh and get answers |
||||
+ Manage session id to replay last query from other cht.sh clients |
||||
+ Quick navigation through answers |
||||
+ Everything is configurable |
||||
|
||||
### How to use it |
||||
|
||||
The easiest way to use this plugin is to use one of the following mappings : |
||||
|
||||
+ `K` get answer on the word under the cursor or the selection on a pager (this |
||||
feature requires vim >= 7.4.1833, you can check if have the right version with : |
||||
`:echo has("patch-7.4.1833")`) |
||||
+ `<leader>KK` same as `K` but works on lines or visual selection (not working |
||||
on neovim, because they killed interactive commands with `:!`) |
||||
+ `<leader>KB` get the answer on a special buffer |
||||
+ `<leader>KR` Replace your question by the answer |
||||
+ `<leader>KP` Past the answer below your question |
||||
+ `<leader>KC` Replay last query, toggling comments |
||||
+ `<leader>KE` Send first error to cht.sh |
||||
+ `<leader>C` Toggle showing comments by default see [configuration](#configuration) |
||||
+ `<leader>KL` Replay last query |
||||
|
||||
The plugins also provides four main commands : |
||||
|
||||
:Cheat |
||||
:CheatReplace |
||||
:CheatPast |
||||
:CheatPager |
||||
|
||||
+ These commands takes 0 or 1 argument. |
||||
+ If you give no argument, it will send the language of the current buffer and |
||||
the visual selection (or the current line / word in `normal` mode) as a plus |
||||
query to cheat.sh and show the answer in a new buffer (`:Cheat`), in place of |
||||
your question (`:CheatReplace`) or in a pager (`:CheatPager`). |
||||
+ If one argument is given, you can complete it from a list of available cheat |
||||
sheets or write your own [query](https://github.com/chubin/cheat.sh#search). |
||||
+ They also take a `bang` that make same transform the query into a plus query: |
||||
for instance : `:Cheat! factory` is the same as `:Cheat &ft/factory+`. |
||||
|
||||
#### HowIn |
||||
|
||||
The `:HowIn` command takes exaclty one argument. |
||||
|
||||
If the argument is one word, it is interpreted as a filetype (language), and |
||||
the current line (or word, depending on |cheat.sh-configuration|) is sent as a |
||||
query for this given language. |
||||
Else the first word of the query should be a filetype. |
||||
|
||||
Examples : |
||||
|
||||
```python |
||||
# Current postion in the buffer : |
||||
with open('foo') as f: |
||||
``` |
||||
```viml |
||||
:HowIn javascript |
||||
``` |
||||
Or |
||||
```viml |
||||
:Howin javascript open file |
||||
``` |
||||
|
||||
#### Frameworks |
||||
|
||||
#### Ids |
||||
|
||||
When you open a buffer, cheat.sh-vim will try to guess if you are using a |
||||
framework and if a framework is found, it will send queries using your |
||||
framework instead of your filetype. |
||||
|
||||
There are also some mappings to change the current framework : |
||||
|
||||
+ `<leader>Kt` : Use filetype instead of framework |
||||
+ `<leader>KT` : Use autodetected framework |
||||
+ `<leader>Kf` : Use next defined framework for current filetype |
||||
+ `<leader>KF` : Use previous defined framework for current filetype |
||||
|
||||
The available Frameworks can be overriden with the following code (adapt to |
||||
your needs) : |
||||
```viml |
||||
let g:CheatSheetFrameworks = { |
||||
\ 'python' : ['python', 'django', ], |
||||
\ 'javascript' : ['javascript', 'node', 'angular', 'jquery'], |
||||
\ 'php' : ['php', 'symphony', 'yii', 'zend'], |
||||
\} |
||||
``` |
||||
|
||||
As you can see the list is far from being exhaustive, please contribute if you |
||||
modify it (see below). |
||||
|
||||
##### Frameworks Detection |
||||
|
||||
This functionnality is in early stage and help is wanted to improve it. |
||||
To detect framework, the plugin go through the list of defined framework for |
||||
the current filetype. The following dictionnary tells the plugin how to detect |
||||
a few frameworks. |
||||
```viml |
||||
let g:CheatSheetFrameworkDetectionMethods = { |
||||
\'django' : { 'type' : 'file', 'value' : 'manage.py' }, |
||||
\'symfony' : { 'type' : 'file', 'value' : 'symfony.phar' }, |
||||
\'jquery' : {'type' :'search', 'value' : 'jquery.*\.js'}, |
||||
\} |
||||
``` |
||||
|
||||
This dictionnary can be overriden by the user. |
||||
|
||||
There are three types of detections : |
||||
|
||||
1. 'file' : 'value' is an argument for the `find` command to locate a file |
||||
`find . -name "value"` |
||||
2. 'search', 'value' is a pattern that should be present in the current file |
||||
3. 'func' : 'value' is the name of a user defined function which should return |
||||
something true if the framework is detected. The function takes one argument |
||||
which is the name of the framework we are currently testing for. |
||||
|
||||
Please report any contribution on [this |
||||
issue](https://gitlab.com/dbeniamine/cheat.sh-vim/issues/51#note_95268282), or |
||||
do MR (PR) on gitlab (resp github) : |
||||
|
||||
|
||||
The `:CheatId` command can be used to manage ids : |
||||
|
||||
:Cheat[!] [newid] " Generates a new id or set id to newid |
||||
" Id will not be overwritten if ! is not given |
||||
:Cheat remove " Completely removes the id |
||||
|
||||
#### Errors |
||||
|
||||
Cheat.sh-vim can directly send the syntaxt and compilation errors / warning to |
||||
cht.sh. To do so, hit `<leader>KE` or run `:CheatError`. |
||||
|
||||
By default, the answer will be displayed on the cheat buffer, to change this |
||||
behavior : |
||||
|
||||
let g:CheatSheetDefaultMode = x |
||||
|
||||
Where x is : |
||||
|
||||
+ 0 : Cheat buffer (default) |
||||
+ 1 : Replace current line (sounds like a very bad idea) |
||||
+ 2 : Use the pager |
||||
+ 3 : Append answer below current line (sounds like a bad idea) |
||||
|
||||
##### Error providers |
||||
|
||||
Currently errors are search from the quickfix, then from syntastic errors. |
||||
To change this order : |
||||
|
||||
let g:CheatSheetProviders = ['syntastic', 'quickfix'] |
||||
|
||||
You can easily add an error provider in 5 steps : |
||||
|
||||
1. Copy the file `cheat.sh/autoload/cheat/providers/quickfix.vim` to |
||||
`cheat.sh/autoload/cheat/providers/myprovider.vim` |
||||
2. Adapt and rename the function (only change quickfix in the name), it must |
||||
return the error string without special chars or an empty string if there are |
||||
no errors / warning |
||||
3. Add your provider name (filename) to the `CheatSheatProvider` list in |
||||
`cheat.sh/autoload/cheat/providers.vim` |
||||
4. Test it |
||||
5. Do a merge request on [gitlab](https://gitlab.com/dbeniamine/cheat.sh-vim/) |
||||
|
||||
##### Syntastic hooks |
||||
|
||||
Cheat.sh-vim uses syntastic hooks to retrieve the error list, if you also need |
||||
to use synstastic hook, make sure that your function calls ours with the initial |
||||
error list : |
||||
|
||||
function SyntasticCheckHook(errors) |
||||
call cheat#providers#syntastic#Hook(a:errors) |
||||
" Do whatever you want to do |
||||
endfunction |
||||
|
||||
#### Navigate |
||||
|
||||
Once you have called on of these commands, you can navigate through questions, |
||||
answers and related with the following mappings : |
||||
|
||||
+ `<leader>KQN` Next Question |
||||
+ `<leader>KAN` Next Answer |
||||
+ `<leader>KSN` Next "See also" |
||||
+ `<leader>KHN` Next in history |
||||
+ `<leader>KQP` Previous Question |
||||
+ `<leader>KAP` Previous Answer |
||||
+ `<leader>KSP` Previous "See also" |
||||
+ `<leader>KHP` Previous in history |
||||
|
||||
In the cheat buffer, the following mappings are also available : |
||||
|
||||
+ `<localleader>h` Previous Answer |
||||
+ `<localleader>j` Next Question |
||||
+ `<localleader>k` Previous Question |
||||
+ `<localleader>l` Next Answer |
||||
+ `<localleader>H` Previous history |
||||
+ `<localleader>J` Next "See also" |
||||
+ `<localleader>K` Previous "See also" |
||||
+ `<localleader>L` Next history |
||||
|
||||
|
||||
You can also directly use the function : |
||||
|
||||
:call cheat#navigate(delta, type) |
||||
|
||||
Where delta is a numeric value for moving (1, or -1 for next or previous) And |
||||
type is one of : `'Q'`, `'A'`, `'S'`, `H` (history), and `C` (replay last |
||||
query, toggling comments). |
||||
|
||||
For instance : |
||||
|
||||
:call cheat#navigate(-3, 'A') |
||||
|
||||
goes back three answers before the current |
||||
|
||||
When navigating, the same mode (pager, buffer, replace) is used as for the last |
||||
request. |
||||
|
||||
#### Notes |
||||
|
||||
+ `<leader>` is usually '\'. |
||||
+ **This plugin is still in beta, Replace mode might remove some of your code, |
||||
use with caution.** |
||||
+ For more info on cheat sheet sources, see |
||||
[cheat.sh](https://github.com/chubin/cheat.sh). |
||||
|
||||
## Install |
||||
|
||||
### Vizardry |
||||
|
||||
If you have [Vizardry](https://github.com/dbeniamine/vizardry) installed, you |
||||
can run from vim: |
||||
|
||||
:Invoke -u dbeniamine cheat.sh-vim |
||||
|
||||
### Vundle |
||||
|
||||
Add the following to your Vundle Plugin list (not tested, but should work) : |
||||
|
||||
Plugin 'dbeniamine/cheat.sh-vim' |
||||
|
||||
### Pathogen install |
||||
|
||||
git clone https://github.com/dbeniamine/cheat.sh-vim.git ~/.vim/bundle/cheat.sh-vim |
||||
|
||||
### Quick install |
||||
|
||||
git clone https://github.com/dbeniamine/cheat.sh-vim.git |
||||
cd cheat.sh-vim/ |
||||
cp -r ./* ~/.vim |
||||
|
||||
## Configuration |
||||
|
||||
Every parameter used to retrieve and display the cheat sheet can be changed, to |
||||
do so, just put the following in you vimrc and ajust to your needs (these are |
||||
the default values that will be used if you do not change them) : |
||||
|
||||
" Vim command used to open new buffer |
||||
let g:CheatSheetReaderCmd='new"' |
||||
|
||||
" Cheat sheet file type |
||||
let g:CheatSheetFt='markdown' |
||||
|
||||
" Program used to retrieve cheat sheet with its arguments |
||||
let g:CheatSheetUrlGetter='curl --silent' |
||||
|
||||
" Flag to add cookie file to the query |
||||
let g:CheatSheetUrlGetterIdFlag='-b' |
||||
|
||||
" cheat sheet base url |
||||
let g:CheatSheetBaseUrl='https://cht.sh' |
||||
|
||||
" cheat sheet settings do not include style settings neiter comments, |
||||
" see other options below |
||||
let g:CheatSheetUrlSettings='q' |
||||
|
||||
" cheat sheet pager |
||||
let g:CheatPager='less -R' |
||||
|
||||
" pygmentize theme used for pager output, see :CheatPager :styles-demo |
||||
let g:CheatSheetPagerStyle=rrt |
||||
|
||||
" Show comments in answers by default |
||||
" (setting this to 0 means giving ?Q to the server) |
||||
let g:CheatSheetShowCommentsByDefault=1 |
||||
|
||||
" cheat sheet buffer name |
||||
let g:CheatSheetBufferName="_cheat" |
||||
|
||||
" Default selection in normal mode (line for whole line, word for word under cursor) |
||||
let g:CheatSheetDefaultSelection="line" |
||||
|
||||
" Default query mode |
||||
" 0 => buffer |
||||
" 1 => replace (do not use or you might loose some lines of code) |
||||
" 2 => pager |
||||
" 3 => paste after query |
||||
" 4 => paste before query |
||||
let g:CheatSheetDefaultMode=0 |
||||
|
||||
Path to cheat sheet cookie |
||||
let g:CheatSheetIdPath=expand('~/.cht.sh/id') |
||||
|
||||
|
||||
|
||||
You can also disable the mappings (see plugin/cheat.vim to redo the mappings |
||||
manually) |
||||
|
||||
let g:CheatSheetDoNotMap=1 |
||||
|
||||
To disable the replacement of man by cheat sheets : |
||||
|
||||
Let g:CheatDoNotReplaceKeywordPrg=1 |
||||
|
||||
## License |
||||
|
||||
This plugin is distributed under GPL Licence v3.0, see |
||||
https://www.gnu.org/licenses/gpl.txt |
||||
|
||||
The demo are creative Commons, CC-SA Igor Chubin. |
@ -1,128 +0,0 @@
@@ -1,128 +0,0 @@
|
||||
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||
" Maintainer: David Beniamine |
||||
" |
||||
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||
" |
||||
" This program is free software: you can redistribute it and/or modify |
||||
" it under the terms of the GNU General Public License as published by |
||||
" the Free Software Foundation, either version 3 of the License, or |
||||
" (at your option) any later version. |
||||
" |
||||
" This program is distributed in the hope that it will be useful, |
||||
" but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
" GNU General Public License for more details. |
||||
" |
||||
" You should have received a copy of the GNU General Public License |
||||
" along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
|
||||
let save_cpo = &cpo |
||||
set cpo&vim |
||||
|
||||
if(!exists("g:CheatSheetFrameworks")) |
||||
let g:CheatSheetFrameworks = { |
||||
\ 'python' : [ 'python', 'django', ], |
||||
\ 'javascript' : ['javascript', 'node', 'angular', 'jquery'], |
||||
\ 'php' : ['php', 'symfony', 'yii', 'zend'], |
||||
\} |
||||
endif |
||||
|
||||
if(!exists("g:CheatSheetFrameworkDetectionMethods")) |
||||
let g:CheatSheetFrameworkDetectionMethods = { |
||||
\'django' : { 'type' : 'file', 'value' : 'manage.py' }, |
||||
\'symfony' : { 'type' : 'file', 'value' : 'symfony.phar' }, |
||||
\'jquery' : {'type' :'search', 'value' : 'jquery.*\.js'}, |
||||
\} |
||||
endif |
||||
|
||||
if(!exists("b:CheatSheetCurrentFramework")) |
||||
let b:CheatSheetCurrentFramework = 0 |
||||
endif |
||||
|
||||
function! s:Detectfromfile(value, fm) |
||||
let dir=expand('%:p:h') |
||||
" Forward search |
||||
silent let ret=system('find '.shellescape(dir).' -name '. |
||||
\shellescape(a:value).' 2>/dev/null') |
||||
" Backward search |
||||
if ret == "" |
||||
let dirs="" |
||||
let parent=substitute(dir, '/[^/]*$', '', '') |
||||
while parent != "" |
||||
let dirs.=" ".shellescape(parent) |
||||
let parent=substitute(parent, '/[^/]*$', '', '') |
||||
endwhile |
||||
silent let ret=system('find '.dirs.' -maxdepth 1 -name '. |
||||
\shellescape(a:value).' 2>/dev/null') |
||||
endif |
||||
return ret != "" |
||||
endfunction |
||||
|
||||
function! s:Detectfromsearch(value, fm) |
||||
return search(a:value, 'cnw') |
||||
endfunction |
||||
|
||||
function! s:Detectfromfunc(value, fm) |
||||
return function(a:value)(a:fm) |
||||
endfunction |
||||
|
||||
function! cheat#frameworks#autodetect(print) |
||||
if(!has_key(g:CheatSheetFrameworks, &ft)) |
||||
return |
||||
endif |
||||
let framework = &ft |
||||
" Try autodetect |
||||
for fm in g:CheatSheetFrameworks[&ft] |
||||
if(has_key(g:CheatSheetFrameworkDetectionMethods, fm) && |
||||
\ function("s:Detectfrom". |
||||
\g:CheatSheetFrameworkDetectionMethods[fm].type)( |
||||
\g:CheatSheetFrameworkDetectionMethods[fm].value, fm) |
||||
\) |
||||
let framework=fm |
||||
break |
||||
endif |
||||
endfor |
||||
" Set framework |
||||
let b:CheatSheetCurrentFramework = index(g:CheatSheetFrameworks[&ft], |
||||
\framework) |
||||
|
||||
if(a:print) |
||||
call cheat#echo('Language for cheat queries changed to : "'. |
||||
\cheat#frameworks#getFt().'"', 's') |
||||
endif |
||||
endfunction |
||||
|
||||
" Try to use a framework if defined or return current filetype |
||||
function! cheat#frameworks#getFt() |
||||
try |
||||
let ft=g:CheatSheetFrameworks[&ft][b:CheatSheetCurrentFramework] |
||||
catch |
||||
let ft=&ft |
||||
endtry |
||||
return ft |
||||
endfunction |
||||
|
||||
" Switch to next filetype |
||||
function! cheat#frameworks#cycle(num) |
||||
if(!has_key(g:CheatSheetFrameworks, &ft)) |
||||
call cheat#echo('No frameworks define for "'.&ft. |
||||
\'", see :help cheat.sh-frameworks', 'E') |
||||
return |
||||
endif |
||||
|
||||
if(a:num == 0) |
||||
" Reset |
||||
let b:CheatSheetCurrentFramework = 0 |
||||
else |
||||
if(abs(b:CheatSheetCurrentFramework) >= len(g:CheatSheetFrameworks[&ft])) |
||||
let b:CheatSheetCurrentFramework = 0 |
||||
endif |
||||
let b:CheatSheetCurrentFramework += a:num |
||||
endif |
||||
|
||||
call cheat#echo('Language for cheat queries changed to : "'. |
||||
\cheat#frameworks#getFt().'"', 's') |
||||
endfunction |
||||
|
||||
let cpo=save_cpo |
||||
" vim:set et sw=4: |
@ -1,27 +0,0 @@
@@ -1,27 +0,0 @@
|
||||
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||
" Maintainer: David Beniamine |
||||
" |
||||
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||
" |
||||
" This program is free software: you can redistribute it and/or modify |
||||
" it under the terms of the GNU General Public License as published by |
||||
" the Free Software Foundation, either version 3 of the License, or |
||||
" (at your option) any later version. |
||||
" |
||||
" This program is distributed in the hope that it will be useful, |
||||
" but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
" GNU General Public License for more details. |
||||
" |
||||
" You should have received a copy of the GNU General Public License |
||||
" along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
|
||||
let save_cpo = &cpo |
||||
set cpo&vim |
||||
|
||||
function! cheat#providers#quickfix#GetError() |
||||
return cheat#providers#GetErrorFromList(getqflist()) |
||||
endfunction |
||||
|
||||
let cpo=save_cpo |
||||
" vim:set et sw=4: |
@ -1,32 +0,0 @@
@@ -1,32 +0,0 @@
|
||||
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||
" Maintainer: David Beniamine |
||||
" |
||||
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||
" |
||||
" This program is free software: you can redistribute it and/or modify |
||||
" it under the terms of the GNU General Public License as published by |
||||
" the Free Software Foundation, either version 3 of the License, or |
||||
" (at your option) any later version. |
||||
" |
||||
" This program is distributed in the hope that it will be useful, |
||||
" but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
" GNU General Public License for more details. |
||||
" |
||||
" You should have received a copy of the GNU General Public License |
||||
" along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
|
||||
let g:save_cpo = &cpo |
||||
set cpo&vim |
||||
|
||||
let s:errors=[] |
||||
|
||||
function! cheat#providers#syntastic#GetError() |
||||
return cheat#providers#GetErrorFromList(s:errors) |
||||
endfunction |
||||
|
||||
function! cheat#providers#syntastic#Hook(errors) |
||||
let s:errors=a:errors |
||||
endfunction |
||||
|
||||
" vim:set et sw=4: |
@ -1,129 +0,0 @@
@@ -1,129 +0,0 @@
|
||||
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||
" Maintainer: David Beniamine |
||||
" |
||||
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||
" |
||||
" This program is free software: you can redistribute it and/or modify |
||||
" it under the terms of the GNU General Public License as published by |
||||
" the Free Software Foundation, either version 3 of the License, or |
||||
" (at your option) any later version. |
||||
" |
||||
" This program is distributed in the hope that it will be useful, |
||||
" but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
" GNU General Public License for more details. |
||||
" |
||||
" You should have received a copy of the GNU General Public License |
||||
" along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
|
||||
let save_cpo = &cpo |
||||
set cpo&vim |
||||
|
||||
" Transforms a high level request into a query ready to be processed by cht.sh |
||||
function! cheat#requests#toquery(request) |
||||
if(a:request.useFt == 1) |
||||
let query='vim:'.a:request.ft.'/' |
||||
else |
||||
let query='' |
||||
endif |
||||
if(a:request.isCheatSheet == 0) |
||||
let query.=substitute(a:request.query, ' ', '+', 'g') |
||||
" There must be a + in the query |
||||
if(match(query, '+') == -1) |
||||
let query.='+' |
||||
endif |
||||
let query.='/'.a:request.q.'/'.a:request.a.','.a:request.s |
||||
else |
||||
let query.=a:request.query |
||||
endif |
||||
let query.='?' |
||||
let query.=g:CheatSheetUrlSettings |
||||
" Color pager requests |
||||
if(a:request.mode!=2) |
||||
let query.='T' |
||||
endif |
||||
if(a:request.comments==0) |
||||
let query.='Q' |
||||
endif |
||||
if(exists("g:CheatSheetPagerStyle") && a:request.mode==2) |
||||
let query.="&style=".g:CheatSheetPagerStyle |
||||
endif |
||||
return query |
||||
endfunction |
||||
|
||||
" Parse the query to update the given request |
||||
function! s:parseQuery(query, request) |
||||
let opts=split(a:query, '/') |
||||
if(len(opts) >= 2) |
||||
let a:request.ft=opts[0] |
||||
let a:request.query=opts[1] |
||||
else |
||||
let a:request.ft=g:CheatSheetFt |
||||
let a:request.query=opts[0] |
||||
let a:request.useFt = 0 |
||||
endif |
||||
if(len(opts) >=3) |
||||
let a:request.q=opts[2] |
||||
else |
||||
let a:request.q=0 |
||||
endif |
||||
if(len(opts) >=4) |
||||
" Remove see related if present |
||||
let a:request.a=substitute(opts[3], '\(.*\),\+.*$', '\1', '') |
||||
else |
||||
let a:request.a=0 |
||||
endif |
||||
" Remove see related uses , not / |
||||
if(match(a:query, ',\d\+$')!=-1) |
||||
let a:request.s=substitute(a:query, '^.*,\(\d\+\)$', '\1', '') |
||||
else |
||||
let a:request.s=0 |
||||
endif |
||||
if(match(a:query,'+')!=-1) |
||||
let a:request.isCheatSheet=0 |
||||
let a:request.useFt = 1 |
||||
else |
||||
let a:request.isCheatSheet=1 |
||||
endif |
||||
return a:request |
||||
endfunction |
||||
|
||||
|
||||
" Prepare an empty request |
||||
function! cheat#requests#init(query, mode, parseQuery) |
||||
let request={ |
||||
\'a' : 0, |
||||
\'q' : 0, |
||||
\'s' : 0, |
||||
\'comments' : g:CheatSheetShowCommentsByDefault, |
||||
\'ft' : cheat#frameworks#getFt(), |
||||
\'isCheatSheet' : 0, |
||||
\'appendpos' : 0, |
||||
\'numLines' : 0, |
||||
\'mode' : g:CheatSheetDefaultMode, |
||||
\'useFt' : 1, |
||||
\'query' : a:query, |
||||
\} |
||||
if(a:mode != 5) |
||||
let request.mode=a:mode |
||||
endif |
||||
|
||||
" Set append pos / remove query if required |
||||
if(request.mode == 1) |
||||
call cheat#echo('removing lines', 'e') |
||||
normal dd |
||||
let request.appendpos=getcurpos()[1]-1 |
||||
elseif(request.mode == 3) |
||||
let request.appendpos=getcurpos()[1] |
||||
elseif(request.mode == 4) |
||||
let request.appendpos=getcurpos()[1]-1 |
||||
endif |
||||
|
||||
if(a:parseQuery) |
||||
call s:parseQuery(a:query, request) |
||||
endif |
||||
return request |
||||
endfunction |
||||
|
||||
let cpo=save_cpo |
||||
" vim:set et sw=4: |
@ -1,314 +0,0 @@
@@ -1,314 +0,0 @@
|
||||
*cheat.sh-vim* ~ |
||||
|
||||
This is a vim plugin to browse cheat sheet from |
||||
cheat.sh (https://github.com/chubin/cheat.sh) directly from vim. |
||||
|
||||
=============================================================================== |
||||
Features *cheat.sh-features* ~ |
||||
|
||||
|
||||
+ Browse existing cheat sheets from cheat.sh directly from vim |
||||
+ Get answers on any programming question directly on your vim with simple mappings |
||||
+ Answers depends of your current filetype or framework see |cheat.sh-frameworks| |
||||
+ Send compilation / syntax error to cht.sh and get answers |
||||
+ Quick navigation through answers |
||||
+ Everything is configurable |
||||
|
||||
How to use it *cheat.sh-how-to-use* ~ |
||||
|
||||
The easiest way to use this plugin is to use one of the following mappings : |
||||
The easiest way to use this plugin is to use one of the following mappings : |
||||
|
||||
+ `K` get answer on the word under the cursor or the selection on a pager (this |
||||
feature requires vim >= 7.4.1833, you can check if have the right version with : |
||||
`:echo has("patch-7.4.1833")`) |
||||
+ `<leader>KK` same as `K` but works on lines or visual selection (not working |
||||
on neovim, because they killed interactive commands with `:!`) |
||||
+ `<leader>KB` get the answer on a special buffer |
||||
+ `<leader>KR` Replace your question by the answer |
||||
+ `<leader>KP` Past the answer below your question |
||||
+ `<leader>KC` Replay last query, toggling comments |
||||
+ `<leader>KE` Send first error to cht.sh |
||||
+ `<leader>C` Toggle showing comments by default see |cheat.sh-configuration| |
||||
+ `<leader>KL` Replay last query |
||||
|
||||
The plugins also provides four main commands : |
||||
> |
||||
:Cheat |
||||
:CheatReplace |
||||
:CheatPast |
||||
:CheatPager |
||||
< |
||||
+ These commands takes 0 or 1 argument. |
||||
+ If you give no argument, it will send the language of the current buffer and |
||||
the visual selection (or the current line / word in `normal` mode) as a plus |
||||
query to cheat.sh and show the answer in a new buffer (`:Cheat`), in place of |
||||
your question (`:CheatReplace`) or in a pager (`:CheatPager`). |
||||
+ If one argument is given, you can complete it from a list of available cheat |
||||
sheets or write your own [query](https://github.com/chubin/cheat.sh#search). |
||||
+ They also take a `bang` that make same transform the query into a plus query: |
||||
for instance : `:Cheat! factory` is the same as `:Cheat &ft/factory+`. |
||||
|
||||
HowIn *cheat.sh-howin* ~ |
||||
|
||||
The `:HowIn` command takes exaclty one argument. |
||||
|
||||
If the argument is one word, it is interpreted as a filetype (language), and |
||||
the current line (or word, depending on |cheat.sh-configuration|) is sent as a |
||||
query for this given language. |
||||
Else the first word of the query should be a filetype. |
||||
|
||||
Examples : |
||||
|
||||
> |
||||
# Current postion in the buffer : |
||||
with open('foo') as f: |
||||
:HowIn javascript |
||||
< |
||||
Or |
||||
> |
||||
:Howin javascript open file |
||||
< |
||||
|
||||
|
||||
Frameworks *cheat.sh-frameworks* ~ |
||||
|
||||
When you open a buffer, cheat.sh-vim will try to guess if you are using a |
||||
framework (see |cheat.sh-framework-detection|) and if a framework is found, it |
||||
will send queries using your framework instead of your filetype. |
||||
|
||||
There are also some mappings to change the current framework : |
||||
|
||||
+ `<leader>Kt` : Use filetype instead of framework |
||||
+ `<leader>KT` : Use autodetected framework |
||||
+ `<leader>Kf` : Use next defined framework for current filetype |
||||
+ `<leader>KF` : Use previous defined framework for current filetype |
||||
|
||||
The available Frameworks can be overriden with the following code (adapt to |
||||
your needs) : |
||||
> |
||||
let g:CheatSheetFrameworks = { |
||||
\ 'python' : ['python', 'django', ], |
||||
\ 'javascript' : ['javascript', 'node', 'angular', 'jquery'], |
||||
\ 'php' : ['php', 'symphony', 'yii', 'zend'], |
||||
\} |
||||
|
||||
As you can see the list is far from being exhaustive, please contribute if you |
||||
modify it (see below). |
||||
|
||||
*cheat.sh-frameworks-detection* |
||||
|
||||
This functionnality is in early stage and help is wanted to improve it. |
||||
To detect framework, the plugin go through the list of defined framework for |
||||
the current filetype. The following dictionnary tells the plugin how to detect |
||||
a few frameworks. |
||||
> |
||||
let g:CheatSheetFrameworkDetectionMethods = { |
||||
\'django' : { 'type' : 'file', 'value' : 'manage.py' }, |
||||
\'symfony' : { 'type' : 'file', 'value' : 'symfony.phar' }, |
||||
\'jquery' : {'type' :'search', 'value' : 'jquery.*\.js'}, |
||||
\} |
||||
|
||||
This dictionnary can be overriden by the user. |
||||
|
||||
There are three types of detections : |
||||
|
||||
1. 'file' : 'value' is an argument for the `find` command to locate a file |
||||
`find . -name "value"` |
||||
2. 'search', 'value' is a pattern that should be present in the current file |
||||
3. 'func' : 'value' is the name of a user defined function which should return |
||||
something true if the framework is detected. The function takes one argument |
||||
which is the name of the framework we are currently testing for. |
||||
|
||||
Please report any contribution on the followin issue, or do MR (PR) on gitlab |
||||
(resp github). |
||||
|
||||
https://gitlab.com/dbeniamine/cheat.sh-vim/issues/51#note_95268282 |
||||
|
||||
<Ids *cheat.sh-ids* ~ |
||||
|
||||
You can manage ids through the `:CheatId` command : |
||||
|
||||
:Cheat[!] [newid] " Generates a new id or set id to newid |
||||
" Id will not be overwritten if ! is not given |
||||
:Cheat remove " Completely removes the id |
||||
|
||||
Id is used to replay query from different clients |
||||
|
||||
Errors *cheat.sh-errors* ~ |
||||
|
||||
Cheat.sh-vim can directly send the syntaxt and compilation errors / warning to |
||||
cht.sh. To do so, hit `<leader>KE` or run `:CheatError`. |
||||
|
||||
By default, the answer will be displayed on the cheat buffer, to change this |
||||
behavior : |
||||
> |
||||
let g:CheatSheetDefaultMode = x |
||||
< |
||||
Where x is : |
||||
|
||||
+ 0 : Cheat buffer (default) |
||||
+ 1 : Replace current line (sounds like a very bad idea) |
||||
+ 2 : Use the pager |
||||
+ 3 : Append answer below current line (sounds like a bad idea) |
||||
|
||||
Error providers *cheat.sh-errors-providers* ~ |
||||
|
||||
Currently errors are search from the quickfix, then from syntastic errors. |
||||
To change this order : |
||||
> |
||||
let g:CheatSheetProviders = ['syntastic', 'quickfix'] |
||||
< |
||||
|
||||
You can easily add an error provider in 5 steps : |
||||
|
||||
1. Copy the file `cheat.sh/autoload/cheat/providers/quickfix.vim` to |
||||
`cheat.sh/autoload/cheat/providers/myprovider.vim` |
||||
2. Adapt and rename the function (only change quickfix in the name), it must |
||||
return the error string without special chars or an empty string if there are |
||||
no errors / warning |
||||
3. Add your provider name (filename) to the `CheatSheatProvider` list in |
||||
`cheat.sh/autoload/cheat/providers.vim` |
||||
4. Test it |
||||
5. Do a merge request on [gitlab](https://gitlab.com/dbeniamine/cheat.sh-vim/) |
||||
|
||||
Syntastic hooks *cheat.sh-syntastic-hook* ~ |
||||
|
||||
Cheat.sh-vim uses syntastic hooks to retrieve the error list, if you also need |
||||
to use synstastic hook, make sure that your function calls ours with the initial |
||||
error list : |
||||
|
||||
function SyntasticCheckHook(errors) |
||||
call cheat#providers#syntastic#Hook(a:errors) |
||||
" Do whatever you want to do |
||||
endfunction |
||||
|
||||
|
||||
|
||||
Navigate *cheat.sh-navigate* ~ |
||||
|
||||
Once you have called on of these commands, you can navigate through questions, |
||||
answers and related with the following mappings : |
||||
|
||||
+ `<leader>KQN` Next Question |
||||
+ `<leader>KAN` Next Answer |
||||
+ `<leader>KSN` Next "See also" |
||||
+ `<leader>KHN` Next in history |
||||
+ `<leader>KQP` Previous Question |
||||
+ `<leader>KAP` Previous Answer |
||||
+ `<leader>KSP` Previous "See also" |
||||
+ `<leader>KHP` Previous in history |
||||
|
||||
In the cheat buffer, the following mappings are available : |
||||
|
||||
+ `<localleader>h` Previous Answer |
||||
+ `<localleader>j` Next Question |
||||
+ `<localleader>k` Previous Question |
||||
+ `<localleader>l` Next Answer |
||||
+ `<localleader>H` Previous history |
||||
+ `<localleader>J` Next "See also" |
||||
+ `<localleader>K` Previous "See also" |
||||
+ `<localleader>L` Next history |
||||
|
||||
You can also directly use the function : |
||||
> |
||||
:call cheat#navigate(delta, type) |
||||
< |
||||
Where delta is a numeric value for moving (1, or -1 for next or previous) And |
||||
type is one of : `'Q'`, `'A'`, `'S'`, `H` (history), and `C` (replay last |
||||
query, toggling comments). |
||||
|
||||
For instance : |
||||
> |
||||
:call cheat#navigate(-3, 'A') |
||||
< |
||||
goes back three answers before the current |
||||
|
||||
When navigating, the same mode (pager, buffer, replace) is used as for the last |
||||
request. |
||||
|
||||
Notes *cheat.sh-notes* ~ |
||||
|
||||
+ `<leader>` is usually '\', see |<leader>| |
||||
+ **This plugin is still in beta, Replace mode might remove some of your code, |
||||
use with caution.** |
||||
+ For more info on cheat sheet sources, see |
||||
[cheat.sh](https://github.com/chubin/cheat.sh). |
||||
|
||||
|
||||
This plugin provides a `:Cheat` command to browse cheat sheets from vim. This |
||||
command takes one argument : a Cheat.sh |
||||
query (https://github.com/chubin/cheat.sh#search), and supports completion. |
||||
|
||||
For more info on cheat sheet source, see |
||||
cheat.sh (https://github.com/chubin/cheat.sh). |
||||
|
||||
============================================================================== |
||||
Configuration *cheat.sh-configuration* ~ |
||||
|
||||
Every parameter used to retrieve and display the cheat sheet can be changed, |
||||
to do so, just put the following in you vimrc and ajust to your needs (these |
||||
are the default values that will be used if you do not change them) : |
||||
> |
||||
" Vim command used to open new buffer |
||||
let g:CheatSheetReaderCmd='new"' |
||||
|
||||
" Cheat sheet file type |
||||
let g:CheatSheetFt='markdown' |
||||
|
||||
" Program used to retrieve cheat sheet with its arguments |
||||
let g:CheatSheetUrlGetter='curl --silent' |
||||
|
||||
" Flag to add cookie file to the query |
||||
let g:CheatSheetUrlGetterIdFlag='-b' |
||||
|
||||
" cheat sheet base url |
||||
let g:CheatSheetBaseUrl='https://cht.sh' |
||||
|
||||
" cheat sheet settings do not include style settings neiter comments, |
||||
" see other options below |
||||
let g:CheatSheetUrlSettings='q' |
||||
|
||||
" cheat sheet pager |
||||
let g:CheatPager='less -R' |
||||
|
||||
" pygmentize theme used for pager output, see :CheatPager :styles-demo |
||||
let g:CheatSheetPagerStyle=rrt |
||||
|
||||
" Show comments in answers by default |
||||
" (setting this to 0 means giving ?Q to the server) |
||||
let g:CheatSheetShowCommentsByDefault=1 |
||||
|
||||
" cheat sheet buffer name |
||||
let g:CheatSheetBufferName="_cheat" |
||||
|
||||
" Default selection in normal mode (line for whole line, word for word under cursor) |
||||
let g:CheatSheetDefaultSelection="line" |
||||
|
||||
" Default query mode |
||||
" 0 => buffer |
||||
" 1 => replace (do not use or you might loose some lines of code) |
||||
" 2 => pager |
||||
" 3 => paste after query |
||||
" 4 => paste before query |
||||
let g:CheatSheetDefaultMode=0 |
||||
|
||||
Path to cheat sheet cookie |
||||
let g:CheatSheetIdPath=expand('~/.cht.sh/id') |
||||
|
||||
< |
||||
You can also disable the mappings (see plugin/cheat.vim to redo the mappings |
||||
manually) |
||||
> |
||||
let g:CheatSheetDoNotMap=1 |
||||
< |
||||
To disable the replacement of man by cheat sheets : |
||||
> |
||||
Let g:CheatDoNotReplaceKeywordPrg=1 |
||||
< |
||||
|
||||
============================================================================== |
||||
Licence *cheat.sh-licence* ~ |
||||
|
||||
This plugin is distributed under GPL Licence v3.0, see |
||||
https://www.gnu.org/licenses/gpl.txt |
@ -1,174 +0,0 @@
@@ -1,174 +0,0 @@
|
||||
" Vim plugin for accessing cheat sheets from cheat.sh. |
||||
" Maintainer: David Beniamine |
||||
" |
||||
" Copyright (C) 2018 David Beniamine. All rights reserved. |
||||
" |
||||
" This program is free software: you can redistribute it and/or modify |
||||
" it under the terms of the GNU General Public License as published by |
||||
" the Free Software Foundation, either version 3 of the License, or |
||||
" (at your option) any later version. |
||||
" |
||||
" This program is distributed in the hope that it will be useful, |
||||
" but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
" GNU General Public License for more details. |
||||
" |
||||
" You should have received a copy of the GNU General Public License |
||||
" along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
|
||||
if exists("g:loaded_cheat_sh") |
||||
finish |
||||
endif |
||||
|
||||
let save_cpo = &cpo |
||||
set cpo&vim |
||||
|
||||
let g:loaded_cheat_sh = "v0.2" |
||||
|
||||
" Default query mode |
||||
if(!exists("g:CheatSheetDefaultMode")) |
||||
let g:CheatSheetDefaultMode=0 |
||||
endif |
||||
|
||||
" cheat sheet base url |
||||
if(!exists("g:CheatSheetBaseUrl")) |
||||
let g:CheatSheetBaseUrl='https://cht.sh' |
||||
endif |
||||
|
||||
" command definition |
||||
command! -nargs=? -bang -count -complete=custom,cheat#completeargs Cheat |
||||
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 0, "<bang>") |
||||
|
||||
command! -nargs=? -count CheatError |
||||
\ call cheat#cheat('', -1, -1, -1, 4, '!') |
||||
|
||||
command! -nargs=? -bang -count -complete=custom,cheat#completeargs CheatReplace |
||||
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 1, "<bang>") |
||||
|
||||
command! -nargs=? -bang -count -complete=custom,cheat#completeargs CheatPager |
||||
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 2, "<bang>") |
||||
|
||||
command! -nargs=? -bang -count -complete=custom,cheat#completeargs CheatPaste |
||||
\ call cheat#cheat(<q-args>, <line1>, <line2>, <count>, 3, "<bang>") |
||||
|
||||
command! -nargs=1 CheatNavigateQuestions call cheat#navigate(<q-args>, 'Q') |
||||
command! -nargs=1 CheatNavigateAnswers call cheat#navigate(<q-args>, 'A') |
||||
command! -nargs=1 CheatSeeAlso call cheat#navigate(<q-args>, 'S') |
||||
command! -nargs=1 CheatHistory call cheat#navigate(<q-args>, 'H') |
||||
command! -nargs=? -bang CheatId call cheat#session#id(<q-args>, "<bang>") |
||||
|
||||
|
||||
command! -nargs=1 -bang -count -complete=custom,cheat#completeargs HowIn |
||||
\ call cheat#howin(<q-args>, <line1>, <line2>, <count>) |
||||
|
||||
if((!exists("g:CheatDoNotReplaceKeywordPrg") || |
||||
\ g:CheatDoNotReplaceKeywordPrg ==0)) |
||||
if(has("patch-7.4.1833")) |
||||
set keywordprg=:CheatPager! |
||||
else |
||||
exe 'set keywordprg='.expand('<sfile>:p:h').'/../scripts/chtpager.sh' |
||||
endif |
||||
endif |
||||
|
||||
if(!exists("g:CheatSheetDoNotMap") || g:CheatSheetDoNotMap ==0) |
||||
nnoremap <script> <silent> <leader>C :call cheat#toggleComments()<CR> |
||||
|
||||
" Buffer |
||||
nnoremap <script> <silent> <leader>KB |
||||
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 0, '!')<CR> |
||||
vnoremap <script> <silent> <leader>KB |
||||
\ :call cheat#cheat("", -1, -1, 2, 0, '!')<CR> |
||||
|
||||
" Pager |
||||
nnoremap <script> <silent> <leader>KK |
||||
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 2, '!')<CR> |
||||
vnoremap <script> <silent> <leader>KK |
||||
\ :call cheat#cheat("", -1, -1, 2, 2, '!')<CR> |
||||
|
||||
vnoremap <script> <silent> <leader>KL :call cheat#session#last()<CR> |
||||
nnoremap <script> <silent> <leader>KL :call cheat#session#last()<CR> |
||||
|
||||
|
||||
" Replace |
||||
nnoremap <script> <silent> <leader>KR |
||||
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 1, '!')<CR> |
||||
vnoremap <script> <silent> <leader>KR |
||||
\ :call cheat#cheat("", -1, -1, 2, 1, '!')<CR> |
||||
|
||||
" Paste |
||||
nnoremap <script> <silent> <leader>KP |
||||
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 4, '!')<CR> |
||||
vnoremap <script> <silent> <leader>KP |
||||
\ :call cheat#cheat("", -1, -1, 4, 1, '!')<CR> |
||||
|
||||
nnoremap <script> <silent> <leader>Kp |
||||
\ :call cheat#cheat("", getcurpos()[1], getcurpos()[1], 0, 3, '!')<CR> |
||||
vnoremap <script> <silent> <leader>Kp |
||||
\ :call cheat#cheat("", -1, -1, 3, 1, '!')<CR> |
||||
|
||||
" Buffer |
||||
nnoremap <script> <silent> <leader>KE |
||||
\ :call cheat#cheat("", -1, -1 , -1, 5, '!')<CR> |
||||
vnoremap <script> <silent> <leader>KE |
||||
\ :call cheat#cheat("", -1, -1, -1, 5, '!')<CR> |
||||
" Toggle comments |
||||
nnoremap <script> <silent> <leader>KC :call cheat#navigate(0, 'C')<CR> |
||||
vnoremap <script> <silent> <leader>KC :call cheat#navigate(0, 'C')<CR> |
||||
|
||||
" Next |
||||
nnoremap <script> <silent> <leader>KQN :call cheat#navigate(1,'Q')<CR> |
||||
vnoremap <script> <silent> <leader>KQN :call cheat#navigate(1,'Q')<CR> |
||||
nnoremap <script> <silent> <leader>KAN :call cheat#navigate(1, 'A')<CR> |
||||
vnoremap <script> <silent> <leader>KAN :call cheat#navigate(1, 'A')<CR> |
||||
nnoremap <script> <silent> <leader>KHN :call cheat#navigate(1, 'H')<CR> |
||||
vnoremap <script> <silent> <leader>KHN :call cheat#navigate(1, 'H')<CR> |
||||
|
||||
" Prev |
||||
nnoremap <script> <silent> <leader>KQP :call cheat#navigate(-1,'Q')<CR> |
||||
vnoremap <script> <silent> <leader>KQP :call cheat#navigate(-1,'Q')<CR> |
||||
nnoremap <script> <silent> <leader>KAP :call cheat#navigate(-1,'A')<CR> |
||||
vnoremap <script> <silent> <leader>KAP :call cheat#navigate(-1,'A')<CR> |
||||
nnoremap <script> <silent> <leader>KHP :call cheat#navigate(-1, 'H')<CR> |
||||
vnoremap <script> <silent> <leader>KHP :call cheat#navigate(-1, 'H')<CR> |
||||
|
||||
" See Also |
||||
nnoremap <script> <silent> <leader>KSN :call cheat#navigate(1,'S')<CR> |
||||
vnoremap <script> <silent> <leader>KSN :call cheat#navigate(1,'S')<CR> |
||||
nnoremap <script> <silent> <leader>KSP :call cheat#navigate(-1,'S')<CR> |
||||
vnoremap <script> <silent> <leader>KSP :call cheat#navigate(-1,'S')<CR> |
||||
|
||||
" Frameworks switch |
||||
nnoremap <script> <silent> <leader>Kf |
||||
\ :call cheat#frameworks#cycle(1)<CR> |
||||
vnoremap <script> <silent> <leader>Kf |
||||
\ :call cheat#frameworks#cycle(1)<CR> |
||||
nnoremap <script> <silent> <leader>KF |
||||
\ :call cheat#frameworks#cycle(-1)<CR> |
||||
vnoremap <script> <silent> <leader>KF |
||||
\ :call cheat#frameworks#cycle(-1)<CR> |
||||
nnoremap <script> <silent> <leader>Kt |
||||
\ :call cheat#frameworks#cycle(0)<CR> |
||||
vnoremap <script> <silent> <leader>Kt |
||||
\ :call cheat#frameworks#cycle(0)<CR> |
||||
nnoremap <script> <silent> <leader>KT |
||||
\ :call cheat#frameworks#autodetect(1)<CR> |
||||
vnoremap <script> <silent> <leader>KT |
||||
\ :call cheat#frameworks#autodetect(1)<CR> |
||||
endif |
||||
|
||||
if(!exists("g:CheatSheetDisableFrameworkDetection") |
||||
\ || g:CheatSheetDisableFrameworkDetection == 0) |
||||
augroup cheat_group |
||||
autocmd! |
||||
autocmd BufReadPost,BufNewFile * call cheat#frameworks#autodetect(0) |
||||
augroup END |
||||
endif |
||||
|
||||
try |
||||
function SyntasticCheckHook(errors) |
||||
call cheat#providers#syntastic#Hook(a:errors) |
||||
endfunction |
||||
endtry |
||||
|
||||
let cpo=save_cpo |
||||
" vim:set et sw=4: |
@ -1,2 +0,0 @@
@@ -1,2 +0,0 @@
|
||||
#!/bin/bash |
||||
\vim -E -c "CheatPager! $@" -c q |
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
workspace.showOutput |
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
{} |
@ -0,0 +1,2 @@
@@ -0,0 +1,2 @@
|
||||
/lib |
||||
node_modules |
@ -0,0 +1,4 @@
@@ -0,0 +1,4 @@
|
||||
{ |
||||
"extends": ["josa-typescript"] |
||||
} |
||||
|
@ -0,0 +1,18 @@
@@ -0,0 +1,18 @@
|
||||
name: Main |
||||
|
||||
on: push |
||||
|
||||
jobs: |
||||
main: |
||||
runs-on: ${{ matrix.os }} |
||||
strategy: |
||||
matrix: |
||||
os: [ubuntu-latest, macos-latest, windows-latest] |
||||
node: [10, 12, 14] |
||||
steps: |
||||
- uses: "actions/checkout@v2" |
||||
- uses: "actions/setup-node@v1" |
||||
with: { node-version: "${{ matrix.node }}" } |
||||
- run: yarn --frozen-lockfile |
||||
- run: yarn build |
||||
- run: yarn lint |
@ -0,0 +1,21 @@
@@ -0,0 +1,21 @@
|
||||
MIT License |
||||
|
||||
Copyright (c) 2019 Josa Gesell |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
@ -0,0 +1,29 @@
@@ -0,0 +1,29 @@
|
||||
# coc-docker |
||||
|
||||
Docker language server extension using [`dockerfile-language-server-nodejs`](https://github.com/rcjsuen/dockerfile-language-server-nodejs) |
||||
for [`coc.nvim`](https://github.com/neoclide/coc.nvim). |
||||
|
||||
## Install |
||||
|
||||
In your vim/neovim, run command: |
||||
|
||||
:CocInstall coc-docker |
||||
|
||||
## Features |
||||
|
||||
See [`dockerfile-language-server-nodejs`](https://github.com/rcjsuen/dockerfile-language-server-nodejs) |
||||
|
||||
## Configuration options |
||||
|
||||
- `docker.enable` set to `false` to disable language server. |
||||
|
||||
Trigger completion in `coc-settings.json` to get complete list. |
||||
|
||||
## Development |
||||
|
||||
1. Run `yarn build` or `yarn build:watch` |
||||
2. Link extension: `yarn run link` / `yarn run unlink` |
||||
|
||||
## License |
||||
|
||||
[MIT © Josa Gesell](LICENSE) |
@ -0,0 +1,62 @@
@@ -0,0 +1,62 @@
|
||||
/*--------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Microsoft Corporation. All rights reserved. |
||||
* Licensed under the MIT License. See LICENSE.md in the project root for license information. |
||||
*--------------------------------------------------------------------------------------------*/ |
||||
'use strict'; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
exports.DockerComposeCompletionItemProvider = void 0; |
||||
const tslib_1 = require("tslib"); |
||||
const coc_nvim_1 = require("coc.nvim"); |
||||
const dockerComposeKeyInfo_1 = tslib_1.__importDefault(require("./dockerComposeKeyInfo")); |
||||
const suggestSupportHelper_1 = require("../utils/suggestSupportHelper"); |
||||
class DockerComposeCompletionItemProvider { |
||||
async provideCompletionItems(textDocument, position, token, context) { |
||||
const hub = new suggestSupportHelper_1.SuggestSupportHelper(); |
||||
// Determine the schema version of the current compose file,
|
||||
// based on the existence of a top-level "version" property.
|
||||
const versionMatch = textDocument.getText().match(/^version:\s*(["'])(\d+(\.\d)?)\1/im); |
||||
const version = versionMatch ? versionMatch[2] : "1"; |
||||
const document = coc_nvim_1.workspace.getDocument(textDocument.uri); |
||||
// Get the line where intellisense was invoked on (e.g. 'image: u').
|
||||
const line = await coc_nvim_1.workspace.getLine(textDocument.uri, position.line); |
||||
if (line.length === 0) { |
||||
// empty line
|
||||
return Promise.resolve(this.suggestKeys('', version)); |
||||
} |
||||
const range = document.getWordRangeAtPosition(position); |
||||
// Get the text where intellisense was invoked on (e.g. 'u').
|
||||
const word = range && textDocument.getText(range); |
||||
const textBefore = line.substring(0, position.character); |
||||
if (/^\s*[\w_]*$/.test(textBefore)) { |
||||
// on the first token
|
||||
return Promise.resolve(this.suggestKeys(word, version)); |
||||
} |
||||
// Matches strings like: 'image: "ubuntu'
|
||||
const imageTextWithQuoteMatchYaml = textBefore.match(/^\s*image\s*:\s*"([^"]*)$/); |
||||
if (imageTextWithQuoteMatchYaml) { |
||||
const imageText = imageTextWithQuoteMatchYaml[1]; |
||||
return hub.suggestImages(imageText); |
||||
} |
||||
// Matches strings like: 'image: ubuntu'
|
||||
const imageTextWithoutQuoteMatch = textBefore.match(/^\s*image\s*:\s*([\w:/]*)/); |
||||
if (imageTextWithoutQuoteMatch) { |
||||
const imageText = imageTextWithoutQuoteMatch[1]; |
||||
return hub.suggestImages(imageText); |
||||
} |
||||
return Promise.resolve([]); |
||||
} |
||||
suggestKeys(word, version) { |
||||
// Attempt to grab the keys for the requested schema version,
|
||||
// otherwise, fall back to showing a composition of all possible keys.
|
||||
const keys = dockerComposeKeyInfo_1.default[`v${version}`] || dockerComposeKeyInfo_1.default.All; |
||||
return Object.keys(keys).map(ruleName => { |
||||
const completionItem = { label: ruleName }; |
||||
completionItem.kind = coc_nvim_1.CompletionItemKind.Keyword; |
||||
completionItem.insertText = ruleName + ': '; |
||||
completionItem.documentation = keys[ruleName]; |
||||
return completionItem; |
||||
}); |
||||
} |
||||
} |
||||
exports.DockerComposeCompletionItemProvider = DockerComposeCompletionItemProvider; |
||||
//# sourceMappingURL=dockerComposeCompletionItemProvider.js.map
|
@ -0,0 +1,162 @@
@@ -0,0 +1,162 @@
|
||||
"use strict"; |
||||
/*--------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Microsoft Corporation. All rights reserved. |
||||
* Licensed under the MIT License. See LICENSE.md in the project root for license information. |
||||
*--------------------------------------------------------------------------------------------*/ |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
// Define the keys that are shared between all compose file versions,
|
||||
// regardless of the major/minor version (e.g. v1-v2.1+).
|
||||
// https://docs.docker.com/compose/yml/
|
||||
const DOCKER_COMPOSE_SHARED_KEY_INFO = { |
||||
'build': ("Path to a directory containing a Dockerfile. When the value supplied is a relative path, it is interpreted as relative to the " + |
||||
"location of the yml file itself. This directory is also the build context that is sent to the Docker daemon.\n\n" + |
||||
"Compose will build and tag it with a generated name, and use that image thereafter."), |
||||
'cap_add': ("Add or drop container capabilities. See `man 7 capabilities` for a full list."), |
||||
'cap_drop': ("Add or drop container capabilities. See `man 7 capabilities` for a full list."), |
||||
'cgroup_parent': ("Specify an optional parent cgroup for the container."), |
||||
'command': ("Override the default command."), |
||||
'container_name': ("Specify custom container name, rather than a generated default name."), |
||||
'cpu_shares': ("CPU shares (relative weight)."), |
||||
'cpu_quota': ("Limit CPU CFS (Completely Fair Scheduler) quota."), |
||||
'cpuset': ("CPUs in which to allow execution."), |
||||
'devices': ("List of device mappings. Uses the same format as the `--device` docker client create option."), |
||||
'dns': ("Custom DNS servers. Can be a single value or a list."), |
||||
'dns_search': ("Custom DNS search domains. Can be a single value or a list."), |
||||
'dockerfile': ("Alternate Dockerfile. Compose will use an alternate file to build with. Using `dockerfile` together with `image` is not allowed. Attempting to do so results in an error."), |
||||
'domainname': ("Container domain name."), |
||||
'entrypoint': ("Overwrite the default ENTRYPOINT of the image."), |
||||
'env_file': ("Add environment variables from a file. Can be a single value or a list.\n\n" + |
||||
"If you have specified a Compose file with `docker-compose -f FILE`, paths in `env_file` are relative to the directory that file is in.\n\n" + |
||||
"Environment variables specified in `environment` override these values."), |
||||
'environment': ("Add environment variables. You can use either an array or a dictionary.\n\n" + |
||||
"Environment variables with only a key are resolved to their values on the machine Compose is running on, which can be helpful for secret or host-specific values."), |
||||
'expose': ("Expose ports without publishing them to the host machine - they'll only be accessible to linked services. \n" + |
||||
"Only the internal port can be specified."), |
||||
'extends': ("Extend another service, in the current file or another, optionally overriding configuration.\nYou can use `extends` on any service together with other configuration keys. " + |
||||
"The `extends` value must be a dictionary defined with a required `service` and an optional `file` key."), |
||||
'external_links': ("Link to containers started outside this `docker-compose.yml` or even outside of Compose, especially for containers that " + |
||||
"provide shared or common services. `external_links` follow " + |
||||
"semantics similar to `links` when specifying both the container name and the link alias (`CONTAINER:ALIAS`)."), |
||||
'extra_hosts': ("Add hostname mappings. Use the same values as the docker client `--add-host` parameter."), |
||||
'hostname': ("Container host name."), |
||||
'image': ("Tag or partial image ID. Can be local or remote - Compose will attempt to pull if it doesn't exist locally."), |
||||
'ipc': ("IPC namespace to use."), |
||||
'labels': ("Add metadata to containers using Docker labels. You can either use an array or a dictionary.\n" + |
||||
"It's recommended that you use reverse-DNS notation to prevent your labels from conflicting with those used by other software."), |
||||
'links': ("Link to containers in another service. Either specify both the service name and the link alias (`CONTAINER:ALIAS`), or " + |
||||
"just the service name (which will also be used for the alias)."), |
||||
'mac_address': ("Container MAC address (e.g. 92:d0:c6:0a:29:33)."), |
||||
'mem_limit': ("Memory limit."), |
||||
'memswap_limit': ("Swap limit equal to memory plus swap: '-1' to enable unlimited swap."), |
||||
'mem_swappiness': ("Tune container memory swappiness (0 to 100) (default -1)."), |
||||
'pid': ("Sets the PID mode to the host PID mode. This turns on sharing between container and the host operating system the PID address space. " + |
||||
"Containers launched with this flag will be able to access and manipulate other containers in the bare-metal machine's namespace and vise-versa."), |
||||
'ports': ("Expose ports. Either specify both ports (`HOST:CONTAINER`), or just the container port (a random host port will be chosen).\n\n" + |
||||
"**Note**: When mapping ports in the `HOST:CONTAINER` format, you may experience erroneous results when using a container port " + |
||||
"lower than 60, because YAML will parse numbers in the format `xx:yy` as sexagesimal (base 60). For this reason, we recommend " + |
||||
"always explicitly specifying your port mappings as strings."), |
||||
'privileged': ("Give extended privileges to this container."), |
||||
'read_only': ("Mount the container's root filesystem as read only."), |
||||
'restart': ("Restart policy to apply when a container exits (default \"no\")."), |
||||
'security_opt': ("Override the default labeling scheme for each container."), |
||||
'shm_size': ("Size of /dev/shm, default value is 64MB."), |
||||
'stdin_open': ("Keep STDIN open even if not attached."), |
||||
'stop_signal': ("Signal to stop a container, SIGTERM by default."), |
||||
'tty': ("Allocate a pseudo-TTY."), |
||||
'ulimits': ("Override the default ulimits for a container. You can either specify a single limit as an integer or soft/hard limits as a mapping."), |
||||
'user': ("Username or UID (format: <name|uid>[:<group|gid>])."), |
||||
'version': ("Specify the compose format that this file conforms to. Omit this property to indicate v1, otherwise, set this to `2`."), |
||||
'volumes': ("Mount paths as volumes, optionally specifying a path on the host machine (`HOST:CONTAINER`), or an access mode (`HOST:CONTAINER:ro`)."), |
||||
'volume_driver': ("If you use a volume name (instead of a volume path), you may also specify a `volume_driver`."), |
||||
'volumes_from': ("Mount all of the volumes from another service or container."), |
||||
'working_dir': ("Working directory inside the container.") |
||||
}; |
||||
// Define the keys which are unique to the v1 format, and were deprecated in v2+.
|
||||
// https://github.com/docker/compose/blob/master/compose/config/config_schema_v1.json
|
||||
const DOCKER_COMPOSE_V1_KEY_INFO = { |
||||
'log_driver': ("Specify a logging driver for the service's containers, as with the `--log-driver` option for docker run. The default value is json-file."), |
||||
'log_opt': ("Specify logging options with `log_opt` for the logging driver, as with the `--log-opt` option for docker run."), |
||||
'net': ("Networking mode. Use the same values as the docker client `--net` parameter.") |
||||
}; |
||||
// Define the keys which are shared with all v2+ compose file versions, but weren't defined in v1.
|
||||
// https://github.com/docker/compose/blob/master/compose/config/config_schema_v2.0.json
|
||||
const DOCKER_COMPOSE_V2_KEY_INFO = { |
||||
// Added top-level properties
|
||||
'services': ("Specify the set of services that your app is composed of."), |
||||
// TODO: There is now a top-level and service-level volumes/networks setting which conflict.
|
||||
// This will be resolved when we add completion that understands file position context.
|
||||
'networks': ("Specifies the networks to be created as part of your app. This is analogous to running `docker network create`."), |
||||
'volumes': ("Specifies the volumes to be created as part of your app. This is analogous to running `docker volume create`."), |
||||
// Added service-level properties
|
||||
'depends_on': ("Specifies the names of services that this service depends on."), |
||||
'logging': ("Logging configuration for the service."), |
||||
'network_mode': ("Networking mode. Use the same values as the docker client `--net` parameter."), |
||||
'tmpfs': ("Mount a temporary file system inside the container. Can be a single value or a list."), |
||||
// Modified service-level properties
|
||||
'build': ("Configuration options that are applied at build time. Can be specified either as a string containing a path to the build context, or an object with the path specified under `context` and optionally `dockerfile` and `args`."), |
||||
// Added service/logging-level properties
|
||||
// TODO: The "driver" property could be a logging driver, a volume driver,
|
||||
// a network driver, or a network IPAM driver, so we should account for
|
||||
// that when we add context-based completion.
|
||||
'driver': ("Specifies the logging driver to use for the service’s container."), |
||||
'options': ('Options to pass to the specified logging driver, provided as key-value pairs.'), |
||||
// Added service/build-level properties
|
||||
'args': ("Add build arguments, which are environment variables accessible only during the build process."), |
||||
'context': ("Either a path to a directory containing a Dockerfile, or a url to a git repository. This directory will be used as the build context that is sent to the Docker daemon."), |
||||
// Added service/network-level properties
|
||||
'aliases': ("Alternative hostnames for this service on the network. Other containers on the same network can use either the service name or this alias to connect to one of the service’s containers."), |
||||
'ipv4_address': ("Specify a static IPv4 address for containers for this service when joining the network."), |
||||
'ipv6_address': ("Specify a static IPv6 address for containers for this service when joining the network."), |
||||
// Network-level properties
|
||||
'driver_opts': ("Specify a list of options as key-value pairs to pass to the driver. Those options are driver-dependent - consult the driver’s documentation for more information."), |
||||
'external': ("If set to true, specifies that this network has been created outside of Compose. `docker-compose up` will not attempt to create it, and will raise an error if it doesn’t exist."), |
||||
'ipam': ("Specify custom IPAM config"), |
||||
// Network/external-level properties
|
||||
// TODO: This would also apply to an external volume,
|
||||
// so we should account for that when we add context-based completion.
|
||||
'name': ("Specifies the name of the externally defined network."), |
||||
// Network/ipam-level properties
|
||||
'config': ("A list with zero or more config blocks."), |
||||
// Network/ipam/config-level properties
|
||||
'aux_addresses': ("Auxiliary IPv4 or IPv6 addresses used by Network driver, as a mapping from hostname to IP."), |
||||
'gateway': ("IPv4 or IPv6 gateway for the master subnet."), |
||||
'ip_range': ("Range of IPs from which to allocate container IPs."), |
||||
'subnet': ("Subnet in CIDR format that represents a network segment."), |
||||
}; |
||||
// Define the keys which were introduced in the v2.1 format.
|
||||
// https://github.com/docker/compose/blob/master/compose/config/config_schema_v2.1.json
|
||||
const DOCKER_COMPOSE_V2_1_KEY_INFO = { |
||||
// Added service-level properties
|
||||
'group_add': ("Specifies additional groups to join"), |
||||
'isolation': ("Container isolation technology"), |
||||
'oom_score_adj': ("Tune host's OOM preferences (-1000 to 1000)"), |
||||
// Added service/network-level properties
|
||||
'link_local_ips': ("List of IPv4/IPv6 link-local addresses for the container"), |
||||
// Added network-level properties
|
||||
'internal': ("Restrict external access to the network"), |
||||
'enable_ipv6': ("Enable IPv6 networking") |
||||
// Note that in v2.1, networks and volumes can now accept a "labels",
|
||||
// property, however, this label is already defined for services
|
||||
// in the v2.0 format, so we don't need to re-define it.
|
||||
}; |
||||
// Define the keys which were introduced in the v2.2 format.
|
||||
// https://github.com/docker/compose/blob/master/compose/config/config_schema_v2.2.json
|
||||
const DOCKER_COMPOSE_V2_2_KEY_INFO = { |
||||
// Added service-level properties
|
||||
'cpu_count': ("Number of usable CPUs (Windows only)"), |
||||
'cpu_percent': ("Usable percentage of the available CPUs (Windows only)"), |
||||
'cpus': ("CPU quota in number of CPUs") |
||||
}; |
||||
// Helper function that merges the specified version-specific keys with the shared
|
||||
// keys, in order to create a complete schema for a specic version.
|
||||
function mergeWithSharedKeys(...versions) { |
||||
return Object.assign({}, DOCKER_COMPOSE_SHARED_KEY_INFO, ...versions); |
||||
} |
||||
exports.default = { |
||||
v1: mergeWithSharedKeys(DOCKER_COMPOSE_V1_KEY_INFO), |
||||
v2: mergeWithSharedKeys(DOCKER_COMPOSE_V2_KEY_INFO), |
||||
"v2.1": mergeWithSharedKeys(DOCKER_COMPOSE_V2_KEY_INFO, DOCKER_COMPOSE_V2_1_KEY_INFO), |
||||
"v2.2": mergeWithSharedKeys(DOCKER_COMPOSE_V2_KEY_INFO, DOCKER_COMPOSE_V2_1_KEY_INFO, DOCKER_COMPOSE_V2_2_KEY_INFO), |
||||
All: mergeWithSharedKeys(DOCKER_COMPOSE_V1_KEY_INFO, DOCKER_COMPOSE_V2_KEY_INFO, DOCKER_COMPOSE_V2_1_KEY_INFO, DOCKER_COMPOSE_V2_2_KEY_INFO) |
||||
}; |
||||
//# sourceMappingURL=dockerComposeKeyInfo.js.map
|
@ -0,0 +1,3 @@
@@ -0,0 +1,3 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
//# sourceMappingURL=types.js.map
|
@ -0,0 +1,30 @@
@@ -0,0 +1,30 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
exports.activate = void 0; |
||||
const tslib_1 = require("tslib"); |
||||
const path_1 = tslib_1.__importDefault(require("path")); |
||||
const coc_nvim_1 = require("coc.nvim"); |
||||
const dockerComposeCompletionItemProvider_1 = require("./dockerCompose/dockerComposeCompletionItemProvider"); |
||||
async function activate(context) { |
||||
const config = coc_nvim_1.workspace.getConfiguration().get('docker', {}); |
||||
if (config.enable === false) { |
||||
return; |
||||
} |
||||
const serverModule = require.resolve('dockerfile-language-server-nodejs/lib/server.js'); |
||||
const serverOptions = { |
||||
module: serverModule, |
||||
transport: coc_nvim_1.TransportKind.ipc, |
||||
args: ["--node-ipc"] |
||||
}; |
||||
const clientOptions = { |
||||
documentSelector: ['Dockerfile', 'dockerfile'] |
||||
}; |
||||
const client = new coc_nvim_1.LanguageClient("docker", "dockerfile-language-server-nodejs", serverOptions, clientOptions); |
||||
context.subscriptions.push(coc_nvim_1.services.registLanguageClient(client), coc_nvim_1.commands.registerCommand("docker.version", async () => { |
||||
const v = require(path_1.default.resolve(__dirname, '..', 'package.json')).version; |
||||
coc_nvim_1.window.showMessage(`Version: ${v}`, 'more'); |
||||
})); |
||||
context.subscriptions.push(coc_nvim_1.languages.registerCompletionItemProvider('docker-compose', 'docker', 'yaml.docker-compose', new dockerComposeCompletionItemProvider_1.DockerComposeCompletionItemProvider())); |
||||
} |
||||
exports.activate = activate; |
||||
//# sourceMappingURL=extension.js.map
|
@ -0,0 +1,121 @@
@@ -0,0 +1,121 @@
|
||||
/*--------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Microsoft Corporation. All rights reserved. |
||||
* Licensed under the MIT License. See LICENSE.md in the project root for license information. |
||||
*--------------------------------------------------------------------------------------------*/ |
||||
'use strict'; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
exports.SuggestSupportHelper = void 0; |
||||
const tslib_1 = require("tslib"); |
||||
const fs_1 = tslib_1.__importDefault(require("fs")); |
||||
const path_1 = tslib_1.__importDefault(require("path")); |
||||
const coc_nvim_1 = require("coc.nvim"); |
||||
const https_1 = require("https"); |
||||
const pkg = JSON.parse(fs_1.default.readFileSync(path_1.default.join(__dirname, '..', '..', 'package.json'), 'utf-8')); |
||||
class SuggestSupportHelper { |
||||
async suggestImages(word) { |
||||
const results = await searchImagesInRegistryHub(word, true); |
||||
return results.map((image) => { |
||||
const stars = image.star_count > 0 |
||||
? [`${image.star_count} ${image.star_count > 1 ? 'stars' : 'star'}`] |
||||
: []; |
||||
return { |
||||
label: image.name, |
||||
kind: coc_nvim_1.CompletionItemKind.Value, |
||||
detail: tagsForImage(image).concat(stars).join(' '), |
||||
insertText: image.name, |
||||
documentation: image.description, |
||||
}; |
||||
}); |
||||
} |
||||
} |
||||
exports.SuggestSupportHelper = SuggestSupportHelper; |
||||
function tagsForImage(image) { |
||||
const tags = []; |
||||
if (image.is_automated) { |
||||
tags.push('Automated'); |
||||
} |
||||
else if (image.is_trusted) { |
||||
tags.push('Trusted'); |
||||
} |
||||
else if (image.is_official) { |
||||
tags.push('Official'); |
||||
} |
||||
return tags.map(t => `[${t}]`); |
||||
} |
||||
const popular = [ |
||||
{ "is_automated": false, "name": "redis", "is_trusted": false, "is_official": true, "star_count": 1300, "description": "Redis is an open source key-value store that functions as a data structure server." }, |
||||
{ "is_automated": false, "name": "ubuntu", "is_trusted": false, "is_official": true, "star_count": 2600, "description": "Ubuntu is a Debian-based Linux operating system based on free software." }, |
||||
{ "is_automated": false, "name": "wordpress", "is_trusted": false, "is_official": true, "star_count": 582, "description": "The WordPress rich content management system can utilize plugins, widgets, and themes." }, |
||||
{ "is_automated": false, "name": "mysql", "is_trusted": false, "is_official": true, "star_count": 1300, "description": "MySQL is a widely used, open-source relational database management system (RDBMS)." }, |
||||
{ "is_automated": false, "name": "mongo", "is_trusted": false, "is_official": true, "star_count": 1100, "description": "MongoDB document databases provide high availability and easy scalability." }, |
||||
{ "is_automated": false, "name": "centos", "is_trusted": false, "is_official": true, "star_count": 1600, "description": "The official build of CentOS." }, |
||||
{ "is_automated": false, "name": "node", "is_trusted": false, "is_official": true, "star_count": 1200, "description": "Node.js is a JavaScript-based platform for server-side and networking applications." }, |
||||
{ "is_automated": false, "name": "nginx", "is_trusted": false, "is_official": true, "star_count": 1600, "description": "Official build of Nginx." }, |
||||
{ "is_automated": false, "name": "postgres", "is_trusted": false, "is_official": true, "star_count": 1200, "description": "The PostgreSQL object-relational database system provides reliability and data integrity." }, |
||||
{ "is_automated": true, "name": "microsoft/aspnet", "is_trusted": true, "is_official": false, "star_count": 277, "description": "ASP.NET is an open source server-side Web application framework" } |
||||
]; |
||||
async function searchImagesInRegistryHub(prefix, cache) { |
||||
if (prefix.length === 0) { |
||||
// return the popular images if user invoked intellisense
|
||||
// right after typing the keyword and ':' (e.g. 'image:').
|
||||
return Promise.resolve(popular.slice(0)); |
||||
} |
||||
// Do an image search on Docker hub and return the results
|
||||
return (await invokeHubSearch(prefix, 100, cache)).results; |
||||
} |
||||
// https://registry.hub.docker.com/v1/search?q=redis&n=1
|
||||
// {
|
||||
// "num_pages": 10,
|
||||
// "num_results": 10,
|
||||
// "results": [
|
||||
// {
|
||||
// "is_automated": false,
|
||||
// "name": "redis",
|
||||
// "is_trusted": false,
|
||||
// "is_official": true,
|
||||
// "star_count": 830,
|
||||
// "description": "Redis is an open source key-value store that functions as a data structure server."
|
||||
// }
|
||||
// ],
|
||||
// "page_size": 1,
|
||||
// "query": "redis",
|
||||
// "page": 1
|
||||
// }
|
||||
function invokeHubSearch(imageName, count, cache) { |
||||
// https://registry.hub.docker.com/v1/search?q=redis&n=1
|
||||
return httpsRequestJson({ |
||||
hostname: 'registry.hub.docker.com', |
||||
port: 443, |
||||
path: '/v1/search?q=' + encodeURIComponent(imageName) + '&n=' + count, |
||||
method: 'GET', |
||||
}, cache); |
||||
} |
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const JSON_CACHE = {}; |
||||
function httpsRequestJson(opts, cache) { |
||||
if (!cache) { |
||||
return doHttpsRequestJson(opts); |
||||
} |
||||
const cacheKey = `${opts.method} ${opts.hostname} ${opts.path}`; |
||||
if (!JSON_CACHE[cacheKey]) { |
||||
JSON_CACHE[cacheKey] = doHttpsRequestJson(opts); |
||||
} |
||||
// new promise to avoid cancelling
|
||||
return new Promise((resolve, reject) => JSON_CACHE[cacheKey].then(resolve, reject)); |
||||
} |
||||
async function doHttpsRequestJson(opts) { |
||||
opts.headers = Object.assign(Object.assign({}, opts.headers), { 'Accept': 'application/json', 'User-Agent': `coc-docker/${pkg.version}` }); |
||||
return JSON.parse(await httpsRequest(opts)); |
||||
} |
||||
async function httpsRequest(opts) { |
||||
return new Promise((resolve, reject) => { |
||||
const req = https_1.request(opts, (res) => { |
||||
let data = ''; |
||||
res.on('data', (d) => data += d); |
||||
res.on('end', () => resolve(data)); |
||||
}); |
||||
req.end(); |
||||
req.on('error', reject); |
||||
}); |
||||
} |
||||
//# sourceMappingURL=suggestSupportHelper.js.map
|
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
../dockerfile-language-server-nodejs/bin/docker-langserver |
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
../dockerfile-utils/bin/dockerfile-utils |
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
../vscode-languageserver/bin/installServerIntoExtension |
@ -0,0 +1,102 @@
@@ -0,0 +1,102 @@
|
||||
{ |
||||
"name": "coc-docker", |
||||
"version": "0.5.0", |
||||
"lockfileVersion": 2, |
||||
"requires": true, |
||||
"packages": { |
||||
"node_modules/dockerfile-ast": { |
||||
"version": "0.1.0", |
||||
"resolved": "https://registry.npmjs.org/dockerfile-ast/-/dockerfile-ast-0.1.0.tgz", |
||||
"integrity": "sha512-qKftHMVoMliYBaYLkgttm+NXhRISVNkIMfAL4ecmXjiWRElfdfY+xNgITiehG0LpUEDbFUa/UDCByYq/2UZIpQ==", |
||||
"dependencies": { |
||||
"vscode-languageserver-types": "^3.16.0" |
||||
}, |
||||
"engines": { |
||||
"node": "*" |
||||
} |
||||
}, |
||||
"node_modules/dockerfile-language-server-nodejs": { |
||||
"version": "0.2.2", |
||||
"resolved": "https://registry.npmjs.org/dockerfile-language-server-nodejs/-/dockerfile-language-server-nodejs-0.2.2.tgz", |
||||
"integrity": "sha512-PdDtFhzVywa2bZK6OFQhIPMSNPNJQa03Ri3ONxBJpxtOwtAaDSnh95iGj/bdPqQLJGoj1Y/yTheDTxLOTTe5JA==", |
||||
"dependencies": { |
||||
"dockerfile-language-service": "0.1.1", |
||||
"dockerfile-utils": "0.1.1", |
||||
"vscode-languageserver": "^7.0.0" |
||||
}, |
||||
"bin": { |
||||
"docker-langserver": "bin/docker-langserver" |
||||
}, |
||||
"engines": { |
||||
"node": "*" |
||||
} |
||||
}, |
||||
"node_modules/dockerfile-language-service": { |
||||
"version": "0.1.1", |
||||
"resolved": "https://registry.npmjs.org/dockerfile-language-service/-/dockerfile-language-service-0.1.1.tgz", |
||||
"integrity": "sha512-Lw4QlxJoy9F1559wxX+0xe5iSNK95Fbzx/YhdmAzfwgbPvdPzvFouIuuMyMPj/Q5JyFH1QAr7VeagOe24w0cqg==", |
||||
"dependencies": { |
||||
"dockerfile-ast": "0.1.0", |
||||
"dockerfile-utils": "0.1.1", |
||||
"vscode-languageserver-protocol": "^3.16.0", |
||||
"vscode-languageserver-types": "^3.16.0" |
||||
}, |
||||
"engines": { |
||||
"node": "*" |
||||
} |
||||
}, |
||||
"node_modules/dockerfile-utils": { |
||||
"version": "0.1.1", |
||||
"resolved": "https://registry.npmjs.org/dockerfile-utils/-/dockerfile-utils-0.1.1.tgz", |
||||
"integrity": "sha512-ddAA8PCAcT4pBQ1AFRnPjetJ31/7BqNKLHQkZebNE0hBAiOr8SzrnIWvJUcBDHrVbASCVl1Ye37hbaTsUmYHsw==", |
||||
"dependencies": { |
||||
"dockerfile-ast": "0.1.0", |
||||
"vscode-languageserver-types": "^3.16.0" |
||||
}, |
||||
"bin": { |
||||
"dockerfile-utils": "bin/dockerfile-utils" |
||||
}, |
||||
"engines": { |
||||
"node": "*" |
||||
} |
||||
}, |
||||
"node_modules/tslib": { |
||||
"version": "2.3.0", |
||||
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.0.tgz", |
||||
"integrity": "sha512-N82ooyxVNm6h1riLCoyS9e3fuJ3AMG2zIZs2Gd1ATcSFjSA23Q0fzjjZeh0jbJvWVDZ0cJT8yaNNaaXHzueNjg==" |
||||
}, |
||||
"node_modules/vscode-jsonrpc": { |
||||
"version": "6.0.0", |
||||
"resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-6.0.0.tgz", |
||||
"integrity": "sha512-wnJA4BnEjOSyFMvjZdpiOwhSq9uDoK8e/kpRJDTaMYzwlkrhG1fwDIZI94CLsLzlCK5cIbMMtFlJlfR57Lavmg==", |
||||
"engines": { |
||||
"node": ">=8.0.0 || >=10.0.0" |
||||
} |
||||
}, |
||||
"node_modules/vscode-languageserver": { |
||||
"version": "7.0.0", |
||||
"resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-7.0.0.tgz", |
||||
"integrity": "sha512-60HTx5ID+fLRcgdHfmz0LDZAXYEV68fzwG0JWwEPBode9NuMYTIxuYXPg4ngO8i8+Ou0lM7y6GzaYWbiDL0drw==", |
||||
"dependencies": { |
||||
"vscode-languageserver-protocol": "3.16.0" |
||||
}, |
||||
"bin": { |
||||
"installServerIntoExtension": "bin/installServerIntoExtension" |
||||
} |
||||
}, |
||||
"node_modules/vscode-languageserver-protocol": { |
||||
"version": "3.16.0", |
||||
"resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.16.0.tgz", |
||||
"integrity": "sha512-sdeUoAawceQdgIfTI+sdcwkiK2KU+2cbEYA0agzM2uqaUy2UpnnGHtWTHVEtS0ES4zHU0eMFRGN+oQgDxlD66A==", |
||||
"dependencies": { |
||||
"vscode-jsonrpc": "6.0.0", |
||||
"vscode-languageserver-types": "3.16.0" |
||||
} |
||||
}, |
||||
"node_modules/vscode-languageserver-types": { |
||||
"version": "3.16.0", |
||||
"resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.16.0.tgz", |
||||
"integrity": "sha512-k8luDIWJWyenLc5ToFQQMaSrqCHiLwyKPHKPQZ5zz21vM+vIVUSvsRpcbiECH4WR88K2XZqc4ScRcZ7nk/jbeA==" |
||||
} |
||||
} |
||||
} |
@ -0,0 +1,22 @@
@@ -0,0 +1,22 @@
|
||||
name: Node.js Builds |
||||
on: [push] |
||||
jobs: |
||||
build: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
matrix: |
||||
node-version: [10.x, 12.x, 14.x] |
||||
steps: |
||||
- uses: actions/checkout@v2 |
||||
- name: Use Node.js ${{ matrix.node-version }} |
||||
uses: actions/setup-node@v1 |
||||
with: |
||||
node-version: ${{ matrix.node-version }} |
||||
- name: Build |
||||
run: | |
||||
npm install |
||||
npm run build |
||||
- name: Test |
||||
run: | |
||||
npm install coveralls --save-dev |
||||
npm run nyc-ci |
@ -0,0 +1,315 @@
@@ -0,0 +1,315 @@
|
||||
# Changelog |
||||
All notable changes to this project will be documented in this file. |
||||
|
||||
## [0.1.0] - 2020-12-24 |
||||
### Added |
||||
- `Property` |
||||
- `getAssignmentOperator()` ([#86](https://github.com/rcjsuen/dockerfile-ast/issues/86)) |
||||
- `getAssignmentOperatorRange()` ([#86](https://github.com/rcjsuen/dockerfile-ast/issues/86)) |
||||
|
||||
## [0.0.30] - 2020-07-14 |
||||
### Fixed |
||||
- do not consider a single escape character as being an argument for the instruction ([#83](https://github.com/rcjsuen/dockerfile-ast/issues/83)) |
||||
- do not consider a single escape character as being a property for an instruction ([#84](https://github.com/rcjsuen/dockerfile-ast/issues/84)) |
||||
|
||||
## [0.0.29] - 2020-07-12 |
||||
### Fixed |
||||
- ignore leading whitespace before a comment in escaped newlines for `getArgumentsContent()` and `getArgumentsRanges()` of `Instruction` ([#82](https://github.com/rcjsuen/dockerfile-ast/issues/82)) |
||||
|
||||
## [0.0.28] - 2020-07-11 |
||||
### Fixed |
||||
- improve handling of trailing whitespace that is not a newline character after an escape character ([#81](https://github.com/rcjsuen/dockerfile-ast/issues/81)) |
||||
|
||||
## [0.0.27] - 2020-06-17 |
||||
### Fixed |
||||
- allow comments to immediately follow the declaration of an ARG or ENV instruction ([#80](https://github.com/rcjsuen/dockerfile-ast/issues/80)) |
||||
|
||||
## [0.0.26] - 2020-04-22 |
||||
### Fixed |
||||
- correct range of multiline arguments that end with a character preceded by an escape character ([#78](https://github.com/rcjsuen/dockerfile-ast/issues/78)) |
||||
- correct range of arguments that are split on multiple lines with escaped whitespace lines in between ([#77](https://github.com/rcjsuen/dockerfile-ast/issues/77)) |
||||
- enable parsing of flag options that do not have a value defined ([#79](https://github.com/rcjsuen/dockerfile-ast/issues/79)) |
||||
|
||||
## [0.0.25] - 2020-04-01 |
||||
### Added |
||||
- `Flag` |
||||
- `getOptions()` ([#75](https://github.com/rcjsuen/dockerfile-ast/issues/75)) |
||||
- `getOption(string)` ([#75](https://github.com/rcjsuen/dockerfile-ast/issues/75)) |
||||
- `hasOptions()` ([#75](https://github.com/rcjsuen/dockerfile-ast/issues/75)) |
||||
- `FlagOption` ([#75](https://github.com/rcjsuen/dockerfile-ast/issues/75)) |
||||
- `Run` ([#76](https://github.com/rcjsuen/dockerfile-ast/issues/76)) |
||||
- `RUN` instructions will now of type `Run` instead of `JSONInstruction` |
||||
- `Run` extends `JSONInstruction` so this is not be a breaking change |
||||
|
||||
### Fixed |
||||
- allow `From`'s `getBuildStage()` and `getBuildStageRange()` to return non-`null` values even if the instruction has more than three arguments as long as parts of it is valid ([#74](https://github.com/rcjsuen/dockerfile-ast/issues/74)) |
||||
|
||||
## [0.0.24] - 2020-03-08 |
||||
### Fixed |
||||
- `Instruction`'s `getArguments()` will no longer exclude arguments that follow an embedded comment that ends with the escape character ([#73](https://github.com/rcjsuen/dockerfile-ast/issues/73)) |
||||
|
||||
## [0.0.23] - 2020-03-08 |
||||
### Fixed |
||||
- `Instruction`'s `getArguments()` will no longer incorrectly exclude arguments because they look like comments ([#72](https://github.com/rcjsuen/dockerfile-ast/issues/72)) |
||||
|
||||
## [0.0.22] - 2020-03-07 |
||||
### Fixed |
||||
- instructions will no longer be cut off prematurely due to empty continuation lines embedded in the keyword itself ([#70](https://github.com/rcjsuen/dockerfile-ast/issues/70)) |
||||
- `Instruction`'s `getArguments()` will now correctly account for multiple embedded comments instead of considering them as an argument ([#71](https://github.com/rcjsuen/dockerfile-ast/issues/71)) |
||||
|
||||
## [0.0.21] - 2020-02-27 |
||||
### Fixed |
||||
- `Instruction`'s `getArgumentsRanges()` will no longer throw an error if an instruction spans multiple lines and has escaped newlines at the beginning of a line ([#67](https://github.com/rcjsuen/dockerfile-ast/issues/67)) |
||||
- `ModifiableInstruction`'s `toString()` will now include the instruction's flags ([#68](https://github.com/rcjsuen/dockerfile-ast/issues/68)) |
||||
- `ModifiableInstruction`'s `getVariables()` will now include variables that are used in the instruction's flags ([#69](https://github.com/rcjsuen/dockerfile-ast/issues/69)) |
||||
|
||||
## [0.0.20] - 2020-02-11 |
||||
### Added |
||||
- `Dockerfile` |
||||
- `getDirectives()` ([#62](https://github.com/rcjsuen/dockerfile-ast/issues/62)) |
||||
- originally introduced in 0.0.18 to support compatibility in the future, the function is now fully implemented and will return an ordered list of all the parser directives defined at the top of the Dockerfile |
||||
|
||||
- `Directive` |
||||
- `syntax` ([#63](https://github.com/rcjsuen/dockerfile-ast/issues/63)) |
||||
- this enum can be used for identifying the `syntax` parser directive used by BuildKit |
||||
|
||||
### Changed |
||||
- `ParserDirective` |
||||
- `getDirective()` ([#63](https://github.com/rcjsuen/dockerfile-ast/issues/63)) |
||||
- this function originally stated that it would return a `Directive` |
||||
- `undefined` would be returned if the name of the parser directive was not recognized |
||||
- the function now returns `Directive | null` |
||||
- the function will return `null` if the parser directive is not recognized instead of `undefined` |
||||
|
||||
### Fixed |
||||
- `Instruction`'s `getArgumentsRanges()` will no longer throw an error if the instruction has its last argument on its own line with no leading whitespace and the length of that argument is one ([#66](https://github.com/rcjsuen/dockerfile-ast/issues/66)) |
||||
|
||||
## [0.0.19] - 2020-01-27 |
||||
### Added |
||||
- `From` |
||||
- `getPlatformFlag()` ([#65](https://github.com/rcjsuen/dockerfile-ast/issues/65)) |
||||
|
||||
### Changed |
||||
- `From` |
||||
- this class now subclasses `ModifiableInstruction` instead of `Instruction` ([#65](https://github.com/rcjsuen/dockerfile-ast/issues/65)) |
||||
- this was changed to support the `--platform` flag introduced in Docker CE 18.04 |
||||
- as `ModifiableInstruction` extends `Instruction`, this should not impact anyone at an API level from a compilation standpoint |
||||
- note that this will break users that previously used `getArguments()` to parse and retrieve the `--platform` flag manually, please replace such usages with the new `getPlatformFlag()` API |
||||
|
||||
## [0.0.18] - 2019-12-07 |
||||
### Added |
||||
- `Dockerfile` |
||||
- `getDirectives()` ([#64](https://github.com/rcjsuen/dockerfile-ast/issues/64)) |
||||
|
||||
### Changed |
||||
- `getDirective()` of `Dockerfile` has been deprecated and will be replaced by `getDirectives()` in the future ([#64](https://github.com/rcjsuen/dockerfile-ast/issues/64)) |
||||
- note that this is purely a cosmetic API change to facilitate migration at the moment, proper support for returning an array will follow in the future |
||||
|
||||
### Fixed |
||||
- add support for TypeScript 3.7 by fixing TS2440 compiler error ([#61](https://github.com/rcjsuen/dockerfile-ast/issues/61)) |
||||
|
||||
## [0.0.17] - 2019-10-13 |
||||
### Fixed |
||||
- correct parsing of image names that were incorrectly identified as a Docker registry ([#59](https://github.com/rcjsuen/dockerfile-ast/issues/59)) |
||||
|
||||
## [0.0.16] - 2019-05-22 |
||||
### Fixed |
||||
- only allow alphanumeric and underscore characters in variable names ([#58](https://github.com/rcjsuen/dockerfile-ast/issues/58)) |
||||
|
||||
## [0.0.15] - 2019-05-21 |
||||
### Fixed |
||||
- variables in `FROM` should return `true` for `isDefined()` if it is defined in the `ARG` instructions above it ([#56](https://github.com/rcjsuen/dockerfile-ast/issues/56)) |
||||
- variables in `FROM` should return `true` for `isBuildVariable()` if it is defined in the `ARG` instructions above it ([#57](https://github.com/rcjsuen/dockerfile-ast/issues/57)) |
||||
|
||||
## [0.0.14] - 2019-04-28 |
||||
### Added |
||||
- `ImageTemplate` |
||||
- `getRange()` ([#53](https://github.com/rcjsuen/dockerfile-ast/issues/53)) |
||||
|
||||
### Changed |
||||
- the enum value for `Keyword.ADD` was incorrectly assigned to `"ARG"`, it is now assigned to `"ADD"` ([#51](https://github.com/rcjsuen/dockerfile-ast/issues/51)) |
||||
- this is a breaking change but presumably no consumers were relying on this incorrect behaviour |
||||
- `Dockerfile`'s `getContainingImage()` has been changed for comments immediately before a build stage |
||||
- previously, they would return the build stage that came after the comment, now they will simply return the entire Dockerfile |
||||
- this is because the comment is actually ambiguous as it may be a commented out instruction for the build stage that came before the comment |
||||
|
||||
### Fixed |
||||
- correct incorrectly assigned string enum value for `Keyword.ADD` ([#51](https://github.com/rcjsuen/dockerfile-ast/issues/51)) |
||||
- ensure quotation marks and apostrophes are included for expanded arguments in `Instruction`'s `getExpandedArguments()` if they surround a variable ([#52](https://github.com/rcjsuen/dockerfile-ast/issues/52)) |
||||
- fixed `getComments()` for build stages so that they will not simply return empty arrays ([#54](https://github.com/rcjsuen/dockerfile-ast/issues/54)) |
||||
- the returned comments will only be from comments contained within the `FROM` instruction and the last instruction of that build stage |
||||
|
||||
## [0.0.13] - 2018-12-20 |
||||
### Fixed |
||||
- prevent TypeError from being thrown by `Dockerfile`'s `resolveVariable(string, number)` when an invalid line number is provided ([#48](https://github.com/rcjsuen/dockerfile-ast/issues/48)) |
||||
- correct compiler error due to incomplete interface signature ([#46](https://github.com/rcjsuen/dockerfile-ast/issues/46)) |
||||
|
||||
## [0.0.12] - 2018-08-10 |
||||
### Fixed |
||||
- handle quoted properties on separate lines properly for `ENV`s and `LABEL`s ([#44](https://github.com/rcjsuen/dockerfile-ast/issues/45)) |
||||
|
||||
## [0.0.11] - 2018-06-16 |
||||
### Fixed |
||||
- ignore initial `ENV`s when resolving variables in `FROM`s ([#44](https://github.com/rcjsuen/dockerfile-ast/issues/44)) |
||||
|
||||
## [0.0.10] - 2018-06-16 |
||||
### Added |
||||
- `From` |
||||
- `getImageRange()` ([#43](https://github.com/rcjsuen/dockerfile-ast/issues/43)) |
||||
- `getImageTag()` ([#43](https://github.com/rcjsuen/dockerfile-ast/issues/43)) |
||||
- `getImageDigest()` ([#43](https://github.com/rcjsuen/dockerfile-ast/issues/43)) |
||||
- `getRegistry()` ([#43](https://github.com/rcjsuen/dockerfile-ast/issues/43)) |
||||
- `getRegistryRange()` ([#43](https://github.com/rcjsuen/dockerfile-ast/issues/43)) |
||||
|
||||
### Changed |
||||
- [upgraded the dependency of Mocha](https://github.com/mochajs/mocha/issues/2791) from 3.x to 5.x |
||||
- versions prior to 4.x of Mocha dependended on Growl 1.9.2 which contained a [security vulnerability](https://github.com/tj/node-growl/issues/60) |
||||
- as Mocha is a `devDependencies` module, there is no reason to believe that the `dockerfile-ast` module itself was affected by this vulnerability |
||||
|
||||
### Fixed |
||||
- do not resolve reinitialized `ARG` variables with `ENV` instructions at the top of the Dockerfile ([#42](https://github.com/rcjsuen/dockerfile-ast/issues/42)) |
||||
- improve parsing of `FROM` instructions that refer to variables ([#39](https://github.com/rcjsuen/dockerfile-ast/issues/39)) |
||||
|
||||
## [0.0.9] - 2018-05-28 |
||||
### Fixed |
||||
- handle comments in the last line of a file properly for `ARG`, `ENV`, and `LABEL` ([#40](https://github.com/rcjsuen/dockerfile-ast/issues/40)) |
||||
- parse `ARG` instructions properly when its value contains an unclosed quote ([#41](https://github.com/rcjsuen/dockerfile-ast/issues/41)) |
||||
|
||||
## [0.0.8] - 2018-05-27 |
||||
### Fixed |
||||
- prevent `getVariables()` from throwing an error if a `LABEL` has no value defined ([#38](https://github.com/rcjsuen/dockerfile-ast/issues/38)) |
||||
|
||||
## [0.0.7] - 2018-05-25 |
||||
### Added |
||||
- `ParserDirective` |
||||
- `toString()` ([#4](https://github.com/rcjsuen/dockerfile-ast/issues/4)) |
||||
- `PropertyInstruction` |
||||
- `getPropertyArguments()` ([#37](https://github.com/rcjsuen/dockerfile-ast/issues/37)) |
||||
- `Variable` |
||||
- `getModifier()` ([#27](https://github.com/rcjsuen/dockerfile-ast/issues/27)) |
||||
- `getModifierRange()` ([#33](https://github.com/rcjsuen/dockerfile-ast/issues/33)) |
||||
- `getSubstitutionParameter()` ([#27](https://github.com/rcjsuen/dockerfile-ast/issues/27)) |
||||
- `getSubstitutionRange()` ([#33](https://github.com/rcjsuen/dockerfile-ast/issues/33)) |
||||
- `toString()` ([#4](https://github.com/rcjsuen/dockerfile-ast/issues/4)) |
||||
|
||||
### Changed |
||||
- `PropertyInstruction` |
||||
- `getArguments()` ([#34](https://github.com/rcjsuen/dockerfile-ast/issues/34)) |
||||
- to make this function more predictable, `PropertyInstruction` no longer overrides this function with its own implementation, existing callers should call `getPropertyArguments()` instead if the old behaviour is desired |
||||
```TypeScript |
||||
// this function has been changed to possibly not return the same thing |
||||
// depending on the structure of the instruction's arguments |
||||
let args = propertyInstruction.getArguments(); |
||||
// to get the same behaviour in 0.0.6, use getPropertyArguments() instead |
||||
let args = propertyInstruction.getPropertyArguments(); |
||||
``` |
||||
|
||||
### Fixed |
||||
- resolve references to uninitialized `ARG` variables against `ARG` variables before the first `FROM` if present ([#26](https://github.com/rcjsuen/dockerfile-ast/issues/26)) |
||||
- change `FROM` to parse its image argument correctly if it is in a private registry ([#28](https://github.com/rcjsuen/dockerfile-ast/issues/28)) |
||||
- fix parsing issue with quoted keys and values in `ARG`, `ENV`, and `LABEL` ([#30](https://github.com/rcjsuen/dockerfile-ast/issues/30)) |
||||
- ignore equals signs that are found inside quotes ([#29](https://github.com/rcjsuen/dockerfile-ast/issues/29)) |
||||
- prevent arguments from being split up if they span multiple lines via escaped newlines ([#34](https://github.com/rcjsuen/dockerfile-ast/issues/34)) |
||||
- prevent variables from being split up if they span multiple lines via escaped newlines ([#35](https://github.com/rcjsuen/dockerfile-ast/issues/35)) |
||||
|
||||
## [0.0.6] - 2018-04-19 |
||||
### Changed |
||||
- `Property` |
||||
- `getRawValue()` has been renamed to `getUnescapedValue()` ([#25](https://github.com/rcjsuen/dockerfile-ast/issues/25)) |
||||
- the underlying implementation of the function has not changed so it should be easy for clients to migrate to the new API |
||||
|
||||
### Fixed |
||||
- fix parsing of spaces embedded within a variable replacement in `ARG`, `ENV`, and `LABEL` instructions ([#24](https://github.com/rcjsuen/dockerfile-ast/issues/24)) |
||||
|
||||
## [0.0.5] - 2018-04-15 |
||||
### Fixed |
||||
- fix resolution of `ARG` variables that are used in a `FROM` ([#22](https://github.com/rcjsuen/dockerfile-ast/issues/22)) |
||||
- prevent error from being thrown if an invalid line number is specified by `Dockerfile`'s `getAvailableVariables(number)` function ([#23](https://github.com/rcjsuen/dockerfile-ast/issues/23)) |
||||
|
||||
## [0.0.4] - 2018-04-03 |
||||
### Added |
||||
- `JSONArgument extends Argument` ([#20](https://github.com/rcjsuen/dockerfile-ast/issues/20)) |
||||
- `getJSONRange()` |
||||
- `getJSONValue()` |
||||
- `Comment` |
||||
- `toString()` ([#4](https://github.com/rcjsuen/dockerfile-ast/issues/4)) |
||||
|
||||
### Changed |
||||
- `JSONInstruction` |
||||
- `getJSONStrings()` now returns `JSONArgument[]` instead of `Argument[]` |
||||
- since `JSONArgument` extends `Argument`, any existing code should continue to work with no code changes required |
||||
|
||||
## [0.0.3] - 2018-02-10 |
||||
### Added |
||||
- `From` |
||||
- `getImageNameRange()` ([#16](https://github.com/rcjsuen/dockerfile-ast/issues/16)) |
||||
- `Instruction` |
||||
- `toString()` ([#4](https://github.com/rcjsuen/dockerfile-ast/issues/4)) |
||||
|
||||
### Fixed |
||||
- calling `ImageTemplate`'s `getAvailableVariables(number)` with a Dockerfile should only return the variables that are declared in the build stage of the given line ([#15](https://github.com/rcjsuen/dockerfile-ast/issues/15)) |
||||
- correct `From`'s `getImageName()` to return the right name for the image if it is pointing at a digest ([#17](https://github.com/rcjsuen/dockerfile-ast/issues/17)) |
||||
- calling `ImageTemplate`'s `getAvailableVariables(number)` on a line with a `FROM` should return variables defined by the Dockerfile's initial `ARG` instructions (if any) ([#18](https://github.com/rcjsuen/dockerfile-ast/issues/18)) |
||||
|
||||
## [0.0.2] - 2018-01-20 |
||||
### Added |
||||
- `Argument` |
||||
- `toString()` ([#4](https://github.com/rcjsuen/dockerfile-ast/issues/4)) |
||||
- `Variable` |
||||
- `isBuildVariable()` ([#13](https://github.com/rcjsuen/dockerfile-ast/issues/13)) |
||||
- `isDefined()` ([#12](https://github.com/rcjsuen/dockerfile-ast/issues/12)) |
||||
- `isEnvironmentVariable()` ([#13](https://github.com/rcjsuen/dockerfile-ast/issues/13)) |
||||
|
||||
### Fixed |
||||
- restrict variable resolution to the containing build stage ([#14](https://github.com/rcjsuen/dockerfile-ast/issues/14)) |
||||
|
||||
### Removed |
||||
- `Argument`'s `getRawValue()` function has been removed ([#10](https://github.com/rcjsuen/dockerfile-ast/issues/10)) |
||||
```TypeScript |
||||
// this convenience function has been removed |
||||
let rawValue = argument.getRawValue(); |
||||
// to retrieve the identical value, use the following code instead |
||||
import { TextDocument } from 'vscode-languageserver-types'; |
||||
let document = TextDocument.create(uri, languageId, version, buffer); |
||||
let range = argument.getRange(); |
||||
let rawValue = buffer.substring(document.offsetAt(range.start), document.offsetAt(range.end)); |
||||
``` |
||||
|
||||
## 0.0.1 - 2017-12-20 |
||||
### Added |
||||
- Dockerfile parser |
||||
- handles escape characters |
||||
- preserves comments |
||||
- provides variable lookup and resolution |
||||
|
||||
[Unreleased]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.1.0...HEAD |
||||
[0.1.0]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.30...v0.1.0 |
||||
[0.0.30]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.29...v0.0.30 |
||||
[0.0.29]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.28...v0.0.29 |
||||
[0.0.28]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.27...v0.0.28 |
||||
[0.0.27]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.26...v0.0.27 |
||||
[0.0.26]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.25...v0.0.26 |
||||
[0.0.25]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.24...v0.0.25 |
||||
[0.0.24]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.23...v0.0.24 |
||||
[0.0.23]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.22...v0.0.23 |
||||
[0.0.22]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.21...v0.0.22 |
||||
[0.0.21]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.20...v0.0.21 |
||||
[0.0.20]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.19...v0.0.20 |
||||
[0.0.19]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.18...v0.0.19 |
||||
[0.0.18]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.17...v0.0.18 |
||||
[0.0.17]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.16...v0.0.17 |
||||
[0.0.16]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.15...v0.0.16 |
||||
[0.0.15]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.14...v0.0.15 |
||||
[0.0.14]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.13...v0.0.14 |
||||
[0.0.13]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.12...v0.0.13 |
||||
[0.0.12]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.11...v0.0.12 |
||||
[0.0.11]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.10...v0.0.11 |
||||
[0.0.10]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.9...v0.0.10 |
||||
[0.0.9]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.8...v0.0.9 |
||||
[0.0.8]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.7...v0.0.8 |
||||
[0.0.7]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.6...v0.0.7 |
||||
[0.0.6]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.5...v0.0.6 |
||||
[0.0.5]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.4...v0.0.5 |
||||
[0.0.4]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.3...v0.0.4 |
||||
[0.0.3]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.2...v0.0.3 |
||||
[0.0.2]: https://github.com/rcjsuen/dockerfile-ast/compare/v0.0.1...v0.0.2 |
@ -0,0 +1,22 @@
@@ -0,0 +1,22 @@
|
||||
Copyright (c) 2017 Remy Suen |
||||
|
||||
MIT License |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
"Software"), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
@ -0,0 +1,58 @@
@@ -0,0 +1,58 @@
|
||||
# Dockerfile AST |
||||
|
||||
[](https://travis-ci.org/rcjsuen/dockerfile-ast) [](https://coveralls.io/github/rcjsuen/dockerfile-ast?branch=master) [](https://david-dm.org/rcjsuen/dockerfile-ast) [](https://opensource.org/licenses/MIT) [](https://www.npmjs.com/package/dockerfile-ast) |
||||
|
||||
The `dockerfile-ast` NPM module is a Dockerfile parser written in TypeScript. |
||||
The module provides full programmatic access to a parsed Dockerfile. |
||||
|
||||
Supported features: |
||||
- escaped newline detection |
||||
- `escape` parser directive considered when parsing |
||||
- comments preserved |
||||
- inlined comments in multiline instructions preserved |
||||
- continuous empty newlines honoured (albeit discouraged as of Docker CE 17.09) |
||||
- `ARG` and `ENV` variable lookup and resolution |
||||
|
||||
Unsupported: |
||||
- `\r` as a a line delimiter |
||||
- only `\r\n` and `\n` are supported as being line delimiters |
||||
- if a `\r` is detected the parser assumes that it is followed by a `\n` |
||||
|
||||
## Development Instructions |
||||
|
||||
If you wish to build and compile this project, you must first install [Node.js](https://nodejs.org/en/download/) if you have not already done so. |
||||
After you have installed Node.js and cloned the repository with Git, you may now proceed to build and compile the project with the following commands: |
||||
|
||||
``` |
||||
npm install |
||||
npm run build |
||||
npm test |
||||
``` |
||||
|
||||
If you are planning to change the code, use `npm run watch` to get the |
||||
TypeScript files transpiled on-the-fly as they are modified. |
||||
|
||||
## Installation Instructions |
||||
|
||||
To add this library as a dependency to your project, please add `dockerfile-ast` as a dependency in your package.json file. |
||||
|
||||
## Using this Module |
||||
|
||||
```TypeScript |
||||
import { DockerfileParser } from 'dockerfile-ast'; |
||||
|
||||
const content = |
||||
`FROM alpine |
||||
ExposE 8080` |
||||
|
||||
let dockerfile = DockerfileParser.parse(content); |
||||
let instructions = dockerfile.getInstructions(); |
||||
for (let instruction of instructions) { |
||||
// FROM |
||||
// EXPOSE |
||||
console.log(instruction.getKeyword()); |
||||
// FROM |
||||
// ExposE |
||||
console.log(instruction.getInstruction()); |
||||
} |
||||
``` |
Binary file not shown.
@ -0,0 +1,11 @@
@@ -0,0 +1,11 @@
|
||||
import { Range, Position } from 'vscode-languageserver-types'; |
||||
export declare class Argument { |
||||
private readonly value; |
||||
private readonly range; |
||||
constructor(value: string, range: Range); |
||||
toString(): string; |
||||
getRange(): Range; |
||||
getValue(): string; |
||||
isAfter(position: Position): boolean; |
||||
isBefore(position: Position): boolean; |
||||
} |
@ -0,0 +1,30 @@
@@ -0,0 +1,30 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
class Argument { |
||||
constructor(value, range) { |
||||
this.value = value; |
||||
this.range = range; |
||||
} |
||||
toString() { |
||||
return this.value; |
||||
} |
||||
getRange() { |
||||
return this.range; |
||||
} |
||||
getValue() { |
||||
return this.value; |
||||
} |
||||
isAfter(position) { |
||||
if (this.range.end.line < position.line) { |
||||
return false; |
||||
} |
||||
return this.range.start.line > position.line ? true : this.range.start.character > position.character; |
||||
} |
||||
isBefore(position) { |
||||
if (this.range.start.line < position.line) { |
||||
return true; |
||||
} |
||||
return this.range.end.line > position.line ? false : this.range.end.character < position.character; |
||||
} |
||||
} |
||||
exports.Argument = Argument; |
@ -0,0 +1,19 @@
@@ -0,0 +1,19 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Line } from './line'; |
||||
export declare class Comment extends Line { |
||||
constructor(document: TextDocument, range: Range); |
||||
toString(): string; |
||||
/** |
||||
* Returns the content of this comment. This excludes leading and |
||||
* trailing whitespace as well as the # symbol. If the comment only |
||||
* consists of whitespace, the empty string will be returned. |
||||
*/ |
||||
getContent(): string; |
||||
/** |
||||
* Returns a range that includes the content of the comment |
||||
* excluding any leading and trailing whitespace as well as the # |
||||
* symbol. May return null if the comment only consists of whitespace |
||||
* characters. |
||||
*/ |
||||
getContentRange(): Range | null; |
||||
} |
@ -0,0 +1,65 @@
@@ -0,0 +1,65 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const line_1 = require("./line"); |
||||
const util_1 = require("./util"); |
||||
class Comment extends line_1.Line { |
||||
constructor(document, range) { |
||||
super(document, range); |
||||
} |
||||
toString() { |
||||
const content = this.getContent(); |
||||
if (content) { |
||||
return "# " + content; |
||||
} |
||||
return "#"; |
||||
} |
||||
/** |
||||
* Returns the content of this comment. This excludes leading and |
||||
* trailing whitespace as well as the # symbol. If the comment only |
||||
* consists of whitespace, the empty string will be returned. |
||||
*/ |
||||
getContent() { |
||||
let range = this.getContentRange(); |
||||
if (range === null) { |
||||
return ""; |
||||
} |
||||
return this.document.getText().substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end)); |
||||
} |
||||
/** |
||||
* Returns a range that includes the content of the comment |
||||
* excluding any leading and trailing whitespace as well as the # |
||||
* symbol. May return null if the comment only consists of whitespace |
||||
* characters. |
||||
*/ |
||||
getContentRange() { |
||||
let range = this.getRange(); |
||||
const startOffset = this.document.offsetAt(range.start); |
||||
let raw = this.document.getText().substring(startOffset, this.document.offsetAt(range.end)); |
||||
let start = -1; |
||||
let end = -1; |
||||
// skip the first # symbol
|
||||
for (let i = 1; i < raw.length; i++) { |
||||
if (!util_1.Util.isWhitespace(raw.charAt(i))) { |
||||
start = i; |
||||
break; |
||||
} |
||||
} |
||||
if (start === -1) { |
||||
return null; |
||||
} |
||||
// go backwards up to the first # symbol
|
||||
for (let i = raw.length - 1; i >= 1; i--) { |
||||
if (!util_1.Util.isWhitespace(raw.charAt(i))) { |
||||
end = i + 1; |
||||
break; |
||||
} |
||||
} |
||||
return vscode_languageserver_types_1.Range.create(this.document.positionAt(startOffset + start), this.document.positionAt(startOffset + end)); |
||||
} |
||||
} |
||||
exports.Comment = Comment; |
@ -0,0 +1,33 @@
@@ -0,0 +1,33 @@
|
||||
import { TextDocument, Range, Position } from 'vscode-languageserver-types'; |
||||
import * as ast from './main'; |
||||
import { ParserDirective } from './parserDirective'; |
||||
import { ImageTemplate } from './imageTemplate'; |
||||
import { Instruction } from './instruction'; |
||||
import { Arg } from './instructions/arg'; |
||||
export declare class Dockerfile extends ImageTemplate implements ast.Dockerfile { |
||||
private readonly document; |
||||
private readonly initialInstructions; |
||||
private readonly buildStages; |
||||
private currentBuildStage; |
||||
private directives; |
||||
/** |
||||
* Whether a FROM instruction has been added to this Dockerfile or not. |
||||
*/ |
||||
private foundFrom; |
||||
constructor(document: TextDocument); |
||||
getEscapeCharacter(): string; |
||||
getInitialARGs(): Arg[]; |
||||
getContainingImage(position: Position): ImageTemplate | null; |
||||
addInstruction(instruction: Instruction): void; |
||||
setDirectives(directives: ParserDirective[]): void; |
||||
getDirective(): ParserDirective | null; |
||||
getDirectives(): ParserDirective[]; |
||||
resolveVariable(variable: string, line: number): string | null | undefined; |
||||
getAvailableVariables(currentLine: number): string[]; |
||||
/** |
||||
* Internally reorganize the comments in the Dockerfile and allocate |
||||
* them to the relevant build stages that they belong to. |
||||
*/ |
||||
organizeComments(): void; |
||||
getRange(): Range | null; |
||||
} |
@ -0,0 +1,183 @@
@@ -0,0 +1,183 @@
|
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
'use strict'; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const ast = require("./main"); |
||||
const imageTemplate_1 = require("./imageTemplate"); |
||||
const from_1 = require("./instructions/from"); |
||||
const util_1 = require("./util"); |
||||
const main_1 = require("./main"); |
||||
class Dockerfile extends imageTemplate_1.ImageTemplate { |
||||
constructor(document) { |
||||
super(); |
||||
this.initialInstructions = new imageTemplate_1.ImageTemplate(); |
||||
this.buildStages = []; |
||||
this.directives = []; |
||||
/** |
||||
* Whether a FROM instruction has been added to this Dockerfile or not. |
||||
*/ |
||||
this.foundFrom = false; |
||||
this.document = document; |
||||
} |
||||
getEscapeCharacter() { |
||||
for (const directive of this.directives) { |
||||
if (directive.getDirective() === ast.Directive.escape) { |
||||
const value = directive.getValue(); |
||||
if (value === '\\' || value === '`') { |
||||
return value; |
||||
} |
||||
} |
||||
} |
||||
return '\\'; |
||||
} |
||||
getInitialARGs() { |
||||
return this.initialInstructions.getARGs(); |
||||
} |
||||
getContainingImage(position) { |
||||
let range = vscode_languageserver_types_1.Range.create(vscode_languageserver_types_1.Position.create(0, 0), this.document.positionAt(this.document.getText().length)); |
||||
if (!util_1.Util.isInsideRange(position, range)) { |
||||
// not inside the document, invalid position
|
||||
return null; |
||||
} |
||||
if (this.initialInstructions.getComments().length > 0 || this.initialInstructions.getInstructions().length > 0) { |
||||
if (util_1.Util.isInsideRange(position, this.initialInstructions.getRange())) { |
||||
return this.initialInstructions; |
||||
} |
||||
} |
||||
for (const buildStage of this.buildStages) { |
||||
if (util_1.Util.isInsideRange(position, buildStage.getRange())) { |
||||
return buildStage; |
||||
} |
||||
} |
||||
return this; |
||||
} |
||||
addInstruction(instruction) { |
||||
if (instruction.getKeyword() === main_1.Keyword.FROM) { |
||||
this.currentBuildStage = new imageTemplate_1.ImageTemplate(); |
||||
this.buildStages.push(this.currentBuildStage); |
||||
this.foundFrom = true; |
||||
} |
||||
else if (!this.foundFrom) { |
||||
this.initialInstructions.addInstruction(instruction); |
||||
} |
||||
if (this.foundFrom) { |
||||
this.currentBuildStage.addInstruction(instruction); |
||||
} |
||||
super.addInstruction(instruction); |
||||
} |
||||
setDirectives(directives) { |
||||
this.directives = directives; |
||||
} |
||||
getDirective() { |
||||
return this.directives.length === 0 ? null : this.directives[0]; |
||||
} |
||||
getDirectives() { |
||||
return this.directives; |
||||
} |
||||
resolveVariable(variable, line) { |
||||
for (let from of this.getFROMs()) { |
||||
let range = from.getRange(); |
||||
if (range.start.line <= line && line <= range.end.line) { |
||||
// resolve the FROM variable against the initial ARGs
|
||||
let initialARGs = new imageTemplate_1.ImageTemplate(); |
||||
for (let instruction of this.initialInstructions.getARGs()) { |
||||
initialARGs.addInstruction(instruction); |
||||
} |
||||
return initialARGs.resolveVariable(variable, line); |
||||
} |
||||
} |
||||
let image = this.getContainingImage(vscode_languageserver_types_1.Position.create(line, 0)); |
||||
if (image === null) { |
||||
return undefined; |
||||
} |
||||
let resolvedVariable = image.resolveVariable(variable, line); |
||||
if (resolvedVariable === null) { |
||||
// refers to an uninitialized ARG variable,
|
||||
// try resolving it against the initial ARGs then
|
||||
let initialARGs = new imageTemplate_1.ImageTemplate(); |
||||
for (let instruction of this.initialInstructions.getARGs()) { |
||||
initialARGs.addInstruction(instruction); |
||||
} |
||||
return initialARGs.resolveVariable(variable, line); |
||||
} |
||||
return resolvedVariable; |
||||
} |
||||
getAvailableVariables(currentLine) { |
||||
if (this.getInstructionAt(currentLine) instanceof from_1.From) { |
||||
let variables = []; |
||||
for (let arg of this.getInitialARGs()) { |
||||
let property = arg.getProperty(); |
||||
if (property) { |
||||
variables.push(property.getName()); |
||||
} |
||||
} |
||||
return variables; |
||||
} |
||||
let image = this.getContainingImage(vscode_languageserver_types_1.Position.create(currentLine, 0)); |
||||
return image ? image.getAvailableVariables(currentLine) : []; |
||||
} |
||||
/** |
||||
* Internally reorganize the comments in the Dockerfile and allocate |
||||
* them to the relevant build stages that they belong to. |
||||
*/ |
||||
organizeComments() { |
||||
const comments = this.getComments(); |
||||
for (let i = 0; i < comments.length; i++) { |
||||
if (util_1.Util.isInsideRange(comments[i].getRange().end, this.initialInstructions.getRange())) { |
||||
this.initialInstructions.addComment(comments[i]); |
||||
} |
||||
else { |
||||
for (const buildStage of this.buildStages) { |
||||
if (util_1.Util.isInsideRange(comments[i].getRange().start, buildStage.getRange())) { |
||||
buildStage.addComment(comments[i]); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
getRange() { |
||||
const comments = this.getComments(); |
||||
const instructions = this.getInstructions(); |
||||
let range = null; |
||||
if (comments.length === 0) { |
||||
if (instructions.length > 0) { |
||||
range = vscode_languageserver_types_1.Range.create(instructions[0].getRange().start, instructions[instructions.length - 1].getRange().end); |
||||
} |
||||
} |
||||
else if (instructions.length === 0) { |
||||
range = vscode_languageserver_types_1.Range.create(comments[0].getRange().start, comments[comments.length - 1].getRange().end); |
||||
} |
||||
else { |
||||
const commentStart = comments[0].getRange().start; |
||||
const commentEnd = comments[comments.length - 1].getRange().end; |
||||
const instructionStart = instructions[0].getRange().start; |
||||
const instructionEnd = instructions[instructions.length - 1].getRange().end; |
||||
if (commentStart.line < instructionStart.line) { |
||||
if (commentEnd.line < instructionEnd.line) { |
||||
range = vscode_languageserver_types_1.Range.create(commentStart, instructionEnd); |
||||
} |
||||
range = vscode_languageserver_types_1.Range.create(commentStart, commentEnd); |
||||
} |
||||
else if (commentEnd.line < instructionEnd.line) { |
||||
range = vscode_languageserver_types_1.Range.create(instructionStart, instructionEnd); |
||||
} |
||||
else { |
||||
range = vscode_languageserver_types_1.Range.create(instructionStart, commentEnd); |
||||
} |
||||
} |
||||
if (range === null) { |
||||
if (this.directives.length === 0) { |
||||
return null; |
||||
} |
||||
return this.directives[0].getRange(); |
||||
} |
||||
else if (this.directives.length === 0) { |
||||
return range; |
||||
} |
||||
return vscode_languageserver_types_1.Range.create(this.directives[0].getRange().start, range.end); |
||||
} |
||||
} |
||||
exports.Dockerfile = Dockerfile; |
@ -0,0 +1,55 @@
@@ -0,0 +1,55 @@
|
||||
import { Range, TextDocument } from 'vscode-languageserver-types'; |
||||
import { FlagOption } from './flagOption'; |
||||
export declare class Flag { |
||||
private readonly range; |
||||
private readonly name; |
||||
private readonly nameRange; |
||||
private readonly value; |
||||
private readonly valueRange; |
||||
private readonly options; |
||||
constructor(document: TextDocument, range: Range, name: string, nameRange: Range, value: string | null, valueRange: Range | null); |
||||
private createFlagOption; |
||||
toString(): string; |
||||
/** |
||||
* Returns the range that encompasses this entire flag. This includes the |
||||
* -- prefix in the beginning to the last character of the flag's value (if |
||||
* it has been defined). |
||||
* |
||||
* @return the entire range of this flag |
||||
*/ |
||||
getRange(): Range; |
||||
/** |
||||
* Returns the name of this flag. The name does not include the -- prefix. |
||||
* Thus, for HEALTHCHECK's --interval flag, interval is the flag's name and |
||||
* not --interval. |
||||
* |
||||
* @return this flag's name |
||||
*/ |
||||
getName(): string; |
||||
/** |
||||
* Returns the range that encompasses the flag's name |
||||
* |
||||
* @return the range containing the flag's name |
||||
*/ |
||||
getNameRange(): Range; |
||||
/** |
||||
* Returns the value that has been set to this flag. May be null if the |
||||
* flag is invalid and has no value set like a --start-period. If the flag |
||||
* is instead a --start-period= with an equals sign then the flag's value |
||||
* is the empty string. |
||||
* |
||||
* @return this flag's value if it has been defined, null otherwise |
||||
*/ |
||||
getValue(): string | null; |
||||
/** |
||||
* Returns the range that encompasses this flag's value. If no value has |
||||
* been set then null will be returned. |
||||
* |
||||
* @return the range containing this flag's value, or null if the flag |
||||
* has no value defined |
||||
*/ |
||||
getValueRange(): Range | null; |
||||
getOption(name: string): FlagOption | null; |
||||
getOptions(): FlagOption[]; |
||||
hasOptions(): boolean; |
||||
} |
@ -0,0 +1,125 @@
@@ -0,0 +1,125 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const flagOption_1 = require("./flagOption"); |
||||
class Flag { |
||||
constructor(document, range, name, nameRange, value, valueRange) { |
||||
this.options = []; |
||||
this.range = range; |
||||
this.name = name; |
||||
this.nameRange = nameRange; |
||||
this.value = value; |
||||
this.valueRange = valueRange; |
||||
if (this.value !== null) { |
||||
let offset = document.offsetAt(valueRange.start); |
||||
let nameStart = -1; |
||||
let valueStart = -1; |
||||
let hasOptions = false; |
||||
for (let i = 0; i < value.length; i++) { |
||||
switch (value.charAt(i)) { |
||||
case '=': |
||||
hasOptions = true; |
||||
if (valueStart === -1) { |
||||
valueStart = i + 1; |
||||
break; |
||||
} |
||||
break; |
||||
case ',': |
||||
this.options.push(this.createFlagOption(document, value, offset, nameStart, valueStart, i)); |
||||
nameStart = -1; |
||||
valueStart = -1; |
||||
break; |
||||
default: |
||||
if (nameStart === -1) { |
||||
nameStart = i; |
||||
} |
||||
break; |
||||
} |
||||
} |
||||
if (hasOptions && nameStart !== -1) { |
||||
this.options.push(this.createFlagOption(document, value, offset, nameStart, valueStart, value.length)); |
||||
} |
||||
} |
||||
} |
||||
createFlagOption(document, content, documentOffset, nameStart, valueStart, valueEnd) { |
||||
const optionRange = vscode_languageserver_types_1.Range.create(document.positionAt(documentOffset + nameStart), document.positionAt(documentOffset + valueEnd)); |
||||
if (valueStart === -1) { |
||||
return new flagOption_1.FlagOption(optionRange, content.substring(nameStart, valueEnd), optionRange, null, null); |
||||
} |
||||
return new flagOption_1.FlagOption(optionRange, content.substring(nameStart, valueStart - 1), vscode_languageserver_types_1.Range.create(document.positionAt(documentOffset + nameStart), document.positionAt(documentOffset + valueStart - 1)), content.substring(valueStart, valueEnd), vscode_languageserver_types_1.Range.create(document.positionAt(documentOffset + valueStart), document.positionAt(documentOffset + valueEnd))); |
||||
} |
||||
toString() { |
||||
if (this.valueRange) { |
||||
return "--" + this.name + "=" + this.value; |
||||
} |
||||
return "--" + this.name; |
||||
} |
||||
/** |
||||
* Returns the range that encompasses this entire flag. This includes the |
||||
* -- prefix in the beginning to the last character of the flag's value (if |
||||
* it has been defined). |
||||
* |
||||
* @return the entire range of this flag |
||||
*/ |
||||
getRange() { |
||||
return this.range; |
||||
} |
||||
/** |
||||
* Returns the name of this flag. The name does not include the -- prefix. |
||||
* Thus, for HEALTHCHECK's --interval flag, interval is the flag's name and |
||||
* not --interval. |
||||
* |
||||
* @return this flag's name |
||||
*/ |
||||
getName() { |
||||
return this.name; |
||||
} |
||||
/** |
||||
* Returns the range that encompasses the flag's name |
||||
* |
||||
* @return the range containing the flag's name |
||||
*/ |
||||
getNameRange() { |
||||
return this.nameRange; |
||||
} |
||||
/** |
||||
* Returns the value that has been set to this flag. May be null if the |
||||
* flag is invalid and has no value set like a --start-period. If the flag |
||||
* is instead a --start-period= with an equals sign then the flag's value |
||||
* is the empty string. |
||||
* |
||||
* @return this flag's value if it has been defined, null otherwise |
||||
*/ |
||||
getValue() { |
||||
return this.value; |
||||
} |
||||
/** |
||||
* Returns the range that encompasses this flag's value. If no value has |
||||
* been set then null will be returned. |
||||
* |
||||
* @return the range containing this flag's value, or null if the flag |
||||
* has no value defined |
||||
*/ |
||||
getValueRange() { |
||||
return this.valueRange; |
||||
} |
||||
getOption(name) { |
||||
for (const option of this.options) { |
||||
if (option.getName() === name) { |
||||
return option; |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
getOptions() { |
||||
return this.options; |
||||
} |
||||
hasOptions() { |
||||
return this.options.length > 0; |
||||
} |
||||
} |
||||
exports.Flag = Flag; |
@ -0,0 +1,15 @@
@@ -0,0 +1,15 @@
|
||||
import { Range } from 'vscode-languageserver-types'; |
||||
export declare class FlagOption { |
||||
private readonly range; |
||||
private readonly name; |
||||
private readonly nameRange; |
||||
private readonly value; |
||||
private readonly valueRange; |
||||
constructor(range: Range, name: string, nameRange: Range, value: string | null, valueRange: Range | null); |
||||
toString(): string; |
||||
getRange(): Range; |
||||
getName(): string; |
||||
getNameRange(): Range; |
||||
getValue(): string | null; |
||||
getValueRange(): Range | null; |
||||
} |
@ -0,0 +1,33 @@
@@ -0,0 +1,33 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
class FlagOption { |
||||
constructor(range, name, nameRange, value, valueRange) { |
||||
this.range = range; |
||||
this.name = name; |
||||
this.nameRange = nameRange; |
||||
this.value = value; |
||||
this.valueRange = valueRange; |
||||
} |
||||
toString() { |
||||
if (this.valueRange !== null) { |
||||
return this.name + "=" + this.value; |
||||
} |
||||
return this.name; |
||||
} |
||||
getRange() { |
||||
return this.range; |
||||
} |
||||
getName() { |
||||
return this.name; |
||||
} |
||||
getNameRange() { |
||||
return this.nameRange; |
||||
} |
||||
getValue() { |
||||
return this.value; |
||||
} |
||||
getValueRange() { |
||||
return this.valueRange; |
||||
} |
||||
} |
||||
exports.FlagOption = FlagOption; |
@ -0,0 +1,67 @@
@@ -0,0 +1,67 @@
|
||||
import { Range, Position } from 'vscode-languageserver-types'; |
||||
import * as ast from './main'; |
||||
import { Comment } from './comment'; |
||||
import { Instruction } from './instruction'; |
||||
import { Arg } from './instructions/arg'; |
||||
import { Cmd } from './instructions/cmd'; |
||||
import { Copy } from './instructions/copy'; |
||||
import { Env } from './instructions/env'; |
||||
import { Entrypoint } from './instructions/entrypoint'; |
||||
import { From } from './instructions/from'; |
||||
import { Healthcheck } from './instructions/healthcheck'; |
||||
export declare class ImageTemplate implements ast.ImageTemplate { |
||||
private readonly comments; |
||||
private readonly instructions; |
||||
addComment(comment: Comment): void; |
||||
getComments(): Comment[]; |
||||
addInstruction(instruction: Instruction): void; |
||||
getInstructions(): Instruction[]; |
||||
protected getInstructionAt(line: number): Instruction | null; |
||||
/** |
||||
* Gets all the ARG instructions that are defined in this image. |
||||
*/ |
||||
getARGs(): Arg[]; |
||||
/** |
||||
* Gets all the CMD instructions that are defined in this image. |
||||
*/ |
||||
getCMDs(): Cmd[]; |
||||
/** |
||||
* Gets all the COPY instructions that are defined in this image. |
||||
*/ |
||||
getCOPYs(): Copy[]; |
||||
/** |
||||
* Gets all the ENTRYPOINT instructions that are defined in this image. |
||||
*/ |
||||
getENTRYPOINTs(): Entrypoint[]; |
||||
/** |
||||
* Gets all the ENV instructions that are defined in this image. |
||||
*/ |
||||
getENVs(): Env[]; |
||||
/** |
||||
* Gets all the FROM instructions that are defined in this image. |
||||
*/ |
||||
getFROMs(): From[]; |
||||
/** |
||||
* Gets all the HEALTHCHECK instructions that are defined in this image. |
||||
*/ |
||||
getHEALTHCHECKs(): Healthcheck[]; |
||||
getOnbuildTriggers(): Instruction[]; |
||||
getAvailableVariables(currentLine: number): string[]; |
||||
/** |
||||
* Resolves a variable with the given name at the specified line |
||||
* to its value. If null is returned, then the variable has been |
||||
* defined but no value was given. If undefined is returned, then |
||||
* a variable with the given name has not been defined yet as of |
||||
* the given line. |
||||
* |
||||
* @param variable the name of the variable to resolve |
||||
* @param line the line number that the variable is on, zero-based |
||||
* @return the value of the variable as defined by an ARG or ENV |
||||
* instruction, or null if no value has been specified, or |
||||
* undefined if a variable with the given name has not |
||||
* been defined |
||||
*/ |
||||
resolveVariable(variable: string, line: number): string | null | undefined; |
||||
getRange(): Range | null; |
||||
contains(position: Position): boolean; |
||||
} |
@ -0,0 +1,218 @@
@@ -0,0 +1,218 @@
|
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
'use strict'; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const arg_1 = require("./instructions/arg"); |
||||
const cmd_1 = require("./instructions/cmd"); |
||||
const copy_1 = require("./instructions/copy"); |
||||
const env_1 = require("./instructions/env"); |
||||
const entrypoint_1 = require("./instructions/entrypoint"); |
||||
const from_1 = require("./instructions/from"); |
||||
const healthcheck_1 = require("./instructions/healthcheck"); |
||||
const onbuild_1 = require("./instructions/onbuild"); |
||||
const util_1 = require("./util"); |
||||
class ImageTemplate { |
||||
constructor() { |
||||
this.comments = []; |
||||
this.instructions = []; |
||||
} |
||||
addComment(comment) { |
||||
this.comments.push(comment); |
||||
} |
||||
getComments() { |
||||
return this.comments; |
||||
} |
||||
addInstruction(instruction) { |
||||
this.instructions.push(instruction); |
||||
} |
||||
getInstructions() { |
||||
return this.instructions; |
||||
} |
||||
getInstructionAt(line) { |
||||
for (let instruction of this.instructions) { |
||||
if (util_1.Util.isInsideRange(vscode_languageserver_types_1.Position.create(line, 0), instruction.getRange())) { |
||||
return instruction; |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
/** |
||||
* Gets all the ARG instructions that are defined in this image. |
||||
*/ |
||||
getARGs() { |
||||
let args = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof arg_1.Arg) { |
||||
args.push(instruction); |
||||
} |
||||
} |
||||
return args; |
||||
} |
||||
/** |
||||
* Gets all the CMD instructions that are defined in this image. |
||||
*/ |
||||
getCMDs() { |
||||
let cmds = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof cmd_1.Cmd) { |
||||
cmds.push(instruction); |
||||
} |
||||
} |
||||
return cmds; |
||||
} |
||||
/** |
||||
* Gets all the COPY instructions that are defined in this image. |
||||
*/ |
||||
getCOPYs() { |
||||
let copies = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof copy_1.Copy) { |
||||
copies.push(instruction); |
||||
} |
||||
} |
||||
return copies; |
||||
} |
||||
/** |
||||
* Gets all the ENTRYPOINT instructions that are defined in this image. |
||||
*/ |
||||
getENTRYPOINTs() { |
||||
let froms = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof entrypoint_1.Entrypoint) { |
||||
froms.push(instruction); |
||||
} |
||||
} |
||||
return froms; |
||||
} |
||||
/** |
||||
* Gets all the ENV instructions that are defined in this image. |
||||
*/ |
||||
getENVs() { |
||||
let args = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof env_1.Env) { |
||||
args.push(instruction); |
||||
} |
||||
} |
||||
return args; |
||||
} |
||||
/** |
||||
* Gets all the FROM instructions that are defined in this image. |
||||
*/ |
||||
getFROMs() { |
||||
let froms = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof from_1.From) { |
||||
froms.push(instruction); |
||||
} |
||||
} |
||||
return froms; |
||||
} |
||||
/** |
||||
* Gets all the HEALTHCHECK instructions that are defined in this image. |
||||
*/ |
||||
getHEALTHCHECKs() { |
||||
let froms = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof healthcheck_1.Healthcheck) { |
||||
froms.push(instruction); |
||||
} |
||||
} |
||||
return froms; |
||||
} |
||||
getOnbuildTriggers() { |
||||
let triggers = []; |
||||
for (let instruction of this.instructions) { |
||||
if (instruction instanceof onbuild_1.Onbuild) { |
||||
let trigger = instruction.getTriggerInstruction(); |
||||
if (trigger) { |
||||
triggers.push(trigger); |
||||
} |
||||
} |
||||
} |
||||
return triggers; |
||||
} |
||||
getAvailableVariables(currentLine) { |
||||
const variables = []; |
||||
for (const arg of this.getARGs()) { |
||||
if (arg.isBefore(currentLine)) { |
||||
const property = arg.getProperty(); |
||||
if (property) { |
||||
const variable = property.getName(); |
||||
if (variables.indexOf(variable) === -1) { |
||||
variables.push(variable); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
for (const env of this.getENVs()) { |
||||
if (env.isBefore(currentLine)) { |
||||
for (const property of env.getProperties()) { |
||||
const variable = property.getName(); |
||||
if (variables.indexOf(variable) === -1) { |
||||
variables.push(variable); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
return variables; |
||||
} |
||||
/** |
||||
* Resolves a variable with the given name at the specified line |
||||
* to its value. If null is returned, then the variable has been |
||||
* defined but no value was given. If undefined is returned, then |
||||
* a variable with the given name has not been defined yet as of |
||||
* the given line. |
||||
* |
||||
* @param variable the name of the variable to resolve |
||||
* @param line the line number that the variable is on, zero-based |
||||
* @return the value of the variable as defined by an ARG or ENV |
||||
* instruction, or null if no value has been specified, or |
||||
* undefined if a variable with the given name has not |
||||
* been defined |
||||
*/ |
||||
resolveVariable(variable, line) { |
||||
let envs = this.getENVs(); |
||||
for (let i = envs.length - 1; i >= 0; i--) { |
||||
if (envs[i].isBefore(line)) { |
||||
for (let property of envs[i].getProperties()) { |
||||
if (property.getName() === variable) { |
||||
return property.getValue(); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
let args = this.getARGs(); |
||||
for (let i = args.length - 1; i >= 0; i--) { |
||||
if (args[i].isBefore(line)) { |
||||
let property = args[i].getProperty(); |
||||
if (property && property.getName() === variable) { |
||||
return property.getValue(); |
||||
} |
||||
} |
||||
} |
||||
return undefined; |
||||
} |
||||
getRange() { |
||||
const instructions = this.getInstructions(); |
||||
if (instructions.length === 0) { |
||||
// all templates should have instructions, this only happens for
|
||||
// the initial set of instruction
|
||||
return vscode_languageserver_types_1.Range.create(0, 0, 0, 0); |
||||
} |
||||
const instructionStart = instructions[0].getRange().start; |
||||
const instructionEnd = instructions[instructions.length - 1].getRange().end; |
||||
return vscode_languageserver_types_1.Range.create(instructionStart, instructionEnd); |
||||
} |
||||
contains(position) { |
||||
const range = this.getRange(); |
||||
if (range === null) { |
||||
return false; |
||||
} |
||||
return util_1.Util.isInsideRange(position, range); |
||||
} |
||||
} |
||||
exports.ImageTemplate = ImageTemplate; |
@ -0,0 +1,27 @@
@@ -0,0 +1,27 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from './dockerfile'; |
||||
import { Line } from './line'; |
||||
import { Argument } from './argument'; |
||||
import { Variable } from './variable'; |
||||
export declare class Instruction extends Line { |
||||
protected readonly dockerfile: Dockerfile; |
||||
protected readonly escapeChar: string; |
||||
private readonly instruction; |
||||
private readonly instructionRange; |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
toString(): string; |
||||
protected getRangeContent(range: Range | null): string | null; |
||||
getInstructionRange(): Range; |
||||
getInstruction(): string; |
||||
getKeyword(): string; |
||||
getArgumentsRange(): Range | null; |
||||
getArgumentsRanges(): Range[]; |
||||
getRawArgumentsContent(): string | null; |
||||
getArgumentsContent(): string | null; |
||||
getArguments(): Argument[]; |
||||
private getRawArguments; |
||||
getExpandedArguments(): Argument[]; |
||||
getVariables(): Variable[]; |
||||
private parseVariables; |
||||
private isBuildVariable; |
||||
} |
@ -0,0 +1,586 @@
@@ -0,0 +1,586 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const util_1 = require("./util"); |
||||
const line_1 = require("./line"); |
||||
const argument_1 = require("./argument"); |
||||
const variable_1 = require("./variable"); |
||||
const main_1 = require("./main"); |
||||
class Instruction extends line_1.Line { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range); |
||||
this.dockerfile = dockerfile; |
||||
this.escapeChar = escapeChar; |
||||
this.instruction = instruction; |
||||
this.instructionRange = instructionRange; |
||||
} |
||||
toString() { |
||||
let value = this.getKeyword(); |
||||
for (let arg of this.getRawArguments()) { |
||||
value += ' '; |
||||
value += arg.getValue(); |
||||
} |
||||
return value; |
||||
} |
||||
getRangeContent(range) { |
||||
if (range === null) { |
||||
return null; |
||||
} |
||||
return this.document.getText().substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end)); |
||||
} |
||||
getInstructionRange() { |
||||
return this.instructionRange; |
||||
} |
||||
getInstruction() { |
||||
return this.instruction; |
||||
} |
||||
getKeyword() { |
||||
return this.getInstruction().toUpperCase(); |
||||
} |
||||
getArgumentsRange() { |
||||
let args = this.getArguments(); |
||||
if (args.length === 0) { |
||||
return null; |
||||
} |
||||
return vscode_languageserver_types_1.Range.create(args[0].getRange().start, args[args.length - 1].getRange().end); |
||||
} |
||||
getArgumentsRanges() { |
||||
let args = this.getArguments(); |
||||
if (args.length === 0) { |
||||
return []; |
||||
} |
||||
if (args[0].getRange().start.line === args[args.length - 1].getRange().end.line) { |
||||
return [vscode_languageserver_types_1.Range.create(args[0].getRange().start, args[args.length - 1].getRange().end)]; |
||||
} |
||||
let ranges = []; |
||||
let end = -1; |
||||
let startPosition = args[0].getRange().start; |
||||
let range = this.getInstructionRange(); |
||||
let extra = this.document.offsetAt(startPosition) - this.document.offsetAt(range.start); |
||||
let content = this.getTextContent(); |
||||
let fullArgs = content.substring(extra, this.document.offsetAt(args[args.length - 1].getRange().end) - this.document.offsetAt(range.start)); |
||||
let offset = this.document.offsetAt(range.start) + extra; |
||||
let start = false; |
||||
let comment = false; |
||||
for (let i = 0; i < fullArgs.length; i++) { |
||||
let char = fullArgs.charAt(i); |
||||
if (char === this.escapeChar) { |
||||
let next = fullArgs.charAt(i + 1); |
||||
if (next === ' ' || next === '\t') { |
||||
whitespaceCheck: for (let j = i + 2; j < fullArgs.length; j++) { |
||||
switch (fullArgs.charAt(j)) { |
||||
case ' ': |
||||
case '\t': |
||||
continue; |
||||
case '\r': |
||||
j++; |
||||
case '\n': |
||||
if (startPosition !== null) { |
||||
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1))); |
||||
} |
||||
startPosition = null; |
||||
start = true; |
||||
comment = false; |
||||
i = j; |
||||
break whitespaceCheck; |
||||
default: |
||||
break whitespaceCheck; |
||||
} |
||||
} |
||||
} |
||||
else if (next === '\r') { |
||||
if (startPosition !== null) { |
||||
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1))); |
||||
startPosition = null; |
||||
} |
||||
start = true; |
||||
comment = false; |
||||
i += 2; |
||||
} |
||||
else if (next === '\n') { |
||||
if (startPosition !== null) { |
||||
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1))); |
||||
} |
||||
startPosition = null; |
||||
start = true; |
||||
comment = false; |
||||
i++; |
||||
} |
||||
else { |
||||
i++; |
||||
} |
||||
} |
||||
else if (util_1.Util.isNewline(char)) { |
||||
if (comment) { |
||||
startPosition = null; |
||||
start = true; |
||||
comment = false; |
||||
} |
||||
} |
||||
else { |
||||
if (!comment) { |
||||
if (startPosition === null) { |
||||
if (char === '#') { |
||||
comment = true; |
||||
continue; |
||||
} |
||||
let position = this.document.positionAt(offset + i); |
||||
if (position.character !== 0) { |
||||
startPosition = vscode_languageserver_types_1.Position.create(position.line, 0); |
||||
} |
||||
} |
||||
end = i; |
||||
} |
||||
} |
||||
} |
||||
if (startPosition === null) { |
||||
// should only happen if the last argument is on its own line with
|
||||
// no leading whitespace
|
||||
ranges.push(vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + end), this.document.positionAt(offset + end + 1))); |
||||
} |
||||
else { |
||||
ranges.push(vscode_languageserver_types_1.Range.create(startPosition, this.document.positionAt(offset + end + 1))); |
||||
} |
||||
return ranges; |
||||
} |
||||
getRawArgumentsContent() { |
||||
let args = this.getArguments(); |
||||
if (args.length === 0) { |
||||
return null; |
||||
} |
||||
return this.getRangeContent(vscode_languageserver_types_1.Range.create(args[0].getRange().start, args[args.length - 1].getRange().end)); |
||||
} |
||||
getArgumentsContent() { |
||||
let args = this.getArguments(); |
||||
if (args.length === 0) { |
||||
return null; |
||||
} |
||||
let content = ""; |
||||
let ranges = this.getArgumentsRanges(); |
||||
let documentText = this.document.getText(); |
||||
for (let range of ranges) { |
||||
content += documentText.substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end)); |
||||
} |
||||
return content; |
||||
} |
||||
getArguments() { |
||||
return this.getRawArguments(); |
||||
} |
||||
getRawArguments() { |
||||
let args = []; |
||||
let range = this.getInstructionRange(); |
||||
let extra = this.document.offsetAt(range.end) - this.document.offsetAt(range.start); |
||||
let content = this.getTextContent(); |
||||
let fullArgs = content.substring(extra); |
||||
let offset = this.document.offsetAt(range.start) + extra; |
||||
let start = false; |
||||
let comment = false; |
||||
let found = -1; |
||||
// determines whether the parser has found a space or tab
|
||||
// whitespace character that's a part of an escaped newline sequence
|
||||
let escapedWhitespaceDetected = false; |
||||
// determines if the parser is currently in an escaped newline sequence
|
||||
let escaping = false; |
||||
let escapeMarker = -1; |
||||
let escapedArg = ""; |
||||
for (let i = 0; i < fullArgs.length; i++) { |
||||
let char = fullArgs.charAt(i); |
||||
if (util_1.Util.isWhitespace(char)) { |
||||
if (escaping) { |
||||
escapedWhitespaceDetected = true; |
||||
if (util_1.Util.isNewline(char)) { |
||||
// reached a newline, any previously
|
||||
// detected whitespace should be ignored
|
||||
escapedWhitespaceDetected = false; |
||||
if (comment) { |
||||
// reached a newline, no longer in a comment
|
||||
comment = false; |
||||
start = true; |
||||
} |
||||
} |
||||
continue; |
||||
} |
||||
else if (found !== -1) { |
||||
if (escapeMarker === -1) { |
||||
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + i)))); |
||||
} |
||||
else { |
||||
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker)))); |
||||
} |
||||
escapeMarker = -1; |
||||
escapedArg = ""; |
||||
found = -1; |
||||
} |
||||
} |
||||
else if (char === this.escapeChar) { |
||||
let next = fullArgs.charAt(i + 1); |
||||
if (next === ' ' || next === '\t') { |
||||
whitespaceCheck: for (let j = i + 2; j < fullArgs.length; j++) { |
||||
let newlineCheck = fullArgs.charAt(j); |
||||
switch (newlineCheck) { |
||||
case ' ': |
||||
case '\t': |
||||
continue; |
||||
case '\r': |
||||
j++; |
||||
case '\n': |
||||
comment = false; |
||||
escaping = true; |
||||
start = true; |
||||
if (found !== -1) { |
||||
escapeMarker = i; |
||||
} |
||||
i = j; |
||||
break whitespaceCheck; |
||||
default: |
||||
escapeMarker = i; |
||||
if (found === -1) { |
||||
i = j - 1; |
||||
} |
||||
break whitespaceCheck; |
||||
} |
||||
} |
||||
} |
||||
else if (next === '\r') { |
||||
comment = false; |
||||
escaping = true; |
||||
start = true; |
||||
if (found !== -1 && escapeMarker === -1) { |
||||
escapeMarker = i; |
||||
} |
||||
i += 2; |
||||
} |
||||
else if (next === '\n') { |
||||
comment = false; |
||||
escaping = true; |
||||
start = true; |
||||
if (found !== -1 && escapeMarker === -1) { |
||||
escapeMarker = i; |
||||
} |
||||
i++; |
||||
} |
||||
else { |
||||
if (escapedWhitespaceDetected && escapeMarker !== -1) { |
||||
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker)))); |
||||
escapedArg = ""; |
||||
found = -1; |
||||
} |
||||
escapeMarker = -1; |
||||
escapedWhitespaceDetected = false; |
||||
escaping = false; |
||||
if (next === '$') { |
||||
escapedArg = escapedArg + char + next; |
||||
} |
||||
else if (next === '') { |
||||
// reached EOF, stop processing
|
||||
break; |
||||
} |
||||
else { |
||||
escapedArg = escapedArg + next; |
||||
} |
||||
if (found === -1) { |
||||
found = i; |
||||
} |
||||
i++; |
||||
} |
||||
} |
||||
else if (!comment) { |
||||
if (start && char === '#') { |
||||
comment = true; |
||||
} |
||||
else { |
||||
if (escapedWhitespaceDetected && escapeMarker !== -1) { |
||||
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker)))); |
||||
escapedArg = ""; |
||||
found = -1; |
||||
} |
||||
escapedWhitespaceDetected = false; |
||||
escaping = false; |
||||
escapeMarker = -1; |
||||
escapedArg = escapedArg + char; |
||||
if (found === -1) { |
||||
found = i; |
||||
} |
||||
} |
||||
// non-whitespace character detected, reset
|
||||
start = false; |
||||
} |
||||
} |
||||
if (found !== -1) { |
||||
if (escapeMarker === -1) { |
||||
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + fullArgs.length)))); |
||||
} |
||||
else { |
||||
args.push(new argument_1.Argument(escapedArg, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + found), this.document.positionAt(offset + escapeMarker)))); |
||||
} |
||||
} |
||||
return args; |
||||
} |
||||
getExpandedArguments() { |
||||
let args = this.getArguments(); |
||||
for (let i = 0; i < args.length; i++) { |
||||
const argRange = args[i].getRange(); |
||||
let offset = this.document.offsetAt(argRange.start); |
||||
const variables = this.parseVariables(offset, args[i].getValue()); |
||||
const swaps = []; |
||||
let requiresExpansion = false; |
||||
for (let variable of variables) { |
||||
const value = this.dockerfile.resolveVariable(variable.getName(), variable.getNameRange().start.line); |
||||
swaps.push(value); |
||||
requiresExpansion = requiresExpansion || value !== undefined; |
||||
} |
||||
if (requiresExpansion) { |
||||
let expanded = ""; |
||||
for (let j = 0; j < swaps.length; j++) { |
||||
const variableRange = variables[j].getRange(); |
||||
const start = this.document.offsetAt(variableRange.start); |
||||
const end = this.document.offsetAt(variableRange.end); |
||||
if (swaps[j]) { |
||||
// replace variable with its resolved value
|
||||
expanded += this.document.getText().substring(offset, start); |
||||
expanded += swaps[j]; |
||||
offset = end; |
||||
} |
||||
else { |
||||
expanded += this.document.getText().substring(offset, end); |
||||
offset = end; |
||||
} |
||||
} |
||||
const argEnd = this.document.offsetAt(argRange.end); |
||||
if (argEnd !== offset) { |
||||
// if the variable's range doesn't match the argument,
|
||||
// append the remaining text
|
||||
expanded += this.document.getText().substring(offset, argEnd); |
||||
} |
||||
args[i] = new argument_1.Argument(expanded, argRange); |
||||
} |
||||
} |
||||
return args; |
||||
} |
||||
getVariables() { |
||||
const variables = []; |
||||
const args = this.getRawArguments(); |
||||
for (const arg of args) { |
||||
let range = arg.getRange(); |
||||
let rawValue = this.document.getText().substring(this.document.offsetAt(range.start), this.document.offsetAt(range.end)); |
||||
const parsedVariables = this.parseVariables(this.document.offsetAt(arg.getRange().start), rawValue); |
||||
for (const parsedVariable of parsedVariables) { |
||||
variables.push(parsedVariable); |
||||
} |
||||
} |
||||
return variables; |
||||
} |
||||
parseVariables(offset, arg) { |
||||
let variables = []; |
||||
variableLoop: for (let i = 0; i < arg.length; i++) { |
||||
switch (arg.charAt(i)) { |
||||
case this.escapeChar: |
||||
if (arg.charAt(i + 1) === '$') { |
||||
i++; |
||||
} |
||||
break; |
||||
case '$': |
||||
if (arg.charAt(i + 1) === '{') { |
||||
let escapedString = "${"; |
||||
let escapedName = ""; |
||||
let nameEnd = -1; |
||||
let escapedSubstitutionParameter = ""; |
||||
let substitutionStart = -1; |
||||
let substitutionEnd = -1; |
||||
let modifierRead = -1; |
||||
nameLoop: for (let j = i + 2; j < arg.length; j++) { |
||||
let char = arg.charAt(j); |
||||
switch (char) { |
||||
case this.escapeChar: |
||||
for (let k = j + 1; k < arg.length; k++) { |
||||
switch (arg.charAt(k)) { |
||||
case ' ': |
||||
case '\t': |
||||
case '\r': |
||||
// ignore whitespace
|
||||
continue; |
||||
case '\n': |
||||
// escape this newline
|
||||
j = k; |
||||
continue nameLoop; |
||||
} |
||||
} |
||||
break; |
||||
case '}': |
||||
escapedString += '}'; |
||||
let modifier = null; |
||||
let modifierRange = null; |
||||
let substitutionParameter = modifierRead !== -1 ? escapedSubstitutionParameter : null; |
||||
let substitutionRange = null; |
||||
if (nameEnd === -1) { |
||||
nameEnd = j; |
||||
} |
||||
else if (nameEnd + 1 === j) { |
||||
modifier = ""; |
||||
modifierRange = vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + nameEnd + 1), this.document.positionAt(offset + nameEnd + 1)); |
||||
} |
||||
else { |
||||
if (substitutionStart === -1) { |
||||
// no substitution parameter found,
|
||||
// but a modifier character existed,
|
||||
// just offset the range by 1 from
|
||||
// the modifier character
|
||||
substitutionStart = modifierRead + 1; |
||||
substitutionEnd = modifierRead + 1; |
||||
} |
||||
else { |
||||
// offset one more from the last
|
||||
// character found
|
||||
substitutionEnd = substitutionEnd + 1; |
||||
} |
||||
modifier = arg.substring(modifierRead, modifierRead + 1); |
||||
modifierRange = vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + modifierRead), this.document.positionAt(offset + modifierRead + 1)); |
||||
substitutionRange = vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + substitutionStart), this.document.positionAt(offset + substitutionEnd)); |
||||
} |
||||
let start = this.document.positionAt(offset + i); |
||||
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 2), this.document.positionAt(offset + nameEnd)), vscode_languageserver_types_1.Range.create(start, this.document.positionAt(offset + j + 1)), modifier, modifierRange, substitutionParameter, substitutionRange, this.dockerfile.resolveVariable(escapedName, start.line) !== undefined, this.isBuildVariable(escapedName, start.line), escapedString)); |
||||
i = j; |
||||
continue variableLoop; |
||||
case ':': |
||||
if (nameEnd === -1) { |
||||
nameEnd = j; |
||||
} |
||||
else if (modifierRead !== -1) { |
||||
if (substitutionStart === -1) { |
||||
substitutionStart = j; |
||||
substitutionEnd = j; |
||||
} |
||||
else { |
||||
substitutionEnd = j; |
||||
} |
||||
escapedSubstitutionParameter += ':'; |
||||
} |
||||
else { |
||||
modifierRead = j; |
||||
} |
||||
escapedString += ':'; |
||||
break; |
||||
case '\n': |
||||
case '\r': |
||||
case ' ': |
||||
case '\t': |
||||
break; |
||||
default: |
||||
if (nameEnd === -1) { |
||||
escapedName += char; |
||||
} |
||||
else if (modifierRead !== -1) { |
||||
if (substitutionStart === -1) { |
||||
substitutionStart = j; |
||||
substitutionEnd = j; |
||||
} |
||||
else { |
||||
substitutionEnd = j; |
||||
} |
||||
escapedSubstitutionParameter += char; |
||||
} |
||||
else { |
||||
modifierRead = j; |
||||
} |
||||
escapedString += char; |
||||
break; |
||||
} |
||||
} |
||||
// no } found, not a valid variable, stop processing
|
||||
break variableLoop; |
||||
} |
||||
else if (util_1.Util.isWhitespace(arg.charAt(i + 1)) || i === arg.length - 1) { |
||||
// $ followed by whitespace or EOF, ignore this variable
|
||||
continue; |
||||
} |
||||
else { |
||||
let escapedName = ""; |
||||
nameLoop: for (let j = i + 1; j < arg.length; j++) { |
||||
let char = arg.charAt(j); |
||||
switch (char) { |
||||
case '\r': |
||||
case '\n': |
||||
case ' ': |
||||
case '\t': |
||||
continue; |
||||
case '$': |
||||
case '\'': |
||||
case '"': |
||||
let varStart = this.document.positionAt(offset + i); |
||||
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + j)), vscode_languageserver_types_1.Range.create(varStart, this.document.positionAt(offset + j)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, varStart.line) !== undefined, this.isBuildVariable(escapedName, varStart.line), '$' + escapedName)); |
||||
i = j - 1; |
||||
continue variableLoop; |
||||
case this.escapeChar: |
||||
for (let k = j + 1; k < arg.length; k++) { |
||||
switch (arg.charAt(k)) { |
||||
case ' ': |
||||
case '\t': |
||||
case '\r': |
||||
// ignore whitespace
|
||||
continue; |
||||
case '\n': |
||||
// escape this newline
|
||||
j = k; |
||||
continue nameLoop; |
||||
} |
||||
} |
||||
// reached EOF after an escape character
|
||||
let start = this.document.positionAt(offset + i); |
||||
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + j)), vscode_languageserver_types_1.Range.create(start, this.document.positionAt(offset + j)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, start.line) !== undefined, this.isBuildVariable(escapedName, start.line), '$' + escapedName)); |
||||
break variableLoop; |
||||
} |
||||
if (char.match(/^[a-z0-9_]+$/i) === null) { |
||||
let varStart = this.document.positionAt(offset + i); |
||||
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + j)), vscode_languageserver_types_1.Range.create(varStart, this.document.positionAt(offset + j)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, varStart.line) !== undefined, this.isBuildVariable(escapedName, varStart.line), '$' + escapedName)); |
||||
i = j - 1; |
||||
continue variableLoop; |
||||
} |
||||
escapedName += char; |
||||
} |
||||
let start = this.document.positionAt(offset + i); |
||||
variables.push(new variable_1.Variable(escapedName, vscode_languageserver_types_1.Range.create(this.document.positionAt(offset + i + 1), this.document.positionAt(offset + arg.length)), vscode_languageserver_types_1.Range.create(start, this.document.positionAt(offset + arg.length)), null, null, null, null, this.dockerfile.resolveVariable(escapedName, start.line) !== undefined, this.isBuildVariable(escapedName, start.line), '$' + escapedName)); |
||||
} |
||||
break variableLoop; |
||||
} |
||||
} |
||||
return variables; |
||||
} |
||||
isBuildVariable(variable, line) { |
||||
if (this.getKeyword() === main_1.Keyword.FROM) { |
||||
for (const initialArg of this.dockerfile.getInitialARGs()) { |
||||
const arg = initialArg; |
||||
const property = arg.getProperty(); |
||||
if (property && variable === property.getName()) { |
||||
return true; |
||||
} |
||||
} |
||||
return undefined; |
||||
} |
||||
let image = this.dockerfile.getContainingImage(vscode_languageserver_types_1.Position.create(line, 0)); |
||||
let envs = image.getENVs(); |
||||
for (let i = envs.length - 1; i >= 0; i--) { |
||||
if (envs[i].isBefore(line)) { |
||||
for (let property of envs[i].getProperties()) { |
||||
if (property.getName() === variable) { |
||||
return false; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
let args = image.getARGs(); |
||||
for (let i = args.length - 1; i >= 0; i--) { |
||||
if (args[i].isBefore(line)) { |
||||
let property = args[i].getProperty(); |
||||
if (property && property.getName() === variable) { |
||||
return true; |
||||
} |
||||
} |
||||
} |
||||
return undefined; |
||||
} |
||||
} |
||||
exports.Instruction = Instruction; |
@ -0,0 +1,7 @@
@@ -0,0 +1,7 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { JSONInstruction } from '../jsonInstruction'; |
||||
export declare class Add extends JSONInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
stopSearchingForFlags(argument: string): boolean; |
||||
} |
@ -0,0 +1,12 @@
@@ -0,0 +1,12 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const jsonInstruction_1 = require("../jsonInstruction"); |
||||
class Add extends jsonInstruction_1.JSONInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
stopSearchingForFlags(argument) { |
||||
return argument.indexOf("--") === -1; |
||||
} |
||||
} |
||||
exports.Add = Add; |
@ -0,0 +1,14 @@
@@ -0,0 +1,14 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Property } from '../property'; |
||||
import { PropertyInstruction } from '../propertyInstruction'; |
||||
export declare class Arg extends PropertyInstruction { |
||||
private property; |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
/** |
||||
* Returns the variable defined by this ARG. This may be null if |
||||
* this ARG instruction is malformed and has no variable |
||||
* declaration. |
||||
*/ |
||||
getProperty(): Property | null; |
||||
} |
@ -0,0 +1,26 @@
@@ -0,0 +1,26 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const property_1 = require("../property"); |
||||
const propertyInstruction_1 = require("../propertyInstruction"); |
||||
class Arg extends propertyInstruction_1.PropertyInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
this.property = null; |
||||
const args = this.getPropertyArguments(); |
||||
if (args.length === 1) { |
||||
this.property = new property_1.Property(this.document, this.escapeChar, args[0]); |
||||
} |
||||
else { |
||||
this.property = null; |
||||
} |
||||
} |
||||
/** |
||||
* Returns the variable defined by this ARG. This may be null if |
||||
* this ARG instruction is malformed and has no variable |
||||
* declaration. |
||||
*/ |
||||
getProperty() { |
||||
return this.property; |
||||
} |
||||
} |
||||
exports.Arg = Arg; |
@ -0,0 +1,6 @@
@@ -0,0 +1,6 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { JSONInstruction } from '../jsonInstruction'; |
||||
export declare class Cmd extends JSONInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
} |
@ -0,0 +1,9 @@
@@ -0,0 +1,9 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const jsonInstruction_1 = require("../jsonInstruction"); |
||||
class Cmd extends jsonInstruction_1.JSONInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
} |
||||
exports.Cmd = Cmd; |
@ -0,0 +1,9 @@
@@ -0,0 +1,9 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Flag } from '../flag'; |
||||
import { JSONInstruction } from '../jsonInstruction'; |
||||
export declare class Copy extends JSONInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
stopSearchingForFlags(argument: string): boolean; |
||||
getFromFlag(): Flag | null; |
||||
} |
@ -0,0 +1,16 @@
@@ -0,0 +1,16 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const jsonInstruction_1 = require("../jsonInstruction"); |
||||
class Copy extends jsonInstruction_1.JSONInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
stopSearchingForFlags(argument) { |
||||
return argument.indexOf("--") === -1; |
||||
} |
||||
getFromFlag() { |
||||
let flags = super.getFlags(); |
||||
return flags.length === 1 && flags[0].getName() === "from" ? flags[0] : null; |
||||
} |
||||
} |
||||
exports.Copy = Copy; |
@ -0,0 +1,6 @@
@@ -0,0 +1,6 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { JSONInstruction } from '../jsonInstruction'; |
||||
export declare class Entrypoint extends JSONInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
} |
@ -0,0 +1,9 @@
@@ -0,0 +1,9 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const jsonInstruction_1 = require("../jsonInstruction"); |
||||
class Entrypoint extends jsonInstruction_1.JSONInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
} |
||||
exports.Entrypoint = Entrypoint; |
@ -0,0 +1,8 @@
@@ -0,0 +1,8 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Property } from '../property'; |
||||
import { PropertyInstruction } from '../propertyInstruction'; |
||||
export declare class Env extends PropertyInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
getProperties(): Property[]; |
||||
} |
@ -0,0 +1,12 @@
@@ -0,0 +1,12 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const propertyInstruction_1 = require("../propertyInstruction"); |
||||
class Env extends propertyInstruction_1.PropertyInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
getProperties() { |
||||
return super.getProperties(); |
||||
} |
||||
} |
||||
exports.Env = Env; |
@ -0,0 +1,57 @@
@@ -0,0 +1,57 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Flag } from '../flag'; |
||||
import { ModifiableInstruction } from '../modifiableInstruction'; |
||||
export declare class From extends ModifiableInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
protected stopSearchingForFlags(argument: string): boolean; |
||||
getImage(): string | null; |
||||
/** |
||||
* Returns the name of the image that will be used as the base image. |
||||
* |
||||
* @return the base image's name, or null if unspecified |
||||
*/ |
||||
getImageName(): string | null; |
||||
/** |
||||
* Returns the range that covers the name of the image used by |
||||
* this instruction. |
||||
* |
||||
* @return the range of the name of this instruction's argument, |
||||
* or null if no image has been specified |
||||
*/ |
||||
getImageNameRange(): Range | null; |
||||
/** |
||||
* Returns the range that covers the image argument of this |
||||
* instruction. This includes the tag or digest of the image if |
||||
* it has been specified by the instruction. |
||||
* |
||||
* @return the range of the image argument, or null if no image |
||||
* has been specified |
||||
*/ |
||||
getImageRange(): Range | null; |
||||
getImageTag(): string | null; |
||||
/** |
||||
* Returns the range in the document that the tag of the base |
||||
* image encompasses. |
||||
* |
||||
* @return the base image's tag's range in the document, or null |
||||
* if no tag has been specified |
||||
*/ |
||||
getImageTagRange(): Range | null; |
||||
getImageDigest(): string | null; |
||||
/** |
||||
* Returns the range in the document that the digest of the base |
||||
* image encompasses. |
||||
* |
||||
* @return the base image's digest's range in the document, or null |
||||
* if no digest has been specified |
||||
*/ |
||||
getImageDigestRange(): Range | null; |
||||
private indexOf; |
||||
private lastIndexOf; |
||||
getRegistry(): string | null; |
||||
getRegistryRange(): Range | null; |
||||
getBuildStage(): string | null; |
||||
getBuildStageRange(): Range | null; |
||||
getPlatformFlag(): Flag | null; |
||||
} |
@ -0,0 +1,198 @@
@@ -0,0 +1,198 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const modifiableInstruction_1 = require("../modifiableInstruction"); |
||||
class From extends modifiableInstruction_1.ModifiableInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
stopSearchingForFlags(argument) { |
||||
return argument.indexOf("--") === -1; |
||||
} |
||||
getImage() { |
||||
return this.getRangeContent(this.getImageRange()); |
||||
} |
||||
/** |
||||
* Returns the name of the image that will be used as the base image. |
||||
* |
||||
* @return the base image's name, or null if unspecified |
||||
*/ |
||||
getImageName() { |
||||
return this.getRangeContent(this.getImageNameRange()); |
||||
} |
||||
/** |
||||
* Returns the range that covers the name of the image used by |
||||
* this instruction. |
||||
* |
||||
* @return the range of the name of this instruction's argument, |
||||
* or null if no image has been specified |
||||
*/ |
||||
getImageNameRange() { |
||||
let range = this.getImageRange(); |
||||
if (range) { |
||||
let registryRange = this.getRegistryRange(); |
||||
if (registryRange) { |
||||
range.start = this.document.positionAt(this.document.offsetAt(registryRange.end) + 1); |
||||
} |
||||
let tagRange = this.getImageTagRange(); |
||||
let digestRange = this.getImageDigestRange(); |
||||
if (tagRange === null) { |
||||
if (digestRange !== null) { |
||||
range.end = this.document.positionAt(this.document.offsetAt(digestRange.start) - 1); |
||||
} |
||||
} |
||||
else { |
||||
range.end = this.document.positionAt(this.document.offsetAt(tagRange.start) - 1); |
||||
} |
||||
return range; |
||||
} |
||||
return null; |
||||
} |
||||
/** |
||||
* Returns the range that covers the image argument of this |
||||
* instruction. This includes the tag or digest of the image if |
||||
* it has been specified by the instruction. |
||||
* |
||||
* @return the range of the image argument, or null if no image |
||||
* has been specified |
||||
*/ |
||||
getImageRange() { |
||||
let args = this.getArguments(); |
||||
return args.length !== 0 ? args[0].getRange() : null; |
||||
} |
||||
getImageTag() { |
||||
return this.getRangeContent(this.getImageTagRange()); |
||||
} |
||||
/** |
||||
* Returns the range in the document that the tag of the base |
||||
* image encompasses. |
||||
* |
||||
* @return the base image's tag's range in the document, or null |
||||
* if no tag has been specified |
||||
*/ |
||||
getImageTagRange() { |
||||
const range = this.getImageRange(); |
||||
if (range) { |
||||
if (this.getImageDigestRange() === null) { |
||||
let content = this.getRangeContent(range); |
||||
let index = this.lastIndexOf(this.document.offsetAt(range.start), content, ':'); |
||||
// the colon might be for a private registry's port and not a tag
|
||||
if (index > content.indexOf('/')) { |
||||
return vscode_languageserver_types_1.Range.create(range.start.line, range.start.character + index + 1, range.end.line, range.end.character); |
||||
} |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
getImageDigest() { |
||||
return this.getRangeContent(this.getImageDigestRange()); |
||||
} |
||||
/** |
||||
* Returns the range in the document that the digest of the base |
||||
* image encompasses. |
||||
* |
||||
* @return the base image's digest's range in the document, or null |
||||
* if no digest has been specified |
||||
*/ |
||||
getImageDigestRange() { |
||||
let range = this.getImageRange(); |
||||
if (range) { |
||||
let content = this.getRangeContent(range); |
||||
let index = this.lastIndexOf(this.document.offsetAt(range.start), content, '@'); |
||||
if (index !== -1) { |
||||
return vscode_languageserver_types_1.Range.create(range.start.line, range.start.character + index + 1, range.end.line, range.end.character); |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
indexOf(documentOffset, content, searchString) { |
||||
let index = content.indexOf(searchString); |
||||
const variables = this.getVariables(); |
||||
for (let i = 0; i < variables.length; i++) { |
||||
const position = documentOffset + index; |
||||
const variableRange = variables[i].getRange(); |
||||
if (this.document.offsetAt(variableRange.start) < position && position < this.document.offsetAt(variableRange.end)) { |
||||
const offset = this.document.offsetAt(variableRange.end) - documentOffset; |
||||
const substring = content.substring(offset); |
||||
const subIndex = substring.indexOf(searchString); |
||||
if (subIndex === -1) { |
||||
return -1; |
||||
} |
||||
index = subIndex + offset; |
||||
i = -1; |
||||
continue; |
||||
} |
||||
} |
||||
return index; |
||||
} |
||||
lastIndexOf(documentOffset, content, searchString) { |
||||
let index = content.lastIndexOf(searchString); |
||||
const variables = this.getVariables(); |
||||
for (let i = 0; i < variables.length; i++) { |
||||
const position = documentOffset + index; |
||||
const variableRange = variables[i].getRange(); |
||||
if (this.document.offsetAt(variableRange.start) < position && position < this.document.offsetAt(variableRange.end)) { |
||||
index = content.substring(0, index).lastIndexOf(searchString); |
||||
if (index === -1) { |
||||
return -1; |
||||
} |
||||
i = -1; |
||||
continue; |
||||
} |
||||
} |
||||
return index; |
||||
} |
||||
getRegistry() { |
||||
return this.getRangeContent(this.getRegistryRange()); |
||||
} |
||||
getRegistryRange() { |
||||
const range = this.getImageRange(); |
||||
if (range) { |
||||
const tagRange = this.getImageTagRange(); |
||||
const digestRange = this.getImageDigestRange(); |
||||
if (tagRange === null) { |
||||
if (digestRange !== null) { |
||||
range.end = this.document.positionAt(this.document.offsetAt(digestRange.start) - 1); |
||||
} |
||||
} |
||||
else { |
||||
range.end = this.document.positionAt(this.document.offsetAt(tagRange.start) - 1); |
||||
} |
||||
const content = this.getRangeContent(range); |
||||
const rangeStart = this.document.offsetAt(range.start); |
||||
const portIndex = this.indexOf(rangeStart, content, ':'); |
||||
const dotIndex = this.indexOf(rangeStart, content, '.'); |
||||
const startingSlashIndex = this.indexOf(rangeStart, content, '/'); |
||||
// hostname detected
|
||||
if (portIndex !== -1 || dotIndex !== -1) { |
||||
return vscode_languageserver_types_1.Range.create(range.start, this.document.positionAt(rangeStart + startingSlashIndex)); |
||||
} |
||||
const registry = content.substring(0, startingSlashIndex); |
||||
// localhost registry detected
|
||||
if (registry === 'localhost') { |
||||
return vscode_languageserver_types_1.Range.create(range.start, this.document.positionAt(rangeStart + startingSlashIndex)); |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
getBuildStage() { |
||||
let range = this.getBuildStageRange(); |
||||
return range === null ? null : this.getRangeContent(range); |
||||
} |
||||
getBuildStageRange() { |
||||
let args = this.getArguments(); |
||||
if (args.length > 2 && args[1].getValue().toUpperCase() === "AS") { |
||||
return args[2].getRange(); |
||||
} |
||||
return null; |
||||
} |
||||
getPlatformFlag() { |
||||
let flags = super.getFlags(); |
||||
return flags.length === 1 && flags[0].getName() === "platform" ? flags[0] : null; |
||||
} |
||||
} |
||||
exports.From = From; |
@ -0,0 +1,9 @@
@@ -0,0 +1,9 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Argument } from '../argument'; |
||||
import { ModifiableInstruction } from '../modifiableInstruction'; |
||||
export declare class Healthcheck extends ModifiableInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
protected stopSearchingForFlags(argument: string): boolean; |
||||
getSubcommand(): Argument | null; |
||||
} |
@ -0,0 +1,17 @@
@@ -0,0 +1,17 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const modifiableInstruction_1 = require("../modifiableInstruction"); |
||||
class Healthcheck extends modifiableInstruction_1.ModifiableInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
stopSearchingForFlags(argument) { |
||||
argument = argument.toUpperCase(); |
||||
return argument === "CMD" || argument === "NONE"; |
||||
} |
||||
getSubcommand() { |
||||
let args = this.getArguments(); |
||||
return args.length !== 0 ? args[0] : null; |
||||
} |
||||
} |
||||
exports.Healthcheck = Healthcheck; |
@ -0,0 +1,10 @@
@@ -0,0 +1,10 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Variable } from '../variable'; |
||||
import { Property } from '../property'; |
||||
import { PropertyInstruction } from '../propertyInstruction'; |
||||
export declare class Label extends PropertyInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
getVariables(): Variable[]; |
||||
getProperties(): Property[]; |
||||
} |
@ -0,0 +1,34 @@
@@ -0,0 +1,34 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const propertyInstruction_1 = require("../propertyInstruction"); |
||||
const util_1 = require("../util"); |
||||
class Label extends propertyInstruction_1.PropertyInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
getVariables() { |
||||
const variables = super.getVariables(); |
||||
const properties = this.getProperties(); |
||||
// iterate over all of this LABEL's properties
|
||||
for (const property of properties) { |
||||
const value = property.getUnescapedValue(); |
||||
// check if the value is contained in single quotes,
|
||||
// single quotes would indicate a literal value
|
||||
if (value !== null && value.length > 2 && value.charAt(0) === '\'' && value.charAt(value.length - 1) === '\'') { |
||||
const range = property.getValueRange(); |
||||
for (let i = 0; i < variables.length; i++) { |
||||
// if a variable is in a single quote, remove it from the list
|
||||
if (util_1.Util.isInsideRange(variables[i].getRange().start, range)) { |
||||
variables.splice(i, 1); |
||||
i--; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
return variables; |
||||
} |
||||
getProperties() { |
||||
return super.getProperties(); |
||||
} |
||||
} |
||||
exports.Label = Label; |
@ -0,0 +1,10 @@
@@ -0,0 +1,10 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { Instruction } from '../instruction'; |
||||
export declare class Onbuild extends Instruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
getTrigger(): string | null; |
||||
getTriggerWord(): string | null; |
||||
getTriggerRange(): Range | null; |
||||
getTriggerInstruction(): Instruction | null; |
||||
} |
@ -0,0 +1,34 @@
@@ -0,0 +1,34 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
/* -------------------------------------------------------------------------------------------- |
||||
* Copyright (c) Remy Suen. All rights reserved. |
||||
* Licensed under the MIT License. See License.txt in the project root for license information. |
||||
* ------------------------------------------------------------------------------------------ */ |
||||
const vscode_languageserver_types_1 = require("vscode-languageserver-types"); |
||||
const parser_1 = require("../parser"); |
||||
const instruction_1 = require("../instruction"); |
||||
class Onbuild extends instruction_1.Instruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
getTrigger() { |
||||
let trigger = this.getTriggerWord(); |
||||
return trigger === null ? null : trigger.toUpperCase(); |
||||
} |
||||
getTriggerWord() { |
||||
return this.getRangeContent(this.getTriggerRange()); |
||||
} |
||||
getTriggerRange() { |
||||
let args = this.getArguments(); |
||||
return args.length > 0 ? args[0].getRange() : null; |
||||
} |
||||
getTriggerInstruction() { |
||||
let triggerRange = this.getTriggerRange(); |
||||
if (triggerRange === null) { |
||||
return null; |
||||
} |
||||
let args = this.getArguments(); |
||||
return parser_1.Parser.createInstruction(this.document, this.dockerfile, this.escapeChar, vscode_languageserver_types_1.Range.create(args[0].getRange().start, this.getRange().end), this.getTriggerWord(), triggerRange); |
||||
} |
||||
} |
||||
exports.Onbuild = Onbuild; |
@ -0,0 +1,7 @@
@@ -0,0 +1,7 @@
|
||||
import { Range, TextDocument } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { JSONInstruction } from '../jsonInstruction'; |
||||
export declare class Run extends JSONInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
stopSearchingForFlags(argument: string): boolean; |
||||
} |
@ -0,0 +1,12 @@
@@ -0,0 +1,12 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const jsonInstruction_1 = require("../jsonInstruction"); |
||||
class Run extends jsonInstruction_1.JSONInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
stopSearchingForFlags(argument) { |
||||
return argument.indexOf("--") === -1; |
||||
} |
||||
} |
||||
exports.Run = Run; |
@ -0,0 +1,6 @@
@@ -0,0 +1,6 @@
|
||||
import { TextDocument, Range } from 'vscode-languageserver-types'; |
||||
import { Dockerfile } from '../dockerfile'; |
||||
import { JSONInstruction } from '../jsonInstruction'; |
||||
export declare class Shell extends JSONInstruction { |
||||
constructor(document: TextDocument, range: Range, dockerfile: Dockerfile, escapeChar: string, instruction: string, instructionRange: Range); |
||||
} |
@ -0,0 +1,9 @@
@@ -0,0 +1,9 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const jsonInstruction_1 = require("../jsonInstruction"); |
||||
class Shell extends jsonInstruction_1.JSONInstruction { |
||||
constructor(document, range, dockerfile, escapeChar, instruction, instructionRange) { |
||||
super(document, range, dockerfile, escapeChar, instruction, instructionRange); |
||||
} |
||||
} |
||||
exports.Shell = Shell; |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue