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.

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

feat: deprecate all functions & types exported from magicExports #3284

Merged
merged 1 commit into from
Nov 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions .changeset/khaki-meals-prove.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
"@remix-run/architect": minor
"@remix-run/cloudflare": minor
"@remix-run/node": minor
"@remix-run/react": minor
"@remix-run/server-runtime": minor
---

Importing functions and types from the `remix` package is deprecated, and all
exported modules will be removed in the next major release. For more details,
[see the release notes for 1.4.0](https://github.com/remix-run/remix/releases/tag/v1.4.0)
where these changes were first announced.
76 changes: 56 additions & 20 deletions rollup.utils.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
const babel = require("@rollup/plugin-babel").default;
const { camelCase } = require("lodash");
const copy = require("rollup-plugin-copy");
const fs = require("fs");
const fse = require("fs-extra");
const nodeResolve = require("@rollup/plugin-node-resolve").default;
const path = require("path");
const babel = require("@rollup/plugin-babel").default;
const nodeResolve = require("@rollup/plugin-node-resolve").default;
const fse = require("fs-extra");
const { camelCase, upperFirst } = require("lodash");
const copy = require("rollup-plugin-copy");

const REPO_ROOT_DIR = __dirname;

Expand Down Expand Up @@ -184,33 +184,69 @@ function magicExportsPlugin({ packageName, version }) {
}

let banner = createBanner(packageName, version);
let moduleName = camelCase(packageName.slice("@remix-run/".length));
let esmContents = banner + "\n";
let tsContents = banner + "\n";
let cjsContents =
banner +
"\n" +
"'use strict';\n" +
"Object.defineProperty(exports, '__esModule', { value: true });\n";
"Object.defineProperty(exports, '__esModule', { value: true });\n\n";

if (magicExports.values) {
let exportList = magicExports.values.join(", ");
esmContents += `export { ${exportList} } from '${packageName}';\n`;
tsContents += `export { ${exportList} } from '${packageName}';\n`;
let deprecationFunctions =
// eslint-disable-next-line no-template-curly-in-string
"const getDeprecatedMessage = (symbol, packageName) => `All \\`remix\\` exports are considered deprecated as of v1.3.3. Please import \\`${symbol}\\` from \\`${packageName}\\` instead. You can run \\`remix migrate --migration replace-remix-imports\\` to automatically migrate your code.`;\n" +
chaance marked this conversation as resolved.
Show resolved Hide resolved
"const warn = (fn, message) => (...args) => {\n" +
" console.warn(message);\n" +
" return fn(...args);\n" +
"};\n\n";

let cjsModule = camelCase(packageName.slice("@remix-run/".length));
cjsContents += `var ${cjsModule} = require('${packageName}');\n`;
for (let symbol of magicExports.values) {
cjsContents +=
`Object.defineProperty(exports, '${symbol}', {\n` +
" enumerable: true,\n" +
` get: function () { return ${cjsModule}.${symbol}; }\n` +
"});\n";
}
esmContents +=
`import * as ${moduleName} from '${packageName}';\n` +
deprecationFunctions;
esmContents += magicExports.values
.map(
(symbol) =>
`/** @deprecated Import \`${symbol}\` from \`${packageName}\` instead. */\n` +
`const ${symbol} = warn(${moduleName}.${symbol}, getDeprecatedMessage('${symbol}', '${packageName}'));\n`
)
.join("\n");
esmContents += `\nexport { ${magicExports.values.join(", ")} };\n`;

tsContents += `import * as ${moduleName} from '${packageName}';\n\n`;
tsContents += magicExports.values
.map(
(symbol) =>
`/** @deprecated Import \`${symbol}\` from \`${packageName}\` instead. */\n` +
`export declare const ${symbol}: typeof ${moduleName}.${symbol};\n`
)
.join("\n");

cjsContents +=
`var ${moduleName} = require('${packageName}');\n` +
deprecationFunctions;
cjsContents += magicExports.values
.map(
(symbol) =>
`/** @deprecated Import \`${symbol}\` from \`${packageName}\` instead. */\n` +
`const ${symbol} = warn(${moduleName}.${symbol}, getDeprecatedMessage('${symbol}', '${packageName}'));\n` +
`exports.${symbol} = ${symbol};\n`
)
.join("\n");
}

if (magicExports.types) {
let exportList = magicExports.types.join(", ");
tsContents += `export type { ${exportList} } from '${packageName}';\n`;
let typesModuleName = `${upperFirst(moduleName)}Types`;

tsContents += `import * as ${typesModuleName} from '${packageName}';\n\n`;
tsContents += magicExports.types
.map(
(symbol) =>
`/** @deprecated Import type \`${symbol}\` from \`${packageName}\` instead. */\n` +
`export declare type ${symbol} = ${typesModuleName}.${symbol};\n`
)
.join("\n");
}

this.emitFile({
Expand Down