Page MenuHomePhabricator

Linter for Diviner
Open, WishlistPublic

Description

It would be nice to have a linter for Diviner markup (I guess this is Remarkup?). We have started using Diviner to write some internal documentation and it would be good to have a linter to ensure consistency.

Some examples of things that could be linted:

  • Use of ` in favor of ##.
  • Spacing within [[ ... | ... ]].
  • Spacing around titles, such as = ... =.
  • Use of = ... = instead of # ... for headings.
  • Consistent usage of - versus * for unordered lists.
  • Use of # for ordered lists (as opposed to hardcoding numbers).
  • Consistent indentation.

Event Timeline

joshuaspence raised the priority of this task from to Needs Triage.
joshuaspence updated the task description. (Show Details)
joshuaspence added projects: Diviner, Lint.
joshuaspence added a subscriber: joshuaspence.
joshuaspence renamed this task from Linter for diviner to Linter for Diviner.Jan 14 2015, 8:08 AM
joshuaspence triaged this task as Wishlist priority.
joshuaspence updated the task description. (Show Details)

I think that the warnings generate by Diviner (I don't believe these are surfaced in the UI currently) should be moved to a Diviner linter.