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

fix: conditional type exports (T1177805) #3661

Merged
merged 5 commits into from
Jul 28, 2023
Merged

fix: conditional type exports (T1177805) #3661

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16c7e0b
conditional type exports
VasilyStrelyaev Jul 27, 2023
2f09ad9
Fix the filename regexp
VasilyStrelyaev Jul 28, 2023
f308fa1
typings copying now works for dx-react-grid-export
VasilyStrelyaev Jul 28, 2023
682d2ba
address Timpohey's remarks
VasilyStrelyaev Jul 28, 2023
51debb3
refactor utils -> getPackageInfo
VasilyStrelyaev Jul 28, 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
10 changes: 8 additions & 2 deletions packages/dx-chart-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-chart-core.umd.cjs",
"import": "./dist/dx-chart-core.es.js",
"require": {
"types": "./dist/dx-chart-core.d.cts",
"default": "./dist/dx-chart-core.umd.cjs"
},
"import": {
"types": "./dist/dx-chart-core.d.ts",
"default": "./dist/dx-chart-core.es.js"
},
"default": "./dist/dx-chart-core.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-core.umd.cjs",
"module": "./dist/dx-core.es.js",
"require": {
"types": "./dist/dx-core.d.cts",
"default": "./dist/dx-core.umd.cjs"
},
"import": {
"types": "./dist/dx-core.d.ts",
"default": "./dist/dx-core.es.js"
},
"default": "./dist/dx-core.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-grid-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-grid-core.umd.cjs",
"import": "./dist/dx-grid-core.es.js",
"require": {
"types": "./dist/dx-grid-core.d.cts",
"default": "./dist/dx-grid-core.umd.cjs"
},
"import": {
"types": "./dist/dx-grid-core.d.ts",
"default": "./dist/dx-grid-core.es.js"
},
"default": "./dist/dx-grid-core.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-chart-bootstrap4/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-chart-bootstrap4.umd.cjs",
"import": "./dist/dx-react-chart-bootstrap4.es.js",
"require": {
"types": "./dist/dx-react-chart-bootstrap4.d.cts",
"default": "./dist/dx-react-chart-bootstrap4.umd.cjs"
},
"import": {
"types": "./dist/dx-react-chart-bootstrap4.d.ts",
"default": "./dist/dx-react-chart-bootstrap4.es.js"
},
"default": "./dist/dx-react-chart-bootstrap4.es.js"
},
"./dist/dx-react-chart-bootstrap4.css": "./dist/dx-react-chart-bootstrap4.css"
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-chart-material-ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-chart-material-ui.cjs.cjs",
"import": "./dist/dx-react-chart-material-ui.es.js",
"require": {
"types": "./dist/dx-react-chart-material-ui.d.cts",
"default": "./dist/dx-react-chart-material-ui.cjs.cjs"
},
"import": {
"types": "./dist/dx-react-chart-material-ui.d.ts",
"default": "./dist/dx-react-chart-material-ui.es.js"
},
"default": "./dist/dx-react-chart-material-ui.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-chart/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-chart.umd.cjs",
"import": "./dist/dx-react-chart.es.js",
"require": {
"types": "./dist/dx-react-chart.d.cts",
"default": "./dist/dx-react-chart.umd.cjs"
},
"import": {
"types": "./dist/dx-react-chart.d.ts",
"default": "./dist/dx-react-chart.es.js"
},
"default": "./dist/dx-react-chart.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-core.umd.cjs",
"import": "./dist/dx-react-core.es.js",
"require": {
"types": "./dist/dx-react-core.d.cts",
"default": "./dist/dx-react-core.umd.cjs"
},
"import": {
"types": "./dist/dx-react-core.d.ts",
"default": "./dist/dx-react-core.es.js"
},
"default": "./dist/dx-react-core.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-grid-bootstrap3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-grid-bootstrap3.umd.cjs",
"import": "./dist/dx-react-grid-bootstrap3.es.js",
"require": {
"types": "./dist/dx-react-grid-bootstrap3.d.cts",
"default": "./dist/dx-react-grid-bootstrap3.umd.cjs"
},
"import": {
"types": "./dist/dx-react-grid-bootstrap3.d.ts",
"default": "./dist/dx-react-grid-bootstrap3.es.js"
},
"default": "./dist/dx-react-grid-bootstrap3.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-grid-bootstrap4/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-grid-bootstrap4.umd.cjs",
"import": "./dist/dx-react-grid-bootstrap4.es.js",
"require": {
"types": "./dist/dx-react-grid-bootstrap4.d.cts",
"default": "./dist/dx-react-grid-bootstrap4.umd.cjs"
},
"import": {
"types": "./dist/dx-react-grid-bootstrap4.d.ts",
"default": "./dist/dx-react-grid-bootstrap4.es.js"
},
"default": "./dist/dx-react-grid-bootstrap4.es.js"
},
"./dist/dx-react-grid-bootstrap4.css": "./dist/dx-react-grid-bootstrap4.css"
Expand Down
8 changes: 7 additions & 1 deletion packages/dx-react-grid-export/merge-dts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,11 @@ import { fileURLToPath } from 'url';
import { dirname } from 'path';

