Skip to content

Commit 62ce415

Browse files
docs & vscode contribs pic patch update for #17 & more
read the readme.md! :)
1 parent 51014f7 commit 62ce415

File tree

4 files changed

+31
-29
lines changed

4 files changed

+31
-29
lines changed

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,59 @@
11
# vscode-data-preview
2-
[VSCode](https://github.com/Microsoft/vscode) Data Preview extension for viewing, slicing and dicing
3-
large `.csv/.tsv`, `.xlsx/.xlsm`, `.json` array, `.arrow` and `.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming analytics WebAssembly library.
2+
[VSCode](https://github.com/Microsoft/vscode) Data Preview 🈸 extension for viewing, slicing & dicing
3+
large `.csv/.tsv`, `.xlsx/.xlsm`, `.json` array, `.arrow` & `.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming data analytics WebAssembly library.
44

55
![Data Preview](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview.png?raw=true
66
"Data Preview")
77

8-
# MVP Features
8+
# Data Preview 🈸 MVP Features
99

10-
- `CSV/TSV`, `XLSX/XLSM`, `JSON array`, and `Arrow` data files preview, sorting and filtering
11-
- Grid Data summary display with Aggregate Functions, Row and Column Pivots (a.k.a. `Group By` and `Split By`)
12-
- Basic Charts auto-gen from data with Aggregate Functions, Row and Column Pivots
13-
- Pluggable charting libraries for stock Charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
14-
- Dark and Light Data Preview panel themes
15-
- Persistent Data Preview settings (sort, filter, pivots, etc.) for restore on vscode reload
10+
- `CSV/TSV`, `XLSX/XLSM`, `JSON array` & `Arrow` data files preview, sorting & filtering
11+
- Grid Data summary display with Aggregate Functions, Row & Column Pivots (a.k.a. `Group By` & `Split By`)
12+
- Basic Charts auto-gen from data with Aggregate Functions, Row & Column Pivots
13+
- Pluggable Data Charting libraries for stock Charts: [highcharts](https://www.highcharts.com/demo) || [d3fc](https://d3fc.io/)
14+
- Dark & Light Data Preview 🈸 Panel Themes
15+
- Persistent Data Preview 🈸 Settings (sort, filter, pivots, etc.) for restore on vscode reload
1616

1717
![Perspective Viewer](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/perspective-viewer.gif?raw=true
1818
"Perspective Viewer")
1919

2020
# Next V.
2121

22-
- Will include `.parquet`, large text and binary data files support, and [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data streaming.
22+
- Will include `.parquet` data format support, large text & binary data files loading & [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data streaming.
23+
24+
**Note:** this Data Preview 🈸 MVP v. is already capable of loading a few MB's large data files with 100+K records & extensive list of supported data formats you'll be hard pressed to find on vscode marketplace.
2325

2426
# Installation
2527

26-
Install this [Data Preview](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-data-preview) via vscode Extensions tab (`Ctrl+Shift+X`) by searching for `data preview`, or via [vscode marketplace search results](https://marketplace.visualstudio.com/search?term=data%20preview&target=VSCode&category=All%20categories&sortBy=Relevance).
28+
Install this [Data Preview](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-data-preview) 🈸 via vscode Extensions tab (`Ctrl+Shift+X`) by searching for `data preview` || via [vscode marketplace search results](https://marketplace.visualstudio.com/search?term=data%20preview&target=VSCode&category=All%20categories&sortBy=Relevance).
2729

28-
List of Data Preview extension vscode contributions, with `data.preview` command, keyboard shortcut, augmented menu contexts for `csv/tsv`, `xlsx/xlsm`, `json` array, and `arrow` data file previews, and configurable theme and charts data preview settings:
30+
List of Data Preview 🈸 extension vscode contributions, with `data.preview` command, keyboard shortcut, augmented vscode UI context menus, added data language mappings, supported data files list & configurable theme & charts Data Preview 🈸 Settings:
2931

3032
![Data Preview Contributions](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview-contributions.png?raw=true
3133
"Data Preview Contributions")
3234

3335
# Configuration
34-
[Create User or Workspace Settings in vscode](http://code.visualstudio.com/docs/customization/userandworkspace#_creating-user-and-workspace-settings) to change default Data Preview extension settings:
36+
[Create User or Workspace Settings in vscode](http://code.visualstudio.com/docs/customization/userandworkspace#_creating-user-and-workspace-settings) to change default Data Preview 🈸 extension Settings:
3537

3638
Setting | Type | Default Value | Description
3739
------- | ---- | ------------- | -----------
3840
data.preview.theme | string | | Data Preview theme: blank for light, or '.dark' for dark theme data previews display.
39-
data.preview.charts.plugin | string | hightcharts | Data Preview charts library to use for stock charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
41+
data.preview.charts.plugin | string | hightcharts | Data Preview 🈸 charts library to use for stock charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
4042

41-
Data Preview using `.dark` theme with `d3fc` charts config, viewing
43+
Data Preview 🈸 example using `.dark` theme with `d3fc` charts config, viewing
4244
[superstore](https://github.com/finos/perspective/blob/master/examples/simple/superstore.arrow)`.arrow` data file :)
4345

4446
![Data Preview Dark](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview-dark.png?raw=true
4547
"Data Preview Dark")
4648

4749
# Usage Tips
4850

49-
## Data Preview Launch Tips
51+
## Data Preview 🈸 Launch Tips
5052

51-
1. Run `View -> Command Palette>Data: Preview Data 🈸` command or hit `Ctrl+Shift+D` in an open text `.csv/.tsv` or `.json` array data file document to launch Data Preview panel.
52-
2. Hit `Ctrl+S` or `File -> Save` your `.csv/.tsv` or `.json` array data file for updates in open Data Preview panel.
53-
3. Right-click on a binary `.xlsx/.xlsm` or `.arrow` data file in vscode File Explorer to launch Data Preview panel.
54-
4. Use exposed `explorer/context`, `editor/title` or `editor/title/context` context menu options to Preview your data files.
53+
1. Run `View -> Command Palette...>Data: Preview Data 🈸` command or hit `Ctrl+Shift+D` in an open text `.csv/.tsv` or `.json` array data file document to launch Data Preview 🈸 panel.
54+
2. Hit `Ctrl+S` or `File -> Save` your `.csv/.tsv` or `.json` array data file for updates in open Data Preview 🈸 panel.
55+
3. Right-click on a binary `.xlsx/.xlsm` or `.arrow` data file in vscode File Explorer to launch Data Preview 🈸 panel.
56+
4. Use exposed `explorer/context`, `editor/title` or `editor/title/context` context menu options to Preview 🈸 your data files.
5557

5658
## Data Grid/Filter/Columns UX Tips
5759

@@ -63,9 +65,6 @@ Data Preview using `.dark` theme with `d3fc` charts config, viewing
6365

6466
# Supported Excel & Other Binary Data Formats
6567

66-
![Data Preview Data](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview-data.png?raw=true
67-
"Data Preview Data")
68-
6968
```js
7069
{
7170
"when": "resourceFilename =~ /.*\\.(csv|tsv|txt|tab|dif|ods|prn|slk|xls|xlsb|xlsx|xlsm|xml|html|json|arrow|arr|parquet|parq)/",
@@ -76,6 +75,9 @@ Data Preview using `.dark` theme with `d3fc` charts config, viewing
7675

7776
See https://github.com/SheetJS/js-xlsx#file-formats for more info on supported `Excel` file formats.
7877

78+
![Data Preview Data](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview-data.png?raw=true
79+
"Data Preview Data")
80+
7981
## Provided Chart Types
8082

8183
- Area Chart
@@ -110,7 +112,7 @@ See https://github.com/SheetJS/js-xlsx#file-formats for more info on supported `
110112

111113
# Dev Log
112114

113-
See [#DataPreview tag on Twitter](https://twitter.com/hashtag/datapreview?f=tweets&vertical=default&src=hash) for the latest and greatest updates on this vscode extension and what's in store next.
115+
See [#DataPreview 🈸 tag on Twitter](https://twitter.com/hashtag/datapreview?f=tweets&vertical=default&src=hash) for the latest and greatest updates on this vscode extension and what's in store next.
114116

115117
# Dev Build
116118

@@ -120,10 +122,10 @@ $ cd vscode-data-preview
120122
$ npm install
121123
$ code .
122124
```
123-
`F5` to launch Data Preview extension VSCode debug session.
125+
`F5` to launch Data Preview 🈸 extension VSCode debug session.
124126

125127
# Contributions
126128

127129
Any and all test, code or feedback contributions are welcome.
128130

129-
Open an issue or create a pull request to make this Data Preview extension work better for all.
131+
Open an issue or create a pull request to make this Data Preview 🈸 extension work better for all.
312 Bytes
Loading

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "vscode-data-preview",
33
"displayName": "Data Preview",
44
"description": "Data Preview",
5-
"version": "1.6.1",
5+
"version": "1.6.2",
66
"publisher": "RandomFractalsInc",
77
"author": "Taras Novak",
88
"contributors": [
@@ -90,7 +90,7 @@
9090
".prn",
9191
".slk",
9292
".xml",
93-
".html"
93+
".html"
9494
],
9595
"aliases": [
9696
"Excel"

0 commit comments

Comments
 (0)