eslint-plugin-udemy

Udemy ESLint Plugin

This package has Udemy specific ESLint rules.

Installation

Install ESLint locally.

$ yarn add eslint --dev

Install the Udemy ESLint Plugin locally.

$ yarn add eslint-plugin-udemy --dev

Configuration

Add a plugins section to your .eslintrc.js and specify udemy as a plugin. You can then add the rules provided by this plugin to your rules section.

List of provided rules

• udemy/import-disallow: Disallow certain imports in JS files.
• udemy/angular-path-based-module-names: Require angular.module name to match relative file path.
• udemy/no-function-prototype: Prefer _.noop or () => {} over Function.prototype.
• udemy/no-settimeout: Prevent setTimeout usages.
• udemy/no-then: Prevent then calls in favor of async / await.

Contributing

See Contributing.

Updating an existing rule

Just follow the approach described in the top-level Contributing section, and do not forget to update both the rule-specific README.md file and this package's List of provided rules section.

Adding a new rule

This repository has a set of custom ESLint rules implemented in the rules folder. In order to create a new rule, you should:

• Create a new folder under the rules folder with the desired rule name.
• Implement the rule in an index.js file, following the existing examples. You can also refer to ESLint's Working with Rules documentation to learn more.
• Once the rule is implemented, create a tests.js file with tests for the rule (once again, following the existing examples). again following existing examples. You can refer to ESLint's RuleTester documentation to learn more.
• Create a README.md file that describes the details of the rule, based on the RULE_README_TEMPLATE.md file.
• Add an entry to the List of provided rules above, and describe the rule in a sentence.
• Push your changes, and continue with creating a PR, publishing to npm as described in Contributing.