Skip to content
Open
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
96 changes: 96 additions & 0 deletions packages/devextreme/build/babel-plugin-add-import-extensions.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
'use strict';

const fs = require('fs');
const path = require('path');

// Makes relative import/export specifiers in the ESM build fully specified, as Node's ESM loader
// and strict-ESM bundler modes require:
// './button' -> './button.js'
// './ui.errors' -> './ui.errors.js' (a dot in a file name is not an extension)
// './grids' -> './grids/index.js'
// The decision is made against the source tree, the way TypeScript resolves the import.

const SOURCE_EXTENSIONS = ['.ts', '.tsx', '.js', '.jsx'];

function isFile(filePath) {
try {
return fs.statSync(filePath).isFile();
} catch {
return false;
}
}

// Files compiled to an intermediate folder (tsc output) are resolved against their sources
function toSourcePath(filePath, sourceRoots) {
const root = sourceRoots.find(({ from }) => filePath.startsWith(from + path.sep));

return root ? path.join(root.to, path.relative(root.from, filePath)) : filePath;
}

function fullySpecify(specifier, importerPath) {
const target = path.resolve(path.dirname(importerPath), specifier);

if (isFile(target)) {
return specifier;
}

if (SOURCE_EXTENSIONS.some((ext) => isFile(`${target}${ext}`))) {
return `${specifier}.js`;
}

if (SOURCE_EXTENSIONS.some((ext) => isFile(path.join(target, `index${ext}`)))) {
return `${specifier}/index.js`;
}

return null;
}

module.exports = function addImportExtensions({ types: t }, { sourceRoots = [] } = {}) {
function rewriteSource(sourcePath, state) {
if (!sourcePath.node || !t.isStringLiteral(sourcePath.node)) {
return;
}

const specifier = sourcePath.node.value;

if (!specifier.startsWith('./') && !specifier.startsWith('../')) {
return;
}

const { filename } = state.file.opts;

if (!filename) {
throw sourcePath.buildCodeFrameError('add-import-extensions needs the file name to resolve relative imports');
}

const importerPath = toSourcePath(filename, sourceRoots);
const resolved = fullySpecify(specifier, importerPath);

if (resolved === null) {
throw sourcePath.buildCodeFrameError(`Cannot resolve '${specifier}' from ${importerPath}`);
}

if (resolved !== specifier) {
const quote = sourcePath.node.extra?.raw?.[0] ?? '\'';
const literal = t.stringLiteral(resolved);
literal.extra = { rawValue: resolved, raw: `${quote}${resolved}${quote}` };

sourcePath.replaceWith(literal);
}
}

return {
name: 'add-import-extensions',
visitor: {
ImportDeclaration: (p, state) => rewriteSource(p.get('source'), state),
ExportNamedDeclaration: (p, state) => rewriteSource(p.get('source'), state),
ExportAllDeclaration: (p, state) => rewriteSource(p.get('source'), state),
ImportExpression: (p, state) => rewriteSource(p.get('source'), state),
CallExpression: (p, state) => {
if (p.get('callee').isImport()) {
rewriteSource(p.get('arguments.0'), state);
}
},
},
};
};
119 changes: 119 additions & 0 deletions packages/devextreme/build/babel-plugin-add-import-extensions.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
import { transformSync } from '@babel/core';
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';

const addImportExtensions = require('./babel-plugin-add-import-extensions');

