@freewheel/eslint-plugin-modulajs

eslint-plugin-modulajs

This plugin contains any custom eslint rules for use in development on the modulajs.

Installation

Prerequisites: Node.js (>=6.0), npm version 3+.

npm install --save-dev eslint eslint-plugin-modulajs

Usage

Add modulajs to the plugins section of ESLint config:

{
  "plugins": [
    "modulajs"
  ]
}

Rules

createmodel-attrs-order _{Stylistic Issues}

This rule enforces the order of the keys in the object that is the argument to createModel.

Please go to this link createmodel-attrs-order for more details.

gettext-params _{Possible Errors}

Note: please ignore this if you are not using gettext as I18n solution, in future we might move this as a separated rule.

This rule validates that the proper arguments are provided to the gettext family functions.

Please go to this link gettext-params for more details.

no-mutable-event-types-payload-in-models _{Best Practices}

this rule forbid mutable objects in eventTypes/watchEventTypes payload defination.

Please go to this link no-mutable-event-types-payload-in-models for more details.

no-mutable-prop-types-in-models _{Best Practices}

By default, this rule checks for the following object-types within the propTypes definition in createModel.

Please go to this link no-mutable-prop-types-in-models for more details.

use-function-in-model-defaults _{Possible Errors}

This rule validates that any non-primitive prop's default value defined in Model defaults should be defined with function.

Please go to this link use-function-in-model-defaults for more details.

Contributing

Please read our contributing guide for details on how to contribute to our project.

License

Apache-2.0