npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-jira-ticket-todo-comment

v1.0.5

Published

Checks TODO comments and informs about missing Jira ticket mentions

Downloads

17,416

Readme

eslint-plugin-jira-ticket-todo-comment

Checks TODO comments and informs about missing Jira ticket mentions

Installation

npm install eslint-plugin-jira-ticket-todo-comment --save-dev

Usage

Add jira-ticket-todo-comment to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "jira-ticket-todo-comment"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "jira-ticket-todo-comment/jira-ticket-todo-comment": "error"
    }
}

Rule Details

This rule aims to enforce consistent style of TODO comments making it easier for developer teams to quickly see if a TODO comment is already in JIRA.

Options

This rule has an optional object option.

  • "projectKey": "TP" (default MP) sets a specific project key which is used in your JIRA project; when not provided the rule will check against the default regex; can NOT be set together with "regex" option
{
    "rules": {
        "jira-ticket-todo-comment/jira-ticket-todo-comment": ["error", { "projectKey":  "TP" }]
    }
}
  • "regex": "^TODO\\s[A-Z]_[A-Z]{1,9}-\\d+\\s?.*" (default ^TODO\\s[A-Z]{2,255}-\\d+(\\s.*)?) allows you to override the default regex which is used to check for the JIRA ticket format; can NOT be set together with "projectKey" option
{
    "rules": {
        "jira-ticket-todo-comment/jira-ticket-todo-comment": ["error", { "regex":  "^TODO\\s[A-Z]_[A-Z]{1,9}-\\d+\\s?.*" }]
    }
}
  • "message": "Please replace this TODO with a JIRA reference." allows you to override the default message that appears when a TODO is detected without any JIRA key.
{
    "rules": {
        "jira-ticket-todo-comment/jira-ticket-todo-comment": ["error", { "message":  "Please replace this TODO with a JIRA reference." }]
    }
}