Git Product home page Git Product logo

auditor's Introduction

auditor

Installation for development

Installation for usage

Install the extension

  • cd extension
  • yarn install
  • vsce package
    • This will create a .vsix
  • Go to the extension section of VSCode and install thee .vsix file

Run the server

  • cd service
  • REPO_PATH=<path-to-the-repo-you-want-to-audit> DB_PATH=<path-to-parent-directory-to-store-db> cargo run --bin auditor -- --port 3000
    • Use cargo watch -- cargo run ... during development for hot reloading

Run the web view

Usage

Customize the extension colors

Modify the settings.json (either at user or workspace level) file and add the following:

  "workbench.colorCustomizations": {
    "auditor.reviewedBackground":"#FFF00055",
    "auditor.modifiedBackground": "#FF000055",
    "auditor.ignoredBackground": "#D3D3D3F0"
  },
  "auditor.auditingFiletypes": ["c", "cpp", "go"],
  "auditor.commenterName": "my name"

Mark lines

Open the command pallet (cmd+shift+P) and search for the following. You can also assign your own shortcuts to these commands.

  • Mark liens as modified
  • Mark liens as reviewed
  • Mark liens as cleared
  • Mark liens as ignored

Click on the + sign that appears on the line number gutter to leave a comment

auditor's People

Contributors

arash-afshar avatar hsiuhsiu avatar

Watchers

 avatar  avatar

auditor's Issues

[Feature] Customizable filetypes allowlist

Currently it is hardcoded in package.json.
Ideally, we want to read it from a setting variable, say codeAuditor.allowedExtensions

Then we can retrieve the list by something like

const vscode = require('vscode');

function activate(context) {
  // Retrieve the configured filename extensions
  const allowedExtensions = vscode.workspace.getConfiguration().get('codeAuditor.allowedExtensions');
  
  // Use the retrieved allowedExtensions in your extension's logic
  // ...
}

exports.activate = activate;

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.