npm run lint doesn't work on windows about node-typescript-boilerplate HOT 9 CLOSED

Ah the fun of platform line endings.

The issue is, some people (including me) have the setting for git line endings doing automatic conversions to CRLF on Windows.

I have revisited my decision and now I have git settings to checkout line endings as LF no matter what, which seems like a saner way to go.

from node-typescript-boilerplate.

Thank you for reporting. I don't have Windows to test this so I'm going to fix it on a separate branch and ask you to validate before merging.

from node-typescript-boilerplate.

I will be happy to do that. Thank you for a great project.

from node-typescript-boilerplate.

@eugenious I've read about linebreak-style check and I'm against setting it to false as the default for this starter. Line breaks should be consistent in source files.

If you're mixing CRLFs with LFs, then in my opinion you should correct those files and settle for one style with either "linebreak-style": [true, "LF"] or "linebreak-style": [true, "CRLF"].

from node-typescript-boilerplate.

@eugenious Please check if #7 fixes npm run lint on Windows.

from node-typescript-boilerplate.

Git can handle line endings by auto-converting CRLF into LF when you add a file to the index, and vice versa when it checks out code onto your filesystem. You can enable this with the core.autocrlf setting.

On Windows, set it to true – this converts LF endings into CRLF on checkout

$ git config --global core.autocrlf true

On Mac and Linux you may want Git to fix files with CRLF endings that were accidentally introduced. To convert CRLF to LF on commit but not the other way around, set core.autocrlf to input

from node-typescript-boilerplate.

Yes I know, and that's exactly the problem!

By setting core.autocrlf to true, projects will be cloned into Windows with CRLF.

And running "npm run lint" locally on Windows will fail, as it expects line endings to be LF, not CRLF.

Of course, I could then in my project enforce: "linebreak-style": [true, "CRLF"].

But then that makes my project ONLY work under Windows. It's no longer cross platform.

from node-typescript-boilerplate.

I still think that enforcing unified line endings across files is a safe default option (and a desired one). It's possible to opt-out - disable this setting or change it to CRLF if you want to.

from node-typescript-boilerplate.

I think I'm still not being clear enough.

Unified line endings across files is normal and expected.

Unified line endings across PLATFORMS, for the same git repository, isn't a universal practice.

Anyway, my solution for this is working fine: I've now adopted the practice of using only LF regardless of platform, and probably this is what everybody should be doing.

Thanks!

from node-typescript-boilerplate.