palantir / palantir/palantir-java-format

[QUESTION] Best practise of how to use palantir-java-format with Maven and VS Code

Open
#832 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
907
Forks
101
Avg merge
1d 3h
Merged PRs (30d)
19

Description

I can't seem to find a forum/channel for discussions/questions, so my aplogies if this is not the right place.

Our team is looking into using Palantir as our Code Convention.

We need it to work with Maven from command line (format) and in our pipelines (vaildate).
In addition, we would like for it to integrate with VS Code which supports (only?) Eclipse Formatter to my knowledge.
Is there some sort of integration using spotless (we don̈́t use gradle)?

We use other programming languages as well and would like to have a similar solution.
Wondering if it would be possible to provide an EditorConfig file for Palantir?

There is a non-official EditorConfig for Google Java Code Style that could be used a starting point.

I understand that you want Palantir to be fixed. However, I think that it is important - in terms of adoption, that Palantir is available officially for different tools, e.g.:

  • Build tools: Maven, Gradle
  • IDEs: IntelliJ, VS Code
  • Code Convention/Style formats: Eclipse Formatter, EditorConfig, Checkstyle, Spotless

Finally, there is not to freightening list of issues currently but are any of these issues something that would block us from using Palantir with satisfaction?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the requested Maven command-line formatting, pipeline validation, VS Code/Eclipse Formatter integration, and EditorConfig support; done would mean defining and documenting a concrete integration path or clearly recording which requests are supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, vscode
Domain
build-system, developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.