fix: Allows naming of outputs individually #896
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
🦋 Changeset detectedLatest commit: 8aaf60f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
rschristian
force-pushed
the
fix/output-naming
branch
from
298e8a4
to
13cc452
Compare
rschristian
force-pushed
the
fix/output-naming
branch
from
13cc452
to
c9d5f24
Compare
rschristian
commented
Mar 28, 2022
Comment on lines
-144
to
+138
| ? blue(`Build "${options.pkg.name}" to ${targetDir}:`) | ||
| ? blue(`Built "${options.pkg.name}":`) |
There was a problem hiding this comment.
targetDir is a bit unknowable now (each output format could theoretically have a different output directory, if the user so desired), so it's been removed.
| @@ -279,42 +270,45 @@ function walk(exports, includeDefault) { | |||
| function getMain({ options, entry, format }) { | |||
| const { pkg } = options; | |||
| const pkgMain = options['pkg-main']; | |||
| const pkgTypeModule = pkg.type === 'module'; | |||
| let multipleEntries = options.multipleEntries; | |||
There was a problem hiding this comment.
multipleEntries needs to act as an escape hatch to our name resolution logic to ensure no collisions.
This can be seen with Microbundle itself; when we create a cli.js and microbundle.js, we need to ensure the assigned name of cli does not get replaced by the "main" field ("microbundle").
rschristian
commented
Mar 28, 2022
| mainNoExtension, | ||
| mainsByFormat.es = resolve( | ||
| (!multipleEntries && | ||
| (pkg.module && !pkg.module.match(/src\//) |
There was a problem hiding this comment.
Random q: What's this match against src/ about? Goes back to repo init afaict so couldn't find any context there.
rschristian
force-pushed
the
fix/output-naming
branch
from
c9d5f24
to
7402b06
Compare
rschristian
force-pushed
the
fix/output-naming
branch
from
7402b06
to
9730b95
Compare
|
Size Change: 0 B Total Size: 65.3 kB ℹ️ View Unchanged
|
rschristian
force-pushed
the
fix/output-naming
branch
from
9730b95
to
8aaf60f
Compare
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.
Summary
Closes #884 and #825
Each output can be individually given output paths now, there's no sharing of names/paths. This removes an over reliance upon
"main"to provide output paths for every other format.There's no longer a guarantee of all output being in the same directory: based on the file paths, different formats can be output in different locations.
The
--outputflag is still functional, but only covers formats that are not provided an explicit path in thepackage.json. For example, if we're missing"module"but still outputting ESM, it will be output at<--output>/<pkg-name>.esm.{js/mjs}For output formats that are not given an explicit path/name, they default to the package name. I think this or
indexare equally valid, but this a) matches our examples in the ReadMe (if we have an example module named "foo", the output tends to befoo.js,foo.esm.js, etc.) and b) real world usage. People tend to prefer naming output than keeping it asindexfrom what I've seen, but YMMV.Edit: Both #825 and #938 bring up the filename specified with
"types"not being acknowledged and I don't think it's something we can support. TSC itself outputs filenames as-is, there's no easy way (besides a post-build script) to have it instead output an arbitrary name for the entry file.rpt2forgoes the Rollup process anyhow under certain circumstances and uses TS to write directly to the filesystem, so we don't necessarily have a good way of altering that post-build ourselves I don't think.