Skip to content

Conversation

stuhood
Copy link
Member

@stuhood stuhood commented Dec 21, 2021

No description provided.

group="com.google.guava",
artifact="guava",
version="31.0.1-jre",
# Because `guava` provides a package which does not match its `group`, we explicitly list it here,
Copy link

@jsirois jsirois Dec 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment applies to acyclic as well but perhaps you're expecting they read the whole repo at which point the comment becomes redundant?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to duplicate with acylic too. We shouldn't assume that people have read this already. Duplication is often a good thing in docs.

"version": "0.2.1",
"packaging": "jar"
},
"directDependencies": [],
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously not for now or even maybe ever but camelCase snake_case mixing in the keys is twitch-inducing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relatedly, probably better to add a versioning field for the lockfile format now rather than later.

/.pants.d/
/dist/
/.pids
/.pants.workdir.file_lock*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mental TODO to move the pid and file lock under .pants.d at some point?

Copy link

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! What do you think about splitting into example-java and example-scala...? I know that's more code to maintain, but I suspect there are lots of Java-only shops where the Scala stuff would be distracting.

group="com.google.guava",
artifact="guava",
version="31.0.1-jre",
# Because `guava` provides a package which does not match its `group`, we explicitly list it here,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to duplicate with acylic too. We shouldn't assume that people have read this already. Duplication is often a good thing in docs.

@stuhood
Copy link
Member Author

stuhood commented Dec 21, 2021

Thanks! What do you think about splitting into example-java and example-scala...? I know that's more code to maintain, but I suspect there are lots of Java-only shops where the Scala stuff would be distracting.

I'm going to leave it for now because ~all of our past consumers used Scala, but I'll add notes to the README.md and pants.toml indicating that either backend can be completely disabled. In future, if pure-Java (or Java+Kotlin) gain traction, we can split and simplify.

pants.toml Outdated
Comment on lines 8 to 9
# backend can be used independently, so there is no need to expose Scala BUILD file
# symbols if you have a pure-Java repository.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto pure-scala

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's far less common to have a Scala repo with no Java at all, so I think it's fine not to belabor this point.

README.md Outdated
Comment on lines 11 to 13
and Scala backends can be independently enabled, so there is no need to expose Scala BUILD file
symbols if you have a pure-Java repository. See comments in the `backends` section of
[`pants.toml`](./pants.toml).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pure Scala too?

@stuhood stuhood merged commit b603e09 into pantsbuild:main Dec 22, 2021
@stuhood stuhood deleted the stuhood/initial-jvm-example branch December 22, 2021 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants