refactor: get rid of unnecessary `get_var()` function

docs: fix sample config

Was using the wrong variable names.

feat: support both Lua global and Vim global for CorpusDirectories

Probably should have been this way from the start. Only really keeping
the Lua global around for backwards compatibility.

feat: add `:Corpus!` and `g:CorpusBangCreation`

Closes: https://github.com/wincent/corpus/issues/81

chore: rename "master" → "main"

fix: avoid E874

Seeing this on recent builds, which suggests that maybe the default
regexp implementation has changed lately:

  Error detected while processing function corpus#buf_write_pre[2]..corpus#update_references
  E874: (NFA) Could not pop the stack!

As `:h NFA` explains:

                                    /\%#= two-engines NFA
    Vim includes two regexp engines:
    1. An old, backtracking engine that supports everything.
    2. A new, NFA engine that works much faster on some patterns, possibly slower
       on some patterns.

    Vim will automatically select the right engine for you.  However, if you run
    into a problem or want to specifically select one engine or the other, you can
    prepend one of the following to the pattern:

            \%#=0   Force automatic selection.  Only has an effect when
                    'regexpengine' has been set to a non-zero value.
            \%#=1   Force using the old engine.
            \%#=2   Force using the NFA engine.

    You can also use the 'regexpengine' option to change the default.

                             E864 E868 E874 E875 E876 E877 E878
    If selecting the NFA engine and it runs into something that is not implemented
    the pattern will not match.  This is only useful when debugging Vim.

fix: change default for g:CorpusPreviewWinhighlight

As suggested in:

    https://github.com/wincent/corpus/issues/75#issuecomment-728212340

because:

> Just a nit, but I'd lean toward a different default. VertSplit is
> decoration so colorschemes are not designed with the expectation it
> it will be used to render text. It seems more likely than almost any
> other syntax group to be set up with very low or no contrast between
> fg and bg.

Switched to LineNr, semi-arbitrarily (there is no guaranteed highlight
group that is going to look good with all colorschemes, but this one
should at least not look invisible).

feat: add settings for controlling highlights

Adds `g:CorpusChooserSelectionHighlight` and
`g:CorpusPreviewWinhighlight`.

Closes: https://github.com/wincent/corpus/issues/75

refactor: use terser access method for getting options

fix: update listing and preview when there are no matches

Because otherwise the last-seen results we had continue to be shown. So
we need, at a minimum, a `vim.cmd('redraw')`, and we also need to clear
out the preview buffer.

refactor: avoid repeated calls to preview()

We always calls it right after `highlight_selection()`, so let's just
fold it into that function.

perf: avoid unnecessary redraw

Don't need to call `redraw()` before calling `preview()` because
`preview()` is going to call it anyway.

fix: handle edge cases when outside of Corpus directory

Example:

  :Corpus <tab>

Expands to:

  :Corpus /

If you hit enter there, we don't want to blindly `cd` to "/". In fact we
never want to `cd` to anything with a slash, unless it is a valid Corpus
directory.

  :Corpus whatever else

should be taken as a cue to open or create the note "whatever else.md"
in the default corpus directory (the first one in the config).

fix: make symlink resolution work again

Order matters here:

    resolve('~/thing')

doesn't resolve symlinks because it treats "~" literally. In other words:

    fnamemodify(resolve('~/thing'), ':p')

doesn't work, but:

    resolve(fnamemodify('~/thing', ':p'))

does.

I broke this in c255bc375ea95689c45c5812e4fda94f33d99b86 while fixing
another bug (which required me to remove an `expand()` call).

docs: replace static screenshot with demo gif

docs: correct logo URL

docs: add logo

feat: filter autocompletion list outside of Corpus directories

This will probably do the wrong thing if you have spaces in your
directories; will fix that if it comes up, I guess.

refactor: get rid of unnecessary expression

fix: make tab completion cycling work outside of Corpus directories

This was getting stuck on second item. Basically, if you call `expand()`
it gets stuck, otherwise it doesn't... (:facepalm:).

So, only call `expand()` if we actually need to (only one place we do
that, which is the ftdetect plug-in).

feat: improve completion

Now you can tab complete the current selection, if it matches the
prefix.

docs: add some initial docs

Built using:

    (cd ~/code/docvim && bin/docvim ~/code/corpus/doc/corpus.txt ~/code/corpus/README.md -c ~/code/corpus -v)

