@miovision/eslint-plugin-disallow-date/README.md

An ESLint plugin to disallow usage of JavaScript Date objects.

# eslint-plugin-disallow-date

[![Build Status](https://travis-ci.org/github/miovision.svg?branch=master)](https://travis-ci.org/github/miovision)

>   An ESLint plugin to disallow usage of JavaScript Date objects.

## Installation

1.  Install [ESLint](http://eslint.org):

    ```
    $ npm i -D eslint
    ```

2.  Install `@miovision/eslint-plugin-disallow-date`:

    ```
    $ npm i -D @miovision/eslint-plugin-disallow-date
    ```

**Note:**
If you installed ESLint globally (using the `-g` flag) then you must also
install `@miovision/eslint-plugin-disallow-date` globally.

## Usage

Add `@miovision/disallow-date` to the plugins section of your `.eslintrc`
configuration file. You can omit the `eslint-plugin-` prefix, but must include
the `@miovision` package scope:

```json
{
    "plugins": [
        "@miovision/disallow-date"
    ]
}
```

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

```json
{
    "rules": {
        "@miovision/disallow-date/no-new-date": 2,
        "@miovision/disallow-date/no-static-date": 2,
        "@miovision/disallow-date/no-to-date": 2,
    }
}
```

Run the linter with `npx eslint --ext=js .`

## Supported Rules

|   | Rule ID                      | Description                                      |
|---|------------------------------|--------------------------------------------------|
|   | disallow-date/no-new-date    | disallow `new Date()` usage                      |
|   | disallow-date/no-static-date | disallow `Date.now()` and other static functions |
|   | disallow-date/no-to-date     | disallow `moment().toDate()` functions           |

## License

The content of this project under the [MIT license](http://opensource.org/licenses/mit-license.php).