Giter VIP home page Giter VIP logo

audit's Introduction

audit

Code auditing mode.

Reviewing files

Workflow:

  1. Look at some code. If it's fine, run M-x audit-ok. This makes it go green.
  2. If there is a problem with some code, run M-x audit-comment. Write a comment in the minibuffer and then you'll see an overlay of that comment in the file.

A populated file, with both comments and good code looks like:

file-review

You can delete any audit section by going to it and running M-x audit-delete.

Run audit-refresh if you open a file and you don't see audit overlays.

Status buffer

Switch to your project root directory and run M-x audit-status. You will get a buffer *audit-status*. Here is an example:

audit-status

You can edit audit comments by going to the comment and hitting e.

audit's People

Contributors

chrisdone avatar

Stargazers

Clemens Radermacher avatar Fox Kiester avatar Joseph LaFreniere avatar Akira Komamura avatar Nicolas M. avatar Craig Roy avatar Yuan Fu avatar Abby Sassel avatar FCP avatar Adam Porter avatar a13ph avatar Jordi Aranda avatar hgye avatar Jakub Kopański avatar Alexey Zabelin avatar Justin Le avatar Michael Sanders avatar Chris A. avatar  avatar  avatar daniel gratzer avatar Erik Svedäng avatar Rudi Grinberg avatar Michael Alan Dorman avatar

Watchers

 avatar Rudi Grinberg avatar Adam Porter avatar James Cloos avatar  avatar  avatar

audit's Issues

Cool

Hi,

Just stumbled upon this. Looks very cool. Also reminds me of the new project https://github.com/cyrus-and/comb. I wonder if you two could collaborate and make a "killer app". :)

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.