Update the README #1353
Merged
Update the README #1353
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It now explains how to run specs for each major implementation, how specs are laid out, and the available options. It also provides some guidance for where to put new specs.
nschonni
reviewed
Mar 2, 2019
| # If you already have a clone of the Dart Sass repo, you can use that instead. | ||
| git clone https://github.com/sass/dart-sass | ||
| (cd dart-sass; pub get) | ||
| export DART_SASS_PATH=`pwd`/dart-sass |
There was a problem hiding this comment.
I think $pwd is more portable than backticks, but i'm not a bash expert
Edit: maybe it's $(pwd) https://github.com/sass/libsass/blob/5c2501eaa115aafafb254fa4f3522efa0ee14edb/script/ci-build-libsass#L12
There was a problem hiding this comment.
Backquotes should work for any sh-compliant shell.
There was a problem hiding this comment.
Think I was coming more from https://github.com/koalaman/shellcheck#style but it looks like that s a style rather than bug rule koalaman/shellcheck#364 (comment)
nshahan
approved these changes
Mar 4, 2019
README.md
Outdated
| :path => "..."` then the Sass unit tests will run against your | ||
| development version of sass-spec. | ||
| HRX archives can contain directories, which means that they can also a single | ||
| file can define multiple different This allows us to write many specs for the |
There was a problem hiding this comment.
Wow, this whole paragraph is a mess. Done.
| * An `error` file, in which case the spec asserts that the Sass implementation | ||
| prints the error message to standard error and exits with a non-zero status | ||
| code when it compiles the input. These specs are known as "error specs". | ||
|
|
There was a problem hiding this comment.
Maybe add a short callout with link to the "implementation-specific-expectations" section here.
nschonni
approved these changes
Mar 6, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It now explains how to run specs for each major implementation, how
specs are laid out, and the available options. It also provides some
guidance for where to put new specs.