Swiftpack.co - Package - dduan/DrString

Circular Logo

Dr. String in the Multiverse of Pedantry

… or "DrString", for short.

DrString finds problems in your Swift docstrings.

Demo Xcode Demo

Documentation

  • Getting Started guides you through how to use DrString in your Swift project.
  • Overview provides the why s and what s of docstring linting.
  • Configuration is a reference to all options for behavior customization.

License

MIT.

Github

link
Stars: 43

Used By

Total: 0

Releases

- 2020-01-27 21:54:18

0.3.4 - 2020-01-21 22:09:47

Improved

  • Fixed bug #149, in which continued line with no prefix whitespace and content were incorrectly included in consideration for vertical alignment.
  • Fixed bug #148, in which superfluously excluded files in config file is reported to have been excluded from command line arguments.
f93ec1f818ee94492135bacacb95f29cd2473ef0222c731c5d6722e31b5be7b5  drstring-x86_64-apple-darwin.tar.gz
7bef5770423da09f267004104496638966f58d6b6fdf9d4edeb593487be1e489  v0.3.4.tar.gz
59e352ffb1627fe52a79e1bdb5c42c696aeaa4eaba2a2b51bdf3d0415f857b16  v0.3.4.zip

0.3.3 - 2020-01-16 23:54:07

Improved

  • Options from command-line arguments now compliments those from a configuration file. Previously a valid configuration cause options from command-line to be completely ignored. Now, the command-line options take precedence over config file.

  • Fixed bug #140, where throws for inits were ignored when extracting code signature.

  • Fixed a bug where small amount of missing spaces prefixing continuation lines in docstring entries are not reported as a problem when vertical alignment is required (#144)

New

  • Docstring entries that does not contain a : in their header (for example, - parameter:) were previously thrown out as invalid. They now are recogonized as entries and DrString will complain about and fix the missing colon character.
df20a04014a14f711ac332bb00849673528427494e30733ba4ea4ec907da0703  drstring-x86_64-apple-darwin.tar.gz
1fde257a01b4991f880c220472c763ebf9110dff6805dce406477410b7c59293  v0.3.3.tar.gz
53fed5043b7877d474c0699352c7cad6b038cde9e9d71d9ebaf559c6a24e475b  v0.3.3.zip

0.3.2 - 2019-12-18 00:18:19

Improved

  • Fixed bug #127, where docstring item with empty content is incorrectly formatted.
1cf945031f54a2467ac0d2631235faece45df23076a14d9cb5793c7af51a1a4f  drstring-x86_64-apple-darwin.tar.gz
f89cfc00c3a892bee6e0c72228c7de160b996e63def131d534b109d3a307825f  v0.3.2.tar.gz
eea7d6df7b660996441a8cb321ece42fe23bbedafca55e46fc139cf064ad3238  v0.3.2.zip

0.3.1 - 2019-12-17 02:07:13

Changes

  • The commandline interface has been re-implemented in a new framework. Notable changes include
    • subcommands no longer have aliases
    • command line options no longer have short names, except for -i and -x.
    • help and version are now subcommands
    • help message layout changes
    • running without subcommand no longer runs the check subcommand

Improved

  • Improved problem description when it's not related to a particular part of code. For example, when a file is superfically excluded (#90).
  • The project now vendors one library with multiple targets as opposed to multiple libraries, one for each target.

New

  • inits are now treated the same as functions. Prior to this release, they were ignored.
a93d021c9402a644ec87547e78a82dd58a51e100c7ca39f474cbae6d4c80ddf0  drstring-x86_64-apple-darwin.tar.gz
48ff6814cae00e94f0ede7d510bc31b8605544e86e78f0e62994b7cbc9482af2  v0.3.1.tar.gz
0a2d28776e95921cfaf7a3633e47835504fe3bc22d1df7efccdb87e0d80b9e28  v0.3.1.zip

0.3.0 - 2019-11-25 18:51:44

New

  • New subcommand format automatically fixes whitespace errors in docstrings according to options specified via command line options or config file.
  • The option ignore-returns that makes presence of returns docstring non-mandatory. (similar to ignore-throws)
  • The option parameter-style enables linting against mixed parameter organizations. "separate" and "grouped" styles can be enfored by using respective values for this option. The value whatever disables checks for this element.
  • The option align-after-colon enables enforcement of starting colomn of descriptions for parameters, returns and throws. For each of these sections, if the setting is set, all lines of descriptions must begin after the : characeter from the first line.
  • The path to config file can now be specified via the --config-file command line option. The default path is .drstring.toml.
  • The format option gained a new value paths, which causes drstring check to print out only paths to problematic files, and not the rest of the problems details.
9c8a91bd7353736e5827e057f8b5583a3a056a2da3bb0b85f131a7ca0203ec1c  drstring-x86_64-apple-darwin.tar.gz
448e1d2adc305585d165a7cb3cd20ad0dea1507f6c8e3c3cd222e8862b28e695  v0.3.0.tar.gz
515b1c9ec483d9199593295856d6b57234ff71c98b3f294319ea0d25f60f3699  v0.3.0.zip

0.2.3 - 2019-11-04 08:04:26

New

  • The option ignore-returns that makes presence of returns docstring non-mandatory. (similar to ignore-throws)
  • The option parameter-style enables linting against mixed parameter organizations. "separate" and "grouped" styles can be enfored by using respective values for this option. The value whatever disables checks for this element.
  • The option align-after-colon enables enforcement of starting column of descriptions for parameters, returns and throws. For each of these sections, if the setting is set, all lines of descriptions must begin after the : characters from the first line.

Improved

  • Superfluous exclusions will be reported with path to the config file from which the exclusion is specified (Thanks, @kastiglione).
66fc0921f0bddd243623bedbe30c26f443842c5f01d441fe34c03c140786810e  drstring-x86_64-apple-darwin.tar.gz
98781dfef7a23ff32d591eff835f17a3b2ef7654aa41e2bee2f7b00d1627ac1c  v0.2.3.zip
9a6dcdaee48f5cdf342519e0aa5b0e593b84d7b4453a0f01a576f0fe1c257778  v0.2.3.tar.gz

0.2.2 - 2019-10-17 06:01:40

New

  • Paths (not including glob patterns) in the exclude option will be deemed superfluous when the check command can't find any docstring problems or when it's not to be checked in the first place. This behavior can be turned off by superfluous-exclusion=true.

Improved

  • If a function does throw, and a throws entry exists, whitespace problems will be detected regardless of value of ignore-throw.
42aa1c4a47085db819c463923f97c5935176c7a69f215ab87cd6b32c461d3f15  drstring-x86_64-apple-darwin.tar.gz
e4d7801bd1dc11064f3399f8c1e8ab30b8f7a3b2f7c8471ee78aa973da317e9e  v0.2.2.zip
34aea61311a8bec927037eb6a1519d4272bec7874130f229361d573b277a6476  v0.2.2.tar.gz

0.2.1 - 2019-10-14 18:36:30

Changes

  • Option for first keyword letter in config file in previous releases were first-keyword-letter. Now it's first-letter, similar to command line argument for the option.
ad4ec94bd36798eaa7a0a46a61c8f7ef5d113ebc0895c632f4219a3aea9488de  drstring-x86_64-apple-darwin.tar.gz
6067688c8c287a3584bba44e8f2130b4d2fee6e01b73a1100a0d0e8e87f25469  v0.2.1.zip
5902902cd70232e38cb59edd366135ea8cf737f4637925d7fe7f916d5eb85f13  v0.2.1.tar.gz

0.2.0 - 2019-10-14 00:01:48

What's new

  • Add problem IDs for each problem identified by check
  • Add subcommand explain for problem ID explaining
  • Support configuration via TOML file
  • Add a lot more documentation both in CLI and repo
  • Add many new rules/options for linting
4f540e78bc0d98177a48408d648bbbc2378d048acb1263321de2962bea14fac4  drstring-x86_64-apple-darwin.tar.gz
891874d2910db225c63e449d0bfe1e19f24d16a8224e8189fb87fd64d97a2b1b  v0.2.0.zip
18a673478e1779b6d1f08f12b818749bec4a1e75c73b9db9178e1b39405bed38  v0.2.0.tar.gz