Skip to content

Commit

Permalink
Warn about CRLF vs LF usage
Browse files Browse the repository at this point in the history
  • Loading branch information
budak7273 committed Jun 15, 2023
1 parent 2d2b4de commit 5360a2b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions modules/ROOT/pages/Tutorials/Setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ You are consciously choosing to make the process take longer if you stick with t
If you ask for help, my first question will be "does your editor say it matches the JSON Schema?"
====

== Always Use CRLF Line Endings

If you're on a Windows computer, you shouldn't have to worry about this -
it should only be an issue if you're writing scripts from a non-Windows machine or if you're generating them programatically.

ContentLib will get confused if you use
https://kuantingchen04.github.io/line-endings/[LF line endings instead of CRLF line endings].
A telltale sign of this mistake is if you see curly braces showing up in the error log in unexpected places (ex. class names).

In VSCode you can convert whatever the current file's line endings are into CRLF by using
'Change All End Of Line Sequence' in the Command Pallette (Ctrl+Shift+P).

== Alternate Approach: Configs Folder

These steps will walk you through setting up a mini mod to test your scripts with,
Expand Down

0 comments on commit 5360a2b

Please sign in to comment.