1.0: deprecations #2409

guybedford · 2018-08-14T17:03:19Z

This PR contains:

Breaking Changes?

yes
no

If yes, please describe the breakage.

Please Describe Your Changes

This is another PR for the 1.0 release only (DO NOT MERGE into master).

This removes old deprecations, and creates new deprecations in Rollup for some of the recent API changes as discussed.

It's currently based to the combination of both #2405 and #2406 to ensure both of those deprecation paths are included.

Removed deprecated features:

options.load
options.resolveId
options.entry
options.transform
options.pureExternalModules
options.moduleId
Output options as intput options
outputOptions.dest
outputOptions.moduleId

New deprecations added:

transformBundle
transformChunk
onwrite
ongenerate
transform dependencies
this.watcher in plugins

All of the new deprecations have deprecation warnings and tests.

TrySound · 2018-08-14T18:54:02Z

Transform is repeated twice

lukastaegert · 2018-08-15T06:58:49Z

Not 100% sure about "output options as input options".
Pro: It is clear where everything belongs and what it has effects on
Con: Using output options as input options could become a nice way of creating defaults for all outputs.

In any case, the current have-baked approach needed to be removed 👍The question is if we want to reintroduce it properly working for all options? Also maybe in a separate PR?

lukastaegert

Very nice! Added some comments. Maybe we want to add more urls to warnings as this helps people jump to the docs right away. For wrongly used plugin hooks, a link to the (upcoming?) plugin API section could be great.

lukastaegert · 2018-08-15T07:06:22Z

src/rollup/types.d.ts

@@ -89,8 +89,8 @@ export interface PluginCache {
 }

 export interface PluginContext {
-	// TODO deprecate:
-	watcher: Watcher;
+	/** @deprecated */


👍 Very good, works nicely in my IDE:

lukastaegert · 2018-08-15T07:11:35Z

src/rollup/types.d.ts

-	load?: LoadHook;
-	resolveId?: ResolveIdHook;
-	resolveExternal?: any;
+	preferConst?: boolean;


I know this one is not documented but I am not sure it should be deprecated. Maybe it should be documented instead? const seems to have a slight performance benefit in certain environments while var has the universal compatibility.

Yes agreed.

lukastaegert · 2018-08-15T07:18:25Z

src/utils/pluginDriver.ts

@@ -102,14 +126,14 @@ export function createPluginDriver(
 				if (typeof warning === 'string') warning = { message: warning };
 				if (warning.code) warning.pluginCode = warning.code;
 				warning.code = 'PLUGIN_WARNING';
-				warning.plugin = plugin.name || '(anonymous plugin)';
+				warning.plugin = plugin.name || `Plugin at position ${pidx + 1}`;


lukastaegert · 2018-08-15T07:21:02Z

src/utils/pluginDriver.ts

+		message: `The ${name} hook used by plugin ${plugin.name ||
+			`at position ${pidx + 1}`} is deprecated. The ${newName} hook should be used instead.`
+	};
+}


Might be nice to add a .url with a link to the upcoming plugin API section on the website once it is available.

Similarly, we could add a link to the big list of options when an unknown option is passed: https://rollupjs.org/guide/en#big-list-of-options

Yup I've wanted to add links recently, but couldn't as we don't have documentation on most of the new errors.

Will see if I can work on refactoring some of the logic from batchWarnings to prepare for this sort of thing though.

guybedford · 2018-08-15T10:26:50Z

The question is if we want to reintroduce it properly working for all options? Also maybe in a separate PR?

It's good to consider this but note that we have been providing all users with deprecation warnings if not doing this, so that the moment those deprecation paths were created that decision was made to deprecate here as far as I'm concerned. That said, we can certainly reconsider this. Personally I think it's good to be explicit and stick with the model we've set.

lukastaegert

Looks good to me!

# Conflicts: # src/rollup/index.ts # src/rollup/types.d.ts # src/utils/mergeOptions.ts # src/utils/pluginDriver.ts # src/watch/index.ts # test/hooks/index.js # test/misc/optionList.js

* emit watch changes as a plugin hook * fix path require * deprecate asset dependencies * renderChunk hook to replace transformChunk * renderChunk to follow all transformBundle tests, type definition * 1.0 deprecations * legacy deprecations * new deprecation tests * type fix, output options deprecations * type fixes * deprecation deprecations

