Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add legacy rollup builds #5570

Merged
merged 3 commits into from
Jun 13, 2023
Merged

feat: Add legacy rollup builds #5570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c894e43
Add legacy rollup output
lachlancollins Jun 13, 2023
42a468f
Use legacy build for main and module fields
lachlancollins Jun 13, 2023
316118c
Remove incorrect docs deprecation
lachlancollins Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/react/guides/migrating-to-v5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,6 @@ Custom loggers were already deprecated in 4 and have been removed in this versio

We have updated our browserslist to produce a more modern, performant and smaller bundle. You can read about the requirements [here](../installation#requirements).

### Supported Bundlers

We have removed the legacy `.esm.js` output, which was used by bundlers which didn't recognise the modern `.mjs` extension such as Webpack v4. If you are still using Webpack v4, you can continue to use TanStack Query v4, or upgrade to Webpack v5 or another bundler.

### Private class fields and methods

TanStack Query has always had private fields and methods on classes, but they weren't really private - they were just private in `TypeScript`. We now use [ECMAScript Private class features](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_class_fields), which means those fields are now truly private and can't be accessed from the outside at runtime.
Expand Down
4 changes: 2 additions & 2 deletions packages/query-async-storage-persister/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/query-broadcast-client-experimental/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/query-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/query-persist-client-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/query-sync-storage-persister/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/react-query-devtools/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/react-query-devtools/rollup.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import { defineConfig } from 'rollup'
import { buildConfigs } from '../../scripts/getRollupConfig.js'

export default defineConfig([
buildConfigs({
...buildConfigs({
name: 'react-query-devtools',
outputFile: 'index',
entryFile: './src/index.ts',
}),
buildConfigs({
...buildConfigs({
name: 'react-query-devtools-prod',
outputFile: 'index.prod',
entryFile: './src/index.ts',
Expand Down
4 changes: 2 additions & 2 deletions packages/react-query-persist-client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/react-query/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/vue-query/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
},
"type": "module",
"types": "build/lib/index.d.ts",
"main": "build/lib/index.cjs",
"module": "build/lib/index.js",
"main": "build/lib/index.legacy.cjs",
"module": "build/lib/index.legacy.js",
"exports": {
".": {
"types": "./build/lib/index.d.ts",
Expand Down
111 changes: 103 additions & 8 deletions scripts/getRollupConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,25 @@ const forceEnvPlugin = (type) =>
preventAssignment: true,
})

const babelPlugin = () =>
/** @param {'legacy' | 'modern'} type */
const babelPlugin = (type) =>
babel({
configFile: resolve(rootDir, 'babel.config.cjs'),
browserslistConfigFile: true,
browserslistConfigFile: type === 'modern' ? true : false,
targets:
type === 'modern'
? ''
: {
chrome: '73',
firefox: '78',
edge: '79',
safari: '12',
ios: '12',
opera: '53',
},
babelHelpers: 'bundled',
exclude: /node_modules/,
extensions: ['.ts', '.tsx', '.native.ts'],
extensions: ['.ts', '.tsx'],
})

/**
Expand All @@ -35,10 +47,23 @@ const babelPlugin = () =>
* @param {boolean} [opts.bundleDeps] - Flag indicating whether to make all deps external.
* @param {boolean} [opts.forceDevEnv] - Flag indicating whether to force development environment.
* @param {boolean} [opts.forceBundle] - Flag indicating whether to force bundling.
* @returns {import('rollup').RollupOptions}
* @returns {import('rollup').RollupOptions[]}
*/
export function buildConfigs(opts) {
const input = [opts.entryFile]
return [modernConfig(opts), legacyConfig(opts)]
}

/**
* @param {Object} opts - Options for building configurations.
* @param {string} opts.name - The name.
* @param {string} opts.outputFile - The output file.
* @param {string} opts.entryFile - The entry file.
* @param {boolean} [opts.bundleDeps] - Flag indicating whether to make all deps external.
* @param {boolean} [opts.forceDevEnv] - Flag indicating whether to force development environment.
* @param {boolean} [opts.forceBundle] - Flag indicating whether to force bundling.
* @returns {import('rollup').RollupOptions}
*/
function modernConfig(opts) {
const forceDevEnv = opts.forceDevEnv || false
const forceBundle = opts.forceBundle || false
const bundleDeps = opts.bundleDeps || false
Expand Down Expand Up @@ -78,12 +103,12 @@ export function buildConfigs(opts) {
]

return {
input,
input: [opts.entryFile],
output: forceBundle ? bundleOutput : normalOutput,
plugins: [
commonJS(),
babelPlugin(),
nodeResolve({ extensions: ['.ts', '.tsx', '.native.ts'] }),
babelPlugin('modern'),
nodeResolve({ extensions: ['.ts', '.tsx'] }),
forceDevEnv ? forceEnvPlugin('development') : undefined,
bundleDeps
? undefined
Expand All @@ -102,3 +127,73 @@ export function buildConfigs(opts) {
],
}
}

/**
* @param {Object} opts - Options for building configurations.
* @param {string} opts.name - The name.
* @param {string} opts.outputFile - The output file.
* @param {string} opts.entryFile - The entry file.
* @param {boolean} [opts.bundleDeps] - Flag indicating whether to make all deps external.
* @param {boolean} [opts.forceDevEnv] - Flag indicating whether to force development environment.
* @param {boolean} [opts.forceBundle] - Flag indicating whether to force bundling.
* @returns {import('rollup').RollupOptions}
*/
function legacyConfig(opts) {
const forceDevEnv = opts.forceDevEnv || false
const forceBundle = opts.forceBundle || false
const bundleDeps = opts.bundleDeps || false

/** @type {import('rollup').OutputOptions[]} */
const bundleOutput = [
{
format: 'esm',
file: `./build/lib/${opts.outputFile}.legacy.js`,
sourcemap: true,
},
{
format: 'cjs',
file: `./build/lib/${opts.outputFile}.legacy.cjs`,
sourcemap: true,
exports: 'named',
},
]

/** @type {import('rollup').OutputOptions[]} */
const normalOutput = [
{
format: 'esm',
dir: `./build/lib`,
sourcemap: true,
preserveModules: true,
entryFileNames: '[name].legacy.js',
},
{
format: 'cjs',
dir: `./build/lib`,
sourcemap: true,
exports: 'named',
preserveModules: true,
entryFileNames: '[name].legacy.cjs',
},
]

return {
input: [opts.entryFile],
output: forceBundle ? bundleOutput : normalOutput,
plugins: [
commonJS(),
babelPlugin('legacy'),
nodeResolve({ extensions: ['.ts', '.tsx'] }),
forceDevEnv ? forceEnvPlugin('development') : undefined,
bundleDeps
? undefined
: externals({
packagePath: './package.json',
deps: true,
devDeps: true,
peerDeps: true,
}),
preserveDirectives(),
],
}
}