Skip to content

Commit

Permalink
Add sourcemap.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hoontee committed Dec 1, 2023
1 parent 8603968 commit c973ff0
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/lync/project-format/files/meta-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Meta Files attach additional data to a file or directory.
They are used in scenarios where it would be desirable to change the properties of something which otherwise cannot be changed from the filesystem.

## Syntax

### File Name
::: info File Name
- `*.Meta.JSON` - For files.
- `Init.Meta.JSON` - For directories.

### Keys
:::
::: info Keys
- string `className` - Changes the ClassName. Usable only with directories.
- table `properties` - A map of properties to set on the Instance.
:::

## Examples
The most common use case is changing the ClassName of a Folder.
Expand Down
32 changes: 29 additions & 3 deletions docs/lync/project-format/sourcemap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,32 @@
::: danger UNFINISHED
This documentation is unfinished.
:::
# Sourcemap
The Sourcemap is an automatically generated file that serves as a layout of the project for other tools to utilize.

This file cannot be deleted and should be ignored unless you're a tool developer.

## Syntax
::: info Keys
- string `name` - Instance.Name.
- string `className` - Instance.ClassName.
- {string} `filePaths` - The list of files that have an effect on the Instance.
- {Instance} `children` - The list of children.
:::

## Example

```json
{
"name": "Example Place",
"className": "DataModel",
"filePaths": [
"default.project.json"
],
"children": [
{
"name": "Workspace",
"className": "Workspace",
"children": []
}
],
...
}
```

0 comments on commit c973ff0

Please sign in to comment.