Skip to content

Comments

Rename 'Grammar' optional step group to 'Antlr' in deploy_to_develop …#2060

Open
gyanranjanpanda wants to merge 1 commit intoaboutcode-org:mainfrom
gyanranjanpanda:fix/rename-grammar-to-antlr-optional-step-2057
Open

Rename 'Grammar' optional step group to 'Antlr' in deploy_to_develop …#2060
gyanranjanpanda wants to merge 1 commit intoaboutcode-org:mainfrom
gyanranjanpanda:fix/rename-grammar-to-antlr-optional-step-2057

Conversation

@gyanranjanpanda
Copy link

@gyanranjanpanda gyanranjanpanda commented Feb 20, 2026

Fixes #2057

Rename the optional step group from "Grammar" to "Antlr" in the develop_to_deploy pipeline to remove ambiguity and align with other technology-specific group names.

This affects three ANTLR-related steps handling .g/.g4 files:

  • find_grammar_packages
  • map_grammar_to_class
  • map_jar_to_grammar_source

Internal identifiers (e.g., GrammarLanguage, database keys) are intentionally unchanged to avoid migrations.

Note: Existing configs or API calls using --groups Grammar must be updated to --groups Antlr.

…pipeline

Fixes aboutcode-org#2057

The  decorator was used for three pipeline steps that
handle ANTLR-specific grammar files (.g/.g4). The name "Grammar" is too generic
and ambiguous — it does not make clear which grammar tool or technology is involved.

Rename the optional step group from "Grammar" to "Antlr" to:
- Align with all other optional step groups in the pipeline that are named after
  their specific technology (Java, Scala, Kotlin, Groovy, AspectJ, Clojure, etc.)
- Make the user-facing CLI --groups flag, REST API, and UI unambiguous
- Clearly communicate that these steps are exclusively for ANTLR grammar files

The three affected steps are:
- find_grammar_packages: finds java packages in .g/.g4 source files
- map_grammar_to_class: maps .class files to their .g/.g4 source
- map_jar_to_grammar_source: maps .jar files to their ANTLR source directory

Note: Internal class names (GrammarLanguage, grammar_package, grammar_to_class)
are database-persisted identifiers and are intentionally NOT changed to avoid
requiring a data migration.

Backward compatibility note: Existing pipeline configs or API calls using
"--groups Grammar" must be updated to "--groups Antlr" after this change.

Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
@gyanranjanpanda gyanranjanpanda force-pushed the fix/rename-grammar-to-antlr-optional-step-2057 branch from 8672a72 to 5993935 Compare February 20, 2026 20:12
@gyanranjanpanda
Copy link
Author

hi @pombredanne could u review this waiting for your feedback

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.

Ambiguous name for "grammar" in the devel_to_deploy pipeline options

1 participant