describe('babel-plugin-add-import-extensions', () => {
let root: string;

const write = (relativePath: string, content = ''): void => {
const filePath = path.join(root, relativePath);
fs.mkdirSync(path.dirname(filePath), { recursive: true });
fs.writeFileSync(filePath, content);
};

const transform = (code: string, relativeFile: string, sourceRoots: object[] = []): string => {
const result = transformSync(code, {
filename: path.join(root, relativeFile),
babelrc: false,
configFile: false,
plugins: [[addImportExtensions, { sourceRoots }]],
});

return result?.code ?? '';
};

beforeEach(() => {
root = fs.mkdtempSync(path.join(os.tmpdir(), 'add-import-extensions-'));

write('js/ui/button.js');
write('js/ui/widget/ui.errors.js');
write('js/__internal/ui/button/index.ts');
write('js/__internal/ui/button/wrapper.tsx');
write('js/__internal/core/m_config.ts');
write('js/viz/funnel.ts');
write('js/viz/funnel/index.ts');
write('js/localization/messages/en.json');
});

afterEach(() => {
fs.rmSync(root, { recursive: true, force: true });
});

it('appends .js to file imports, including names that contain a dot', () => {
const code = transform(
"import Button from './button';\nimport errors from './widget/ui.errors';",
'js/ui/component.js',
);

expect(code).toContain("from './button.js'");
expect(code).toContain("from './widget/ui.errors.js'");
});

it('resolves .ts and .tsx sources to .js output', () => {
const code = transform("import config from './m_config';\nimport Wrapper from '../ui/button/wrapper';", 'js/__internal/core/consumer.ts');

expect(code).toContain("from './m_config.js'");
expect(code).toContain("from '../ui/button/wrapper.js'");
});

it('points directory imports at index.js', () => {
const code = transform("import Button from '../__internal/ui/button';", 'js/ui/button.js');

expect(code).toContain("from '../__internal/ui/button/index.js'");
});

it('prefers a file over a directory with the same name, like TypeScript', () => {
const code = transform("import funnel from './funnel';", 'js/viz/chart.ts');

expect(code).toContain("from './funnel.js'");
});

it('rewrites re-exports and dynamic imports', () => {
const code = transform(
"export * from './button';\nexport { default } from './button';\nconst lazy = () => import('./button');",
'js/ui/index.js',
);

expect(code).toContain("export * from './button.js'");
expect(code).toContain("export { default } from './button.js'");
expect(code).toContain("import('./button.js')");
});

it('keeps the original quote style', () => {
const code = transform('import Button from "./button";', 'js/ui/component.js');

expect(code).toContain('from "./button.js"');
});

it('leaves package imports and existing extensions untouched', () => {
const code = transform(
"import $ from 'jquery';\nimport helper from '@babel/runtime/helpers/extends';\nimport en from '../localization/messages/en.json';",
'js/ui/button.js',
);

expect(code).toContain("from 'jquery'");
expect(code).toContain("from '@babel/runtime/helpers/extends'");
expect(code).toContain("from '../localization/messages/en.json'");
});

it('resolves files compiled to another folder against their sources', () => {
write('artifacts/dist_ts/__internal/ui/button/wrapper.js');

const code = transform(
"import errors from '../../../ui/widget/ui.errors';\nimport config from '../../core/m_config';",
'artifacts/dist_ts/__internal/ui/button/wrapper.js',
[{ from: path.join(root, 'artifacts/dist_ts'), to: path.join(root, 'js') }],
);

expect(code).toContain("from '../../../ui/widget/ui.errors.js'");
expect(code).toContain("from '../../core/m_config.js'");
});

it('fails the build on an import that does not resolve', () => {
expect(() => transform("import missing from './missing';", 'js/ui/button.js'))
.toThrow(/Cannot resolve '\.\/missing'/);
});
});
41 changes: 31 additions & 10 deletions packages/devextreme/build/transpile-config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
'use strict';

const path = require('path');
const addImportExtensions = require('./babel-plugin-add-import-extensions');

