Data

Tools

Indexes

Applications

Experiments

Open Source Science

codesparks-pmd-demo

This is a demo implementation of a CodeSparks plugin for the IntelliJ IDEA.

https://github.com/segroup-uni-trier/codesparks-pmd-demo

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization segroup-uni-trier has institutional domain (www.st.uni-trier.de)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

codesparks-framework ide idea-plugin program-analysis software-maintenance source-code-augmentation visualization
Last synced: 4 months ago · JSON representation ·

Repository

This is a demo implementation of a CodeSparks plugin for the IntelliJ IDEA.

Basic Info
  • Host: GitHub
  • Owner: segroup-uni-trier
  • License: apache-2.0
  • Language: Java
  • Default Branch: main
  • Homepage:
  • Size: 3.31 MB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 0
  • Open Issues: 2
  • Releases: 1
Topics
codesparks-framework ide idea-plugin program-analysis software-maintenance source-code-augmentation visualization
Created about 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

CodeSparks Demo Plugin

This is a demo implementation of a CodeSparks plugin for the IntelliJ IDEA that can be used as a template for further plugins. It makes use of the PMD Java API to calculate the cyclomatic complexity of Java classes and methods in the current project. Using the CodeSparks framework, the source code is augmented with interactive glyph-based visualizations that display the values of the cyclomatic complexity and an interpretation of them.

Build

Prerequisites:

  1. Apache Ant (>=1.10)
  2. JDK 11
  3. IntelliJ IDEA Community Edition 2022.2.4 (or comparable)
  4. Specify the path to the IntelliJ IDEA installation directory in the idea.properties file.

To create the actual CodeSparks plugin run ant (default target=zip) in the terminal.

Install

Download the the pre-built demo plugin (ZIP file from the releases section).

Or build it yourself from the sources: Download the sources and type ant in the terminal which will run the default target zip (see build.xml).

The ZIP file can then be installed in IntelliJ IDEA:

  1. File → Settings → Plugins
  2. Install Plugin from Disk...
  3. Choose Plugin File, i.e. the ZIP file created with ant or downloaded from the release section.
  4. OK → Apply → OK

Note, the actions of this CodeSparks plugin are added to the toolbar which might be hidden dependening on your preferences. To show the toolbar:

  1. View → Appearance → Toolbar

Tested under

Operating systems:

  1. Windows 10 22H2 64-bit, Build 19045.2364
  2. Linux Mint 21 Vanessa 64-bit, Kernel 5.15.0-56-generic x86_64

IntelliJ IDEA versions:

  1. 2022.2.4 Community Edition (Build #IC-222.4459.24, built on November 22, 2022)

License

The CodeSparks Demo Plugin is Open Source software released under the Apache 2.0 license. Note, some parts of this software, such as the compile and runtime dependencies, may have different licenses (see NOTICE.txt).

Owner

  • Name: Software-Engineering Group at the University of Trier
  • Login: segroup-uni-trier
  • Kind: organization
  • Email: diehl@uni-trier.de
  • Location: Trier, Germany

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Moseler"
    given-names: "Oliver"
    orcid: "https://orcid.org/0000-0003-3118-4968"
title: "CodeSparks Demo Plugin"
version: 1.0.0
doi: 
url: "https://github.com/segroup-uni-trier/codesparks-pmd-demo"
date-released: 2023-01-04

GitHub Events

Total
  • Push event: 1
  • Fork event: 1
Last Year
  • Push event: 1
  • Fork event: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 2
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • onewhl (2)
Pull Request Authors
  • olivermoseler (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

ivy.xml maven
  • net.sourceforge.pmd:pmd-core 6.29.0
  • net.sourceforge.pmd:pmd-java 6.29.0