Skip to content

Releases: dduan/DrString

0.6.1

20 Feb 23:10
0.6.1
1931434
Compare
Choose a tag to compare
  • Fix linux release process
99833f0ad3d9f3bbf40aee88c6f959a0a9b03e3b7b34e2fca660644e13c1f3ef  drstring-universal-apple-darwin.tar.gz
50cbf3dbb9b675d7bd179b02e7925f3729d2e0c8c9fd4df09ea1cd2f15c50205  drstring-x86_64-unknown-ubuntu.tar.gz

0.6.0

20 Feb 22:23
0.6.0
da7265e
Compare
Choose a tag to compare
  • Update to swift-syntax from Swift 5.9
45d29540dd560a17f9facbeab080cfe7f0b9b3f726a357b3a7865bf6f5d1bbe0  drstring-universal-apple-darwin.tar.gz

0.5.2

23 Mar 20:34
44334d7
Compare
Choose a tag to compare
  • Add support for Swift 5.6, specifically, async signatures.
  • Darwin executable is now a fat binary running natively on M1 as well as intel
  • Releases now include executables built in and for official Swift docker containers for Ubuntu.
  • Now includes completion scripts for Fish shell in Scripts/completions/drstring.fish.
  • Simplified packaging for macOS. Now it no longer distribute a dynamic libarary. The executable is packaged
    on the root level of the package.
b9b33eb8501911783aca551961b1d61939dd2efb73eef072a84094db27a89b69  0.5.2.tar.gz
7325b5f2aa670f10da1b6588d24c0cdfd1a4b33fd473f6ba13981c8e3b903568  0.5.2.zip
860788450cf9900613454a51276366ea324d5bfe71d1844106e9c1f1d7dfd82b  drstring-x86_64-apple-darwin.tar.gz
4589cfa00cebb31882ef4e51b2738e9974a51dc037b6a491ed25b0a120a415be  drstring-x86_64-unknown-ubuntu.tar.gz

0.5.1

29 Dec 11:04
5558688
Compare
Choose a tag to compare

Built for Swift 5.5

aacf65466e86ad249fc247d99def9c78cc0e50aaa70878bbd506b3a8408aa53e  drstring-x86_64-apple-darwin.tar.gz
6f918378c4fcce0ccf12065827d3122a219410620dc33ad8bd62e070758b7e06  v0.5.1.tar.gz
cc38231c498df2897b45f20fa6ffbff2067327da59bf900f5b78da773deee1ca  v0.5.1.zip

0.5.0

24 Dec 06:07
Compare
Choose a tag to compare

New

  • drstring check now reports each problem it finds with a file path, line, and column, as apposed to before,
    where all problems for a specific signature are grouped together. Each type of problem has a custom column
    position to best indicate which part of the docstring it relates to.
  • drstring extract's output for existing docstrings gained a new field relativeLineNumber for each
    "entry".

