eslint-plugin-expires

1.1.0 • Public • Published

eslint-plugin-expires NPM version Build Status

An ESLint plugin that warns on and after a specified date/time

Installation

First, you need to install ESLint:

$ npm install eslint --save-dev

Then, install eslint-plugin-expires:

$ npm install eslint-plugin-expires --save-dev

Configuration

Add eslint-plugin-expires to your .eslintrc file by specifying it in plugins section.

{
    "plugins": [
        "expires"
    ]
}

Next, enable rule in rules section.

{
    "rules": {
        "expires": 2
    }
}

Usage

// EXPIRES: 2056-06-15
// EXPIRES: 2047-06-15T02:00+01:00
// EXPIRES: 2055-06-15T22:48:11Z

/**
 * EXPIRES: 2032-01-01
 *
 * TODO: after this date do that thing you need to remember to do
 */
  • You need to add rule in a comment
  • You must write EXPIRES: (capitalized and colon appended)
  • Specify date in ISO-8601 format such as 1992-08-09. Otherwise, rule gives Invalid date! error.
  • If you want to add hour, you need to specify timezone. Otherwise, rule gives You must define a timezone error.
  • If everything configured properly, when the given date comes, rule gives Date expired! error.

Package Sidebar

Install

npm i eslint-plugin-expires

Weekly Downloads

0

Version

1.1.0

License

MIT

Last publish

Collaborators

  • digencer