Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve config file docs #2543

Open
1 task done
yoyo930021 opened this issue Dec 10, 2020 · 2 comments
Open
1 task done

Improve config file docs #2543

yoyo930021 opened this issue Dec 10, 2020 · 2 comments

Comments

@yoyo930021
Copy link
Member

yoyo930021 commented Dec 10, 2020

  • I have searched through existing issues

Feature Request

We have three config file.

  • vetur.config.js
  • tsconfig.json/jsconfig.json
  • package.json

We need to describe their previous relationships and roles.

@chris-NR
Copy link

I arrived at this issue after trying to figure out how to fix an 'incorrect' vetur project configuration. This was my experience:

  1. vetur extension seems to initialise OK when opening the workspace (no warnings or errors reported)
  2. two warnings pop up on opening a .vue file:
  • vetur can't find package.json
  • vetur can't find tsconfig.json or jsconfig.json
  1. I figured that as these files are a very important part of the app I should fix the issue....
  2. I already have package.json and jsconfig.json in my vue project but these are one folder below my 'project root' e.g. root/frontend/package.json not root/package.json so this must be the problem.....
  3. I looked at the docs and found the (very confusing) section on the vetur.config.js file and so I had a go at fixing it by creating the config file with the 'vetur root' one level down. The 'monorepo / projects' section confused me as I don't know what a monorepo is so I left that section out and just set the default root

vetur

  1. Unfortunately this did not work and I can't figure out why from the docs
  2. I have found the option to disable the warning in the vetur settings however I have no idea what an 'incorrectly setup' project means or whether this is a good or bad thing to do!
  3. I finally managed to fix it by trial and error, this is the working vetur.config.js file

vetur2

@chris-NR
Copy link

I have also learnt what a monorepo is and I do indeed have a monorepo containing my backend node.js code and my frontend vue.js code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants