fix: windows build with ping.js

[MikeMcC399]

This PR fixes an issue building and committing the action on Microsoft Windows.

Issue

On Windows, compiling the source code using vercel/ncc would cause Windows-style CRLF end-of-line characters to be embedded in dist/index.js, but only for the portion of code coming from src/ping.js. Other parts of the file dist/index.js were using unix-style LF as end-of-line character.

Carrying out the same action on a unix system such as Ubuntu results in only LF characters being used.

This would lead to unnecessary git differences if the action were changed and committed to GitHub from unix and Windows in turn.

Resolution

The run format command is changed from:

"format": "prettier --write index.js" to
"format": "prettier --write index.js src/ping.js"

prettier is now used additionally on src/ping.js to pre-process this source file and convert the end-of-line character consistently to LF before it is fed to ncc build for compilation.

The Prettier: End of Line option is set to lf by default in v2.0.0 and is not overridden in .prettierrc.json. The action currently uses v2.8.4 of Prettier, so this default applies already.

This PR is a prerequisite for re-enabling a husky pre-commit hook (see also #743) so that it can work consistently across operating systems (unix / Windows).

Verification

Ubuntu

On Ubuntu 22.04, execute:

npm ci
npm run format
npm run build
git status

confirm the message:

"nothing to commit, working tree clean"

Microsoft Windows

Move to Microsoft Windows (11 Pro) and execute

git config --global core.autocrlf

Confirm that the default value of true is set (see Git Configuration). If not, then execute

git config --global core.autocrlf true

Now execute:

npm ci
npm run format
npm run build
git add .
git status

confirm the message:

"nothing to commit, working tree clean"

[jaffrepaul]

There are two issues/PRs regarding ping.js updates. Can either of these be folded into this work to creating a larger update?

• fix: make conditions of ping more explicit #600
• Ping every second or every N seconds #333

[MikeMcC399]

@jaffrepaul

There are two issues/PRs regarding ping.js updates. Can either of these be folded into this work to creating a larger update?

• feat: make conditions of ping more explicit #600
• Ping every second or every N seconds #333

Sorry for the misunderstanding. I added clarification to the original post:

The run format command is changed from:

"format": "prettier --write index.js" to
"format": "prettier --write index.js src/ping.js"

All that this PR does is to make sure that CRLF is stripped off before src/ping.js is handed to ncc build for compilation in a Windows environment. On Ubuntu it's not an issue anyway.

This PR is not modifying the function of src/ping.js at all, so it does not make sense to combine the above PR and issue into this PR.

• The PR fix: make conditions of ping more explicit #600 should be handled separately from this one.
• The issue Ping every second or every N seconds #333 requires coding, so somebody would need to convert this into a PR in any case first. Resolving the issue wait-on issues with Node.js 18 #811 should however be given a much higher priority.

[MikeMcC399]

@AtofStryker
Will you arrange for a second reviewer for this PR? It is one of the prerequisites for supporting Renovate to become more automated when dependencies are involved that flow into the action build.

[AtofStryker]

@MikeMcC399 I can take care of that. @lmiller1990 can you take a look here as well?

[lmiller1990]

🚀

[github-actions]

🎉 This PR is included in version 5.6.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