Skip to content

Commit dac2b52

Browse files
committed
chore: rename DoGe -> vim-doge; update CHANGELOG; add ToC in all MD files
1 parent 45a9c71 commit dac2b52

File tree

7 files changed

+60
-19
lines changed

7 files changed

+60
-19
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ generate documentation.
3535
**Settings**
3636

3737
<!--
38-
If applicable, describe your custom DoGe settings like so:
38+
If applicable, describe your custom vim-doge settings like so:
3939
4040
```vim
4141
let g:doge_mapping = '<Leader>f'

.github/PULL_REQUEST_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Prelude
22

3-
Thank you for helping out DoGe!
3+
Thank you for helping out vim-doge!
44

55
<!--
66
Replace [ ] with [x] with those you agree with.
77
-->
88

9-
By contributing to DoGe you agree to the following statements:
9+
By contributing to vim-doge you agree to the following statements:
1010

1111
- [ ] I have read and understood the [Contribution Guidelines](https://github.com/kkoomen/vim-doge/blob/master/CONTRIBUTING.md).
1212
- [ ] I have read and understood the [Code of Conduct](https://github.com/kkoomen/vim-doge/blob/master/CODE_OF_CONDUCT.md).

CHANGELOG.md

+37
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
1+
## [4.0.0](https://github.com/kkoomen/vim-doge/compare/v3.22.0...v4.0.0)
2+
3+
In v4 a new custom [vim-doge-helper](./helper/) has been created, completely
4+
developed in Rust from scratch, being a replacement for the old NodeJS version
5+
that vim-doge had in v3.
6+
7+
This new version resolves the following problems that existed prior to v4:
8+
- Failing Windows builds due to node-gyp build problems
9+
- Templating limitations: v4 contained basic templating functionality that
10+
was customly written, as opposed to v4 that uses
11+
[Tera](https://tera.netlify.app/docs)
12+
- Limited platform builds: v3 required due to NodeJS that binaries were created
13+
on the target machine itself that it was eventually used for. Windows builds
14+
had to be created on a windows runner and support for Apple Silicon had to be
15+
build on arm64 machines, but v4 can use the power of cross-compilation of Rust
16+
(through LLVM) to make builds for any platform we want, all on a single
17+
machine.
18+
- Tree-sitter language limitations: v3 required parsers to be published on NPM,
19+
but these packages weren't maintained that well. If there was no package of a
20+
certain parser on NPM, then we simply can't implement the language. With v4 we
21+
can use the tree-sitter GitHub source to be included in Cargo.toml that can
22+
link everything properly from C to Rust and we don't need any third-party
23+
package manager anymore in-between vim-doge and tree-sitter.
24+
- Vimscript logic: v3 contained docblock generating logic that should actually
25+
not be managed in vim. For example, It used plain regex to do some additional
26+
pre/post-processing rather than using tree-sitter. In v4 all the logic has
27+
been moved to the [vim-doge-helper](./helper/) and all the vimscript code is
28+
only a bridge between the user and the vim-doge-helper.
29+
- Speed: v4 allows docblocks to be generated with the blink of an eye, as
30+
opposed to v3 where users had to wait a bit, and even worse, the first
31+
docblock genereration you did in v3 after you've downloaded the vim-doge
32+
binary, did require NodeJS to start the runtime which would take a second or
33+
two.
34+
35+
36+
Besides the above being resolved,
37+
138
## [3.22.0](https://github.com/kkoomen/vim-doge/compare/v3.21.0...v3.22.0) (2023-06-10)
239

340
### Features

CONTRIBUTING.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,18 @@ When contributing make sure you have read and understood the
1111

1212
- [Contribution Guidelines](#contribution-guidelines)
1313
- [Table of Contents](#table-of-contents)
14-
- [How does DoGe work?](#how-does-doge-work)
14+
- [How does vim-doge work?](#how-does-vim-doge-work)
1515
- [Topics](#topics)
16-
- [Linting](#linting)
17-
- [Documentation](#documentation)
18-
- [Doc standard](#doc-standard)
19-
- [Filetype / language](#filetype--language)
20-
- [Configurable setting](#configurable-setting)
21-
- [Code](#code)
22-
- [Tests](#tests)
16+
* [Linting](#linting)
17+
* [Documentation](#documentation)
18+
* [Doc standard](#doc-standard)
19+
* [Filetype / language](#filetype--language)
20+
* [Configurable setting](#configurable-setting)
21+
* [Code](#code)
22+
* [Tests](#tests)
2323
- [Tips](#tips)
24-
- [Writing your first pattern](#writing-your-first-pattern)
25-
- [Additional token formatting](#additional-token-formatting)
26-
- [Creating TODO placeholders](#creating-todo-placeholders)
27-
- [Default value](#default-value)
28-
- [Conditional rendering](#conditional-rendering)
24+
* [Parsers](#parsers)
25+
+ [Doc standards templating](#doc-standards-templating)
2926

3027
# How does vim-doge work?
3128

helper/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22

33
Helper extension for the [vim-doge](https://github.com/kkoomen/vim-doge)
44
plugin that parses code in order to generate docblocks using
5-
[tree-sitter](https://github.com/tree-sitter/tree-sitter).
5+
[tree-sitter](https://github.com/tree-sitter/tree-sitter), written in Rust.
6+
7+
# Table of Contents
8+
- [vim-doge-helper](#vim-doge-helper)
9+
- [Table of Contents](#table-of-contents)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Contributing](#contributing)
613

714
# Installation
815

plugin/doge.vim

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ if !exists('g:doge_mapping')
6262
""
6363
" (Default: '<Leader>d')
6464
"
65-
" The mapping to trigger DoGe. The mapping accepts a count, to select a
65+
" The mapping to trigger vim-doge. The mapping accepts a count, to select a
6666
" specific doc standard, if more than one is defined.
6767
let g:doge_mapping = '<Leader>d'
6868
endif

test/options/doge_buffer_mappings.vader

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Do (trigger doge):
1515
\<Tab>
1616
Lorem ipsum
1717

18-
# Trigger an additional <Tab> to deactivate DoGe.
18+
# Trigger an additional <Tab> to deactivate vim-doge.
1919
\<Tab>
2020

2121
Then (all buffer mappings should not exists anymore):

0 commit comments

Comments
 (0)