Git Product home page Git Product logo

samuelcabralcruz / sensei Goto Github PK

View Code? Open in Web Editor NEW
0.0 3.0 0.0 737 KB

This plugin has been developed to ease the work of software engineer courses' assistants that are in charge of going through tons of source files in order to provide feedback and advices to students.

License: MIT License

Kotlin 88.58% CSS 10.01% JavaScript 1.41%
education software-engineering code-reviews administration jetbrains-plugin

sensei's Introduction

Sensei - Code Review Plugin for JetBrains IDEs

List of features

Limitations

  • Report highlighting might not work if language fall of this list.
  • Line markers in the IDE might be misplaced depending on the granularity of the PSI elements.

Code Highlighting

  • We use prism in order to highlight code snippets.
  • In order to update the scripts (prism.css and prism.js), simply go to the following page.
    • Here are the options we currently use:
      • Compression: Minified version
      • Theme: Coy
      • Languages: All
      • Plugins:
        • Line Highlight
        • Line Numbers
        • Normalize whitespace
        • Toolbar
        • Copy to Clipboard Button
  • We also customize the exported stylesheet.
    • Remove the pseudo-elements on the pre tag
      pre[class*="language-"]:before,
      pre[class*="language-"]:after {
      	content: '';
      	z-index: -2;
      	display: block;
      	position: absolute;
      	bottom: 0.75em;
      	left: 0.18em;
      	width: 40%;
      	height: 20%;
      	max-height: 13em;
      	box-shadow: 0px 13px 8px #979797;
      	-webkit-transform: rotate(-2deg);
      	-moz-transform: rotate(-2deg);
      	-ms-transform: rotate(-2deg);
      	-o-transform: rotate(-2deg);
      	transform: rotate(-2deg);
      }
    • Remove line highlight gradient
      .line-highlight {
          background: linear-gradient(to right, hsla(201, 100%, 50%, .1) 70%, hsla(201, 100%, 50%, 0));
      }
    • Modify the line highlighting color
      .line-highlight {
          ...
          background: hsla(201, 100%, 50%, .08);
          ...
      }
      
      .line-highlight:before,
      .line-highlight[data-end]:after {
          ...
          background-color: hsla(201, 100%, 50%, 1);
          color: hsl(201, 100%, 95%);
          ...
      }
    • Remove vertical separator
      pre[class*="language-"] > code {
          ...
          border-left: 10px solid #358ccb;
          box-shadow: -1px 0px 0px 0px #358ccb, 0px 0px 0px 1px #dfdfdf;
          ...
      }
    • Remove alternate line background
      pre[class*="language-"] > code {
          ...
          background-image: linear-gradient(transparent 50%, rgba(69, 142, 209, 0.04) 50%);
          background-size: 3em 3em;
          background-origin: content-box;
          background-attachment: local;
          ...
      }
    • Remove right padding
      code[class*="language"] {
          ...
          padding: 0 1em;
          ...
      }
    • Remove margin pre tag
      pre[class*="language-"] {
          ...
          margin: 0;
          ...
      }
      
      /* Margin bottom to accommodate shadow */
      :not(pre) > code[class*="language-"],
      pre[class*="language-"] {
          background-color: #fdfdfd;
          -webkit-box-sizing: border-box;
          -moz-box-sizing: border-box;
          box-sizing: border-box;
          margin-bottom: 1em;
      }
    • Modify code background color
      pre[class*="language-"] > code {
          ... 
          background-color: #ededed;
          ...
      }
    • Remove tokens background color
      .token.operator,
      .token.entity,
      .token.url,
      .token.variable {
          ...
          background: rgba(255, 255, 255, 0.5);
          ...
      }
      
      .language-css .token.string,
      .style .token.string {
          ...
          background: rgba(255, 255, 255, 0.5);
          ...
      }
    • Remove inline code related styling
      /* Inline code */
      :not(pre) > code[class*="language-"] {
          position: relative;
          padding: .2em;
          border-radius: 0.3em;
          color: #c92c2c;
          border: 1px solid rgba(0, 0, 0, 0.1);
          display: inline;
          white-space: normal;
      }
      
      :not(pre) > code[class*="language-"]:after,
      pre[class*="language-"]:after {
          right: 0.75em;
          left: auto;
          -webkit-transform: rotate(2deg);
          -moz-transform: rotate(2deg);
          -ms-transform: rotate(2deg);
          -o-transform: rotate(2deg);
          transform: rotate(2deg);
      }
    • Hide overflow code block
      code[class*="language"] {
          ...
          overflow: hidden;
      }

JQuery

In order to use JQuery, we have to download a minified version. We are currently using the version jQuery Core 3.4.1. There was a mention to include integrity and crossorigin attributes to the script tag, but we did not.

Favicon

Favicon images have been generated using Real Favicon Generator.

sensei's People

Contributors

samuelcabralcruz avatar

