Giter Club home page Giter Club logo

pybadcomments's Introduction

tests Code style: black License: MIT

PyBadComments Linter

A Python code linter designed to find banned words/phrases in Python comments and raise a warning.

A list of words and phrases can be supplied to the library in its pyproject.toml configuration and it will search any given files for those words in the comments and raise a warning, pointing to the exact line and offending word that has caused the warning. It uses regex and will match the exact characters in the strings provided, including any whitespace.

It can be installed as a pre-commit hook to allow for pre-commit linting.

References

Inspired and aided by tryceratops

Testing

Samples

Sample files for testing on can be provided in the 'samples' folder. These files act like real Python scripts upon which the linter can be run to test for banned words.

Feel free to add any sample files needed to test unique cases.

Testing code without a sample file

It is possible to provide Python code as a string and test upon that in test files.

[WIP] Need to ensure the code is setup to allow this.

pybadcomments's People

Contributors

heymoonman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.