TypeScript support for the existing Node.js example

[onpaws]

Hi there, I'm Pat. First time contributor. Thanks for your efforts on skaffold!

Fixes: #4261

Description

The example Node.js project is a great starting point for JavaScript developers. Some developers may prefer to use TypeScript, so this PR intends to do the minimum number of steps to port the existing Node.js example to TypeScript, making sure hot reload still works in the expected way.

Steps I took:

• Duplicated examples/nodejs and renamed to examples/typescript
• npm install typescript
• tsc --init and accepted all defaults.
• Added the minimum necessary type dependencies (@types/express and @types/node) to keep the compiler happy.
• Ported the two JavaScript files to TypeScript.
• Swapped nodemon for tsc-watch, which appears to be drop-in compatible.

Follow-up Work
[VS Code] Potentially consider remote debugging

Tests

I didn't write new tests because I'm not sure what exactly it should mean to "test" an example.

That being said make test seems to still pass:

Generated proto files are updated!
PASSED hack/test-generated-proto.sh in 2s
Running linters...
RUN hack/boilerplate.sh
PASSED hack/boilerplate.sh in 1s
RUN hack/gofmt.sh
PASSED hack/gofmt.sh in 1s
RUN hack/golangci-lint.sh
Installing GolangCI-Lint
golangci/golangci-lint info checking GitHub for tag 'v1.30.0'
golangci/golangci-lint info found version: 1.30.0 for v1.30.0/darwin/amd64
golangci/golangci-lint info installed /Users/paws/Developer/skaffold/hack/bin/golangci-lint
PASSED hack/golangci-lint.sh in 62s

Same for make integration -- the new examples/typescript folder did show up in the output and it appears to pass also. (I'm not going to pretend I understand what this test suite is actually doing :) Maybe it copies all the examples into examples/?)

<snip>
=== RUN   TestDiagnose/typescript
time="2021-01-31T13:51:49+01:00" level=info msg="Running [skaffold diagnose] in examples/typescript"
time="2021-01-31T13:51:49+01:00" level=info msg="Ran [skaffold diagnose] in 107.417913ms"
<snip>
--- PASS: TestDiagnose/typescript (0.11s)
<snip>

Versions

OS: macOS 11.1 20C69
Node: v14.15.4
TypeScript: 4.1.3

[google-cla]

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

[codecov]

Codecov Report

Merging #5325 (28692a7) into master (c254d25) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #5325   +/-   ##
=======================================
  Coverage   71.80%   71.80%           
=======================================
  Files         392      392           
  Lines       14228    14228           
=======================================
  Hits        10217    10217           
  Misses       3259     3259           
  Partials      752      752           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c254d25...28692a7. Read the comment docs.

[onpaws]

@googlebot I fixed it.

[onpaws]

I see Travis tests mostly pass, except for buildpacks, which I find a bit curious b/c I didn't touch anything to do with buildpacks, at least AFAIK. Happy to look into it - have a feeling rebase-ing this PR off some other commit than master may resolve. Is there a better branch to target? What do you think?

FAIL: TestDebug/buildpacks (390.59s)

[IsaacPD]

Thanks for the contribution @onpaws , I believe there's an issue with the buildpacks test, I've been seeing failures on some of our recent PRs. So I would not worry to much about it but feel free to report any findings related to the issue to #5326 .

In regards to the changes you made, you added the example under integration\examples, could you also duplicate it under examples?

[gsquared94]

In regards to the changes you made, you added the example under integration\examples, could you also duplicate it under examples?

@IsaacPD the examples directory gets populated from integration/examples on every new version release. It doesn't need to be done manually.

[onpaws]

@IsaacPD my first commit actually put it in examples/ like you said, but then I saw the README section 'Note for contributors' and it sounds like a build script does it automatically. Thanks for looking out :)

[IsaacPD]

The test have that are failing have been temporarily disabled on master, could you please rebase to catch these changes and prevent travis from failing. Thanks

[onpaws]

Yep, you got it, coming right up

[onpaws]

Hopefully this is the desired commit:
097325d65..c254d2512 master -> upstream/master

Let's see if the tests pass this time 🤞

Update: hooray, looks like they did 🥳