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

Use custom transformer when building solution references #1550

Merged
merged 6 commits into from
Nov 30, 2022
Merged

Use custom transformer when building solution references #1550

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3720126
Refactor getting custom transformer into a dedicated function
feosuna1 Nov 21, 2022
ece3ea2
Implement `getCustomTransformer` in `makeSolutionBuilderHost`
feosuna1 Nov 21, 2022
cc36048
Merge branch 'main' into feo/bugfix/custom-transformer-in-build-solution
johnnyreilly Nov 25, 2022
7c20481
Remove redundant `.toString`
feosuna1 Nov 25, 2022
ed3f70f
Runtime check that project is a string
feosuna1 Nov 26, 2022
0ca0902
Update `CHANGELOG.md` and `package.json`
feosuna1 Nov 29, 2022
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
67 changes: 38 additions & 29 deletions src/instances.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,33 +347,6 @@ export function initializeInstance(

instance.initialSetupPending = false;

// same strategy as https://github.com/s-panferov/awesome-typescript-loader/pull/531/files
let { getCustomTransformers: customerTransformers } = instance.loaderOptions;
let getCustomTransformers = Function.prototype;

if (typeof customerTransformers === 'function') {
getCustomTransformers = customerTransformers;
} else if (typeof customerTransformers === 'string') {
try {
customerTransformers = require(customerTransformers);
} catch (err) {
throw new Error(
`Failed to load customTransformers from "${
instance.loaderOptions.getCustomTransformers
}": ${err instanceof Error ? err.message : 'unknown error'}`
);
}

if (typeof customerTransformers !== 'function') {
throw new Error(
`Custom transformers in "${
instance.loaderOptions.getCustomTransformers
}" should export a function, got ${typeof customerTransformers}`
);
}
getCustomTransformers = customerTransformers;
}

if (instance.loaderOptions.transpileOnly) {
const program = (instance.program =
instance.configParseResult.projectReferences !== undefined
Expand All @@ -385,7 +358,7 @@ export function initializeInstance(
: instance.compiler.createProgram([], instance.compilerOptions));

const getProgram = () => program;
instance.transformers = getCustomTransformers(program, getProgram);
instance.transformers = getCustomTransformers(instance.loaderOptions, program, getProgram);
// Setup watch run for solution building
if (instance.solutionBuilderHost) {
addAssetHooks(loader, instance);
Expand Down Expand Up @@ -419,6 +392,7 @@ export function initializeInstance(
const getProgram = () => instance.builderProgram?.getProgram();
instance.program = getProgram();
instance.transformers = getCustomTransformers(
instance.loaderOptions,
instance.program,
getProgram
);
Expand All @@ -436,7 +410,7 @@ export function initializeInstance(
);

const getProgram = () => instance.languageService!.getProgram();
instance.transformers = getCustomTransformers(getProgram(), getProgram);
instance.transformers = getCustomTransformers(instance.loaderOptions, getProgram(), getProgram);
}

addAssetHooks(loader, instance);
Expand All @@ -448,6 +422,41 @@ export function initializeInstance(
}
}

export function getCustomTransformers(
loaderOptions: LoaderOptions,
program: typescript.Program | undefined,
getProgram: (() => typescript.Program | undefined) | undefined
) {
// same strategy as https://github.com/s-panferov/awesome-typescript-loader/pull/531/files
let { getCustomTransformers: customerTransformers } = loaderOptions;
let getCustomTransformers = Function.prototype;

if (typeof customerTransformers === 'function') {
getCustomTransformers = customerTransformers;
} else if (typeof customerTransformers === 'string') {
try {
customerTransformers = require(customerTransformers);
} catch (err) {
throw new Error(
`Failed to load customTransformers from "${
loaderOptions.getCustomTransformers
}": ${err instanceof Error ? err.message : 'unknown error'}`
);
}

if (typeof customerTransformers !== 'function') {
throw new Error(
`Custom transformers in "${
loaderOptions.getCustomTransformers
}" should export a function, got ${typeof customerTransformers}`
);
}
getCustomTransformers = customerTransformers;
}

return getCustomTransformers(program, getProgram);
}

function getScriptRegexp(instance: TSInstance) {
// If resolveJsonModules is set, we should accept json files
if (instance.configParseResult.options.resolveJsonModule) {
Expand Down
23 changes: 22 additions & 1 deletion src/servicesHost.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type * as typescript from 'typescript';
import * as webpack from 'webpack';
import { getParsedCommandLine } from './config';
import * as constants from './constants';
import { getOutputFileNames } from './instances';
import { getCustomTransformers, getOutputFileNames } from './instances';
import {
CacheableHost,
ConfigFileInfo,
Expand Down Expand Up @@ -766,6 +766,11 @@ export function makeSolutionBuilderHost(
reportSolutionBuilderStatus,
reportWatchStatus
);

// Keeps track of the various `typescript.CustomTransformers` for each program that is created.
const customTransformers = new Map<string, typescript.CustomTransformers>();

// let lastBuilderProgram: typescript.CreateProgram | undefined = undefined;
const solutionBuilderHost: SolutionBuilderWithWatchHost = {
...sysHost,
...moduleResolutionHost,
Expand All @@ -789,12 +794,28 @@ export function makeSolutionBuilderHost(
);
instance.typeReferenceResolutionCache?.update(instance.compilerOptions);
instance.moduleResolutionCache?.update(instance.compilerOptions);

if (options) {
// The `configFilePath` is the same value that is used as the `project` parameter of
// `getCustomtransformers` below.
const project = options.configFilePath?.toString();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the toString necessary?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't it always a string?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. I don't know what I was thinking. It's a string.

if (project) {
// Custom transformers need a reference to the `typescript.Program`, that reference is
// unavailable during the the `getCustomTransformers` callback below.
const transformers = getCustomTransformers(instance.loaderOptions, result.getProgram(), result.getProgram);
customTransformers.set(project, transformers);
}
}

return result;
},
resolveModuleNames,
resolveTypeReferenceDirectives,
diagnostics,
...createWatchFactory(filePathKeyMapper, compiler),
getCustomTransformers: function (project: string) {
return customTransformers.get(project);
},
// Overrides
writeFile: (name, text, writeByteOrderMark) => {
const key = filePathKeyMapper(name);
Expand Down
3 changes: 3 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { lib } from './lib';

console.log(lib.one, lib.two, lib.three);
67 changes: 67 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/expectedOutput-4.9/bundle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development").
* This devtool is neither made for production nor for readable output files.
* It uses "eval()" calls to create a separate source file in the browser devtools.
* If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/)
* or disable the default devtool with "devtool: false".
* If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/).
*/
/******/ (() => { // webpackBootstrap
/******/ "use strict";
/******/ var __webpack_modules__ = ({

/***/ "./app.ts":
/*!****************!*\
!*** ./app.ts ***!
\****************/
/***/ ((__unused_webpack_module, exports, __webpack_require__) => {

eval("\nexports.__esModule = true;\nvar lib_1 = __webpack_require__(/*! ./lib */ \"./lib/index.ts\");\n/*transform was here*/ console.log(lib_1.lib.one, lib_1.lib.two, lib_1.lib.three);\n\n\n//# sourceURL=webpack:///./app.ts?");

/***/ }),

/***/ "./lib/index.ts":
/*!**********************!*\
!*** ./lib/index.ts ***!
\**********************/
/***/ ((__unused_webpack_module, exports) => {

eval("\nexports.__esModule = true;\nexports.lib = void 0;\n/*transform was here*/ exports.lib = {\n one: 1,\n two: 2,\n three: 3\n};\n\n\n//# sourceURL=webpack:///./lib/index.ts?");

/***/ })

/******/ });
/************************************************************************/
/******/ // The module cache
/******/ var __webpack_module_cache__ = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/ // Check if module is in cache
/******/ var cachedModule = __webpack_module_cache__[moduleId];
/******/ if (cachedModule !== undefined) {
/******/ return cachedModule.exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
/******/ // no module.id needed
/******/ // no module.loaded needed
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/************************************************************************/
/******/
/******/ // startup
/******/ // Load entry module and return exports
/******/ // This entry module can't be inlined because the eval devtool is used.
/******/ var __webpack_exports__ = __webpack_require__("./app.ts");
/******/
/******/ })()
;
5 changes: 5 additions & 0 deletions ...comparison-tests/projectReferencesWithCustomTransformer/expectedOutput-4.9/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export declare const lib: {
one: number;
two: number;
three: number;
};
9 changes: 9 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/expectedOutput-4.9/lib/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ...mparison-tests/projectReferencesWithCustomTransformer/expectedOutput-4.9/lib/index.js.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ...-tests/projectReferencesWithCustomTransformer/expectedOutput-4.9/lib/tsconfig.tsbuildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"program":{"fileNames":["../../../node_modules/typescript/lib/lib.d.ts","../../../node_modules/typescript/lib/lib.es5.d.ts","../../../node_modules/typescript/lib/lib.dom.d.ts","../../../node_modules/typescript/lib/lib.webworker.importscripts.d.ts","../../../node_modules/typescript/lib/lib.scripthost.d.ts","./index.ts"],"fileInfos":["2dc8c927c9c162a773c6bb3cdc4f3286c23f10eedc67414028f9cb5951610f60",{"version":"8730f4bf322026ff5229336391a18bcaa1f94d4f82416c8b2f3954e2ccaae2ba","affectsGlobalScope":true},{"version":"3aafcb693fe5b5c3bd277bd4c3a617b53db474fe498fc5df067c5603b1eebde7","affectsGlobalScope":true},{"version":"7fac8cb5fc820bc2a59ae11ef1c5b38d3832c6d0dfaec5acdb5569137d09a481","affectsGlobalScope":true},{"version":"097a57355ded99c68e6df1b738990448e0bf170e606707df5a7c0481ff2427cd","affectsGlobalScope":true},"28ead8445f54a115ea5f778da4f4f80579fbae42ac6ccc3493626084ed335839"],"options":{"composite":true,"newLine":1,"skipLibCheck":true,"sourceMap":true},"referencedMap":[],"exportedModulesMap":[],"semanticDiagnosticsPerFile":[6,1,3,2,5,4],"emitSignatures":[[6,"82b9c263edd140802d0afbd57d557b2c41db16c5ad9a744bca8c71ad5b10f66f"]],"latestChangedDtsFile":"./index.d.ts"},"version":"4.9.3"}
8 changes: 8 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/expectedOutput-4.9/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
asset bundle.js 2.6 KiB [emitted] (name: main)
asset lib/tsconfig.tsbuildinfo 1.17 KiB [compared for emit]
asset lib/index.js.map 188 bytes [compared for emit]
asset lib/index.js 152 bytes [compared for emit]
asset lib/index.d.ts 84 bytes [compared for emit]
./app.ts 131 bytes [built] [code generated]
./lib/index.ts 119 bytes [built] [code generated]
webpack compiled successfully
67 changes: 67 additions & 0 deletions ...rison-tests/projectReferencesWithCustomTransformer/expectedOutput-transpile-4.9/bundle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development").
* This devtool is neither made for production nor for readable output files.
* It uses "eval()" calls to create a separate source file in the browser devtools.
* If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/)
* or disable the default devtool with "devtool: false".
* If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/).
*/
/******/ (() => { // webpackBootstrap
/******/ "use strict";
/******/ var __webpack_modules__ = ({

/***/ "./app.ts":
/*!****************!*\
!*** ./app.ts ***!
\****************/
/***/ ((__unused_webpack_module, exports, __webpack_require__) => {

eval("\nObject.defineProperty(exports, \"__esModule\", ({ value: true }));\nvar lib_1 = __webpack_require__(/*! ./lib */ \"./lib/index.ts\");\n/*transform was here*/ console.log(lib_1.lib.one, lib_1.lib.two, lib_1.lib.three);\n\n\n//# sourceURL=webpack:///./app.ts?");

/***/ }),

/***/ "./lib/index.ts":
/*!**********************!*\
!*** ./lib/index.ts ***!
\**********************/
/***/ ((__unused_webpack_module, exports) => {

eval("\nexports.__esModule = true;\nexports.lib = void 0;\n/*transform was here*/ exports.lib = {\n one: 1,\n two: 2,\n three: 3\n};\n\n\n//# sourceURL=webpack:///./lib/index.ts?");

/***/ })

/******/ });
/************************************************************************/
/******/ // The module cache
/******/ var __webpack_module_cache__ = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/ // Check if module is in cache
/******/ var cachedModule = __webpack_module_cache__[moduleId];
/******/ if (cachedModule !== undefined) {
/******/ return cachedModule.exports;
/******/ }
/******/ // Create a new module (and put it into the cache)
/******/ var module = __webpack_module_cache__[moduleId] = {
/******/ // no module.id needed
/******/ // no module.loaded needed
/******/ exports: {}
/******/ };
/******/
/******/ // Execute the module function
/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/************************************************************************/
/******/
/******/ // startup
/******/ // Load entry module and return exports
/******/ // This entry module can't be inlined because the eval devtool is used.
/******/ var __webpack_exports__ = __webpack_require__("./app.ts");
/******/
/******/ })()
;
5 changes: 5 additions & 0 deletions ...-tests/projectReferencesWithCustomTransformer/expectedOutput-transpile-4.9/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export declare const lib: {
one: number;
two: number;
three: number;
};
9 changes: 9 additions & 0 deletions ...on-tests/projectReferencesWithCustomTransformer/expectedOutput-transpile-4.9/lib/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ...ests/projectReferencesWithCustomTransformer/expectedOutput-transpile-4.9/lib/index.js.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ...jectReferencesWithCustomTransformer/expectedOutput-transpile-4.9/lib/tsconfig.tsbuildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"program":{"fileNames":["../../../node_modules/typescript/lib/lib.d.ts","../../../node_modules/typescript/lib/lib.es5.d.ts","../../../node_modules/typescript/lib/lib.dom.d.ts","../../../node_modules/typescript/lib/lib.webworker.importscripts.d.ts","../../../node_modules/typescript/lib/lib.scripthost.d.ts","./index.ts"],"fileInfos":["2dc8c927c9c162a773c6bb3cdc4f3286c23f10eedc67414028f9cb5951610f60",{"version":"8730f4bf322026ff5229336391a18bcaa1f94d4f82416c8b2f3954e2ccaae2ba","affectsGlobalScope":true},{"version":"3aafcb693fe5b5c3bd277bd4c3a617b53db474fe498fc5df067c5603b1eebde7","affectsGlobalScope":true},{"version":"7fac8cb5fc820bc2a59ae11ef1c5b38d3832c6d0dfaec5acdb5569137d09a481","affectsGlobalScope":true},{"version":"097a57355ded99c68e6df1b738990448e0bf170e606707df5a7c0481ff2427cd","affectsGlobalScope":true},"28ead8445f54a115ea5f778da4f4f80579fbae42ac6ccc3493626084ed335839"],"options":{"composite":true,"newLine":1,"skipLibCheck":true,"sourceMap":true},"referencedMap":[],"exportedModulesMap":[],"semanticDiagnosticsPerFile":[6,1,3,2,5,4],"emitSignatures":[[6,"82b9c263edd140802d0afbd57d557b2c41db16c5ad9a744bca8c71ad5b10f66f"]],"latestChangedDtsFile":"./index.d.ts"},"version":"4.9.3"}
8 changes: 8 additions & 0 deletions ...ison-tests/projectReferencesWithCustomTransformer/expectedOutput-transpile-4.9/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
asset bundle.js 2.64 KiB [emitted] (name: main)
asset lib/tsconfig.tsbuildinfo 1.17 KiB [compared for emit]
asset lib/index.js.map 188 bytes [compared for emit]
asset lib/index.js 152 bytes [compared for emit]
asset lib/index.d.ts 84 bytes [compared for emit]
./app.ts 167 bytes [built] [code generated]
./lib/index.ts 119 bytes [built] [code generated]
webpack compiled successfully
1 change: 1 addition & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/lib/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
!*.js.map
5 changes: 5 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export declare const lib: {
one: number;
two: number;
three: number;
};
9 changes: 9 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/lib/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/lib/index.js.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions test/comparison-tests/projectReferencesWithCustomTransformer/lib/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export const lib = {
one: 1,
two: 2,
three: 3
};
Loading