Deprecate Compiler::compile in favor of Compiler::compileString #334
Conversation
This file contains hidden or 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
This restores backward compatibility on the compile() method by keeping a string return value. The modern API using a CompilationResult object is now available through compileString instead. This modern API does not write the sourcemap to the filesystem when configuring an external sourcemap. This is expected to be done by the caller (similar to the fact the CSS is not written to disk). However, the sourcemap comment is present in the CSS.
stof
commented
Mar 16, 2021
| * | ||
| * @throws SassException when the source fails to compile | ||
| */ | ||
| public function compileString($source, $path = null) |
Member
Author
There was a problem hiding this comment.
I named the parameter source rather than code, as I think that's a better name for what it is. However, note that I'm not considering parameter names as covered by backward compatibility yet. I haven't reviewed the full codebase regarding names. So using PHP 8 named parameters is still something downstream projects will do at their own risk.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This restores backward compatibility on the
compile()method by keeping a string return value.The modern API using a CompilationResult object is now available through
compileStringinstead. This modern API does not write the sourcemap to the filesystem when configuring an external sourcemap. This is expected to be done by the caller (similar to the fact the CSS is not written to disk). However, the sourcemap comment is present in the CSS.Closes #320