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

Sync arbitrary file extensions as plaintext #562

Closed
OttoHatt opened this issue Jun 28, 2022 · 5 comments
Closed

Sync arbitrary file extensions as plaintext #562

OttoHatt opened this issue Jun 28, 2022 · 5 comments
Labels
impact: medium Moderate issue for Rojo users or a large issue with a reasonable workaround. scope: cli Relevant to the Rojo CLI status: needs design Needs more planning before implementation type: enhancement Feature or improvement that should potentially happen

Comments

@OttoHatt
Copy link

OttoHatt commented Jun 28, 2022

Rojo already has a way of syncing plaintext files in as StringValues. A lot of programs (i.e. dialogue files, markdown) export into plaintext formats that could be with interpreted with a parser in-game. It'd be cool to define a list of file extensions that are resolved as if they were plain .txt files.

@OttoHatt OttoHatt changed the title Sync arbitrary file extensions Sync arbitrary file extensions as plaintext Jun 28, 2022
@Kampfkarren
Copy link
Member

Kampfkarren commented Jun 28, 2022

This presents a real forwards compatibility hazard :(

Actually, I guess if it's an explicit list of extensions, then that could take priority.

@OttoHatt
Copy link
Author

OttoHatt commented Jun 28, 2022

I think a whitelist (maybe as an optional array in the top-level of .project.json files) is the only way to go about it? I'm not sure how you'd implement this without it feeling too clunky; it almost crosses into the domain of Remodel as you're effectively processing the contents of files before they're synced in...

For now though, would it be considered adding some files (other than .txt) that are imported like plaintext? I think .yarn and .md would be a good start? I think there is a good use case for external authoring tools, and I imagine as the Luau package ecosystem gets better we'll start seeing more parsing libraries for these formats.

@Kampfkarren
Copy link
Member

Eventually Rojo plugins intend to fill the space you're talking about, but that's a pretty big architecture.

@sasial-dev
Copy link
Contributor

I feel like LISENCE/LISENCE.md should be sync in as plaintext

@boatbomber boatbomber added type: enhancement Feature or improvement that should potentially happen scope: cli Relevant to the Rojo CLI status: needs design Needs more planning before implementation impact: medium Moderate issue for Rojo users or a large issue with a reasonable workaround. labels Jul 25, 2022
@kennethloeffler
Copy link
Member

This is closed by #813, which will be available in Rojo 7.5.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: medium Moderate issue for Rojo users or a large issue with a reasonable workaround. scope: cli Relevant to the Rojo CLI status: needs design Needs more planning before implementation type: enhancement Feature or improvement that should potentially happen
Projects
None yet
Development

No branches or pull requests

5 participants