feat: Added Camelcase Linters, complexity and max-params and code changes accordingly #137
Conversation
WalkthroughThis update introduces stricter coding standards in the project by enforcing new ESLint rules for complexity, maximum parameters, and camelcase usage across various JavaScript files. It also updates the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
yarn.lockis excluded by!**/*.lock
Files selected for processing (13)
- .eslintrc.js (2 hunks)
- package.json (1 hunks)
- seeders/02_addresses.js (1 hunks)
- seeders/03_stores.js (1 hunks)
- seeders/04_supplier.js (1 hunks)
- seeders/05_supplier_products.js (1 hunks)
- seeders/06_store_products.js (1 hunks)
- seeders/07_purchased_products.js (1 hunks)
- seeders/08_users.js (1 hunks)
- server/database/index.js (1 hunks)
- server/database/tests/index.test.js (1 hunks)
- server/gql/models/addresses/index.js (1 hunks)
- server/utils/testUtils/mockData.js (1 hunks)
Files skipped from review due to trivial changes (12)
- package.json
- seeders/02_addresses.js
- seeders/03_stores.js
- seeders/04_supplier.js
- seeders/05_supplier_products.js
- seeders/06_store_products.js
- seeders/07_purchased_products.js
- seeders/08_users.js
- server/database/index.js
- server/database/tests/index.test.js
- server/gql/models/addresses/index.js
- server/utils/testUtils/mockData.js
Additional comments not posted (2)
.eslintrc.js (2)
36-36: Themax-paramsrule is set to limit functions to a maximum of five parameters, which should help in maintaining cleaner and more manageable function signatures.Verification successful
The verification process confirms that there are no functions in the JavaScript codebase that exceed the five-parameter limit set by the
max-paramsrule in.eslintrc.js. This ensures compliance with the ESLint configuration aimed at maintaining cleaner and more manageable function signatures.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that no functions exceed five parameters. # Test: Search for functions with more than five parameters. Expect: No occurrences. ast-grep --lang javascript --pattern $'function $_($_, $_, $_, $_, $_, $_) { $$$ }'Length of output: 84
37-37: Thecomplexityrule is appropriately set to a threshold of 10, which is a standard practice to ensure functions are not overly complex.
| @@ -23,7 +23,7 @@ module.exports = { | |||
| 'key-spacing': [2, { beforeColon: false, afterColon: true }], | |||
| 'arrow-parens': ['error', 'as-needed'], | |||
| 'arrow-body-style': [2, 'as-needed'], | |||
|
|
|||
| camelcase: ['error', { properties: 'always', ignoreImports: false }], | |||
There was a problem hiding this comment.
Tip
Codebase Verification
Several files in the codebase still use non-camelCase property names, which conflicts with the newly configured camelcase rule in .eslintrc.js. Here are some of the files that need attention:
webpack.server.config.jsseeders/08_users.jsserver/utils/token.jsserver/utils/testUtils/mockData.jsserver/utils/tests/migrateUtils.test.jsserver/utils/testUtils/index.jsseeders/06_store_products.jsseeders/07_purchased_products.jsseeders/03_stores.jsseeders/05_supplier_products.jsserver/tests/index.test.jsserver/index.jsserver/middleware/gqlAuth/constants.jsserver/utils/testUtils/dbConfig.jsserver/database/models/store_products.jsserver/database/models/suppliers.jsserver/database/models/supplier_products.jsserver/database/models/stores.jsserver/database/models/purchased_products.jsserver/database/models/products.jsserver/database/models/index.jsserver/database/models/addresses.jsserver/gql/models/tests/supplierProducts/query.test.jsserver/gql/models/tests/supplierProducts/mutation.test.jsserver/database/models/users.jsserver/gql/models/tests/purchasedProducts/query.test.jsserver/gql/models/tests/purchasedProducts/mutation.test.jsserver/gql/models/tests/products/query.test.jsseeders/04_supplier.jsserver/gql/models/addresses/index.jsserver/gql/models/aggregate/tests/purchasedProductsUtils.test.jsserver/gql/models/aggregate/purchasedProductsUtils.jsserver/gql/models/aggregate/tests/index.test.jsserver/gql/models/aggregate/index.jsserver/gql/models/tests/storeProducts/query.test.jsserver/gql/models/tests/storeProducts/mutation.test.js
Please review and refactor these files to comply with the ESLint camelcase rule to avoid linting errors.
Analysis chain
The camelcase rule is correctly configured to enforce camelCase naming for all properties and includes checks on imports. Ensure that this change is reflected across the entire codebase to avoid linting errors.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that all properties in JavaScript files adhere to camelCase naming convention.
# Test: Search for non-camelCase property names. Expect: No occurrences.
rg --type js --pcre2 '[a-z]+(_[a-z]+)+' --files-with-matches
Length of output: 1461
###Description
<title>Table</title> <style> table { border-collapse: collapse; width: 100%; } th, td { border: 1px solid black; padding: 8px; text-align: left; } th { background-color: #f2f2f2; } </style>In this Pr I have added following linters
Related Links
Description
Steps to Reproduce / Test
Checklist
yarn testpassesGIF's
Summary by CodeRabbit
New Features
sqlite3package to enhance database interactions and stability.Refactor
Style