An open API service indexing awesome lists of open source software.

https://github.com/alefragnani/vscode-read-only-indicator

Read-Only Indicator Extension for Visual Studio Code
https://github.com/alefragnani/vscode-read-only-indicator

file-access vscode

Last synced: over 1 year ago
JSON representation

Read-Only Indicator Extension for Visual Studio Code

Awesome Lists containing this project

README

          

[![](https://vsmarketplacebadges.dev/version-short/alefragnani.read-only-indicator.svg)](https://marketplace.visualstudio.com/items?itemName=alefragnani.read-only-indicator)
[![](https://vsmarketplacebadges.dev/downloads-short/alefragnani.read-only-indicator.svg)](https://marketplace.visualstudio.com/items?itemName=alefragnani.read-only-indicator)
[![](https://vsmarketplacebadges.dev/rating-short/alefragnani.read-only-indicator.svg)](https://marketplace.visualstudio.com/items?itemName=alefragnani.read-only-indicator)
[![](https://img.shields.io/github/actions/workflow/status/alefragnani/vscode-read-only-indicator/main.yml?branch=master)](https://github.com/alefragnani/vscode-read-only-indicator/actions?query=workflow%3ACI)




Read-only Logo

# What's new in Read-only Indicator 3.11

* Adds new **UIMode**
* Published to **Open VSX**
* Adds **Folder Level** commands support
* Adds **Workspace Trust** support

## Support

**Read-only Indicator** is an open source extension created for **Visual Studio Code**. While being free and open source, if you find it useful, please consider supporting it.











# Read-only Indicator

It adds an area in the status bar, indicating if the file is **read-only** or **writeable**. It will be automatically updated, every time you open any file.

# Features

The indicator is automatically updated. You don't need to do anything.

File Access | Status Bar Preview |
----------- | ------------------ |
Read-only |![Read-only](images/screenshot-readonly.png)
Writeable |![Writeable](images/screenshot-writeable.png)

## Available commands

* `File Access: Change File Access`
* `File Access: Toggle File Access`
* `File Access: Make Read Only [RO]`
* `File Access: Make Writeable [RW]`

### Available commands in Explorer view

* `Make Read Only`
* `Make Writeable`

> **Note**
> These commands are not available on Linux.

## Available settings

* Defines the position where the Status Bar indicator is located
```json
"fileAccess.position": "left" // or "right"
```

* Define how much information is displayed in the Status Bar indicator
```json
"fileAccess.uiMode": "complete" // or "simple" or "iconOnly"
```

* Hides the Status Bar indicator when the file is Writeable
```json
"fileAccess.hideWhenWriteable": true // or false
```

* Set what to do when the Status Bar indicator is clicked
```json
"fileAccess.indicatorAction": "choose" // or "toggle"
```

## Available colors

For more information about customizing colors in VSCode, see [Theme Color](https://code.visualstudio.com/api/references/theme-color).

* Choose the Status Bar indicator text color when the file is Read Only
```json
"workbench.colorCustomizations": {
"fileAccess.readonlyForeground": "#ff7fc0",
}
```

* Choose the Status Bar indicator text color when the file is Writeable
```json
"workbench.colorCustomizations": {
"fileAccess.writeableForeground": "#7fcc7f",
}
```

## Contributors

Special thanks to the people that have contributed to the project:

* Riku Kanayama (@k-kuroguro) - Wrong description on Readme ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/67))
* dO.Ob -> zhaolei (@zzhaolei) - Support folder level commands to MacOS ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/60))
* Riku Kanayama (@k-kuroguro) - Typos in settings names ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/51))
* Riku Kanayama (@k-kuroguro) - Support folder level commands to change File Access ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/49))
* Riku Kanayama (@k-kuroguro) - New Command: `File Access: Toggle File Access` ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/40))
* Chris Antos (@chrisant996) - Settings to choose the colors of the Status Bar text ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/24))
* Chris Antos (@chrisant996) - Only show Status Bar indicator when Read-only ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/24))
* joshwiker14 (@joshwiker14) - Add support for MacOs and Linux ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/13))
* Tom Chapple (@TomChapple) - Allow for toggling File Access via Status Bar ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/11))
* Franklin Yu (@FranklinYu) - Reformat Readme ([see PR](https://github.com/alefragnani/vscode-read-only-indicator/pull/9))

Also thanks to everyone who helped opening issues with ideas and bug reports.

# License

[MIT](LICENSE.md) © Alessandro Fragnani