Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhanced Linting Script: Blogging like techniques have been applied to make the error handling better and the configuration more flexible #1782

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Enhanced Linting Script: Blogging like techniques have been applied to make the error handling better and the configuration more flexible #1782

wants to merge 2 commits into from

Commits on Aug 31, 2024

  1. linting_tool.py 

    There are a number of changes that have been made to the linting script in the recent past and these changes bring a lot of improvement to the script. 
 
 First of all, the script has been supplemented with error handling and reporting options of the new level. This enhancement makes it possible to address problems that may come up during the linting process in a better way by providing detailed information on the problems faced. New features of logging have been implemented to help users know the exact actions to perform to correct the code problems and in a more faster way. 
 
 As for the code analysis, the script has become more diverse and is capable of working with a number of file types and extensions. It uses `cpplint` for C++ files and `pylint` for Python files so as to cover all the possible linting needs. This improvement helps the script to overcome the deficiencies that would normally arise due to different code bases and follow the coding conventions of C++ and Python. 
 
 A new and marked enhancement is the availability of configuration options which can be set. New in version 1. 5. 0: Users are now able to specify a custom Pylint configuration file using the `--pylint-rc` option. This feature is an enhancement that increases the level of flexibility to the linting process by enabling users to configure the linting rules as they wish. 
 
 There are also improvements in the header guard convention in the update especially for DMLC projects. The script has been enhanced with a better way of generating header guards to enhance on the naming convention. This is very important while working with code especially in large projects, to ensure that the code is clean and there are no conflicts. 
 
 Also, the script has been updated with the ability of path exclusion. It is possible to skip certain paths and it is very helpful when you are working with some files that are not needed in a certain linting task. This enhances the effectiveness of linting as it eliminates or reduces the amount of code that needs to be checked to the important ones. 
 
 Last but not the least; there are improvements made on the script to make it runnable on virtually any operating system and Python version. Some changes have been made for file paths and encoding problems to provide better and smooth experience for users. 
 
 In a nutshell, these changes enhance the functionality of the linting script and make it a very useful tool in enforcing code standards across different development environments.
    @AnandPolamarasetti
    AnandPolamarasetti authored Aug 31, 2024
    Configuration menu
    Copy the full SHA
    79efcc5 View commit details
    Browse the repository at this point in the history

  2. Merge pull request #1 from AnandPolamarasetti/AnandPolamarasetti-patch-1 

    Improving Linting Script with Error Handling and Configuration and Path Exceptions
    @AnandPolamarasetti
    AnandPolamarasetti authored Aug 31, 2024
    Configuration menu
    Copy the full SHA
    5b0b3c6 View commit details
    Browse the repository at this point in the history