Depot

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 234 Open GitHub ↗

Structured data editor built inside VS Code

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Depot logo](https://raw.githubusercontent.com/afterschoolstudio/Depot/master/images/depot_logo.png)

# Depot
**Depot** is a structured data editor for Visual Studio Code that leverages Code's Custom Editor API to allow you to edit JSON data like a spreadsheet. Data you would normally store in raw JSON or XML can instead be stored, edited, and managed, all through a _single_ Depot file.

### Requirements
* Visual Studio Code 1.48+

[Download as a Visual Studio Code Extension Here](https://marketplace.visualstudio.com/items?itemName=afterschool.depot)

[![Sponsor Link](https://img.shields.io/github/sponsors/afterschoolstudio?style=social&logo=github-sponsors)](https://github.com/sponsors/afterschoolstudio)

## Features
* Edit data normally stored as raw JSON in a spreadsheet style interface
* A Depot file contains its data model, making the file itself portable to any other program
* Because the file uses JSON with newlines, you can easily track changes to data values or the model itself through source control

![Depot logo](https://raw.githubusercontent.com/afterschoolstudio/Depot/master/images/depot_screenshot.png)

## Sponsor

If you use or find value in Depot, we'd love it if you could sponsor the project! Click the link below or [navigate here](https://github.com/sponsors/afterschoolstudio) to choose a tier to support this project at.

[![Sponsor Link](https://img.shields.io/github/sponsors/afterschoolstudio?style=social&logo=github-sponsors)](https://github.com/sponsors/afterschoolstudio)

## Quickstart

[Watch an overview video here](https://www.youtube.com/watch?v=tCTQvd3zkEg)

1. Install Depot as an extension in VS Code or through the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=afterschool.depot)
2. Once installed, use the "Create a new Depot file" command to create a new Depot file in your workspace.
3. Click on the file, create a new sheet, and start working!

You can also manually create a Depot file by creating a file with this as its contents and giving it a ```.dpo``` extension:

```
{
    "sheets":[]
}
```

Note that once Depot is installed, the extension will try to open any file with ```.dpo``` through the Depot editor. If you want to manually create a Depot file, I suggest creating the file as a ```.txt``` file, adding the above contents, then changing the file's extension to ```.dpo```.

### Custom File Extensions
You can also use a custom file extension for Depot by editing your ```settings.json``` file and adding the following line:

### For most recent Code Versions

```
{
    "workbench.editorAssociations": {
        "*.foo" : "depot.data",
        "*.bar" : "depot.data"
    }
}
```

### For Code Versions Before 1.56

```
"workbench.editorAssociations": [
    {
        "viewType": "depot.data",
        "filenamePattern": "*.foo"
    },
    {
        "viewType": "depot.data",
        "filenamePattern": "*.bar"
    }
]
```

In the above example, clicking on a file with ```.foo``` or ```.bar``` would also open that file for editing in Depot.

### Other Extension Settings

```depot.defaults.newFileName``` allows you to set the default name for a new Depot file created through the Command Palette command.

## About / Why

Depot is meant as a way to allow people to edit data for their applications and programs in a manner that is common for data editing (spreadsheets) but also structured and indexable (JSON).

A Depot file is special because it contains not only its data, but also stores its data model inside itself. This means any given Depot file can be loaded and used anywhere, as the file itself contains the instructions for reading it. This also means the file can perform validation of itself at edit time, making sure that variables are within defined ranges or point to other valid sheets and lines.

Additionally, because Depot uses JSON with newlines, your data can be easily versioned through things like Git. Any changes to the data model or data itself will be reflected in the Depot file, with the same accuracy as normal source control.

Lastly, Depot could not exist without the work done by Nicholas Canasse on [CastleDB](https://github.com/ncannasse/castle). Depot is heavily inspired by CastleDB, but with the goal of bringing structed data editing to the IDE itself instead of needing to use another program. If you're familiar with CastleDB, you can [read more about the similarites and differences between it and Depot here](https://github.com/kkukshtel/Depot/wiki/Depot-vs.-CastleDB).

## Under the hood

A Depot file (```.dpo```) is just JSON, but unlike normal JSON it's organized through Sheets, Lines, and Columns.

### Sheets

[Read more about sheets on the wiki here](https://github.com/kkukshtel/Depot/wiki/Depot-Sheet-Information)

At the highest level, a Depot file consists of some number of sheets. These sheets are invididual collections of structured data, with the added benefit that they can also reference each other.

### Lines

A given sheet also has some number of lines. You can think of a sheet's lines as entries in the database defined by the sheet. Lines have data based on what columns are in the sheet it is a part of.

### Columns

[For a deeper dive on columns and their types, click here](https://github.com/kkukshtel/Depot/wiki/Depot-Column-Information)

Columns define the fields of a sheet that a line can have data for. Columns can be specific primitive types (```string```, ```bool```, ```int```, etc.), but can also be other special types unique to Depot:

|Type|Icon|Description|Storage Type|Default Value|
|---|---|---|---|---|
| GUID | None | A generated GUID for the given line. These cannot be edited. | String value | guid as string |
| ID | None | The ID of a column. These are ideally unique, and Depot will warn you if you duplicate the value. | String value | index in sheet as string |
| Text | ![New Text Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newText.png) | A standard line of text. | String value | `""` |
| Long Text | ![New Long Text Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newLongText.png) | Longer line of text. These fields can be resized in the editor. | String Value | `""` |
| Float | ![New Float Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newFloat.png) | Any number | Number value | `0` |
| Int | ![New Int Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newInt.png) | Integer number | Number value | `0` |
| Bool | ![New Bool Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newBool.png) | True / False boolean value. | true or false | `true` |
| Image | ![New Image Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newImage.png) | Path to an image relative to the location of the Depot file (displayed in the sheet) | String relative path to the image | `""` |
| Single Select | ![New Single Select Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newEnum.png) | Exclusive choice between a set number of choices | String value | `""` |
| Multi Select | ![New Multi Select Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newMulti.png) | Several choices between a set number of choices | Array of selected values as strings | `` |
| Line Reference | ![New Line Reference Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newLineLink.png) | A reference to a line in a sheet in the current Depot file | String GUID of selected line | `""` |
| Sheet Reference | ![New Sheet Reference Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newSheetLink.png) | A reference to a sheet in the current Depot file | String GUID of selected sheet | `""` |
| List | ![New List Icon](https://github.com/kkukshtel/Depot/raw/master/images/icons/newList.png) | An array of structured data | Array of structured values | `[]` |
| File | ![New File Reference](https://github.com/kkukshtel/Depot/raw/master/images/icons/newFile.png) | Path to a file relative to the location of the Depot file (displayed in the sheet) | String relative path to the image | `""` |
| Properties | ![New Properties](https://github.com/kkukshtel/Depot/raw/master/images/icons/newProps.png) | This is a top level JSON object that allows you to specify properties for lines and index them directly from a line instead of needing to use an array. | JSON Object | `{}` |
| Grid | ![New Grid](https://github.com/kkukshtel/Depot/raw/master/images/icons/newGrid.png) | This is a top level Array object that allows you to specify an array of values and index them directly from a line instead of needing to use a list on entries. | Array | `[true,true,true,true]` |

## Wiki
For more in-depth documentation on Depot, [you can read the wiki here](https://github.com/kkukshtel/Depot/wiki).

## Edge Cases

* When the sheet a line reference field references is deleted, the line value goes to "", the default values are cleared, and the sheet is reset to "".
* When the linw a line reference field references is deleted the lines that pointed to that line get their linked value set to "". Defaults that pointed to that get pointed to ""
* If the sheet column is modified for a line reference field, the defaults and values stay as their old values but display an error that they link to an unreachable value

## Release Notes

Read the [Changelog](./CHANGELOG.md) for older versions and minor releases

### 1.6.0
- [Launched Github Sponsor Profile](7i5jem7qfdze5trgz7x4juo7od2qn5dsp2n4gaopurskbyn3d5za)! Read more on the [Changelog](./CHANGELOG.md).
- Optimizations and Quality of Life
  - Improves performance when working with large data files
  - Adds in ability for any line to be copied (see specifics in [Changelog](./CHANGELOG.md))
  - Adds ```depot.openWithSchemaEditingOn``` to settings to allow you to disable schema editing by default
  - Filepicker no longer assumes text files
  - Fixes compilation issues on fresh clone

---

## Attribution

Image samples in the example folder are from [game-icons.net](https://game-icons.net/) under the [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license

Depot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README