const common = {
plugins: [
['babel-plugin-inferno', { 'imports': true }],
Expand All @@ -14,6 +17,18 @@ const targets = {
samsung: 13,
};

const esmQunit = Object.assign({}, common, {
// eslint-disable-next-line spellcheck/spell-checker
presets: [['@babel/preset-env', { targets, modules: false }]],
plugins: common.plugins.concat([
// Plain `@babel/runtime/helpers/*` paths resolve to the ESM or CJS helper through
// @babel/runtime's exports map, so tools that run esm/ as CommonJS (Jest) can load them
['@babel/plugin-transform-runtime', {
version: '7.5.0' // https://github.com/babel/babel/issues/10261#issuecomment-514687857
}],
])
});

module.exports = {
cjs: Object.assign({}, common, {
presets: [['@babel/preset-env', { targets }]],
Expand All @@ -30,14 +45,20 @@ module.exports = {
])
}),

esm: Object.assign({}, common, {
// eslint-disable-next-line spellcheck/spell-checker
presets: [['@babel/preset-env', { targets, modules: false }]],
plugins: common.plugins.concat(
[['@babel/plugin-transform-runtime', {
useESModules: true,
version: '7.5.0' // https://github.com/babel/babel/issues/10261#issuecomment-514687857
}]]
)
})
esm: Object.assign({}, esmQunit, {
plugins: esmQunit.plugins.concat([
[addImportExtensions, {
// __internal is compiled by tsc into artifacts/dist_ts first
sourceRoots: [{
from: path.resolve(__dirname, '../artifacts/dist_ts'),
to: path.resolve(__dirname, '../js'),
}],
}],
])
}),

// The QUnit runner's import map gives tests extensionless URLs (testing/runner/lib/importMap.ts).
// A test and the library have to import a module by the same URL to share one instance,
// so QUnit artifacts keep extensionless imports.
esmQunit,
};
1 change: 0 additions & 1 deletion packages/devextreme/js/localization/ldml/number.js
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
export * from '../../__internal/core/localization/ldml/number';
export { FormatterConfig } from '../../__internal/core/localization/number';
2 changes: 1 addition & 1 deletion packages/devextreme/js/viz/core/renderers/animation.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import * as Animation from '__internal/viz/core/renderers/animation';
import * as Animation from '../../../__internal/viz/core/renderers/animation';

export default Animation;
39 changes: 39 additions & 0 deletions packages/devextreme/project.json
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@
},
"configurations": {
"qunit": {
"configKey": "esmQunit",
"removeDebug": false
}
},
Expand Down Expand Up @@ -383,6 +384,7 @@
},
"configurations": {
"qunit": {
"configKey": "esmQunit",
"removeDebug": false
}
},
Expand Down Expand Up @@ -413,6 +415,7 @@
},
"configurations": {
"qunit": {
"configKey": "esmQunit",
"removeDebug": false
}
}
Expand All @@ -433,6 +436,7 @@
},
"configurations": {
"qunit": {
"configKey": "esmQunit",
"removeDebug": false
}
}
Expand Down Expand Up @@ -1288,6 +1292,35 @@
"{projectRoot}/artifacts/npm/devextreme-internal/package.json"
]
},
"build:npm:exports-map": {
"executor": "devextreme-nx-infra-plugin:generate-exports-map",
"cache": false,
"options": {
"packageDir": "./artifacts/npm/devextreme",
"ignore": ["__internal", "bin", "bundles", "cjs", "dist", "esm", "license", "scss"],
"extraExports": {
"./bundles/*": { "types": "./bundles/*.d.ts", "default": "./bundles/*.js" },
"./localization/messages/*.json": "./localization/messages/*.json",
"./dist/*": "./dist/*",
"./scss/*": "./scss/*",
"./esm/*.json": "./esm/*.json",
"./esm/*.js": "./esm/*.js",
"./esm/*": "./esm/*.js",
"./cjs/*.json": "./cjs/*.json",
"./cjs/*.js": "./cjs/*.js",
"./cjs/*": "./cjs/*.js",
"./*.d": { "types": "./*.d.ts" }
}
},
"configurations": {
"internal": {
"packageDir": "./artifacts/npm/devextreme-internal"
}
},
"metadata": {
"description": "Adds the \"exports\" map to the assembled package.json: one entry per module stub, type-only modules from declarations, plus extraExports."
}
},
"compress:npm-sources": {
"executor": "devextreme-nx-infra-plugin:compress",
"options": {
Expand Down Expand Up @@ -1546,6 +1579,7 @@
"pnpm nx run devextreme:build:npm:dist:package-json",
"pnpm nx run devextreme:build:npm:assemble",
"pnpm nx run devextreme:build:npm:root-package-json",
"pnpm nx run devextreme:build:npm:exports-map",
"pnpm nx run devextreme:compress:npm-sources",
"pnpm nx run devextreme:verify:public-modules",
"pnpm nx run devextreme:build:npm:scss"
Expand Down Expand Up @@ -1587,6 +1621,7 @@
"pnpm nx run devextreme:build:npm:dist:package-json",
"pnpm nx run devextreme:build:npm:assemble",
"pnpm nx run devextreme:build:npm:root-package-json",
"pnpm nx run devextreme:build:npm:exports-map",
"pnpm nx run devextreme:compress:npm-sources -c production",
"pnpm nx run devextreme:verify:public-modules",
"pnpm nx run devextreme:build:npm:scss"
Expand All @@ -1599,6 +1634,7 @@
"pnpm nx run devextreme:build:npm:dist:package-json -c internal",
"pnpm nx run devextreme:build:npm:assemble -c internal",
"pnpm nx run devextreme:build:npm:root-package-json -c internal",
"pnpm nx run devextreme:build:npm:exports-map -c internal",
"pnpm nx run devextreme:compress:npm-sources -c internal",
"pnpm nx run devextreme:verify:public-modules",
"pnpm nx run devextreme:build:npm:scss -c internal"
Expand All @@ -1611,6 +1647,7 @@
"pnpm nx run devextreme:build:npm:dist:package-json -c internal",
"pnpm nx run devextreme:build:npm:assemble -c internal",
"pnpm nx run devextreme:build:npm:root-package-json -c internal",
"pnpm nx run devextreme:build:npm:exports-map -c internal",
"pnpm nx run devextreme:compress:npm-sources -c production-internal",
"pnpm nx run devextreme:verify:public-modules",
"pnpm nx run devextreme:build:npm:scss -c internal"
Expand All @@ -1623,6 +1660,7 @@
"pnpm nx run devextreme:build:npm:dist:package-json",
"pnpm nx run devextreme:build:npm:assemble -c test-internal",
"pnpm nx run devextreme:build:npm:root-package-json",
"pnpm nx run devextreme:build:npm:exports-map",
"pnpm nx run devextreme:compress:npm-sources",
"pnpm nx run devextreme:verify:public-modules",
"pnpm nx run devextreme:build:npm:scss"
Expand All @@ -1635,6 +1673,7 @@
"pnpm nx run devextreme:build:npm:dist:package-json",
"pnpm nx run devextreme:build:npm:assemble -c test-internal",
"pnpm nx run devextreme:build:npm:root-package-json",
"pnpm nx run devextreme:build:npm:exports-map",
"pnpm nx run devextreme:compress:npm-sources -c production",
"pnpm nx run devextreme:verify:public-modules",
"pnpm nx run devextreme:build:npm:scss"
Expand Down
Loading
Loading