@@ -53,26 +53,26 @@ You can configure Roughly as an [external formatter in RStudio](https://roughly.
5353
5454## Usage
5555
56- Start the language server :
56+ Run roughly as a formatter :
5757
5858```
59- roughly lsp
59+ roughly fmt # Format all files in the current directory
60+ roughly fmt <path> # Format all files in `<path>`
61+ roughly fmt --check # Only check if files would be formatted
62+ roughly fmt --diff # Only show diff if files would be formatted
6063```
6164
62- To run roughly as a formatter :
65+ To run Roughly as a linter :
6366
6467```
65- roughly fmt # Format all files in the current directory
66- roughly fmt <path> # Format all files in `<path>`
67- roughly fmt --check # Only check if files would be formatted
68- roughly fmt --diff # Only show diff if files would be formatted
68+ roughly check # Check all files in the current directory
69+ roughly check <path> # Check all files in `<path>`
6970```
7071
71- Or, to run Roughly as a linter :
72+ Or, to run Roughly as a language server :
7273
7374```
74- roughly check # Check all files in the current directory
75- roughly check <path> # Check all files in `<path>`
75+ roughly lsp # Usually started automatically by your editor
7676```
7777
7878## Configuration
@@ -84,10 +84,6 @@ case = "snake_case" # or camelCase
8484spaces = 2
8585```
8686
87- ## Documentation
88-
89- For comprehensive documentation, visit [ roughly.felixandreas.me] ( https://roughly.felixandreas.me ) .
90-
9187## Features
9288
9389* Completion
@@ -96,7 +92,7 @@ For comprehensive documentation, visit [roughly.felixandreas.me](https://roughly
9692* Formatting
9793* Diagnostics
9894 * Syntax
99- * Missing commans, Trailing commas,
95+ * Missing and trailing commas
10096 * Assignments, casing
10197* Indexing
10298 * Globals
@@ -105,24 +101,13 @@ For comprehensive documentation, visit [roughly.felixandreas.me](https://roughly
105101 * Generics
106102 * Methods
107103 * (TODO) R6
108- * Goto Document Symbol <kbd >Ctrl</kbd > <kbd >Shift</kbd > + <kbd >O</kbd >
109- * Goto Workspace Symbol <kbd >Ctrl</kbd > + <kbd >T</kbd >
104+ * Goto Document Symbol (VS Code shortcut <kbd >Ctrl</kbd > <kbd >Shift</kbd > + <kbd >O</kbd >)
105+ * Goto Workspace Symbol (VS Code shortcut <kbd >Ctrl</kbd > + <kbd >T</kbd >)
110106* VS Code Extension
111- * Commands
107+ * Commands (< kbd >Ctrl</ kbd > + < kbd >Shift</ kbd > + < kbd >P</ kbd >)
112108 * Start/Stop/Restart the Language Server
113109 * Open logs
114110
115- ## Project layout
116-
117- Currently this extension assumes that your ` R ` code has the following folder structure:
118-
119- | Path | Type |
120- | -------------| -----------|
121- | ` R ` | directory |
122- | ` R/*.R ` | file |
123- | ` NAMESPACE ` | file |
124-
125-
126111## Development
127112
128113See our [ development documentation] ( https://roughly.felixandreas.me/development ) .
0 commit comments