Bug fixes

  • In grouped parameter style, spacing between the dash - and the parameter was not checked before. From this
    release on, any spacing except a single space is deemed problematic. (#225)
  • If documentation for throws and returns starts on the second line, previously this was considered
    problematic. But it's pretty common to start on the next line. This bug has been fixed. (#213)
35e7a66c27f8babe549da3eff2b79bdcd9b6bcb5c61f9837cf9fedbe52908358  drstring-x86_64-apple-darwin.tar.gz
c210bd86fcff2d6a96783831f28dc8118dcdcc995ccb235ec2292ea4a51adb43  v0.5.0.zip
62d5270b690ebd65f60464f626d6c5c919fa4103d588346df7dc3786734db6fb  v0.5.0.tar.gz

0.4.3

19 Dec 20:40
Compare
Choose a tag to compare
  • Introduce a new subcommand: extract. It outputs existing docsting, and the signature associated
    with it, in JSON format.
715bc3c0ad7f57492ed764ced5884b87c9f98c866a931ea0ca49116258d6aa93  drstring-x86_64-apple-darwin.tar.gz
302cb4d8f929e32eb738c5f3408b3ad016b242a33863bd8775e14cd5dd4b53d8  v0.4.3.zip
83fafbe610477bcaf4ea79698b9d277389691fc8d0a8641810afd11d40473a23  v0.4.3.tar.gz

0.4.2

07 Aug 06:15
Compare
Choose a tag to compare

New

  • A boolean option empty-patterns that allows empty path patterns to exist in include/exclude list.
  • CLI auto-complete scripts for Bash and Zsh.
081f5ded9f884db0fce02754b980a36755156d7cb3ca25a32a7ac7fe6d434823  drstring-x86_64-apple-darwin.tar.gz
1f5f6304a8ec03251b13696600ac0400e2ac8df11e9210af214009157889e73a  v0.4.2.tar.gz
890fcf3be6e9b5e041f2ce735ffb4d98f5b9197ab595f2e3f1258d01fd2bedc7  v0.4.2.zip

0.4.1

02 Jul 09:08
Compare
Choose a tag to compare

Improvements

  • Parameter entries mistakenly start with - Parameters is now parsed as entries, whereas before they were
    treated as multi-parameter headers, and their descriptions get dropped as a consequence.
  • When a config file is invalid TOML, and its location is inferred, DrString now properly reports this.
    Previously it just complains as if there isn't any configuration (missing input).
  • Updated dependencies which brings some fixes for bugs that lead to crash in edge cases.
  • Fixed a bug where paths caused by exclusion pattern is seen as "explicitly" excluded.

Changes

  • The version subcommand is replaced by a flag on the main command. So drstring --version instead of
    drstring version.
49fc7b630ec6f1e3711d4013407223edbc3540a4e05bc2b7e4da0467df5f879f  drstring-x86_64-apple-darwin.tar.gz
3df1725902a65a0ac17e0c6b6f89f126d32c3c9432cf6ef9e5dfd587fb4b8165  v0.4.1.tar.gz
015cdab22a94015df251295e34f22b30fa91c9aaeed1a3c633c285e9bea491f4  v0.4.1.zip

0.4.0

15 Apr 04:16
a73c016
Compare
Choose a tag to compare

Changed

  • Supports Swift 5.2 syntax, which also means the project requires 5.2 to build.
  • For boolean options, instead of specifying negative value with false following the flag on the command line, a new corresponding negative flag should be used. For example, previously, not ignoring docstring section for throws can be specified by --ignore-throws false. Now it should be --no-ignore-throws.
    The help texts for all boolean commands have been updated to reflect this.

New

  • Similar to boolean options, now there's negative flags to override repeatable values on the command line.
    Example: --no-needs-separation will negate any needs-separation values.
8a218a5262b5a6493c0189fca3827ca769638799457f62e68466d089521978d5  drstring-x86_64-apple-darwin.tar.gz
8ef5b8bd16580346ae469e314cf42517422702a8620543f25c84c74097b99b1e  v0.4.0.tar.gz
c93a47798e42c2f6e367058f48e31158cc017a59766f043a0b49eb374be6e385  v0.4.0.zip

0.3.6

05 Feb 23:10
Compare
Choose a tag to compare

New

  • Patterns used as part of inclusion/exclusion list may not match any files in the file system. This is now detected and reported as a problem.

Improved

  • The count of issues is now accurate no matter how many issues were found.
f23ea603ebc825d53614305ade83b295ada95d6f29f32e5cead6b1438e738eb8  drstring-x86_64-apple-darwin.tar.gz
d1b5ac6eb7e5e316752be3c5c03098d288720b556bde106948be83be65f2e024  v0.3.6.tar.gz
ce31cb3dd4d93b0a6b2e8b7b8e615bfdfa8741a053019d4c3585f38ed71dc4ed  v0.3.6.zip