Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added 2to3.md #341

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Temporary Items

# Visual Studio cache directory
.vs/
.idea/

# Gradle cache directory
.gradle/
Expand Down Expand Up @@ -151,4 +152,4 @@ export.log
/_api/

# Test coverage data
YarnSpinner.Tests/coverage/
YarnSpinner.Tests/coverage/
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Added

- A document to serve as a roadmap for current and future changes until Yarn 3 is released.

### Changed

- Merged LanguageServer projects into the core YarnSpinner repository.
Expand Down
14 changes: 14 additions & 0 deletions Documentation/2to3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Yarn Spec 3 Proposals

This document lists features that were accepted into the Yarn 3 language specification. If a feature is listed here, it may or may not mean that it has already been implemented by the official YarnSpinner runtime.

The purpose of this document is severalfold:
- document features that were already added to YarnSpinner since 2021-09-30 when the Yarn 2 language specification was published;
- serve as a roadmap for future language development;
- allow multiple language runtime implementations (including unofficial ones) to know what features are currently being developed, or will be added in the future, thus making it easier for them to implement those features at their own pace;
- it will also make writing Yarn 3 spec much easier when we are ready to publish it.

Items that are included in this list could be:
- new language features;
- changes to existing language features;
- features that already exist in YarnSpinner but were not properly documented in [Yarn 2](Yarn-Spec.md) spec, or documented incorrectly.