Page MenuHomeFreeBSD

vale integration with editors
ClosedPublic

Authored by bofh on Nov 11 2022, 4:20 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mar 7 2024, 6:03 PM
Unknown Object (File)
Dec 20 2023, 7:27 AM
Unknown Object (File)
Aug 28 2023, 1:50 AM
Unknown Object (File)
Aug 14 2023, 4:23 AM
Unknown Object (File)
Aug 14 2023, 4:21 AM
Unknown Object (File)
Aug 14 2023, 4:21 AM
Unknown Object (File)
Aug 14 2023, 4:09 AM
Unknown Object (File)
Jun 30 2023, 6:44 PM
Subscribers

Details

Summary

My previous commit of .vale.ini was not helpful for editor integration as vim creates a file outside the git repository(specially /tmp) where vale styles were not applicable. This commit changes the applicable file patterns to match editor integration.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

bofh requested review of this revision.Nov 11 2022, 4:20 PM
bofh created this revision.

Looks good as a first introduction to vale. A few fixes and then you can commit it to the FDP primer.

documentation/content/en/books/fdp-primer/editor-config/_index.adoc
65 ↗(On Diff #112945)

I think it is safe to remove the "for the developers/contributors/committers" part as it is basically available for everyone. No need to make a distinction then.

66 ↗(On Diff #112945)

s/IDES/IDEs/

72 ↗(On Diff #112945)

Can you distinguish the root commands from the ones that don't need to be run as root? I think we use # for root and % for non-root users throughout our docs.

This revision was not accepted when it landed; it landed in state Needs Review.Nov 12 2022, 10:21 PM
This revision was automatically updated to reflect the committed changes.

I will fix the FDP as per your comments. This was required as there is a bug in vale which I am working on and referencing this file everyone will ask me to fix this first.

bofh retitled this revision from vale integration with vim editor to vale integration with editors.Nov 12 2022, 10:25 PM
bofh edited the summary of this revision. (Show Details)