import buildDefinitions from '../../scripts/merge-dts.js';
import { copyCommonJsTypes, getPackageInfo, getDtsOutFile } from '../../scripts/utils.js';

buildDefinitions(dirname(fileURLToPath(import.meta.url)), true);
const packageDirectory = dirname(fileURLToPath(import.meta.url));
const pkg = getPackageInfo(packageDirectory);
const dtsOutFile = getDtsOutFile(packageDirectory, pkg.types);

buildDefinitions(packageDirectory, true);
copyCommonJsTypes(dtsOutFile);
10 changes: 8 additions & 2 deletions packages/dx-react-grid-export/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-grid-export.umd.cjs",
"import": "./dist/dx-react-grid-export.es.js",
"require": {
"types": "./dist/dx-react-grid-export.d.cts",
"default": "./dist/dx-react-grid-export.umd.cjs"
},
"import": {
"types": "./dist/dx-react-grid-export.d.ts",
"default": "./dist/dx-react-grid-export.es.js"
},
"default": "./dist/dx-react-grid-export.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-grid-material-ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-grid-material-ui.cjs.cjs",
"import": "./dist/dx-react-grid-material-ui.es.js",
"require": {
"types": "./dist/dx-react-grid-material-ui.d.cts",
"default": "./dist/dx-react-grid-material-ui.cjs.cjs"
},
"import": {
"types": "./dist/dx-react-grid-material-ui.d.ts",
"default": "./dist/dx-react-grid-material-ui.es.js"
},
"default": "./dist/dx-react-grid-material-ui.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-grid/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-grid.umd.cjs",
"import": "./dist/dx-react-grid.es.js",
"require": {
"types": "./dist/dx-react-grid.d.cts",
"default": "./dist/dx-react-grid.umd.cjs"
},
"import": {
"types": "./dist/dx-react-grid.d.ts",
"default": "./dist/dx-react-grid.es.js"
},
"default": "./dist/dx-react-grid.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-scheduler-material-ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-scheduler-material-ui.cjs.cjs",
"import": "./dist/dx-react-scheduler-material-ui.es.js",
"require": {
"types": "./dist/dx-react-scheduler-material-ui.d.cts",
"default": "./dist/dx-react-scheduler-material-ui.cjs.cjs"
},
"import": {
"types": "./dist/dx-react-scheduler-material-ui.d.ts",
"default": "./dist/dx-react-scheduler-material-ui.es.js"
},
"default": "./dist/dx-react-scheduler-material-ui.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-react-scheduler/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-react-scheduler.umd.cjs",
"import": "./dist/dx-react-scheduler.es.js",
"require": {
"types": "./dist/dx-react-scheduler.d.cts",
"default": "./dist/dx-react-scheduler.umd.cjs"
},
"import": {
"types": "./dist/dx-react-scheduler.d.ts",
"default": "./dist/dx-react-scheduler.es.js"
},
"default": "./dist/dx-react-scheduler.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-scheduler-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-scheduler-core.umd.cjs",
"import": "./dist/dx-scheduler-core.es.js",
"require": {
"types": "./dist/dx-scheduler-core.d.cts",
"default": "./dist/dx-scheduler-core.umd.cjs"
},
"import": {
"types": "./dist/dx-scheduler-core.d.ts",
"default": "./dist/dx-scheduler-core.es.js"
},
"default": "./dist/dx-scheduler-core.es.js"
}
},
Expand Down
10 changes: 8 additions & 2 deletions packages/dx-testing/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,14 @@
"type": "module",
"exports": {
".": {
"require": "./dist/dx-testing.umd.js",
"import": "./dist/dx-testing.es.js",
"require": {
"types": "./dist/dx-testing.d.cts",
"default": "./dist/dx-testing.umd.js"
},
"import": {
"types": "./dist/dx-testing.d.ts",
"default": "./dist/dx-testing.es.js"
},
"default": "./dist/dx-testing.es.js"
}
},
Expand Down
10 changes: 7 additions & 3 deletions scripts/merge-dts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { join, sep } from 'path';
import { readFileSync, existsSync } from 'fs';
import { existsSync } from 'fs';
import rimraf from 'rimraf';
import replace from 'replace-in-file';
import dts from 'dts-bundle';

