https://github.com/berkeley-cs61b/intellij-plugin

https://github.com/berkeley-cs61b/intellij-plugin

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/berkeley-cs61b/intellij-plugin
• Owner: Berkeley-CS61B
• License: gpl-3.0
• Created: 2017-01-25T03:19:19.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T07:34:19.000Z (almost 2 years ago)
• Last Synced: 2024-08-29T07:55:22.881Z (almost 2 years ago)
• Language: Java
• Size: 22.3 MB
• Stars: 12
• Watchers: 27
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CS 61B Plugin

![Build](https://github.com/Berkeley-CS61B/intellij-plugin/workflows/Build/badge.svg)

[![Version](https://img.shields.io/jetbrains/plugin/v/edu.berkeley.cs61b.plugin.svg)](https://plugins.jetbrains.com/plugin/edu.berkeley.cs61b.plugin)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/edu.berkeley.cs61b.plugin.svg)](https://plugins.jetbrains.com/plugin/edu.berkeley.cs61b.plugin)

Plugin for CS 61B at UC Berkeley. Includes a style checker (Checkstyle). This plugin no longer includes the Java Visualizer: it has been split off into a separate plugin: https://plugins.jetbrains.com/plugin/11512-java-visualizer

## Installation

- Using IDE built-in plugin system:

  

  Settings/Preferences > Plugins > Marketplace > Search for "CS 61B" >

  Install Plugin

  

- Manually:

  Download the [latest release](https://github.com/Berkeley-CS61B/intellij-plugin/releases/latest) and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

## Updating style checker

1. Add the cs61b__checks.xml file in the [style_config](./src/main/resources/style_config) folder.

2. For suppressions, add the cs61b__suppressions.xml file in the [style_config](./src/main/resources/style_config) folder.

3. Add the semester's config line in [index.txt](./src/main/resources/style_config/index.txt). The line should have the format

  ```(regex for current semester)(checks xml)(suppressions xml)```

4. Update the plugin version in [gradle.properties](./gradle.properties)

5. Update the Change Notes under "[Unreleased]"

---

Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template