https://github.com/mysticatea/eslint-plugin-es

ESLint plugin about ECMAScript syntactic features.
https://github.com/mysticatea/eslint-plugin-es

ecmascript eslint eslint-plugin javascript npm-package

Last synced: 3 days ago
JSON representation

ESLint plugin about ECMAScript syntactic features.

• Host: GitHub
• URL: https://github.com/mysticatea/eslint-plugin-es
• Owner: mysticatea
• License: mit
• Created: 2018-03-31T09:14:56.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-01-26T09:52:59.000Z (almost 3 years ago)
• Last Synced: 2024-12-16T01:03:45.472Z (10 days ago)
• Topics: ecmascript, eslint, eslint-plugin, javascript, npm-package
• Language: JavaScript
• Homepage: https://eslint-plugin-es.mysticatea.dev/
• Size: 12.7 MB
• Stars: 108
• Watchers: 5
• Forks: 21
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-es

[![npm version](https://img.shields.io/npm/v/eslint-plugin-es.svg)](https://www.npmjs.com/package/eslint-plugin-es)

[![Downloads/month](https://img.shields.io/npm/dm/eslint-plugin-es.svg)](http://www.npmtrends.com/eslint-plugin-es)

[![Build Status](https://github.com/mysticatea/eslint-plugin-es/workflows/CI/badge.svg)](https://github.com/mysticatea/eslint-plugin-es/actions)

[![Coverage Status](https://codecov.io/gh/mysticatea/eslint-plugin-es/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-plugin-es)

[![Dependency Status](https://david-dm.org/mysticatea/eslint-plugin-es.svg)](https://david-dm.org/mysticatea/eslint-plugin-es)

ESLint plugin which disallows each ECMAScript syntax.

## 🏁 Goal

[Espree](https://github.com/eslint/espree#readme), the default parser of [ESLint](https://eslint.org/), has supported `ecmaVersion` option.

However, the error messages of new syntax are not readable (e.g., "unexpected token" or something like).

When we use this plugin along with the latest `ecmaVersion` option value, it tells us the readable error message for the new syntax, such as "ES2020 BigInt is forbidden."

Plus, this plugin lets us disable each syntactic feature individually.

## 📖 Usage

See [documentation](https://eslint-plugin-es.mysticatea.dev/)

## 🚥 Semantic Versioning Policy

This plugin follows [semantic versioning](http://semver.org/) and [ESLint's semantic versioning policy](https://github.com/eslint/eslint#semantic-versioning-policy).

- We will release a new minor version to add new rules when TC39 decided to advance proposals to Stage 4. In the minor releases, we don't update configs.

- We will release a new major version to update configs when new ECMAScript snapshots are available.

## 📰 Changelog

See [releases](https://github.com/mysticatea/eslint-plugin-es/releases).

## ❤️ Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

### Development Tools

- `npm test` runs tests and measures coverage.

- `npm run clean` removes the coverage result of `npm test` command.

- `npm run coverage` shows the coverage result of the last `npm test` command.

- `npm run docs:build` builds documentation.

- `npm run docs:watch` builds documentation on each file change.

- `npm run watch` runs tests on each file change.