@tsuyoshiwada/tslint-ass-wipe-yourself

[EXPERIMENTAL RULE] A TSLint rule. annotation comment are requires assignee name.

A rule that requires Assignee as an annotation comment such as TODO orFIXME as follows.

class Clazz {
  public static foo(): void {
    // TODO @tsuyoshiwada Add super features.
    //      ^^^^^^^^^^^^^ Should be enter an account name beginning with `@`
  }
}

By leaving a clear Assignee in the comment, we will eliminate the code that will become untouched.

Installation

$ npm install --save-dev @tsuyoshiwada/tslint-ass-wipe-yourself

Configuration

Basic config

By default, Assertee is required for TODO and FIXME.

{
  "extends": ["@tsuyoshiwada/ass-wipe-yourself"],
  "rules": {
    "ass-wipe-yourself": true
  }
}

Customize config

For example, to add NOTE, pass the array as follows.

{
  "extends": ["@tsuyoshiwada/ass-wipe-yourself"],
  "rules": {
    "ass-wipe-yourself": [true, ["TODO", "FIXME", "NOTE"]]
  }
}

Schema

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

Contribute

1. Fork it!
2. Create your feature branch: $ git checkout -b my-new-feature
3. Commit your changes: $ git commit -am 'Add some feature'
4. Push to the branch: $ git push origin my-new-feature
5. Submit a pull request 💪

CHANGELOG

See CHANGELOG.md

Development

We will develop using the following npm scripts.

yarn test

Execute TSLint --test.

License

MIT @ tsuyoshiwada