Skip to content

Instantly share code, notes, and snippets.

@Neo-Zhixing Neo-Zhixing/readme.md
Last active Feb 24, 2019

Embed
What would you like to do?
HackIllinois HTMLHint

Mission

HTMLHint: The static code analysis tool for your HTML to improve the code review and refinement process.

What HTMLHint does

HTMLHint analyzes your HTML code based on specific rules, that the user can customise if needed. HTMLHint works on both the command line as well as with extensions that enable the analysis tools directly on IDEs. HTMLHint now also includes a loader for Webpack to make HTMLHint a universal developer tool.

Our Contributions

The foundations of HTMLHint were set up and this hackathon brought the project more life with improvements to legacy code and additions to features. This included migrating from the legacy functionality in ES5 to ES6. Additionally, the project was enhanced to move from Grunt to implementing Webpack that enables support for many more possibilities for this code analysis tool as a universal tool that can be implemented in more IDEs.

We also implemented improvements to existing long term bugs in the code base. Furthermore, we expanded HTMLHint's feature set to improve the tool's functionality. This was accompanied with updates to the documentation as well. Lastly, we began the development of a front end for HTMLHint to replace the legacy website with one built using Gatsby for long term use.

Accomplishments that we're proud of

HTMLHint is an amazing code analysis tool that aids code review and refinement. We were very fortunate to work on a powerful tool that has an amazing potential. HTMLHint is a project built in JavaScript and we were able to update the project to improve legacy code and add support for future improvement to the tool's functionality.

We were able to file many pull requests on HTMLHint as well as fix and resolve project issues that had been pending for a long time whilst also implementing functionality for new features and a website.

Closed issues:

Opened issues:

Merged Pull Requests:

Closed Pull Requests:

What we learned from our challenges

As with any project, navigating around existing code takes time and our amazing mentor provided help in understanding the foundations of the project that allowed us to independently, and successfully, improve the project's code and functionality.

What's next

Working with open source was an amazing opportunity to not only grow our skillsets by contributing to HTMLHint but also allowed us to work on an amazing code analysis tool that has a large following and hence have a real world impact in aiding users with their code review, refinement and analysis process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.