marcohu / rules_antlr Goto Github PK

Instead of shipping each rule only with a single ANTLR dependency, it would be better to bundle several releases and let the user pick one. This way updating to a new rules_antlr release would be possible without having to care about the dependencies.

Instead of just

antlr_dependencies(4)

also support the more specific

antlr_dependencies(471)

When I make my rule, doing

antlr(
    name = "simple_boolean",
    srcs = ["SimpleBoolean.g4"],
    language = "Python3",
    listener = False,
    visitor = True,
)

it puts the generated files into:

bazel-bin/utils/rule_engine/simple_boolean.py

Am I missing something about doing python imports? I can't find a way to import a package that has a . in it. But I see the code this is very explicitly doing this step. What am I missing to be able to then import and use these generated files?

It works fine when I run antlr myself, instead of via this.

It works fine in my golang side implementation.

Thanks for any help.

The src jars are not deterministically generated, as the jars include modified timestamps. Please consider using something like bazel's javatools's jarcreator.

thomasbao12@f845d76

Note that the above change makes the jar's layout mirror the output directory's layout

Im noticing that there have been no updates to this repo in almost 2 years, and issues/prs dont seem to be addressed.

wondering if the repo is still maintained, or whether there are any maintained forks

// Code generated from /home/sustrik/.cache/bazel/_bazel_sustrik/329223ef44c790813be2d08fc6e228b5/sandbox/linux-sandbox/832/execroot/__main__/Foo.g4 by ANTLR 4.7.2. DO NOT EDIT.

Would it be possible to change that to:

// Code generated from Foo.g4 by ANTLR 4.7.2. DO NOT EDIT.

AFAICS this can be achieved by running the generator from the directory in question.

Recently Maven Central started enforcing HTTPS when downloading artifacts (ref)

We've fixed the URLs as per their suggestion in our fork: https://github.com/graknlabs/rules_antlr/tree/0.2.1

@marcohu would it be possible for you to release 0.2.1 which contains updated URLs? Unfortunately, upgrading to 0.4.0 for us is not an option because we're using Java 8 and it contains code that is only compatible with Java 11 (such as String::isBlank)

Would be great to just generate the individual outputs into genfiles instead.

Seems that ANTLR 4.9.x is not in the list of supported versions.

TL;DR

The canonical reference to rules_antlr is lost. The proposal is to transfer it to bazel-contrib. Help wanted.

Context

I'm creating this issue as @marcohu hasn't been active on GitHub since 2022, and this repo hasn't been maintained for much longer (as evidenced by issue #19).

The only other contributor besides @marcohu is @vmax, who I believe does not have write access and also has stale PRs (see PR #18).

I've also tried to find "Marco Hunsicker" on LinkedIn without success. If anyone knows how to contact him, please let me know.

That said, there are some forks available, but they do not inspire confidence in terms of maintainability and are not suitable for various use cases. These forks seem to be one-time efforts to add specific features or support for certain ANTLR versions and haven't been updated since.

Bzlmod

In its current state, the project can't be published to the Bazel Central Registry (BCR), and projects relying on it won't be able to leverage Bzlmod to pull this dependency. There's an issue requesting its inclusion (see issue #1575), and another project is awaiting its inclusion (see issue #137).

Proposal

Following @EdSchouten's suggestion (see issue comment), I propose a "hostile takeover" to migrate these rules to @bazel-contrib.

The guidance is provided at Hosting rules repositories in the bazel-contrib org, which states:

Criteria for accepting rule sets into this repo and avoid them from getting stale:

1. Must use an OSI-approved OSS license, preferably Apache-2.0.
2. Must have wide applicability in the community.
3. Must have a clear point of contact who answers questions from the SIG.
4. Must be "production quality":
   • clear README or other documentation outlining the goal of these rules, how to use them etc.
   • generated API documentation
   • include examples of use
   • tests that are running continuously
5. Must reply to issues/PRs in 2-3 weeks (exact service level agreement TBD)
6. Must have more than one person who is committed to review/approve PRs
   • We recommend encoding this as a CODEOWNERS file.
7. Must publish semver releases.
   • Optional: follow the same release pattern as the rules-template does.
8. Must work with LTS Bazel version
9. Must publish the rules to the Bazel Central Registry, keep that CI green

Call to Action

The project clearly does not comply with all these items. In the meantime, I've created a fork at my repository, and my intention is to uplift it, reconcile it with other forks (when possible), and hand it over.

However, I would love not to do this alone, so I'm asking for help or volunteers.

I also want to highlight items 5 and 6, which state that we will need people willing to review and approve PRs.

Did the repo https://github.com/marcohu/stardoc_templates.git repo get marked private recently? I was trying to build your repo and it failed due to that repo being missing. I worked around it by removing the stardoc invocations.

Nice rule implementation!