CMU-17313Q / fall23-nodebb-just-relax

fall23-nodebb-just-relax created by GitHub Classroom
GNU General Public License v3.0
0 stars 2 forks source link

Integrating the JShint Tool #79

Closed Maria-Aidarus closed 10 months ago

Maria-Aidarus commented 10 months ago

Resolves #74

We have integrated the JSHint tool into our project's development process through GitHub Actions. This integration ensures that every time there is a pull request or a merge to the main branch,JSHint automatically assesses our JavaScript code for quality and adherence to coding standards. By defining this specific workflow in our repository's configuration, we have created an efficient way to maintain code consistency and identify potential issues early in the development cycle.

First, we began by installing the JSHint tool, adding it as a dependency within the package.json file. Next, we created a .jshintrc file to define the coding style rules and configurations that JSHint should adhere to, including rules related to global variables and coding standards. To incorporate JSHint into our development workflow, we then created a jshint.yaml file, configuring it within GitHub Actions. This setup ensured that JSHint automatically checks our code quality whenever there are commits to the main branch or new pull requests. Additionally, we crafted a .jshintignore file to exclude directories that only contain templates from the JSHint analysis, optimizing the tool's performance.