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

docs: Add common use case scenario for Vue CLI lint command #4583

Open
wants to merge 2 commits into
base: docs
Choose a base branch
from

Conversation

bencodezen
Copy link
Member

@bencodezen bencodezen commented Sep 16, 2019

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Underlying tools
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

Other information:

Copy link
Member

@NataliaTepluhina NataliaTepluhina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this, Ben! I've added a few comments regarding base branch

@@ -92,6 +92,32 @@ There are a few useful flags:

- `--report` and `--report-json` will generate reports based on your build stats that can help you analyze the size of the modules included in your bundle.

## vue-cli-service lint
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

concern: I think this section of the CLI docs describes only scripts available with the basic setup, i.e. without any CLI plugins included. However, lint script is added only with @vue/cli-plugin-eslint. My suggestion would be to move this part to respective docs (i.e. @vue/cli-plugin-eslint documentation).

Also, PRs to docs should be created using master or next branch as a base (see Contributing guide).

In master ESLint plugin docs are located here

In next we changed them to be the part of the main documentation rather than standalone READMEs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoa that's weird. I just used the "Edit" link on the page to do this. That's interesting that it made the destination vuejs:docs rather than master (which is what I assumed).

Shall I just make the PR for next then?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, that's a great catch! I will fix the Vuepress links to the repo! 🙇‍♀

Yes, I think a PR for next should work 😉

docs/guide/cli-service.md Outdated Show resolved Hide resolved
Co-Authored-By: Natalia Tepluhina <NataliaTepluhina@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants