Skip to content

Commit

Permalink
Add notes to REAME.md
Browse files Browse the repository at this point in the history
  • Loading branch information
faustinoaq committed Aug 8, 2017
1 parent ed5b37d commit 28715d3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ Other features like _syntax highlighting_, _snippets_, _symbols_ and _basic comp
"crystal-lang.completion": true,
"crystal-lang.hover": true,
"crystal-lang.server": "",
"crystal-lang.logLevel": "error"
"crystal-lang.logLevel": "error",
"crystal-lang.compiler": "crystal"
}
```

Expand Down Expand Up @@ -83,9 +84,11 @@ The default value is 20.

### 3.3. MainFile

Note: reload VSCode to apply this setting.

`crystal-lang.mainFile` says to the compiler which file should analyze.

It is useful when `"crystal-lang.problems" = "build"` in projects where a main file do `require "./**"`
It is useful with `"crystal-lang.problems" = "build"` in projects where a main file do `require "./**"`

Also is used by features like **implementations** and show **type on hover** to specify the tool scope.

Expand All @@ -99,6 +102,8 @@ Also is used by features like **implementations** and show **type on hover** to

### 3.4. ProcessesLimit

Note: reload VSCode to apply this setting.

This extension block the amout of crystal processes executing in parallel to reduce resources usage.

Commonly crystal takes milliseconds to do something like formatting, but in some projects other features like implementations or completion can take a moment. To prevent using too many resources you can set the amount of processes with:
Expand Down Expand Up @@ -200,6 +205,17 @@ Levels avaliables:
}
```

### 3.10. Compiler

> Note: reload VSCode to apply this setting.
Allow to set a custom absolute path for Crystal compiler executable.

```json
"crystal-lang.compiler": "/usr/bin/crystal"
}
```

## 4. Messages

Sometimes in some projects, `crystal tool` turns heavy, in this case you can check error and info messages.
Expand Down

0 comments on commit 28715d3

Please sign in to comment.