* Add English docs to repo * emit watch changes as a plugin hook * deprecate asset dependencies * 1.0 API changest status * watcher interface simplifications * Add new option errors * Make sure only valid JS is piped to stdout * Refine error handling to include dyamic imports * Fix output sorting * 1.0: deprecations (#2409) * emit watch changes as a plugin hook * fix path require * deprecate asset dependencies * renderChunk hook to replace transformChunk * renderChunk to follow all transformBundle tests, type definition * 1.0 deprecations * legacy deprecations * new deprecation tests * type fix, output options deprecations * type fixes * deprecation deprecations * Only print file ids in plugin warnings and errors if present * Upgrading to Acorn 6 (#2486) * WIP Upgrading to Acorn 6 * Fix rollup-plugin-commonjs issue, remaining type issues and tests * Sort options list in docs (no content changes) * Make sure --input option supports named entries as well as default CLI options * Make preferConst an output option * Small type fixes * Externalise acorn * Allow the `d` alias for the `--dir` option * Further refine types and make sure returning false from resolveId marks imports as external * Thoroughly review and update docs

Conduitry · 2018-12-29T16:52:58Z

The changelog mentions that returning dependencies from the transform hook has been deprecated in favor of the watchChange hook, which doesn't seem accurate.

The actual deprecation message says to use this.addWatchFile(), which sounds like it would be better - but this function is not currently documented in the guide.

lukastaegert · 2019-01-03T08:52:01Z

Thanks! I think things got a little messed up with the watchChange hook and the addWatchFile context function. Looking through these things now.

@egoist

@egoist @lmihaidaniel Fixes #147 The `onwrite` rollup hook has been deprecated in favor of `generateBundle` in `rollup@1.x.x`. rollup/rollup#2409

@egoist

@egoist @lmihaidaniel Fixes egoist#147 The `onwrite` rollup hook has been deprecated in favor of `generateBundle` in `rollup@1.x.x`. rollup/rollup#2409

guybedford changed the base branch from watch-events-and-render-chunk-fix to render-chunk-fix August 14, 2018 17:28

guybedford force-pushed the 1.0-deprecations branch from a177f2b to b0d0880 Compare August 14, 2018 17:28

lukastaegert reviewed Aug 15, 2018

View reviewed changes

lukastaegert approved these changes Aug 20, 2018

View reviewed changes

lukastaegert force-pushed the render-chunk-fix branch from d7184f2 to 87b4e49 Compare August 21, 2018 04:45

lukastaegert changed the base branch from render-chunk-fix to master August 25, 2018 13:45

lukastaegert changed the base branch from master to 1.0 September 7, 2018 10:43

guybedford added 11 commits September 7, 2018 12:47

emit watch changes as a plugin hook

f7d8bdc

fix path require

71dd12a

deprecate asset dependencies

9835152

renderChunk hook to replace transformChunk

dae86f8

renderChunk to follow all transformBundle tests, type definition

1fddee1

1.0 deprecations

0153486

legacy deprecations

afff91c

new deprecation tests

384952b

type fix, output options deprecations

0256745

type fixes

56d8044

deprecation deprecations

014a10d

lukastaegert force-pushed the 1.0 branch from de60640 to 612f7fb Compare September 7, 2018 11:48

lukastaegert force-pushed the 1.0-deprecations branch from 0632cde to 014a10d Compare September 7, 2018 11:48

Merge branch '1.0' into 1.0-deprecations

105a355

# Conflicts: # src/rollup/index.ts # src/rollup/types.d.ts # src/utils/mergeOptions.ts # src/utils/pluginDriver.ts # src/watch/index.ts # test/hooks/index.js # test/misc/optionList.js

lukastaegert merged commit 87dfc29 into 1.0 Sep 7, 2018

lukastaegert deleted the 1.0-deprecations branch September 7, 2018 12:09

guybedford mentioned this pull request Sep 7, 2018

1.0 changes #2293

Merged

This was referenced Jan 9, 2019

Compatibility with rollup@1.x.x egoist/rollup-plugin-postcss#147

Closed

Use generateBundle instead of onwrite egoist/rollup-plugin-postcss#148

Merged

kaheglar mentioned this pull request Jan 28, 2019

transformChunk hook used by plugin loadz0r is deprecated surma/rollup-plugin-loadz0r#39

Closed

rj-hwang mentioned this pull request Mar 12, 2019

The generateBundle hook should be used instead of the onwrite hook. RJHwang/rollup-plugin-css-porter#3

Closed

doktordata mentioned this pull request Apr 24, 2019

Compatibility with rollup@1.x.x haifeng2013/rollup-plugin-bundle-html#3

Closed

StreetStrider mentioned this pull request May 6, 2019

dependencies warning aMarCruz/rollup-plugin-pug#16

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1.0: deprecations #2409

1.0: deprecations #2409

guybedford commented Aug 14, 2018 •

edited

TrySound commented Aug 14, 2018

lukastaegert commented Aug 15, 2018

lukastaegert left a comment

lukastaegert Aug 15, 2018

lukastaegert Aug 15, 2018

guybedford Aug 15, 2018

lukastaegert Aug 15, 2018

lukastaegert Aug 15, 2018

lukastaegert Aug 15, 2018

guybedford Aug 15, 2018

lukastaegert Aug 20, 2018

guybedford commented Aug 15, 2018

lukastaegert left a comment

Conduitry commented Dec 29, 2018

lukastaegert commented Jan 3, 2019

1.0: deprecations #2409

1.0: deprecations #2409

Conversation

guybedford commented Aug 14, 2018 • edited

Breaking Changes?

Please Describe Your Changes

TrySound commented Aug 14, 2018

lukastaegert commented Aug 15, 2018

lukastaegert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guybedford commented Aug 15, 2018

lukastaegert left a comment

Choose a reason for hiding this comment

Conduitry commented Dec 29, 2018

lukastaegert commented Jan 3, 2019

guybedford commented Aug 14, 2018 •

edited