Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

72 lines (57 loc) · 4.28 KB
Raw

Contributing Guide

Thank you for your interest in contributing to this extension!

There are many ways in which you can contribute, beyond writing code. Please read the following document to check how you can get involved.

Questions and Feedback

Have questions or feedback? Feel free to let us know! You can share your thoughts in our Gitter channel: Gitter

Reporting Issues

You can report issues whenever:

  • Identify a reproducible problem within the extension
  • Have a feature request

Looking for an Existing Issue

Before creating a new issue, please do a search to see if the issue or feature request has already been filed.

If you find your issue already exists, make relevant comments and add your reaction:

  • 👍 - upvote
  • 👎 - downvote

Writing Good Bug Reports and Feature Requests

In order to let us know better about the issue, please make sure the following items are included with each issue:

  • The version of VS Code
  • Your operating system
  • Reproducible steps
  • What you expected to see, versus what you actually saw
  • Images, animations, or a link to a video showing the issue occurring
  • A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
  • Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)

Contributing Fixes

If you are interested in writing code to fix issues, please check the following content to see how to set up the developing environment.

Overview

The extension has three major modules, which are listed as follow:

  • The extension client written in TypeScript - UI logic mostly
  • The Checkstyle checker written in Java - Interact with the Checkstyle's tooling API.
  • The Checkstyle runner written in Java - The OSGi bundle loaded into the Java Language Server and interact with the extension client.

Setup

  1. Make sure you have latest LTS JDK, Node.js, VS Code and Java Extension Pack installed.
  2. Fork and clone the repository: git clone https://github.com/jdneo/vscode-checkstyle.git.
  3. cd vscode-checkstyle.
  4. Install the node dependencies: npm install.
  5. Build the Java modules: npm run build-plugin.
  6. Open the directory vscode-checkstyle in VS Code.
  7. Install the Eclipse PDE Support extension in your VS Code.
  8. Install the TypeScript + Webpack Problem Matchers in your VS Code.
  9. Open a Java file and wait until 👍 shows in the right-bottom of the status bar

    Note: Sometimes, if you find the code navigation is not working in the Java code, please try:

    • right click the target.target file and select Reload Target Platform.
    • Reload your VS Code.

Debugging

  1. Hit F5 (or run Launch Extension in the debug viewlet) to launch the extension in debug mode

    This will open a new VS Code window as a debug session. Open a Java project folder and let the extension be activated, then you can debug it.

  2. If you want to debug the Checkstyle runner, run Attach to Checkstyle Plugin in the debug viewlet.

Note: If the Java code is changed by you, please run npm run build-plugin before you start debugging, the output jars will be generated in the folder server/. Or you can use the HCR feature provided by the VS Code Java Debugger extension.

Build Your Own Private Build

If you want to build and install your own private build:

npm run build-plugin
npx vsce@latest package
code --install-extension vscode-checkstyle-*.vsix

Check Linting Errors:

Run npm run lint to check linting errors.