DOCS-685: Use prettier linter #1835
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viambot
added
the
safe to build
|
Overall readability score: 55.78 (🟢 +1.33)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
npentrel
force-pushed
the
try-prettier
branch
from
fc0d730 to
2daa84f
Compare
npentrel
commented
Sep 15, 2023
| 6. Paste the raw fragment contents into the **Raw JSON** config field. | ||
| 7. Click **Save config**. | ||
| 8. Now, you can edit the config either in **Raw JSON** mode or in **Builder** mode. | ||
| 4. Toggle to [**Raw JSON** mode](/try-viam/try-viam-tutorial/#raw-json). |
npentrel
force-pushed
the
try-prettier
branch
from
2daa84f to
b969f09
Compare
npentrel
force-pushed
the
try-prettier
branch
from
31f8f98 to
53fc266
Compare
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
force-pushed
the
try-prettier
branch
2 times, most recently
from
b298a95 to
fb0710a
Compare
npentrel
commented
Sep 22, 2023
npentrel
force-pushed
the
try-prettier
branch
4 times, most recently
from
a8f8595 to
c6f1d88
Compare
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
force-pushed
the
try-prettier
branch
from
642bba9 to
4d75b52
Compare
npentrel
force-pushed
the
try-prettier
branch
4 times, most recently
from
830177f to
7c0513c
Compare
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
force-pushed
the
try-prettier
branch
from
7c0513c to
8c6ca95
Compare
npentrel
force-pushed
the
try-prettier
branch
3 times, most recently
from
c5cfe65 to
12fd734
Compare
npentrel
force-pushed
the
try-prettier
branch
from
12fd734 to
e26665f
Compare
andf-viam
approved these changes
Sep 22, 2023
There was a problem hiding this comment.
Ok wow! LGTM! Left a question about possible clobbering with the python linter we also just added, and noted a few more instances where we could use <!-- prettier-ignore --> if desired.
Lots of big diffs makes me a bit nervous, didn't go through all deeply, but everything I spot checked through looks great! Nice work on this!!
| "rightm" | ||
| ], | ||
| "left": ["leftm"], | ||
| "right": ["rightm"], |
There was a problem hiding this comment.
I know this is JSON, but conceptually this feels like clobbering with the python linter we also just deployed (py linter enforces expansion of some nested components to new lines, for example, counter to what is happening here)
Will prettier ever try to fix python indenting already handled by the py lintiner? Or vice versa? Or are they carefully scoped: (prettier = MD and JSON but skip py code fences || pylintything = py code fences only)?
If so, no worries, should be good!
There was a problem hiding this comment.
Prettier skipx python code snippets so all good 😊.
| "digital_interrupts": [ | ||
| "<your-digital_interrupts-name-1>", | ||
| "<your-digital_interrupts-name-2>" | ||
| ] |
There was a problem hiding this comment.
Oh! If the array contains 2+ values, multi-line but if single value = single line (like in docs/components/base/wheeled.md)?? I like that!
There was a problem hiding this comment.
I think it's if the values can fit on one line without exceeding 80 chars
| @@ -97,7 +98,7 @@ If you have another controller that you want to use to control your robot, feel | |||
| ## Troubleshooting | |||
|
|
|||
| - If you are not able to see a drop-down menu with the name of your controller appear in the **Control** tab, try specifying the `dev_file` attribute to match the exact path to your device. | |||
| You can also try setting `auto_reconnect` to `True`. | |||
| You can also try setting `auto_reconnect` to `True`. | |||
There was a problem hiding this comment.
Is this right? single item UL element is to be ... indented two whitespace characters? Would have expected - per other instances.
There was a problem hiding this comment.
This is a continuation of the previous item not a new one. So the indentation is to match that item
| @@ -102,17 +102,17 @@ Edit and fill in the attributes as applicable. | |||
|
|
|||
| The following attributes are available for a `gps-nmea-rtk-pmtk` movement sensor: | |||
|
|
|||
There was a problem hiding this comment.
Do you also want a <!-- prettier-ignore --> here too?
| @@ -102,15 +101,15 @@ Edit and fill in the attributes as applicable. | |||
|
|
|||
| The following attributes are available for a `gps-nmea-rtk-pmtk` movement sensor: | |||
|
|
|||
There was a problem hiding this comment.
Do you also want a <!-- prettier-ignore --> here too?
JessamyT
reviewed
Sep 22, 2023
| }, | ||
| "ticks_per_rotation": 100 | ||
| }, | ||
| "depends_on": ["board1", "encoder1"] |
There was a problem hiding this comment.
This is odd. Does it have to do that?
There was a problem hiding this comment.
Yes it does that to conserve space if the array is short enough to fit on one line
There was a problem hiding this comment.
My concern is just that this is different from what the app does--I wish we could get it to match the app so that people can seamlessly cross-reference
There was a problem hiding this comment.
But I suppose not a common issue since implicit dependencies are the norm, and most places where we still have anything in depends_on could be removed
There was a problem hiding this comment.
if there were more here it would split onto multiple lines, so we could do that or change the names if we want to ensure it's on two lines, but let's do that separately.
JessamyT
reviewed
Sep 22, 2023
Co-authored-by: JessamyT <[email protected]>
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
npentrel
commented
Sep 22, 2023
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/bb368a369f39e2b2ba210581ee3364f7952f5e24/public |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It would appear prettier for markdown is an all or nothing kind of linter. There is no way to to turn off ANY rules for markdown linting. So whether we want to use it, is up to us:
Advantages:
Disadvantages: