Giter Club home page Giter Club logo

javaparser-maven-sample's Introduction

JavaParser

Maven Central Build Status Coverage Status Join the chat at https://gitter.im/javaparser/javaparser License LGPL-3/Apache-2.0 DOI

This project contains a set of libraries implementing a Java 1.0 - Java 21 Parser with advanced analysis functionalities.

Our main site is at JavaParser.org

Sponsors

Support this project by becoming a sponsor! Become a sponsor. Your donation will help the project live and grow successfully.

Javaparser uses OpenCollective to gather money.

Thank you to our sponsors!

Setup

The project binaries are available in Maven Central.

We strongly advise users to adopt Maven, Gradle or another build system for their projects. If you are not familiar with them we suggest taking a look at the maven quickstart projects (javaparser-maven-sample, javasymbolsolver-maven-sample).

Just add the following to your maven configuration or tailor to your own dependency management system.

Please refer to the Migration Guide when upgrading from 2.5.1 to 3.0.0+

Maven:

<dependency>
    <groupId>com.github.javaparser</groupId>
    <artifactId>javaparser-symbol-solver-core</artifactId>
    <version>3.26.1</version>
</dependency>

Gradle:

implementation 'com.github.javaparser:javaparser-symbol-solver-core:3.26.1'

Since Version 3.5.10, the JavaParser project includes the JavaSymbolSolver. While JavaParser generates an Abstract Syntax Tree, JavaSymbolSolver analyzes that AST and is able to find the relation between an element and its declaration (e.g. for a variable name it could be a parameter of a method, providing information about its type, position in the AST, ect).

Using the dependency above will add both JavaParser and JavaSymbolSolver to your project. If you only need the core functionality of parsing Java source code in order to traverse and manipulate the generated AST, you can reduce your projects boilerplate by only including JavaParser to your project:

Maven:

<dependency>
    <groupId>com.github.javaparser</groupId>
    <artifactId>javaparser-core</artifactId>
    <version>3.26.1</version>
</dependency>

Gradle:

implementation 'com.github.javaparser:javaparser-core:3.26.1'

Since version 3.6.17 the AST can be serialized to JSON. There is a separate module for this:

Maven:

<dependency>
    <groupId>com.github.javaparser</groupId>
    <artifactId>javaparser-core-serialization</artifactId>
    <version>3.26.1</version>
</dependency>

Gradle:

implementation 'com.github.javaparser:javaparser-core-serialization:3.26.1'

How To Compile Sources

If you checked out the project's source code from GitHub, you can build the project with maven using:

./mvnw clean install

If you want to generate the packaged jar files from the source files, you run the following maven command:

./mvnw package

NOTE the jar files for the two modules can be found in:

  • javaparser/javaparser-core/target/javaparser-core-\<version\>.jar
  • javaparser-symbol-solver-core/target/javaparser-symbol-solver-core-\<version\>.jar

If you checkout the sources and want to view the project in an IDE, it is best to first generate some of the source files; otherwise you will get many compilation complaints in the IDE. (./mvnw clean install already does this for you.)

./mvnw javacc:javacc

If you modify the code of the AST nodes, specifically if you add or remove fields or node classes, the code generators will update a lot of code for you. The run_metamodel_generator.sh script will rebuild the metamodel, which is used by the code generators which are run by run_core_generators.sh Make sure that javaparser-core at least compiles before you run these.

Note: for Eclipse IDE follow the steps described in the wiki: https://github.com/javaparser/javaparser/wiki/Eclipse-Project-Setup-Guide

More information

JavaParser.org is the main information site or see the wiki page https://github.com/javaparser/javaparser/wiki.

License

JavaParser is available either under the terms of the LGPL License or the Apache License. You as the user are entitled to choose the terms under which adopt JavaParser.

For details about the LGPL License please refer to LICENSE.LGPL.

For details about the Apache License please refer to LICENSE.APACHE.

javaparser-maven-sample's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar jlerbsc avatar matozoid avatar mysteraitch avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

javaparser-maven-sample's Issues

ParseProblemException in lombok 1.18.16

Hi, I am using JavaParser 3.24.7 to parse a few opensource projects and I got an exception during the creation of the compilation unit for the file "src\core\lombok\javac\handlers\HandleVal.java" from lombok release 1.18.16:
Exception in thread "main" com.github.javaparser.ParseProblemException: (line 107,col 64) "var" is not allowed here.

The error occurs in this part of code (second line of the block):

		if (localNode.shouldDeleteLombokAnnotations()) {
			JavacHandlerUtil.deleteImportFromCompilationUnit(localNode, val.class.getName());
			JavacHandlerUtil.deleteImportFromCompilationUnit(localNode, lombok.experimental.var.class.getName());
			JavacHandlerUtil.deleteImportFromCompilationUnit(localNode, var.class.getName());
		}

HandleVal.zip

java.lang.NoClassDefFoundError: com/github/javaparser/ast/visitor/GenericVisitor

Hello there,
I am trying to run the maven_sample project, namely, the LogicPositivizer.java file, but the error that I receive is as follows:

Error: Unable to initialize main class App
Caused by: java.lang.NoClassDefFoundError: com/github/javaparser/ast/visitor/GenericVisitor

The commands I run are:

mvn clean install java -cp target/<name-of-jar-file> com.yourorganization.maven_sample.LogicPositivizer

Does anybody know here this issue might use from? It happens both while using Intellij IDEA and in terminal.

Warning during build

[INFO] Including com.github.javaparser:javaparser-core:jar:3.15.21 in the shaded jar.
[WARNING] javaparser-core-3.15.21.jar, javaparser-maven-sample-1.0-SNAPSHOT.jar define 1 overlapping resources: 
[WARNING]   - META-INF/MANIFEST.MF
[WARNING] maven-shade-plugin has detected that some class files are
[WARNING] present in two or more JARs. When this happens, only one
[WARNING] single version of the class is copied to the uber jar.
[WARNING] Usually this is not harmful and you can skip these warnings,
[WARNING] otherwise try to manually exclude artifacts based on
[WARNING] mvn dependency:tree -Ddetail=true and the above output.
[WARNING] See http://maven.apache.org/plugins/maven-shade-plugin/
[INFO] Attaching shaded artifact.

This is probably because of an upgraded dependency? Be sure to manually test these projects after upgrading, because they have no tests.

identation and comments are not preserved

When saving the modified source, Javaparser also adds newlines, and moves comments from end of line to above the line.
This is harmless, but when ran agains a large code base it would produces a gigantic commit change, while only a small fraction of it is useful.

How to cite Java-parser in article/paper

Hi,
I am not able to find a reference for Java parser, so that I can cite it. As I have used it in my work.
Please, provide me any pointer or information that I can use to cite it in a research article.

Thank you.

Upates to javaparser-maven-sample/README.md

As a complete nooB at Maven and JavaParser, this sample project sounded perfect for me. However, I stumbled a lot trying to use it. I would like to make a few suggestions (highlighted in italics) to this README:

On line 4, please make two changes so the sentence reads:
This fully working sample Maven project parses and generates code with JavaParser
Reason: the existing line 4 is a sentence fragment. As a 30 yr tech writer/editor, I feel the overwhelming need to read/write complete sentences. Changing the first word and deleting the seventh word ("that") will make this a complete sentence with minimal impact to the original wording.

On line 6, please add the word "sample" between the first and second words so it reads:
This sample is targeted at people without Maven experience..
Reason: adding the word "sample" makes the word "this" a little more specific. Grammatically, the word "this" refers to the last noun written which is the word "code".

Between lines 10 and 11, please add instructions similar to:
If required, install git . If you haven't already done so, clone this sample repository with git clone https://github.com/javaparser/javaparser-maven-sample.git. Change to the root folder of where this sample project was installed (where the pom.xml file is located).
Reason: As a Maven nooB, I didn't know if I was supposed to manually clone this sample project or if Maven would somehow auto-magically figure out what repository dependency I had. I finally decided that because I needed the pom.xml file that I needed to git a clone of this sample myself and run mvn from inside the main/top/root folder of this sample. I know, I know, now it seems so obvious but I am a double nooB, both git and Maven.

Add to line 14:
This runs LogicPositivizer which reads, parses, and modifies the code in resources/Blabla.java and then writes the modified file to the output folder.
Reason: as a complete nooB, I had wildly wrong expectations about what this sample would do or produce. It was only after drilling down in the src tree and reading thru LogicPositivizer.java and Blabla.java that I appreciated what had happened. It sort of reminded me of a chemistry experiment where a material is added to the clear liquid in a test tube and the liquid remains clear and apparently unaffected afterwards, only to find out later that a clear odorless gas was output. I didn't understand and appreciate what had just happened. Maybe even at end of LogicPositivizer.java, insert a System.out.println("parsed Blabla.java and wrote modified file to output folder."); statement to tell user that something happened.

Somewhere after line 16, please add a line similar to:
Please refer to "JavaParser: Visited" for more information about what the code in LogicPositivizer.java does.
Reason: If someone jumps into this sample completely unaware of how powerful JavaParser is, they may be confused or mystified by the sample code.

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.