feat(vue-app): add vetur helpers for components auto-complete on VS Code

[atinux]

Add helpers to support auto-complete on VS Code.

Fixes #3174

One thing left, @octref needs to confirm that it can work since @nuxt/vue-app is a dependency of nuxt and is not a direct dependency of a nuxt project.

[codecov-io]

Codecov Report

Merging #4524 into dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #4524   +/-   ##
=======================================
  Coverage   91.07%   91.07%           
=======================================
  Files          61       61           
  Lines        2184     2184           
  Branches      527      527           
=======================================
  Hits         1989     1989           
  Misses        177      177           
  Partials       18       18

---

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 eda33bc...39b4684. Read the comment docs.

[pi0]

Should we also include new NLink and NChild aliases?

[atinux]

I already did @pi0 :)

[octref]

I'll add a manual check for vue-app dependency (it's not explicitly stated in pacakge.jsos's dependencies, and I want to avoid checking all node_modules).

Does that mean https://github.com/nuxt-community/nuxt-helper-json can be archived?

[pi0]

@octref I think we would need that repo for backward compatibility.

[octref]

• You didn't include them in files in package.json. They won't be published.
• These JSON will be importable from @nuxt/vue-app/helpers/vetur/nuxt-tags.json, correct?
• You don't need the vetur key in package.json anymore.

[octref]

One more question. What's the version below which @nuxt/vue-app won't be available, so I can fallback to https://github.com/nuxt-community/nuxt-helper-json?

[pi0]

@octref Thanks for your patient review. I've tried to apply the required changes.

The helpers should be importable from either:

• @nuxt/vue-app-edge/vetur/nuxt-{tags,attributes}.json
• @nuxt/vue-app/vetur/nuxt-{tags,attributes}.json

The new vue-app package with helpers included should be available from next minor release (v2.4.0)

[octref]

From what @atinux told me, nuxt, nuxt-legacy, nuxt-edge all depends on @nuxt/vue-app, where nuxt wants to ship those JSONs. What is @nuxt/vue-app-edge?

My plan was to check for node_modules/@nuxt/vue-app for the two JSON when I see nuxt, nuxt-legacy, nuxt-edge on deps or dev deps.

[pi0]

@octref Every nuxt mono-repo package has a version with -edge in front of it for edge release channel. (They are internally wired-up together) :) I somehow feel it would be easier to keep using a standalone repository for vetur integration. /cc @atinux

[octref]

The problem is versioning. Let's say you shipped <nuxt-new-component>. The only way to ensure users who can use it in runtime also gets the updated IntelliSense is to ship the definitions with the runtime library.

So if I'm reading correct, is the situation:

• One nuxt app will have either @nuxt/vue-app or @nuext/vue-app-edge in node_modules
• nuxt and nuxt-legacy depends on @nuxt/vue-app
• nuxt-edge depends on @nuxt/vue-app-edge

[pi0]

@octref Yes, you are right. checking either @nuxt/vue-app or @nuxt/vue-app-edge in node_modules should do the trick :)

[atinux]

Thank you @octref for your help on this :)

I validate @pi0 last comment:

checking either @nuxt/vue-app or @nuxt/vue-app-edge in node_modules should do the trick :)

For people living on the edge (lol) and having the last definitions, it's good if vetur can also look to @nuxt/vue-app-edge too.

Is it good for you @octref ?

[octref]

OK, I'll do it this way:

• If nuxt/nuxt-legacy/nuxt-edge < 2.4.0 found in package.json, I'll fall back to use https://github.com/nuxt-community/nuxt-helper-json
• If nuxt/nuxt-legacy/nuxt-edge > 2.4.0 found in package.json, I'll check @nuxt/vue-app or @nuxt/vue-app-edge for the definitions.

[atinux]

Perfect @octref

I am merging this PR then :)