Skip to content

Commit

Permalink
chore: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marabesi committed Dec 12, 2021
1 parent 660eec7 commit 1dbd6e0
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ php-import-checker helps you know when a given class is imported but not used, p

- Highlight every unused class that is imported with `use`
- Change the color to fit your theme
- opt-in for latest changes and give feedback

For example if there is an image subfolder under your extension project workspace:

Expand All @@ -23,6 +24,23 @@ For example if there is an image subfolder under your extension project workspac

![Change highlight color](demo-color.gif)

## Settings

The settings described in this section go under the json option `php.import.highlight`,
a basic configuration that would change the highlight color, would be something
like:

```json
"php.import.highlight": {
"color": "#EDF791"
}
```

|Option|Type|Description|
|------|----|-----------|
|color|String| Uses the RGB color defined in this option to highlight the unused imports - helpful to match the color with your preferred theme.|
|use_next_version|Boolean| Opt-in to the latest changes to the extension without breaking current behavior. Note: if you are using this option and find anything wrong, please open an issue.|

## Requirements

Visual Code 1.6 +

0 comments on commit 1dbd6e0

Please sign in to comment.