Watchers

 avatar  avatar  avatar

sensei's Issues

Make Preset Dropdown Searchable

As a course assistant, I want to be able to quickly search for a preset comment and have a quick look at the filtered list of matching results.

Internationalization

As a course assistant, I would like to configure the language of the application to respect my education establishment rules.

Report Comment Copy Button

As a student, I want to easily copy a comment of my review to easily bring context when I will discuss with my teammates or write an email to a course staff member to get more details about it.

Official Logo

As an anonymous user who is browsing to find a plugin to help me review educational projects, I want to see a nice logo associated with the plugin to easily recognize it.

Prevent Dialog Resizing

As a course assistant, I don't want the plugin dialogs to constantly change size unless I do it voluntarily.

Edit Review Details

As a course assistant, I want to be able to modify the review details (reviewer name, evaluation name, course name, team number, etc.).

java.lang.IllegalStateException: containingFile.virtualFile must not be null

java.lang.IllegalStateException: containingFile.virtualFile must not be null at ca.ulaval.glo.view.lineMarker.RunnableLineMarkerProvider.collectSlowLineMarkers(RunnableLineMarkerProvider.kt:26) at com.intellij.codeInsight.daemon.impl.LineMarkersPass.queryProviders(LineMarkersPass.java:190) at com.intellij.codeInsight.daemon.impl.LineMarkersPass.lambda$doCollectInformation$3(LineMarkersPass.java:85) at com.intellij.codeInsight.daemon.impl.Divider.divideInsideAndOutsideInOneRoot(Divider.java:115) at com.intellij.codeInsight.daemon.impl.LineMarkersPass.doCollectInformation(LineMarkersPass.java:80) at com.intellij.codeHighlighting.TextEditorHighlightingPass.collectInformation(TextEditorHighlightingPass.java:56) at com.intellij.codeInsight.daemon.impl.PassExecutorService$ScheduledPass.lambda$doRun$1(PassExecutorService.java:414) at com.intellij.openapi.application.impl.ApplicationImpl.tryRunReadAction(ApplicationImpl.java:1084) at com.intellij.codeInsight.daemon.impl.PassExecutorService$ScheduledPass.lambda$doRun$2(PassExecutorService.java:407) at com.intellij.openapi.progress.impl.CoreProgressManager.lambda$executeProcessUnderProgress$12(CoreProgressManager.java:624) at com.intellij.openapi.progress.impl.CoreProgressManager.registerIndicatorAndRun(CoreProgressManager.java:698) at com.intellij.openapi.progress.impl.CoreProgressManager.computeUnderProgress(CoreProgressManager.java:646) at com.intellij.openapi.progress.impl.CoreProgressManager.executeProcessUnderProgress(CoreProgressManager.java:623) at com.intellij.openapi.progress.impl.ProgressManagerImpl.executeProcessUnderProgress(ProgressManagerImpl.java:66) at com.intellij.codeInsight.daemon.impl.PassExecutorService$ScheduledPass.doRun(PassExecutorService.java:406) at com.intellij.codeInsight.daemon.impl.PassExecutorService$ScheduledPass.lambda$run$0(PassExecutorService.java:382) at com.intellij.openapi.application.impl.ReadMostlyRWLock.executeByImpatientReader(ReadMostlyRWLock.java:174) at com.intellij.openapi.application.impl.ApplicationImpl.executeByImpatientReader(ApplicationImpl.java:181) at com.intellij.codeInsight.daemon.impl.PassExecutorService$ScheduledPass.run(PassExecutorService.java:380) at com.intellij.concurrency.JobLauncherImpl$VoidForkJoinTask$1.exec(JobLauncherImpl.java:184) at java.base/java.util.concurrent.ForkJoinTask.doExec(ForkJoinTask.java:290) at java.base/java.util.concurrent.ForkJoinPool$WorkQueue.topLevelExec(ForkJoinPool.java:1020) at java.base/java.util.concurrent.ForkJoinPool.scan(ForkJoinPool.java:1656) at java.base/java.util.concurrent.ForkJoinPool.runWorker(ForkJoinPool.java:1594) at java.base/java.util.concurrent.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:183)

Custom Line Marker Icons

As a course assistant reviewing a project, I would like to see a custom icon specific to Sensei to mark the lines where I left the comments and avoid any confusion with other plugins.

Save Comment As Preset

As a course assistant, I want to be able to save a custom comment as a preset for later reuse.
Once saved, I could also reuse it for different projects.

Access Resources MacOSX

it seems to have an issue with resources access on MacOSX systems
might be due to path encoding of report generation

Dark Theme Review Report

As a student, I want to be able to toggle between light and dark mode while I am consulting my review report.

Produce ZIP Ready to Share

As a corrector, I want a sharable zip file to be generated that I will simply have to send to the student for them to consult the final report.

  • This zip file could be generated at the same time than the report or on demand with a different action

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.