# Rules Validation/Linting in IDE

**URL:** <https://community.auth0.com/t/rules-validation-linting-in-ide/43338>\
**Category:** Get Help\
**Tags:** rules\
**Created:** [May 20, 2020, 4:30pm UTC](https://community.auth0.com/t/rules-validation-linting-in-ide/43338 "2020-05-20T16:30:37Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![calqulate](https://sea1.discourse-cdn.com/auth0/user_avatar/community.auth0.com/calqulate/32/19295_2.png) [@calqulate](https://community.auth0.com/u/calqulate)\
**Post date:** [May 20, 2020, 4:30pm UTC](https://community.auth0.com/t/rules-validation-linting-in-ide/43338/1 "2020-05-20T16:30:37Z")

</div>

Hello,

In Webstorm, using JSDoc helps document the hook function parameters as follows:

```auto
/**
@param {object} user - user being created
@param {string} user.tenant - Auth0 tenant name
@param {string} user.username - user's username
@param {string} user.password - user's password
@param {string} user.email - user's email
@param {boolean} user.emailVerified - indicates whether email is verified
@param {string} user.phoneNumber - user's phone number
@param {boolean} user.phoneNumberVerified - indicates whether phone number is verified
@param {object} context - Auth0 context info, such as connection
@param {string} context.requestLanguage - language of the application agent
@param {object} context.connection - connection info
@param {object} context.connection.id - connection ID
@param {object} context.connection.name - connection name
@param {object} context.connection.tenant - connection tenant
@param {object} context.webtask - Hook (webtask) context
@param {function} callback - Function (error, response)
 */

```

Is there a similar “documentation” for Auth0 Rule functions, or any way you know of to avoid linting errors on Rules?

Thanks in advance!

---

<div class="post-metadata">

**Author:** ![dan.woda](https://sea1.discourse-cdn.com/auth0/user_avatar/community.auth0.com/dan.woda/32/18340_2.png) [@dan.woda](https://community.auth0.com/u/dan.woda)\
**Post date:** [May 21, 2020, 5:39pm UTC](https://community.auth0.com/t/rules-validation-linting-in-ide/43338/3 "2020-05-21T17:39:25Z")

</div>

Hi @calqulate,

The only documentation for these objects that I can find are the official docs. I don’t see any definitions like the ones in hooks unfortunately.

> **[User Object Properties in Rules](https://auth0.com/docs/customize/rules/user-object-in-rules)**
>
> Describes the properties of the user object that stores information about the logged in user, returned by the identity provider.

> **[Context Object Properties in Rules](https://auth0.com/docs/customize/rules/context-object)**
>
> Learn about the properties of the Rules context object, which stores information about users' IP addresses, applications, and location.

---

<div class="post-metadata">

**Author:** ![dan.woda](https://sea1.discourse-cdn.com/auth0/user_avatar/community.auth0.com/dan.woda/32/18340_2.png) [@dan.woda](https://community.auth0.com/u/dan.woda)\
**Post date:** [May 26, 2020, 4:42pm UTC](https://community.auth0.com/t/rules-validation-linting-in-ide/43338/4 "2020-05-26T16:42:46Z")

</div>

A post was split to a new topic: [Can you turn off the linter in the code editor?](https://community.auth0.com/t/can-you-turn-off-the-linter-in-the-code-editor/43638)

---

<div class="post-metadata">

**Author:** ![system](https://global.discourse-cdn.com/auth0/original/3X/b/5/b560f266932fcce5d57f09a6595bd50518cae3f3.jpeg) [@system](https://community.auth0.com/u/system)\
**Post date:** [June 10, 2020, 4:42pm UTC](https://community.auth0.com/t/rules-validation-linting-in-ide/43338/5 "2020-06-10T16:42:50Z")

</div>

This topic was automatically closed 15 days after the last reply. New replies are no longer allowed.