import { copyCommonJsTypes, getPackageInfo, getDtsOutFile } from './utils.js';

const getIndexDts = (packageDirectory, dtsPath) => {
let indexDts = join(dtsPath, 'index.d.ts');

Expand All @@ -19,8 +21,8 @@ export default (packageDirectory, skipBundle = false) => {
const dtsPath = join(packageDirectory, 'dist', 'dts');

if (!skipBundle) {
const pkg = JSON.parse(readFileSync(join(packageDirectory, 'package.json')));
const dtsOutFile = join(packageDirectory, pkg.types);
const pkg = getPackageInfo(packageDirectory);
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is better to split this on steps instead of extracting this logic into util function

const dtsOutFile = getDtsOutFile(packageDirectory, pkg.types);
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like an overcomplicating. What's the difference between your function and using join?

const indexDts = getIndexDts(packageDirectory, dtsPath);

replace.sync({
Expand All @@ -37,6 +39,8 @@ export default (packageDirectory, skipBundle = false) => {
outputAsModuleFolder: true,
headerPath: 'none',
});

copyCommonJsTypes(dtsOutFile);
}

rimraf(dtsPath, () => {});
Expand Down
10 changes: 6 additions & 4 deletions scripts/ts-generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
} from 'fs';

import { join } from 'path';
import { copyCommonJsTypes } from './utils.js';

const ROOT_PATH = join(process.cwd(), 'packages');
const SOURCE_FOLDER = 'docs/reference';
Expand Down Expand Up @@ -345,10 +346,11 @@ const generateTypeScriptForPackage = (packageName) => {
console.log(`Building TypeScript definitions for '${packageName}-${theme}'.`);
const themeDistFolder = join(ROOT_PATH, `${packageName}-${theme}`, TARGET_FOLDER);
ensureDirectory(themeDistFolder);
writeFileSync(
join(themeDistFolder, `${packageName}-${theme}.d.ts`),
themesIndexContent,
);

const dtsOutFile = join(themeDistFolder, `${packageName}-${theme}.d.ts`);

writeFileSync(dtsOutFile, themesIndexContent);
copyCommonJsTypes(dtsOutFile);
});
};

Expand Down
14 changes: 14 additions & 0 deletions scripts/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { existsSync, copyFileSync, readFileSync } from 'fs';
import { join } from 'path';

const getCommonJsTypesPath = dtsPath => dtsPath.replace(/\.ts$/, '.cts');

export const copyCommonJsTypes = (dtsPath) => {
if (existsSync(dtsPath)) {
copyFileSync(dtsPath, getCommonJsTypesPath(dtsPath));
}
};

export const getPackageInfo = packageDir => JSON.parse(readFileSync(join(packageDir, 'package.json')));

export const getDtsOutFile = (packageDir, typesDir) => join(packageDir, typesDir);
Copy link
Contributor

Choose a reason for hiding this comment

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

We've simply duplicated using of join. Remove this function

Loading