Adding ESlint to the project

infinispan / js-client

Javascript client for Infinispan, over the Hot Rod wire protocol

https://infinispan.org/docs/hotrod-clients/js/latest/js_client.html

Apache License 2.0

15 stars 28 forks source link

Adding ESlint to the project #96

Closed helio-frota closed 1 year ago

helio-frota commented 2 years ago

This commit adds eslint to the project using a configuration file based on opossum https://github.com/nodeshift/opossum library in which also apply linting to the JSDoc bits.
This commit also removes the unused .jshintrc file.

helio-frota commented 2 years ago

This PR can be merged with no harm

Suggestions:

After fix all the lint issues you can rename the npm script from lint to pretest so that it will run automatically every time you run the tests.
You can add the --fix option later to automatically try to fix some linting errors in the future

"lint": "eslint --fix --ignore-path .gitignore .",

helio-frota commented 2 years ago

This PR is related to https://github.com/infinispan/js-client/issues/81 but does not fixes the lint issues found, that is just the setup in a way that does not block the CI.

helio-frota commented 2 years ago

Once merged that will also help with the TS support effort https://github.com/infinispan/js-client/pull/93 as the linter is looking for proper JSDoc syntax.

helio-frota commented 2 years ago

@rigazilla @NeerajGartia21 I changed to a draft PR I think that is the best and we don't need to merge this. So you can decide to apply or not based in your future PRs.

Also because the intention is not to make impact in the dev process flow of the team :+1:

rigazilla commented 1 year ago

merged thanks @helio-frota