Skip to content

Commit

Permalink
Deprecate TOML standard library format, introduce new YML based forma…
Browse files Browse the repository at this point in the history
…t. Roblox standard libraries now generate outside of directories (Kampfkarren#364)
  • Loading branch information
Kampfkarren authored Jun 5, 2022
1 parent 416be35 commit 4624569
Show file tree
Hide file tree
Showing 40 changed files with 4,531 additions and 4,290 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,9 @@ insert_final_newline = false

[*.yml]
indent_style = space
indent_size = 2

# This makes it a lot less painful to write YAMLs in docs
[*.md]
indent_style = space
indent_size = 2
2 changes: 1 addition & 1 deletion .github/workflows/generate-roblox-std.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ jobs:
uses: actions/upload-artifact@v1
with:
name: roblox
path: roblox.toml
path: roblox.yml
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,18 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## Unreleased
### Added
- Added [new YAML based standard library format](https://kampfkarren.github.io/selene/usage/std.html). The old TOML format is now deprecated and will not have any new functionality added to it, but will be preserved for the forseeable future.
- You can upgrade old TOML standard libraries by running `selene upgrade-std library.toml`, which will create a new .yml file of the same name in the new format.
- This only affects **standard library files**. `selene.toml` has not changed.
- Added `debug.resetmemorycategory` to the Roblox standard library.
- Added `debug.setmemorycategory` to the Roblox standard library.
- Added `--no-summary` option to suppress summary information.

### Changed
- Roblox standard library files are now no longer generated in the project directory, and will be updated automatically every 6 hours. You can update it manually with `selene update-roblox-std`.
- As per the deprecation of TOML standard libraries, you should delete your `roblox.toml` if you have one.
- It is possible to pin a standard library in the same way `roblox.toml` was if you are in an environment where you do not want automatic updates, such as one where you want to limit selene's internet usage. Learn more [on the Roblox Guide documentation page](https://kampfkarren.github.io/selene/roblox.html).

## [0.17.0] - 2022-04-10
### Added
- Added `start_line`, `start_column`, `end_line`, and `end_column` to JSON diagnostic output.
Expand Down
Loading

0 comments on commit 4624569

Please sign in to comment.