refactor!: Clarify build-time–run-time distinction #104
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
SimonAlling
changed the title
Merged
SimonAlling
added a commit
that referenced
this pull request
Jul 31, 2024
This release renames the `build` and `lib` export paths to `build-time` and `run-time`, respectively (#104). ## Migration guide You need to adapt your imports like this: * ```diff -import … from "userscripter/build"; +import … from "userscripter/build-time"; ``` * ```diff -import … from "userscripter/lib/foo"; +import … from "userscripter/run-time/foo"; ``` This command should accomplish that in a typical Git-tracked userscript: ```bash for f in $(git ls-files "$(git rev-parse --show-toplevel)"); do sed -i 's#userscripter/build#userscripter/build-time#g' $f sed -i 's#userscripter/lib#userscripter/run-time#g' $f done ```
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.
This PR modifies the public API in an attempt to clarify the distinction between the build-time and the run-time parts of Userscripter. This should help users not accidentally import a build-time module in run-time code, which results in a completely incomprehensible wall of error messages since #96 (v3.0.0).
Consumers will have to adapt as follows:
This command should make the required changes in a typical Git-tracked userscript:
💡
git show --color-words='build-time|\w+|.'