Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Logisim #6786

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add Logisim #6786

wants to merge 3 commits into from

Conversation

turtlebasket
Copy link

@turtlebasket turtlebasket commented Apr 7, 2024

Description

Adding support for Logisim (Evolution) files. Logisim is a popular FOSS tool for digital system design, typically used for educational purposes. Logisim files are actually just XML but contain circuit logic that can be viewed and simulated in Logisim, making the .circ format somewhat comparable to .ipynb.

Checklist:

  • I am adding a new extension to a language.

    • The new extension is used in hundreds of repositories on GitHub.com
    • I have included a real-world usage sample for all extensions added in this PR:
      • Sample source(s):
        • [URL to each sample source, if applicable]
      • Sample license(s):
    • I have included a change to the heuristics to distinguish my language from others using the same extension.
  • I am adding a new language.

  • I am fixing a misclassified language

    • I have included a new sample for the misclassified language:
      • Sample source(s):
        • [URL to each sample source, if applicable]
      • Sample license(s):
    • I have included a change to the heuristics to distinguish my language from others using the same extension.
  • I am changing the source of a syntax highlighting grammar

    • Old: [URL to grammar repo]
    • New: [URL to grammar repo]
  • I am updating a grammar submodule

  • I am adding new or changing current functionality

    • I have added or updated the tests for the new or changed functionality.
  • I am changing the color associated with a language

    • I have obtained agreement from the wider language community on this color change.
      • [URL to public discussion]
      • [Optional: URL to official branding guidelines for the language]

@turtlebasket turtlebasket requested a review from a team as a code owner April 7, 2024 00:27
Copy link
Member

@lildude lildude left a comment

Choose a reason for hiding this comment

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

As this is standard XML, the extension should be added to the XML language entry. We try to limit the splitting of things like XML and JSON to new entries only when they deviate and have their own grammar.

The samples/Logisim/astro8_cpu.circ sample is also way too big. Please remove it or replace it with a smaller sample.

@turtlebasket
Copy link
Author

Sounds like it'd be appropriate to convert this PR to add the .circ extension to XML and move the samples (except for the large one) to samples/XML instead?

- remove astro8 example
- move .circ examples to samples/XML
- remove Logisim languages.yml entry
- add .circ extension to XML entry
@turtlebasket
Copy link
Author

Alrighty, updated- lmk if anything looks off with this

@@ -0,0 +1,353 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
Copy link
Collaborator

Choose a reason for hiding this comment

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

@turtlebasket Are there many .circ files that lack an XML header? If not, then these files should be classified correctly as XML on GitHub, as Linguist has a dedicated strategy for recognising files that begin with the line

<?xml version=

If many .circ files in-the-wild lack these headers and aren't receiving any highlighting, then this addition is still valid (and you can dismiss this 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.

None yet

4 participants