if you like haiku
and want your comments to be
enable this rule
blank lines are ignored.
lines must be contiguous.
there are some options.
Examples of incorrect code for this rule:
// this isn't haiku
Examples of correct code for this rule:
// a bad example
// of haiku. but a good one
// for the linting rule.
"prefix": ""
(default) if you want haiku enforcement, but only for certain comments, you can use this to check for a prefix. the prefix must be on every line.
Examples:
/* eslint haiku:comment: ["error", { prefix: "~" }] */
// not haiku. but it's ok
//
// ~ however, this is.
// ~ and eslint will check it.
// ~ and complain if wrong.
"includeLineComments": true
(default) set to false if you only want to check haiku in/* block comments */
."includeBlockComments": true
(default) set to false if you only want to check haiku in// line comments
.
if you set both false,
you might as well disable
the entire rule.
if you hate haiku
or aren't quite crazy enough
to require it.