sheetjs-vscode-extension/README.md

# SheetJS VSCode Extension

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/asadbek.sheetjs-demo)](https://marketplace.visualstudio.com/items?itemName=asadbek.sheetjs-demo)
[![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/asadbek.sheetjs-demo)](https://marketplace.visualstudio.com/items?itemName=asadbek.sheetjs-demo)


[![View on Marketplace](https://img.shields.io/badge/View%20on-Marketplace-blue?style=for-the-badge&logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=asadbek.sheetjs-demo)
[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/asadbek.sheetjs-demo)](https://marketplace.visualstudio.com/items?itemName=asadbek.sheetjs-demo)

[![View on Open VSX](https://img.shields.io/badge/View%20on-Open%20VSX-blue?style=for-the-badge&logo=eclipseide)](https://open-vsx.org/extension/asadbek/sheetjs-demo)
[![Open VSX Downloads](https://img.shields.io/open-vsx/dt/asadbek/sheetjs-demo)](https://open-vsx.org/extension/asadbek/sheetjs-demo)




---

<img src="https://git.sheetjs.com/asadbek064/sheetjs-vscode-extension/raw/branch/main/asset/sheetjs-vscode-extension-demo.gif" alt="SheetJS VSCode Extension Preview" width="600"/>

## SpreadSheet Viewer

Powered by [SheetJS](http://sheetjs.com/) a powerful VSCode extension that lets you view spreadsheets right in your editor. Works with **XLSX**, **XLS**, **CSV**, **ODS** and 30+ other formats.


## Key Features

- Caches workbooks and sheets to avoid re-parsing files
- Loads sheets on-demand when switching between them
- Automatically reloads when files are edited externally
- Handles mega large files with pagination
- Toggle viewer on/off for specific file extensions via command palette or context menu

## Supported File Formats

[Supported File Formats](https://docs.sheetjs.com/docs/miscellany/formats/)
|  |  | |
| :--- | :--- | :--- |
| .xlsx | .prn | .wk4 |
| .xlsm | .et | .123 |
| .xlsb | .ods | .wq1 |
| .xls | .fods | .wq2 |
| .xlw | .uos | .wb1 |
| .xlr | .dbf | .wb2 |
| .numbers | .wk1 | .wb3 |
| .csv | .wk3 | .qpw |
| .dif | .wks | .xlr |
| .slk | .wk2 | .eth |
| .sylk | | |

## Usage

### Disabling/Enabling the Viewer

You can easily disable the SheetJS viewer for specific file extensions:

<img src="https://git.sheetjs.com/asadbek064/sheetjs-vscode-extension/raw/branch/main/asset/toggle_context_menu.png" alt="SheetJS VSCode Extension Preview" width="600"/>
<img src="https://git.sheetjs.com/asadbek064/sheetjs-vscode-extension/raw/branch/main/asset/toggle_ext_via_palette.png" alt="SheetJS VSCode Extension Preview" width="600"/>

**Command Palette** (Ctrl/Cmd+Shift+P):
- `SheetJS: Disable Viewer for Current File Extension` - Switches to default text editor for that extension
- `SheetJS: Enable Viewer for Current File Extension` - Re-enables the viewer

**Context Menu**: Right-click any spreadsheet file in the Explorer to access the same commands.

**Built-in VSCode**: Right-click any file and select "Open With..." to choose between SheetJS Viewer and other editors.

### Override Constants (Available Settings)
- `sheetjs.maxRows` - Rows displayed per page (default: **1000**)
- `sheetjs.maxColumns` - Columns displayed (default: **100**)
- `sheetjs.maxCachedWorkbooks` - Workbooks kept in memory (default: **10**)
- `sheetjs.maxCachedSheets` - Sheet pages cached (default: **255**)

Changes take effect when opening a new spreadsheet file (existing open files need to be reopened)

## Getting Started
Want to integrate SheetJS in your own VSCode extension? Check out our [detailed tutorial](https://docs.sheetjs.com/docs/)
to learn how to implement these capabilities in your projects.

## Why even make this?

Fair question. I view spreadsheets constantly at work—XLSX, XLS, CSV, ODS, you name it. The existing options were inadequate:

**Microsoft Excel**: Bulky. Takes several seconds to open multi-megabyte files. Overkill for just viewing data.

**Other VSCode extensions**: Tried them all. Common problems:
- Can't open older XLS formats and refuse to read large files
- Consume 500MB+ RAM for a few-megabyte file
- Ship a full Excel-like editing experience nobody asked for

**My requirements were simple**:
1. Open any spreadsheet format instantly
2. Display the actual data representation
3. Reflect external edits immediately
4. Not destroy my RAM

Extensions shouldn't replicate Excel or some other tool. They should let you quickly iterate and validate data in context.
That's what this does.

### **Some popular extension**

![](./asset/other_extensions_refuses_to_open_file.png)
![](./asset/other_extension_600MB_ram_usage.png)

### **Mine 😊**

![](./asset/mine_easy_open_large_files.png)
![](./asset//mine_less_ram_usage.png)

## Development

To run the extension in development mode, install dependencies with `pnpm install` and press F5 in VSCode. This opens a new Extension Development Host window where you can test the extension by opening any spreadsheet file.


Build for production with `pnpm run package`.

## Publishing
```bash
npx vsce login foo
npx vsce publish
```

## Learn More
For more information on using this extension and integrating SheetJS capabilities in your own projects, visit our [documentation](https://docs.sheetjs.com/docs/).

---
_Created by Asadbek Karimov  | [contact@asadk.dev](mailto:contact@asadk.dev) | [asadk.dev](https://asadk.dev)_