Skip to content

Latest commit

 

History

History
1381 lines (868 loc) · 98 KB

CHANGELOG.md

File metadata and controls

1381 lines (868 loc) · 98 KB

4.0.0 (2023-07-09)

In v4 a new custom vim-doge-helper has been created, completely developed in Rust from scratch, being a replacement for the old NodeJS version that vim-doge had in v3.

TL;DR: v4 now generates docblocks ~96% faster and has 87% smaller bundle sizes compared to v3.

This new version resolves the following problems that existed prior to v4:

  • Failing Windows builds due to node-gyp build problems
  • Templating limitations: v3 contained basic templating functionality that was custom written, as opposed to v4 that uses Tera
  • Limited platform builds: v3 required due to NodeJS that binaries were created on the target machine itself that it was eventually used for. Windows builds had to be created on a windows runner and support for Apple Silicon had to be build on arm64 machines, but v4 can use the power of cross-compilation of Rust (through LLVM) to make builds for multiple architectures.
  • Tree-sitter language limitations: v3 required parsers to be published on NPM, but these packages aren't maintained that well. If there was no package of a certain parser on NPM, then we simply can't implement the language. With v4 we can use the tree-sitter GitHub source to be included in Cargo.toml that can link everything properly from C to Rust and we don't need any third-party package manager anymore in-between vim-doge and tree-sitter.
  • Vimscript logic: v3 contained docblock generating logic that should actually not be managed in vim. For example, It used plain regex to do some additional pre/post-processing rather than using tree-sitter. In v4 all the logic has been moved to the vim-doge-helper and all the vimscript code is only a bridge between the user and the vim-doge-helper.
  • Speed: v4 allows docblocks to be generated with the blink of an eye, as opposed to v3 where users had to wait a bit, and even worse, the first docblock genereration you did in v3 after you've downloaded the vim-doge binary, did require NodeJS to start the runtime which lead to a total wait time of ±0.4s until the docblock was generated. With v4, docblock are generated in about ±0.015s.
  • Bundle size: v3 bundles were ~30MB, whereas v4 bundles are ~4MB (87% smaller)

3.22.0 (2023-06-10)

Features

  • only replace \t chars when not followed by "param" (c7354ff)

3.21.0 (2023-05-05)

Features

  • rust: insert docblock above macros (74b7ba1)

3.20.0 (2023-05-01)

