Request for FIRRTL language support
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 13k
- Forks
- 1.4k
- Avg merge
- 15h 36m
- Merged PRs (30d)
- 3
Description
Language
FIRRTL: Flexible Intermediate Representation for RTL. This is an Intermediate Representation (IR) for digital circuit design.
Additional resources
Specification: https://github.com/chipsalliance/firrtl-spec
You can find compiled PDFs of the specification on the Releases page.
The specification itself contains KDE XML to define syntax highlighting for the spec's pandoc flow, which gives syntax highlighting for firrtl code blocks in the spec's PDF: https://github.com/chipsalliance/firrtl-spec/blob/main/include/firrtl.xml
There are a few other syntax highlighting resources for FIRRTL (emacs, vim, sublime text), but those aren't as well maintained as the KDE XML in the specification.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the FIRRTL specification and its include/firrtl.xml KDE syntax definition, then compare existing Prism language definitions to identify the appropriate entry point. Done means FIRRTL code receives Prism syntax highlighting with coverage validated by the repository's relevant language tests.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100