https://github.com/dustinspecker/eslint-plugin-no-use-extend-native

ESLint plugin to prevent use of extended native objects
https://github.com/dustinspecker/eslint-plugin-no-use-extend-native

Last synced: 2 days ago
JSON representation

ESLint plugin to prevent use of extended native objects

• Host: GitHub
• URL: https://github.com/dustinspecker/eslint-plugin-no-use-extend-native
• Owner: dustinspecker
• License: mit
• Created: 2015-08-19T00:56:32.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T01:57:45.000Z (6 months ago)
• Last Synced: 2024-05-23T02:47:01.380Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 93.8 KB
• Stars: 53
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

• awesome-eslint - no-use-extend-native - Prevent using extended native objects. (Plugins / Practices and Specific ES Features)

README

        
# eslint-plugin-no-use-extend-native

[![NPM version](https://badge.fury.io/js/eslint-plugin-no-use-extend-native.svg)](https://badge.fury.io/js/eslint-plugin-no-use-extend-native)

[![Coverage Status](https://coveralls.io/repos/github/dustinspecker/eslint-plugin-no-use-extend-native/badge.svg?branch=main)](https://coveralls.io/github/dustinspecker/eslint-plugin-no-use-extend-native?branch=main)

> ESLint plugin to prevent use of extended native objects

## Install

First, install ESLint via

```

npm install --save-dev eslint

```

Then install eslint-plugin-no-use-extend-native

```

npm install --save-dev eslint-plugin-no-use-extend-native

```

## Usage

In your `eslint.config.js` file add the plugin as such:

```javascript

import eslintPluginNoUseExtendNative from 'eslint-plugin-no-use-extend-native'

export default [

  {

    plugins: {

      'no-use-extend-native': eslintPluginNoUseExtendNative,

    },

    rules: {

      'no-use-extend-native/no-use-extend-native': 2,

    },

  },

]

```

If you want the default of the single rule being enabled as an error, you can also just use the following instead of

all of the above:

```javascript

import eslintPluginNoUseExtendNative from 'eslint-plugin-no-use-extend-native'

export default [

  eslintPluginNoUseExtendNative.configs.recommended,

]

```

With this plugin enabled, ESLint will find issues with using extended native objects:

```javascript

import colors from 'colors';

console.log('unicorn'.green);

// => ESLint will give an error stating 'Avoid using extended native objects'

[].customFunction();

// => ESLint will give an error stating 'Avoid using extended native objects'

```

More examples can be seen in the [tests](https://github.com/dustinspecker/eslint-plugin-no-use-extend-native/blob/master/test/test.js).

## Usage with no-extend-native

ESLint's [`no-extend-native`][no-extend-native] rule verifies code is not **modifying** a native prototype. e.g., with the `no-extend-native` rule enabled, the following lines are each considered incorrect:

```javascript

String.prototype.shortHash = function() { return this.substring(0, 7); };

Object.defineProperty(Array.prototype, "times", { value: 999 });

```

`no-use-extend-native` verifies code is not **using** a non-native prototype. e.g., with the `no-use-extend-native` plugin enabled, the following line is considered incorrect:

```javascript

"50bda47b09923e045759db8e8dd01a0bacd97370".shortHash() === "50bda47";

```

The `no-use-extend-native` plugin is designed to work with ESLint's `no-extend-native` rule. `no-extend-native` ensures that native prototypes aren't extended, and should a third party library extend them, `no-use-extend-native` ensures those changes aren't depended upon.

[no-extend-native]: http://eslint.org/docs/rules/no-extend-native

## LICENSE

MIT © [Dustin Specker](https://github.com/dustinspecker)