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

doc: fix linting command for vcbuild #11151

Closed
wants to merge 1 commit into from
Closed

Conversation

Trott
Copy link
Member

@Trott Trott commented Feb 3, 2017

Currently, vcbuild only supports jslint. vcbuild lint will not
work because there is no lint task specified in vcbuild.bat. Update
documentation to use vcbuild jslint instead.

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@Trott Trott added the doc Issues and PRs related to the documentations. label Feb 3, 2017
@seishun
Copy link
Contributor

seishun commented Feb 3, 2017

Might want to mention that vcbuild jslint only does part of what make lint does.

@silverwind
Copy link
Contributor

Why not add vcbuild lint?

@seishun
Copy link
Contributor

seishun commented Feb 3, 2017

@silverwind it seems it's not so simple: #5514 (comment)

But sure, it would be a better solution.

@Trott
Copy link
Member Author

Trott commented Feb 3, 2017

Might want to mention that vcbuild jslint only does part of what make lint does.

Done.

Copy link
Contributor

@seishun seishun left a comment

Choose a reason for hiding this comment

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

LGTM unless someone implements vcbuild lint.

CONTRIBUTING.md Outdated
`make lint`/`vcbuild lint`.
`make lint`/`vcbuild jslint`. (At this time, only JavaScript linting is
available on Windows. `make lint` on POSIX will run both JavaScript linting and
C++ linting.)
Copy link
Contributor

@seishun seishun Feb 3, 2017

Choose a reason for hiding this comment

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

I don't like how the text between brackets is longer than the text it's supposed to clarify. Maybe it's better just mention lint and jslint separately.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps just remove the parens?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, parens removed.

@mscdex mscdex added build Issues and PRs related to build files or the CI. tools Issues and PRs related to the tools directory. labels Feb 3, 2017
CONTRIBUTING.md Outdated
`make lint`/`vcbuild lint`.
`make lint`/`vcbuild jslint`. (At this time, only JavaScript linting is
available on Windows. `make lint` on POSIX will run both JavaScript linting and
C++ linting.)
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps just remove the parens?

Currently, `vcbuild` only supports `jslint`. `vcbuild lint` will not
work because there is no `lint` task specified in `vcbuild.bat`. Update
documentation to use `vcbuild jslint` instead.
@Trott
Copy link
Member Author

Trott commented Feb 6, 2017

Landed in dccd97d

@jasnell
Copy link
Member

jasnell commented Mar 7, 2017

Would need backport PRs to land on v4 or v6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants