Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -92,5 +92,13 @@ spark-*
openspec
.aider*

# Eclipse project files
.settings
.classpath
.project
*/.settings
*/.classpath
*/.project

# Laika
*sitemap.xml
*sitemap.xml
10 changes: 10 additions & 0 deletions docs/src/06-contributing/01-contributing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,16 @@ Focus on a specific suite while iterating:
| `./build/sbt -Dspark.version=4.0.1 compile` | Compiles against Spark 4.x APIs. |
| `./build/sbt package -Dvendor.name=dbx` | Produces Databricks-compatible Spark Connect jars. |

### 3.5 Note about mixed Java/Scala project

GraphFrames is a mixed Java/Scala project that is built with `sbt`. At the moment the only IDE that natively supports using `sbt` to build Java projects is Intellij IDEA. At the same time, GraphFrames provides a workaround for users of VSCode, Emacs, Neovim and other IDEs/editors that rely on the Eclipse JDTLS Language Server. Users can run:

```bash
./build/sbt eclipse
```

This will generate Eclipse project files for all the GraphFrames subprojects and after that users can get the full support of the Java features in their IDE/editor.

---

## 4. Python workflow
Expand Down
5 changes: 5 additions & 0 deletions project/plugins.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,8 @@ libraryDependencies ++= Seq(
"io.circe" %% "circe-generic",
"io.circe" %% "circe-parser"
).map(_ % circeVersion)

// Eclipse project export:
// - use it with VSCode, Emacs, Vim, etc
// to make the autocompletion work for Java files
addSbtPlugin("com.github.sbt" % "sbt-eclipse" % "6.0.0")
Loading