Features

  • manually compile for osx arm64 (e547ece)
  • c,cpp: add docblock tag custom char config option (closes #534) (f772669)
  • c,cpp: add in-out direction docblock param jumps (closes #533) (4872f45)

Bug Fixes

  • cpp: support direction in-out for param tags (076bf12)

3.19.1 (2023-01-20)

3.19.0 (2022-12-26)

Features

  • python: implement omit_redundant_param_types option (4eda2dd)

3.18.0 (2022-08-19)

Features

  • remove CreateDocStandard command due to unmaintainble and unnecessary complex logic (8c402d6)
  • cpp: support three new doxygen cpp doc standards (82a8d98)

Bug Fixes

  • c,cpp: use !summary at @brief instead of !description (85bc0c7)

3.17.0 (2022-07-25)

Features

3.16.0 (2022-07-25)

Features

  • javascript/typescript: add @return based on return type or return statement value (cc67ab3)

3.15.0 (2022-07-24)

Bug Fixes

  • downgrade node from v18 to v16 (87ef8af)
  • ci: use latest VIM v8 version rather than v9 (b60c4fc)

Features

  • copy over PR #313 due to unrelated histories and adjust logic (a8eceb6)

3.14.0 (2022-06-17)

Bug Fixes

  • adjust startPosition logic (1692e96)
  • adjust startPosition logic (d11695e)
  • cpp: insert comment at correct position for classes, struct and function declarations (870eafd)
  • cpp: limit startPosition bottom limit to 0 (51c7a6d)

Features

  • expand comment where the function starts (742fd25)

3.13.0 (2022-06-15)

Bug Fixes

  • adjust startPosition logic (1692e96)
  • adjust startPosition logic (d11695e)
  • cpp: limit startPosition bottom limit to 0 (51c7a6d)

Features

  • expand comment where the function starts (742fd25)

3.12.0 (2022-05-01)

Bug Fixes

  • adjust typescript parser (3a433fe)
  • exclude windows builds because of node-gyp issues (cdc686e)
  • remove yarn and update package-lock.json (85c945a)
  • resolve broken TS tests (bbaca07)
  • resolve linter issues (7fee3af)
  • python: remove colon after return types in numpy doc (#308) (a27735a)

Features

  • add new husky config (86b585f)
  • update caxa command (1f07855)
  • upgrade everything (99caf16)
  • use improved lua parser and fix broken tests (6650989)

3.11.0 (2021-10-09)

Features

3.10.0 (2021-04-28)

Bug Fixes

  • fix issue with return type not rendering when it should (3421840)
  • fix issue with void return being rendered (3126f68)
  • get omit_redundant_param_types test passing, add better description (7882a1a)
  • optimise code and fix filetype switching issue (e6bab1f)
  • revert changing default to optional in membertype expressions template. (e17fb0b)
  • revert version (60ec8f0)

Features

  • Add option to remove redundant param types in jsdoc. (17b6147)
  • Add tests for omit_redundant_param_types option for javascript, add option description to readme. (3049d64)

3.9.1 (2021-03-29)

Bug Fixes

3.9.0 (2021-03-15)

Features

  • implement Errors and Safety sections (358a0fa)
  • implement rust with support for functions/methods (77becd5)

3.8.1 (2021-03-07)

Bug Fixes

  • windows: remove old param in build.ps1 (5aec2f6)

3.8.0 (2021-03-07)

Bug Fixes

Features

  • replace vercel/pkg with caxa (3c145fd)

Features

  • replace vercel/pkg with caxa (3c145fd)

3.7.0 (2021-02-17)

Bug Fixes

  • adjust python errors; adjust package.json and tsconfig to use build/ instead of dist/ (e0f29d4)
  • temp allow more output in CI (871c2da)
  • use the same logic for the DogeCreateDocStandard command in the test itself (2eafe9b)
  • ci: use correct checkout path for vader.vim (6d4c7eb)

Features

  • rename build:binary -> build:binary:unix (7ec480c)

3.6.0 (2020-12-19)

Bug Fixes

  • cpp: support functions that return pointers (#179) (493336a)

Features

3.5.4 (2020-11-17)

Bug Fixes

  • adjust elif statement to be compatible with dash (#160) (3964cb0)

3.5.3 (2020-11-17)

Bug Fixes

  • make install script compatible with dash (#160) (3129f22)

3.5.2 (2020-11-16)

3.5.2-beta.1 (2020-11-16)

Bug Fixes

  • use shellescape() in system call and resolve typo (#157) (3b55111)

3.5.2-beta.0 (2020-11-16)

Bug Fixes

  • use case-sensitive check for doge#install() (400e871)

Features

  • do not download binary if already downloaded (b5695b6)

3.5.1 (2020-10-31)

Bug Fixes

  • windows: prefix install.ps1 with powershell.exe (5853802)

3.5.0 (2020-10-31)

Bug Fixes

  • ci: exit 1 if reached 5 test tries (f4bd0de)
  • ci: only run windows tests for now (cc00317)
  • ci: run windows tests but only for Vim, exclude NeoVim (e3a0300)
  • ci: use correct windows target value (41eab11)
  • test: make sure the vim-doge rtp are the only runtimepaths (3c963e9)
  • tests: call execute() method in test/vimrc (7be6a45)
  • tests: only create ~/.vim dir on non-windows systems (206a584)
  • tests: temporarily disable neovim tests (4a4e74d)
  • tests: update vimrc runtimepath to work on windows (2684c96)
  • tests: use proper runtimepath and only run windows tests (0d72744)
  • windows: use shellslash check for g:doge_dir (57777b7)
  • add path fix for windows in vercel/pkg submodule (9cf0164)

Features

  • ci: first try to support windows (709b6c6)
  • windows: set shell=powershel before running ps1 script (184f510)

3.4.2-beta.5 (2020-10-27)

3.4.2-beta.4 (2020-10-27)

3.4.2-beta.3 (2020-10-27)

Bug Fixes

  • ci: only support win64 for now (cd4a7fb)

3.4.2-beta.2 (2020-10-27)

Bug Fixes

  • ci: resolve path to parent dir for windows (02aabcb)

3.4.2-beta.1 (2020-10-27)

Bug Fixes

  • ci: use powershell equivalent of != and && (fcaa173)

3.4.2-beta.0 (2020-10-27)

Features

  • add initial windows build script setup (24869f9)

3.4.1 (2020-10-24)

Bug Fixes

  • typescript: do not generate docs for function calls (65ae158)

3.4.0 (2020-10-24)

Bug Fixes

Features

3.3.2-beta.26 (2020-10-24)

Bug Fixes

  • ci: use underscores in yml keys (74df0df)

3.3.2-beta.25 (2020-10-24)

Bug Fixes

  • give prio to ./bin/vim-doge.exe instead of ./bin/vim-doge (5e42557)
  • ci: add vader.vim to neovim tests (dde32db)
  • ci: always build from source with neovim (6b1a0e9)
  • ci: bump neovim version from v0.2.0 -> v0.2.1 (1435a2b)
  • ci: bump neovim version from v0.2.1 -> v0.2.2 (33a4d1d)
  • ci: bump neovim version from v0.2.2 -> v0.3.0 (3e12b0a)
  • ci: bump neovim version from v0.3.0 -> v0.3.2 (356cd50)
  • ci: change vim_type:vim to vim_type:neovim for neovim tests (5cd086f)
  • ci: check if binary exists before using chmod (b1b5a89)
  • ci: convert TARGET env var into output var (cce2d2c)
  • ci: do not run chmod on vim-doge.exe (7d4bc9d)
  • ci: pass target to build script (b33ebb0)
  • ci: surpress chmod errors from build.sh (910b6b9)
  • ci: use head instead of stable vim version (1dc882c)
  • install script: fix incorrect unarchiving commands (f001e03)

Features

  • remove support for windows (2d7010d)
  • ci: add neovim tests (54ecd1a)
  • ci: include windows-latest in the tests (34cdb72)
  • ci: use matrix.include to switch target version and other vars (2c763f3)
  • ci: use thinca/action-setup-vim instead of rhysd/action-setup-vim (06165aa)

3.3.2-beta.24 (2020-10-23)

Bug Fixes

  • ci: use matrix method for ubuntu and macos (05ff5f7)

3.3.2-beta.23 (2020-10-23)

Bug Fixes

  • ci: remove invalid needs-key (fc43674)

3.3.2-beta.22 (2020-10-23)

Bug Fixes

  • ci: run on release:created instead of created tag (4f4af3f)

3.3.2-beta.21 (2020-10-23)

Bug Fixes

  • ci: replace [0-9]+ with * (67c66b0)

3.3.2-beta.20 (2020-10-23)

3.3.2-beta.19 (2020-10-23)

Bug Fixes

  • ci: only use negate pattern for the releas (7087532)

3.3.2-beta.18 (2020-10-23)

Bug Fixes

  • ci: exclude beta versions in main release (d0ff95f)

3.3.2-beta.17 (2020-10-23)

Features

  • ci: add release workflow (de3b0c4)

3.3.2-beta.16 (2020-10-23)

Bug Fixes

  • ci: revert incorrect RUNNER_OS and url vars (123a3c6)

3.3.2-beta.15 (2020-10-23)

Bug Fixes

  • ci: use env prefix for remaining env vars (ca73ea5)

3.3.2-beta.14 (2020-10-23)

Bug Fixes

  • ci: use env prefix for env vars (25f5816)

3.3.2-beta.13 (2020-10-23)

Bug Fixes

  • ci: use workaround for the upload-release-assets args (b136772)

3.3.2-beta.12 (2020-10-23)

3.3.2-beta.11 (2020-10-23)

3.3.2-beta.10 (2020-10-23)

Bug Fixes

3.3.2-beta.9 (2020-10-23)

3.3.2-beta.8 (2020-10-23)

3.3.2-beta.7 (2020-10-23)

Bug Fixes

  • ci: change runner.os to $RUNNER_OS (d0d054c)
  • ci: only run beta-release workflow on new tags (0e8627c)

3.3.2-beta.6 (2020-10-23)

Bug Fixes

  • ci: move env key from root scope to job scope (0259ab2)

3.3.2-beta.5 (2020-10-23)

Bug Fixes

  • ci: build multiple releases on different systems (da62246)

3.3.2-beta.4 (2020-10-23)

Features

  • ci: build release assets with actions/create-release and actions/upload-release-asset (635148c)

3.3.2-beta.3 (2020-10-23)

Bug Fixes

  • ci: specify all branches, excluding tags (950a82a)

3.3.2-beta.2 (2020-10-23)

Bug Fixes

  • ci: only build release assets on published type (2fbe1f4)

3.3.2-beta.1 (2020-10-23)

Bug Fixes

  • ci: use env variables for node-version and build target (eaf8e5b)

Features

  • ci: rename ci.yml to tests.yml (f9a35a0)

3.3.2-beta.0 (2020-10-23)

Bug Fixes

  • revert package.json version back (20142bf)
  • ci: add matrix prefix for variable (3bfa189)
  • ci: do not compress binary if no name has been given (d607ee0)
  • ci: replace old $tests var with all the necessary globs (3f8c81f)
  • ci: set runtimepath correctly for unix / macunix (2b634c5)
  • ci: split up single job into separate linux + macos jobs (0e25059)
  • ci: use proper testing setup for vim + neovim (6022cab)
  • add vader as a submodule and adjust test vimrc runtimepath (21bbbc1)

Features

  • ci: add linux build to the release.yml (287dd6b)
  • ci: add release workflow (678d913)
  • move echo to the top to ensure proper color echoing (6e66713)
  • ci: filter vader output (4fd24e4)
  • gitmodules: add shallow = true to vader (73da31a)
  • remove travis.yml and setup initial CI workflow (0c35ac9)

3.3.1 (2020-10-20)

Bug Fixes

  • install.sh: Only make dir when it does not exists (#113) (3006c7b)

3.3.0 (2020-10-20)

Features

  • archive binaries in builds for faster downloads (42e92f6)

3.3.0 (2020-10-20)

Features

  • archive binaries in builds for faster downloads (42e92f6)

3.2.10 (2020-10-20)

Bug Fixes

  • typescript: use TSX parser to support JSX/TSX in JS/TS (#110) (60cbfe7)

3.2.9 (2020-10-17)

Bug Fixes

3.2.8 (2020-10-17)

Bug Fixes

  • use correct regex for self-closing tag (#110) (96636f1)

3.2.7 (2020-10-17)

Bug Fixes

3.2.6 (2020-10-17)

Bug Fixes

  • javascript: strip html tags from source code, fixes #110 (6ea1d83)

3.2.5 (2020-10-17)

Bug Fixes

  • remove ./bin/vim-doge before installing (35b7c9e)

3.2.4 (2020-10-17)

Bug Fixes

  • use custom fork to ensure no unexpected breaking changes (b460bcc)

3.2.3 (2020-10-17)

Bug Fixes

  • remove v prefix in version when downloading (ffc583f)

3.2.2 (2020-10-17)

Bug Fixes

  • add staged .version file after version bump (ead9864)

3.2.1 (2020-10-17)

Features

  • add .version file for install script instead of stripping it from package.json (e3cc326)

3.2.0 (2020-10-17)

Features

  • remove support for g:doge_parsers (0159f3e)

3.1.1 (2020-10-13)

3.1.2-beta.9 (2020-10-17)

Bug Fixes

  • remove redundant ROOT_DIR in variable to ensure chmod executes correctly (f84cb9d)

3.1.2-beta.8 (2020-10-17)

Bug Fixes

  • adjust logic in doge#helpers#parser() to allow local build + prod build (c3f5651)

3.1.2-beta.7 (2020-10-16)

Bug Fixes

  • resolve ROOT_DIR properly (270c41b)

3.1.2-beta.6 (2020-10-16)

Bug Fixes

  • add extensions to ensure dirname commands works (0e55767)

3.1.2-beta.5 (2020-10-16)

Bug Fixes

  • rename install/build scripts and remove most logging (ca3338b)
  • resolve ROOT_DIR properly (271e457)

3.1.2-beta.4 (2020-10-16)

Bug Fixes

  • add missing echo in install script (35bad8e)

3.1.2-beta.3 (2020-10-16)

Bug Fixes

  • add ROOT_DIR in front of OUTFILE path (c927d44)

3.1.2-beta.2 (2020-10-16)

Bug Fixes

  • resolve ROOT_DIR properly in build/install scripts (4d45442)
  • use realpath instead of dirname in setup/build scripts (c2ac7da)

3.1.2-beta.1 (2020-10-16)

Features

  • optimise install + build scripts (06db921)
  • update doge#install() (fdfcd2f)

3.1.2-beta.0 (2020-10-16)

Features

  • add initial setup (bf7745b)
  • add proper build flow into single binary; add release-it config (17b42dc)

3.1.1 (2020-10-13)

Features

  • javascript: use !name instead of !parentName for the sake of multi-cursor (7a56d28)

3.1.0 (2020-10-13)

Bug Fixes

Features

  • javascript: add new destructuring option, closes #109 (72f2432)

3.0.1 (2020-10-08)

Bug Fixes

  • make rimraf a dep instead of devdep (4085897)

Features

  • python: remove types from google doc (#97) (92e9973)

3.0.0 (2020-10-08)

Bug Fixes

  • docker: rimraf dist/* instead of dist to fix conflict with volume (60a32c8)
  • add doge#helpers#deepsubstitute() back (78adc13)
  • docker: add webpack to Dockerfile (3c7012d)
  • python: add semicolon for numpy exception (#77) (af1c1f2)
  • resolve broken tests for all versions (239ff81)

Features

  • add doge#install() and g:doge_parsers for dynamic language selection (cfe6edb)
  • revert python method back; remove webpack (8aa0e50)
  • javascript: parse exceptions in the function body and add it in the docblock (cd7c835)
  • php: add default !name if exception name couldnt be parsed (29a269c)
  • php: add exception names via body in docblock (7cb1fda)
  • python: add default !name if exception name couldnt be parsed (#77) (dced707)
  • python: add exception names via body in docblock (#77) (1699fd7)
  • add initial tree-sitter rewrite for javascript/typescript (ec88a48)
  • add proper support for javascript (1f1a5b1)
  • add support for bash (ed587cf)
  • add support for C (77ae35b)
  • add support for c++ (6ad7e0c)
  • add support for java + groovy (72842b4)
  • add support for lua (dc2d178)
  • add support for python (027216a)
  • add support for ruby (5a11538)
  • run webpack build before running tests (1f2b6a9)
  • update docs; restructure TS files (f4244a2)
  • javascript: add support for typeparams; add @template tag to template and TS generics tests (f7bfb09)
  • javascript: optimise optional param parsinga and generator functions (6ed3f90)
  • php: rewrite php templates and tests (d7e12e0)

2.8.0 (2020-09-02)

Features

  • python: add support for async functions (#93) (4c0b771)

2.7.1 (2020-08-16)

Bug Fixes

  • javascript: remove unnecessary \s* (cf6c13d)

Features

  • fix typescript multiline function declaration with decorators bug (aaecec0)
  • remove blockchain link from funding.yml (7cd7038)
  • remove debug comments (011a814)
  • python: add configuration option to use single quotes (#92) (6a1dfe0)

2.6.0 (2020-07-25)

Features

  • add proper support for advanced typescript syntax (761d2a3)

2.5.1 (2020-07-24)

Features

2.5.0 (2020-07-13)

Features

2.4.2 (2020-06-05)

Features

  • DogeCreateDocStandard: Do not pre-create the path and and write the file after generation (#87) (3fa9d05)

2.4.1 (2020-05-29)

Bug Fixes

  • #86: Allow default exports for JavaScript-like languages (8f725bb), closes #86

2.4.0 (2020-05-29)

Features

  • javascript: Add support for TypeScript ES7 decorators (8b8a74d)

2.3.0 (2020-05-22)

Bug Fixes

Features

  • javascript: Add Promise as a return type when a function is async (57712e9)

2.2.9 (2020-05-15)

Bug Fixes

  • #85: Indent line based on current line rather than next or previous line (9553b5b), closes #85

Features

2.2.7 (2020-03-13)

Bug Fixes

  • Preprocess aliased filetypes (1aba70d)
  • ruby: Fix ruby without parentheses (7f2adf0)

Features

  • Allow patterns to denormalize input (5915891)

2.2.5 (2020-03-05)

Bug Fixes

  • doge#buffer#get_supported_doc_standards: Order list based on how it should be defined (da8b5c5)

2.2.4 (2020-02-21)

Bug Fixes

  • javascript/typescript: Support @generator tag; Escape pipe characters in input to ensure union types are parsed correctly (25b34b2)

2.2.3 (2020-02-19)

Bug Fixes

  • #80: Check whether current filetype is supported (50efe22), closes #80

2.2.2 (2020-02-18)

Bug Fixes

  • #79: Support advanced typescript parameters (40f15e1), closes #79

2.2.1 (2020-01-28)

Bug Fixes

  • #76: Add check when switching from an alias ft to alias ft (19b8a6e), closes #76

2.2.0 (2020-01-01)

Bug Fixes

  • Ensure doc standards and patterns are not stacked when switching filetype (2a1937b)

Features

  • #73: Add g:doge_filetype_aliases to ToC (5ebf787), closes #73
  • #73: Add support for g:doge_filetype_aliases; fix: prevent patterns getting stacked when changing filetype (aa1912f), closes #73

2.1.0 (2019-12-28)

Bug Fixes

  • funding: Add quotes to ensure correct parsing (3061c38)
  • Remove duplicates properly in doge#buffer#get_supported_doc_standards() (7db29f7)
  • Unlet parameters key instead of v:false (a638cd9)

Features

  • #71: Add support for PHP 7 return type declaration and PHP 8 union types (ec27953), closes #71
  • Add polyfill for mkdir, see E739; Add tests (679f7dc)
  • Add silent! to every execute() (c1a526f)
  • Rebase changes from 25c64d1 v1.17.4 (23196a9)
  • Return when opening file to prevent duplicate content (74e0f5d)
  • funding: Add paypal.me link (da2c511)
  • Add new doge#buffer functions (8960e0c)
  • Initial rewrite for all languages (c67974d)
  • Rebase changes from c2f427a v1.17.5 (880447e)
  • Rename doge#generate#pattern() -> doge#pattern#generate() (03c5263)
  • Use doge#buffer#register_doc_standard in all ftplugins (3312abd)
  • Validate patterns when generating (27df1d3)

1.17.5 (2019-12-02)

Bug Fixes

  • #67: Allow protected and private function data modifier (c2f427a), closes #67

1.17.4 (2019-12-01)

Bug Fixes

  • #66: Remove returnType when the type is void (25c64d1), closes #66

Features

  • Add prefix to tempfile for c-family languages (e899e51)
  • Remove opencollective funding page (4fa2c09)

1.17.3 (2019-11-27)

Bug Fixes

  • #64: Support optional parameter indicator for TypeScript class methods (ca27745), closes #64

1.17.2 (2019-11-26)

Bug Fixes

  • #62: Allow public keyword for functions (bda99bb), closes #62

1.17.1 (2019-11-25)

Bug Fixes

  • #61: Exclude self, cls and klass from python documentation (f9db43a), closes #61

Features

  • Add BTC donation address (f458d57)

1.16.0 (2019-11-18)

Bug Fixes

Features

1.15.3 (2019-11-18)

Bug Fixes

  • #58: Change logic for jump_forward() and jump_backward() to fix conflict with vim-cool (cf9ea1d)

1.15.2 (2019-11-17)

Features

1.15.1 (2019-11-17)

Bug Fixes

  • Create temp file in the same dir as the current active vim buffer (#57) (685d8b1)
  • Move FUNDING.yml to the right location (b2cdaf8)
  • Typo of old v0.3, updated this to v0.4 (6cb70ac)

Features

  • Add FUNDING.yml (175e512)
  • ISSUE_TEMPLATE: Update bug_report template (317ef1d)
  • Update travis.yml with new NeoVim v0.4 (0961db5)
  • docker: Upgrade Vim v8.1.2000 -> v8.1.2300 and NeoVim v0.3.8 -> v0.4.3 (dac31f8)

1.15.0 (2019-11-16)

Bug Fixes

  • Adjust check for py3file issue for Vim v7.4.2119 (ded59fb)
  • Change name property to funcName in libclang.py (b682fb5)
  • failing test (98eb5c8)
  • Get return type in right way; Resolve failing tests (d8e5356)
  • javascript tests (9c123af)
  • linter issues (70ec33b)
  • merge conflict feature/clang-c <-- feature/clang (c4e74c1)
  • py3file error for Vim v7.4.2119 (a3e94d7)
  • Set corrects paths for tests (54618ad)

Features

  • Add class-template and struct-template tests; Add support for virtual-functions (e70bd5d)
  • Add initial working version (cd935f6)
  • Add more doxygen docblock styles (f340b6c)
  • Add stable support for C; Optimise C++ cases (6261f15)
  • Optimise docker for clang develpoment; Add basic function tests (3317f32)
  • Setup basic support for C (f08c35d)
  • Update vim-testbed which fixed 7.4.2119 python build failing; Add expected docblocks in playground (2795e9c)
  • generator:libclang.py: Remove unused function (64e1692)

1.14.1 (2019-10-25)

Bug Fixes

  • #54: Allow export keyword in front of variables (507425b), closes #54

1.14.0 (2019-10-24)

Bug Fixes

  • #54: Optimise incorrect javascript/typescript patterns (d10e62b), closes #54
  • check for todo count inside TextChanged/InsertLeave autocmd func (2879331)
  • Revert back to 2b5a17d (3b3ed40)
  • #50: Update helptags; Adjust option description; Add new option to README (143597c), closes #50

Features

  • Simplify code and update docs (1743fe3)
  • Update php playground generated scenario (eb0157d)

1.13.0 (2019-09-11)

Bug Fixes

  • incorrect logical operator for version check (b80bfbb)
  • Incorrect patch version (3bcc337)
  • Incorrect path version (1703e00)
  • Remove duplicate content (c76a745)
  • Remove unnecessary == v:true check (866abd4)
  • Shorten version check condition (e123c82)
  • Simplify wrapping logic (86e231a)
  • Update broken version checks (66e3251)
  • Update incorrect version for unsupported vim version (14e4ce5)
  • Use correct l: and s: scope; Put s:no_trim outside of function (c9eb506)

Features

  • Add g:doge_comment_jump_wrap backwards jumping tests (d2e2abb)
  • Add release badge (1092f88)
  • Add tests (f0971a3)
  • Add tests (010edaf)
  • Enable continues cycling with surrounding TODOs (1321811)
  • Ensure correct regex interpretation by enforcing magic (64cb9f8)
  • Ensure search starts from the beginning of the line (7241a29)
  • README: Add missing g:doge_buffer_mappings section (50c1c76)
  • Ensure correct regex interpretation by enforcing magic (5631741)
  • Follow coding standards; adjust incorrect version check; optimise mappings (20333b0)
  • Order Vim versions ascending (bc87f64)
  • Update doc/doge.txt; Optimise version compatibility check (bf8296c)
  • Update minimum supported versions for Travis & docs (1a52360)
  • Update travis.yml to run for Vim 8.0 (a7ca880)
  • Use variable for duplicate regex chars (453b12b)
  • Use variable for duplicate regex chars (399a615)

1.11.2 (2019-08-26)

Bug Fixes

  • #37: Allow generation for Java body-less method declarations (f0169c0), closes #37
  • #38: Remove parameter type hints in Java methods in generated docs (a095438), closes #38

Features

  • Update php playground examples (2fdd869)

1.11.1 (2019-07-30)

Bug Fixes

  • php: Add TODO context for class properties including missing tests (9b5bbae)
  • Prevent using to redraw buffer correctly (a1ce619)

Features

  • Adjust DogeGenerate command declaration (a47e59a)

1.9.3 (2019-07-28)

Bug Fixes

  • python: Allow whitespace before the colon when using type hints (d403bcd)

1.9.2 (2019-07-28)

Features

  • #31: Filter out the self parameter in Python methods (7087d68), closes #31

1.9.1 (2019-07-28)

Bug Fixes

  • #30: Prevent indenting when empty line (ce62c8e), closes #30

1.9.0 (2019-07-26)

Features

  • javascript: Support class properties (a55b24f)

1.8.2 (2019-07-26)

Bug Fixes

  • javascript: Remove additional whiteline after main function description (45eddac)

1.8.1 (2019-07-26)

Bug Fixes

  • php: Use correct phpdoc description format (33ed53b)

1.8.0 (2019-07-24)

Features

  • Implement @return tag for PHP; Adjust conditional token format to ensure correct parsing (af43f96)

1.7.0 (2019-07-23)

Features

  • javascript: Add pattern for functions inside objects (718cada)

1.6.1 (2019-07-22)

Bug Fixes

  • cpp: Change kotline -> c++ in error message (7ee3ec6)

Features

  • cpp: Check for 0 or more occurences in the regex pattern instead of making it optional (e69ea80)
  • cpp: Use TODO context placeholder instead of raw context (f391791)

1.6.0 (2019-07-21)

Bug Fixes

  • Adjust tests to be correct; remove additional # in @examples tag (ca21fea)
  • Change TODO in [TODO:description] for doge_comment_interactive option test (54a2626)
  • Exclude tab chars by adjusting the regex in doge#token#replace (1290981)

Features

  • Remove scala demo (3310584)
  • Update demo README (4fed02b)
  • CONTRIBUTING.md: Update ToC (20ce496)
  • javascript: Change TODO to !description (7d247b5)
  • Add .editorconfig (e6c12e4)
  • Add .editorconfig (9bfa350)
  • Add TODO contexts for every language by adding the new ! placeholder (5360d9a)
  • Update playground generations for all languages (bb31964)
  • Update python, js and php patterns by adding TODO context (196df07)
  • Use new demos from asciinema (304b104)
  • python: Add more TODO context (70cf0d2)

1.5.2 (2019-07-20)

Bug Fixes

  • #26: Allow colon inside C++ angle bracket notation in the return type (83df9d1), closes #26
  • Adjust typos in tests (12c0df0)
  • Update functions-doc-google tests for return type (f539f52)

Features

  • Remove url hash id to match 80 columns (6a4ef14)
  • CONTRIBUTING.md: Add doc-standard section (e2ef9b7)
  • Add missing Google doc standard in ftplugin root description (c8dd2a4)

1.4.7 (2019-07-19)

Bug Fixes

  • #20: Use start of docblock for the description instead of @description tag for javascript/typescript (1ab5871), closes #20

Features

  • Add new issue template for languages (7578b95)

1.4.6 (2019-07-19)

Bug Fixes

  • #17: Add & in cpp function regex var name to match a specific case (e874cc3), closes #17

1.4.5 (2019-07-18)

Bug Fixes

  • #14: Allow dot-characters in python parameter type hint (93d9e1f), closes #14

1.4.4 (2019-07-18)

Bug Fixes

  • #9: Preprocess indent position for python for inserting below declaration and adjust preprocess order (8cb1876), closes #9

1.4.3 (2019-07-18)

Bug Fixes

  • Set correct has(nvim-0.3.2) (7efa503)
  • #12: Optimise plugin root check to allow nvim 0.3.2+ (9d0a36e), closes #12

1.4.2 (2019-07-18)

Bug Fixes

  • #4: Remove to fix mapping-already-exists error (9d6f686)

1.4.1 (2019-07-18)

Bug Fixes

  • Do not display error msg when no generation can be done (aaaccc4)

1.4.0 (2019-07-18)

Features

  • Support TODO contexts (28413b9)
  • Use global script variable for doge#helpers#placeholder (1b1d88f)
  • ISSUE_TEMPLATE: Add settings-section and improve the description-section (655a00d)

1.3.2 (2019-07-17)

Features

  • Change default g:doge_mapping to d instead of (873bf1f)
  • playground: Regenerate the expected results (1bc5297)

1.3.0 (2019-07-12)

Features

  • python: Add 'optional' keyword in type hint (issue #6) (5db4a61)
  • python: Add support for Google doc standard (issue #6) (336460e)
  • python: Add support for type hints within comments (issue #6) (2b4cacb)
  • python: Split up tests for numpy doc (5a89b6d)
  • python: Update functions-doc-numpy test descriptions (d647476)
  • Link to demos folder instead of README (8a17071)
  • Update doc_standard.md issue template (8182ab3)

1.2.3 (2019-07-10)

Bug Fixes

  • cpp: Prevent @return tag to be added when returning void (issue #5) (ec4fdd9)
  • Adjust broken test for the python numpy doc (1a0dd2e)

1.2.1 (2019-06-28)

Features

  • cpp: Support declarations and add support for advanced function syntax (#2) (fae8dbe)

1.2.0 (2019-06-27)

Features

  • Add initial C++ version (94f8c74)
  • Add support for C++ including tests (issue #2) (277c36f)

1.1.0 (2019-06-27)

Features

  • Delete demos (edbca0e)
  • Prefix every parameter token line with ! markup (84d10c1)
  • re-add demo gifs (51a1618)
  • re-add demo gifs (be862a8)
  • Re-add demos (f5fbd26)
  • Remove demo gifs (c033a49)
  • Strip comments before generating to ensure patterns do not break (12cc8da)
  • Support multiple doc standard (feature issue #3) (cda039c)

1.0.0 (2019-06-24)

Bug Fixes

  • Add missing \s* in regex (764f705)
  • Add missing abort after doge#helpers#count function (793ef26)
  • Add missing abort attribute for s:uppercase helper function (871acbc)
  • Adjust links from old repo (bb6909d)
  • Remove in mapping (13bcdb6)
  • Replace \s*|\s* rather then " | " (a08dab2)
  • Set correct assertion expected value for g:doge_comment_interactive test (2956ff5)
  • Set correct option flag for travis and correct bash variable for run-tests script when pulling docker image (b80b262)
  • Use > operator instead of >= to fix incorrect calculation for Scala (0e44b6b)
  • README: Add missing ) characters (bd4ef9d)
  • README: Correct repo naming in getting-started (f41c911)
  • README: Replace gfi with doge (f7f512a)
  • README: Use bold markdown rather then emphasized text (3459abb)

Features

  • Update banner (ab550c1)
  • tests: Add another test case to the doge_comment_interactive setting (4aa0749)
  • Add correct markdown (7f61510)
  • Add DoGe banner (ff53ed8)
  • Add g:doge_comment_todo_suffix option and logic to remove TODO in params (936a274)
  • Add license from w0rp/ale for bash test scripts (5265b4b)
  • Add neovim 0.3.2+ support; Add fancy badges to README (e3b6f57)
  • Add preprocess function doge#preprocessors##insert_position() for Java and Groovy (569223b)
  • Add quicklinks for users to quickly add a bug report of feature request (2c1ed94)
  • Add README.md in the playground/ directory rather then inline comments (3280e0f)
  • Add scala tests (78eaa10)
  • Add support for Groovy by inhering Java logic (798bf38)
  • Add support for interactive comments insert below (94b3f59)
  • Add support for kotlin (d3dd35c)
  • Add tests for coffee script (a820f85)
  • Add tests for java (c7eda6f)
  • Add tests for setting g:doge_comment_interactive (b30461e)
  • Change "- TODO" in "TODO" (8a58aeb)
  • Change test name type from "tags" -> "tag" (eab77b3)
  • Convert &filetype to uppercase for the user prompts (e405e12)
  • Disable g:doge_comment_interactive to prevent tests from breaking (f27dfae)
  • Document doge#helpers#count function (1c0ffca)
  • Fix broken tests by reset the option g:doge_comment_todo_suffix after it has been used (21c603e)
  • Fix linting errors (7901b80)
  • Implement basic working version of todo-jumping functionality (c68aaee)
  • Implement support for R including tests (121e7de)
  • Implement tests for js,jsx,typescript,tsx (93a7c9c)
  • Optimise banner in size and quality (c440940)
  • Optimise ISSUE_TEMPLATE files along with the plugin messages (9a4f2ec)
  • Optimise jumping logic to a stable version (d30c404)
  • Optimise PHP function parameter regex (cec1cb8)
  • Optimise the comment jump logic (64b183e)
  • Remove unnecessary Given statement in test and remove duplicate test (b99b818)
  • Use a separate key for each token (179130d)
  • tests: Add a python scenario for g:doge_comment_interactive to below-comments (082acf2)
  • Remove duplicate comment in php playground (d3712e6)
  • Rename arg to p as an abbr of param (35b3249)
  • Set g:doge_comment_todo_suffix back to 1 by default (201354f)
  • Support vim 8.0.1630+ from now on (3058c14)
  • Update markdown table for the language overview (c5eb458)
  • Update vimrc for test environment (41d8223)
  • Use markdown syntax rather for all emojis (ce9f967)
  • Use variable rather then global variable in helper function (cd3b79d)
  • java: Add correct description in java tests (77c3b03)
  • java: Make return type optional in class method declaration (a668d33)
  • kotlin: Add tests for functions and classes (552b562)
  • kotlin: Adjust some declaration in the playground (4acc63d)
  • kotlin: Allow external class definition in regex for classes (1c0672b)
  • kotlin: Use @property rather then @param for classes (40118ed)
  • php: Correct test description (efb1a88)
  • README: Add more clarification for the Contributing -> Linting section (390450c)
  • README: Change order of headings (5c6c290)
  • README: Check kotlin as done (1af5bb5)
  • README: Update Table of Contents (2c810c5)
  • Add configurable option g:doge_mapping (53259a6)
  • Add doc/tags file and update README with :help commands (285a5a4)
  • Add expected comments for PHP playground (3ce87c1)
  • Add initial file structure and setup (da2df41)
  • Add javascript support, tests and ftplugin (5849aee)
  • Add logic to find the FQN for a class property based on the constructor func of the surrounding class (fe0f3f6)
  • Add lua tests (a4251c3)
  • Add ruby tests (77921e6)
  • Add support for coffeescript functions incl. flowjs support (25bfafc)
  • Add support for Java (1429529)
  • Add support for ruby with YARD (f255208)
  • Add support for the Lua language (f1f1b12)
  • Add tests for python filetype (f02d075)
  • Add top-comment for all playground files to give some indication what it is (052fc34)
  • Adjust incorrect variable; Show all output of vader with verbose flag enabled (a80c3b6)
  • Adjust indentation for b:doge_pattern items (9522f3e)
  • Change description in ruby test (8429114)
  • Change license from MIT -> GNU GPLv3.0 (c122ca0)
  • Change MIT -> GPL-3.0 in code files (6afea17)
  • Do not delete/insert comment if nothing has changed (cf4f953)
  • Do not trim in comparison check for variables l:oldline vs l:newline (d7f0a18)
  • Fix linting errors and implement linter-only and vim-81-only env option (4cf5e6d)
  • Fix remaining linting errors (62e03ed)
  • Format vader test output (3a44f7b)
  • Implement javascript/typescript/tsx/jsx ftplugins with complete logic and scenarios (336e4ee)
  • Implement php tests (f542c8f)
  • Implement support for python docs; improved ftplugin documentation (6588e53)
  • Implement support for Scala (3cc724a)
  • Improve generating logic (2ecdc46)
  • Initial version of automated testing (f203100)
  • Initial version that generates a proper comment for PHP functions/methods (be5cfdb)
  • Make doge#token#replace_string a local script function (88b34d5)
  • Move all tests to a playground folder (b185920)
  • Optimise doge#token#replace() to replace multiple tokens in string; Remove comment before inserting; Add regex documentation (eac09a9)
  • Optimise php regex to ensure parameters are parsed correctly (48603c6)
  • Optimise vim-pack installation syntax (ef0d808)
  • Remove @function if it is not a function declared with the keyword "function" (873fee5)
  • Remove key trim_comparision_check since it is no longer used (43d2d7d)
  • Remove logic for old-comment check (18c0042)
  • Remove separator to be a configurable option per ftplugin (ad2430e)
  • Remove top comments with unnecessary template (1b4d7a2)
  • Remove unnecessary echoerr (eaa7128)
  • Rename test/languages folder to test/filetypes (d9f42b0)
  • Revert .+ to .{-} for php (aa0a5b1)
  • Revert doge#token#replace_string function and implement exclamation-mark logic (68e1b63)
  • Set 2 spaces rather then 4 in test vimrc (d2000be)
  • Trigger comment on current line, rather then next line; Indent comment based on current line (2330fa4)
  • Update kotlin regex patterns to improve type-hint detection (9cfdf13)
  • Update test files and added example test files (bdad685)
  • Use a comment separator in-between tests in the php tests (cfc8b2e)
  • lua: Enforce magic regex interpretation (81eb8ac)
  • php: Add a doge#preprocessors namespace for all the filetype specific preprocess functions (93c8ebb)
  • php: Use the FQN for class types if the import is not an alias (86c62ed)
  • README: Add new languages to the TODO list (a3bf2bb)
  • README: Add quote of Martin Fowler (16cca15)
  • README: set align attribute on h1 rather then surrounding

    (7ede579)

  • run-tests: Add colored output with glyphs (b6d0df7)
  • Support default token values; refactor: Split up doge#generate and split up token functions (d82cb52)
  • Update php and lua comment templates (a9d26a4)
  • Update playground/test.js with new scenarios (287231e)
  • Update README introduction (8554c23)
  • README: Add description and supported-languages section (900a9f0)
  • README: Add Typescript to the supported-languages list (3b79af6)
  • README: Change JAVA -> Java (544abab)
  • README: Remove flowjs check under coffeescript (79cd39e)
  • README: Update supported-languages section (24e4e04)
  • README: Update ToC (d126b94)
  • Support multiline function expressions (bff43a4)
  • Use javascript and typescript without the unneeded jsx ftplugin and tests (352b1d0)