Page MenuHomePhabricator
Differential D9000

Update doc for available lints
ClosedPublic
Actions

Authored by avivey on May 7 2014, 1:54 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Dec 17, 12:55 AM
Unknown Object (File)
Thu, Dec 12, 2:24 AM
Unknown Object (File)
Wed, Dec 11, 6:18 PM
Unknown Object (File)
Sat, Dec 7, 9:08 PM
Unknown Object (File)
Fri, Dec 6, 11:23 PM
Unknown Object (File)
Wed, Dec 4, 3:15 AM
Unknown Object (File)
Fri, Nov 29, 8:17 PM
Unknown Object (File)
Fri, Nov 29, 12:57 PM
View All Files
Subscribers
epriestley
hach-que
joshuaspence
Korvin

Details

Reviewers
epriestley
Group Reviewers
Blessed Reviewers
Commits
Restricted Diffusion Commit
rP61257d88d532: Update doc for available lints
Summary
  • Mention many new linters now included.
  • Basic description of .arclint + example
  • Move Philosophy sections above Configuration sections.
Test Plan

compile with bin/diviner.

Diff Detail

Repository
rP Phabricator
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

avivey updated this revision to Diff 21373.May 7 2014, 1:54 AM
avivey retitled this revision from to Update doc for available lints.
avivey updated this object.
avivey edited the test plan for this revision. (Show Details)
avivey added a reviewer: epriestley.
Herald added a reviewer: Blessed Reviewers. · View Herald TranscriptMay 7 2014, 1:54 AM
Herald added subscribers: Korvin, epriestley. · View Herald Transcript
Harbormaster completed remote builds in B281: Diff 21373.May 7 2014, 1:55 AM
avivey added a subscriber: hach-que.May 7 2014, 1:59 AM

I never actually used the .arclint, so some of what I wrote may be wrong; It's mostly based on the code in ArcanistConfigurationDrivenLintEngine.

src/docs/user/userguide/arcanist_lint.diviner
59–61

@hach-que, is this right?

epriestley edited edge metadata.May 7 2014, 2:00 AM

man this is a lame D9000

we have the worst luck

avivey edited edge metadata.May 7 2014, 2:04 AM
avivey added a subscriber: joshuaspence.
epriestley accepted this revision.May 7 2014, 2:07 AM
epriestley edited edge metadata.

For the lists of stuff, I think we should write something like:

$ arc lint --list

...(or maybe arc list-linters or something? Or arc linter-info <optional linter>?) which prints out something like this:

[Installed] jshint 1.2.3
[Installed] pylint 2.5.4
[Old Version] pep8 0.0.3
[Not Installed] etc
[Not Installed] etc

...so we don't have to have 35 pages of docs? Maybe we could give them an optional method like getHelpURI() and print that out.

Anyway this is clearly better and we can clean it up once someone comes up with a good name for the command.

This revision is now accepted and ready to land.May 7 2014, 2:07 AM
epriestley closed this revision.May 7 2014, 2:08 AM
epriestley updated this revision to Diff 21374.

Closed by commit rP61257d88d532 (authored by @avivey, committed by @epriestley).

hach-que added inline comments.May 7 2014, 8:09 AM
src/docs/user/userguide/arcanist_lint.diviner
59–61

Yeah that's right (I actually saw this in the online docs early today and was like whoaa my repo is linked to)

Revision Contents
Changeset List

PathSize
src/
docs/
user/
userguide/
166 lines

Diff 21374

View Options

src/docs/user/userguide/arcanist_lint.diviner

Loading...
Phabricator · Built by Phacility