fix: handle filenames split across I/O chunks

In my initial testing, never saw split names, but I have now, so fixing
it.

refactor: inline cancel function

No value in it being declared separately; it just adds vertical space
for no benefit.

refactor: drop unused pid binding

feat: run listing and search as async jobs

This means you can hold down a key in the command line and it won't get
laggy. Instead of kicking of blocking serial jobs one after the other,
we cancel the previous job and start a new one. This makes things super
responsive.

fix: do nothing unless on Neovim

To avoid things blowing up when we try to do Lua stuff on Vim.

fix: make padding work on wide screens

fix: don't let people create files with untrimmed whitespace

fix: restore cursor positioning

Forgot that I needed this (even though the cursor is not visible) in
order to scroll the selection into view, if necessary.

chore: port corpus#choose()

chore: add some TODO comments

perf: avoid eagerly loading Corpus

Of course, it will load as soon as you do _anything_ in the commandline,
but at least it won't hurt startup time in the common case.

fix: show selection on initial load/search

fix: pad buffer with empty lines to extend foldcolumn

fix: stop numbers from showing up in foldcolumn

feat: make selection extend all the way across in chooser window

feat: use foldcolumn to make pane separation more obvious

Or rather than "more", "at all".

fix: make matching non-greedy anything

Means we can actually search for multiple words again.

feat: add highlighting of selected row

feat: improve appearance by using `'winhl'`

refactor: port preview_next and preview_previous to Lua

refactor: implement preview

Doesn't update when you move yet, because I haven't wired up those
bindings, but it shows correctly on first render and when you change the
command line query.

refactor: start building out chooser window with Lua

refactor: replace some home-made stuff with Neovim built-ins

feat: add util.list.push

feat: auto-init Git repo if needed

Some refactoring included here along the way in making this work, and
some TODOs noted inline.

fix: invert sense of smartcase check

This was mis-ported from the Vimscript version in e24661d3.

Meant that "smartcase" queries (ie. containing uppercase) were
case-insensitive, and non-smartcase queries (ie. all lowercase) were the
opposite.

perf: lazy-load utility modules

refactor: prefer v:lua over luaeval

It's terser, and this is why I made "corpus" a global in the first
place.

fix: make sure Lua module loaded whenany autoloaded function runs

refactor: extract "util" functions

This might be my JS developer mentality coming through here but I really
want to have clear APIs for dealing with "list"-like tables and
"dict"-like ones, so that's where I'm starting here.

fix: port and fix corpus#commit() to Lua

We were failing to commit new files because we passed "file" instead of
"file.md" (due to the ":r" modifier).

refactor: continue Lua port

Arbitrary cut-off point here. Trying to keep this working at each
incremental step.

refactor: start porting to Lua

Experimental. Just want to see if it is any faster.

There is some sketchy quoting and concatenation going on here in the
Vimscript, but that's temporary and will go away as the associated code
gets ported.

feat: allow ".md" extension when creating new files

Just say you want to create a file "foo.md" but you already have one
called "food.md"; you can't just type "foo" and hit enter because that
will just open the existing file. If we weren't in the terminal, and we
could actually distinguish between enter and, say, control-enter, then
we could use that as a cue to create the file. But we are in the
terminal, so we instead allow you to type "foo.md". That won't match
"food.md" unless you happen to have that string inside it (unlikely), so
in this way you can add an extension, optionally, as a way of forcing a
unique match and thus creating a new file. Subtle, but useful.

chore: add standard Vim plug-in boilerplate

chore: add license headers to individual files

docs: add LICENSE.md

This existed in a former incarnation of this branch (added in
abda4ad505a0f208), so just resurrect it here.

docs: tweak README again for clarity

Mention transition to Vim earlier on, and add a screenshot to make it
more obvious.

docs: update README to reflect current status

This notes that the Vim plug-in version is now the "official" Corpus
line of development; the code for the JS-powered version can still be
found in the repo history, obviously.

Really, the entire document needs to be rewritten, but I'll have to
tackle that later.

docs: bring README.md across from old "master" branch

As of: 47821885da24509998720feaf4c52c9801dc5647

chore: ignore "media" worktree

Merge branch 'vim'

Similar to what we did in 3933f06f97aa537e28a67615211e1d21d930b186, this
is a "trick" merge to replace the "master" branch with the contents of
the "vim" branch, preserving the history of both in the DAG.

First, up, got ready to extract the "vim" branch from my dotfiles repo
as of this commit:

    https://github.com/wincent/wincent/commit/612f9512ec5ef43c9861b4e4049b05e0c050d352

Steps:

    git checkout --detach 612f9512ec5ef43c9861b4e4049b05e0c050d352

    git filter-branch --prune-empty --index-filter '
        # On macOS, need to brew install grep gnu-sed findutils first
        git ls-files -z | gegrep -zv  "\.vim/pack/bundle/opt/corpus" |
            gxargs -0 -r git rm --cached -q
        # Move files to root directory
        git ls-files -s | gsed -e "s-\t.\+vim/pack/bundle/opt/corpus/-\t-" |
            GIT_INDEX_FILE=$GIT_INDEX_FILE.new \
            git update-index --index-info &&
            ( test ! -f "$GIT_INDEX_FILE.new" \
                || mv -f "$GIT_INDEX_FILE.new" "$GIT_INDEX_FILE" )
    '

ie. using trick described here:

    https://stackoverflow.com/a/14764368/2103996

To rewrite history of "corpus" directory, which has been renamed twice,
to appear as though it were all at the repo root:

- roles/dotfiles/files/.vim/pack/bundle/opt/corpus
- aspects/dotfiles/files/.vim/pack/bundle/opt/corpus
- aspects/vim/files/.vim/pack/bundle/opt/corpus

End result was c9ecd780e261d1b9411782d8afd6f02507ccdea0, so:

    # Name the branch
    git branch scratch c9ecd780e261d1b9411782d8afd6f02507ccdea0

    # Restore master
    git checkout master

    # (Later on, can throw away scratch branch with this...)
    git branch -D scratch

In this repo:

    git add local path-to-dotfiles
    git fresh # an alias to fetch all remotes; ie. git remote update --prune
    git show local/scratch # sanity check
    git branch vim local/scratch # name branch here too
    git checkout vim
    git merge -s ours --allow-unrelated-histories master
    git commit --amend (to fix message)

Note that to get real history in here, reading it in with:

    :read !git log --oneline --no-decorate local/scratch

Finally, will twiddle the branches to point at the right commits (ie.
"master" needs to point at "vim").

* vim:
  fix(corpus): make sure we autocommit changes to new files
  refactor(corpus): scope command-line mappings more tightly
  fix(vim): avoid error on /usr/bin/vim startup
  feat(corpus): make it possible to create new files from search
  fix(corpus): actually detect backticks
  fix(corpus): fix bad fence detection pattern
  fix(corpus): remove errant logging
  fix(corpus): abort link detection if you run into an adjacent link
  refactor(corpus): remove unnecessary "repo" config
  refactor(corpus): clean up a code comment
  fix(corpus): work around unexpected `git-grep -z` behavior
  fix(corpus): store labels case insensitively
  style(corpus): fix code formatting
  fix(corpus): make sure preview redraws
  perf(corpus): make synthetic preview window
  perf(corpus): debounce previews
  refactor(corpus): remove dead code
  fix(corpus): work around for ftdetect not running on first
  feat(corpus): approach feature-completeness for initial version
  feat(corpus): preview when switching via c-j, c-k
  feat(corpus): prototype of typeahead search
  fix(corpus): make sure we actually get config when trying to jump
  chore(corpus): give up on fancy search/navigation for now
  refactor(corpus): lame attempt at making previewing faster
  refactor(corpus): revisit preview windows etc
  fix(corpus): fix bad deletebufline() call
  feat(corpus): support visual mode
  feat(corpus): make <C-]> navigate to a link target (or linkify)
  feat(corpus): partially sort link reference definitions
  feat(corpus): implement crude target transform
  feat(corpus): get autolinking working
  test(corpus): add some stub tests
  feat(corpus): don't manage titles automatically unless autotitle is set
  refactor(corpus): deduplicate some logic
  feat(corpus): update tags when auto-updating metadata
  feat(corpus): update title metadata on save
  feat(corpus): add multi-directory configuration
  refactor(corpus): start preparing minimal version of Corpus experiment
  chore(corpus): enable Corpus experiment but turn it into a no-op
  feat: use up/down to move among quickfix results
  feat: integrate quickfix list and proper search
  feat: use Git to search inside files
  feat: add initial experimentation with previews

fix(corpus): make sure we autocommit changes to new files

refactor(corpus): scope command-line mappings more tightly

Although, as noted in the comments, could do this a little more
conservatively. I think I'll just provide settings to override the
mappings so that you suppress them if you want.

docs: remove errant hyphen

docs: link to Vim-based Corpus screencast

fix(vim): avoid error on /usr/bin/vim startup

feat(corpus): make it possible to create new files from search

fix(corpus): actually detect backticks

Given:

   foo `bar` baz

On finding first backtick, intent was to find second one, but we just
found the same one again due to our failure to add one to the index.
This broke code span detection, cause this to get improperly treated as
a shortcut link:

    foo `baz [bar] boom`

Same problem doesn't occur with links:

    foo [bar] baz

Because when we are at "[" and scan ahead looking for "]", there is no
possibility of finding "]" at "[" even without the index increment,
because they obviously don't match.

fix(corpus): fix bad fence detection pattern

Was preventing fenced code blocks from being detected.

fix(corpus): remove errant logging

fix(corpus): abort link detection if you run into an adjacent link

Otherwise, if cursor is on "foo" in:

    This [is a link] and foo is before [another link].

Then we'll end up thinking that we found one big (and invalid) link:

         [is a link] and foo is before [another link]

instead of linking foo:

    This [is a link] and [foo] is before [another link].

refactor(corpus): remove unnecessary "repo" config

refactor(corpus): clean up a code comment

fix(corpus): work around unexpected `git-grep -z` behavior

It does not behave like `git-ls-files -z`, which emits paths as-is.
Rather, it will omit paths like those noted in the comments.

fix(corpus): store labels case insensitively

So as to avoid creating duplicate link reference definitions given input
like:

    [Open source] is more than just [open source].

    ie. we want:

    [Open source]: /wiki/Open_source

    not:

    [Open source]: /wiki/Open_source
    [open source]: /wiki/open_source

style(corpus): fix code formatting

fix(corpus): make sure preview redraws

perf(corpus): make synthetic preview window

Because it might be faster.

perf(corpus): debounce previews

Because they are super slow.

refactor(corpus): remove dead code

fix(corpus): work around for ftdetect not running on first

feat(corpus): approach feature-completeness for initial version

feat(corpus): preview when switching via c-j, c-k

feat(corpus): prototype of typeahead search

fix(corpus): make sure we actually get config when trying to jump

chore(corpus): give up on fancy search/navigation for now

As noted in the comments, navigating via the quickfix listing is too
slow, any we don't want to pollute the stack with junk anyway.

Trouble is we have fast content search (eg. ":Ack") and fast title
search (eg. ":CommandT"), but we don't have a slick preview mechanism
like we do in the graphical Corpus.

We *might* be able to get something to work nicely with `:pedit` if we
hack deeply into Command-T, but I am not sure I want to do that.
Basically, it would consist of running a search powered by `git grep`
at the prompt (debounced), and basically just using Command-T's
MatchWindow, not its search, and plugging in `:pedit`-based preview
(likely debounced). At first blush, I don't think we want to do any of
that, and might be better off just reimplementing the MatchWindow
functionality from scratch using VimScript alone (and maybe some of the
newer functionality, like floating windows).

refactor(corpus): lame attempt at making previewing faster

Doesn't work because the "current" quickfix item isn't changing.

refactor(corpus): revisit preview windows etc

This is some early POC code that I wrote a while back. Now that I have a
basic version of the auto-linking working, I think it's time to start
looking at the "navigation/search" side of the equation.

fix(corpus): fix bad deletebufline() call

"." will match any buffer with a name, so this was causing an E93 "more
than one match" as soon as you had more than one buffer.

feat(corpus): support visual mode

feat(corpus): make <C-]> navigate to a link target (or linkify)

feat(corpus): partially sort link reference definitions

We don't re-sort existing ones, but we at least make sure that any new
ones that we add get inserted in sorted order relative to each other.

feat(corpus): implement crude target transform

To avoid unwanted "%20" in web URLs.

feat(corpus): get autolinking working

Still need transform though, for the Masochist use case. Because if we
link to a page like "[some page]", the link reference definition will
be:

    [some page]: </wiki/some page>

And the link works, but it takes you to:

    https://wincent.com/wiki/some%20page

instead of:

    https://wincent.com/wiki/some_page

test(corpus): add some stub tests

feat(corpus): don't manage titles automatically unless autotitle is set

refactor(corpus): deduplicate some logic