update build configuration to not use dts-cli #3781

zxbodya · 2023-07-21T14:43:13Z

Updating build configuration to directly use tsc, esbuild and rollup instead of dts-cli.

Also updating publish configuration to include source files, improving debug experience for consumers.

continuation of #3771

Reasons for making this change

improving build time
allowing to run typescript compiler separately from build (and so making it easier to quickly check for type errors)
by having typescript build output, it is possible to have correct navigation to source improving DX
prerequisite for updating typescript version

Changes

using tsc to generate esm modules and typescript definitions, among other benefits this allows to navigation to sources inside the monorepo
using esbuild for creating commonjs and esm bundle
using rollup for creating umd bundle from esm bundle
adding src folder to published files, so it can be used together with provided source maps

Changes in exported artefacts

no more split to production/development bundles
no overrides to use ems import path (for example imports from antd/lib are not overritten to use antd/es)

Both of this, if needed - are expected to be configured in a bundler on the library consumer side

heath-freenome · 2023-07-24T20:02:50Z

@zxbodya Go ahead and get this working now that the jest PR is merged

zxbodya · 2023-07-25T10:09:44Z

packages/utils/test/getSchemaType.test.ts

-        getSchemaType(test.schema),
-        `${JSON.stringify(test.schema)} should guess type of ${test.expected}`
-      ).toEqual(test.expected);
+  test.each(cases.map((c) => [c.expected, c.schema]))(


replacement for usage of jest-expect-message to avoid type errors in type definitions it provides

zxbodya · 2023-07-25T12:14:29Z

packages/docs/main.js

@@ -1,41 +0,0 @@
-$(function () {


the file is not used anymore, and also has broken link to unpkg

zxbodya · 2023-07-25T12:24:49Z

packages/docs/docs/00-introduction.mdx

@@ -39,24 +39,6 @@ import Form from '@rjsf/core';

 Our latest version requires React 16+. You can also install `react-jsonschema-form` (the 1.x version) which works with React 15+.

-### As a script served from a CDN


core.cjs.production.min.js is to be no longer correct after the changes (new link should be to index.js and it is also not minified)

However, for both urls - it is a commonjs bundle, which will not work in browser environment because it will try to "require" all the dependencies (react, lodash, etc…)

This can be changes to umd bundle, but that also would not be easy - requiring bunch of script tags with all the dependencies. And so, I believe, it is better to just remove this section entirely to avoid confusion and also to consider umd bundle as deprecated and to remove that in next major version(in case anyone still using it)

If we were to deprecate it, we would want to add documentation now. Probably here? @nickgros ?

This probably should have always been the UMD bundle. I don't know of a use case for referencing the cjs bundle from a script

Not sure if we should deprecate the UMD bundle, but that can be a separate discussion

packages/chakra-ui/src/IconButton/ChakraIconButton.tsx

heath-freenome · 2023-07-28T14:54:50Z

packages/chakra-ui/tsconfig.json

+    // todo:
+    // ../../node_modules/@chakra-ui/menu/dist/declarations/src/use-menu.d.ts:986:61 - error TS2694: Namespace '"node_modules/csstype/index".Property' has no exported member 'ColorAdjust'.


I'm guessing that you haven't figured out how to pull in the type for the button yet?

replace todo with a comment about skipLibCheck

heath-freenome · 2023-07-28T14:56:19Z

packages/docs/docs/00-introduction.mdx

@@ -39,24 +39,6 @@ import Form from '@rjsf/core';

 Our latest version requires React 16+. You can also install `react-jsonschema-form` (the 1.x version) which works with React 15+.

-### As a script served from a CDN


If we were to deprecate it, we would want to add documentation now. Probably here? @nickgros ?

packages/fluent-ui/src/BaseInputTemplate/BaseInputTemplate.tsx

heath-freenome · 2023-07-28T14:58:52Z

packages/fluent-ui/tsconfig.json

+    // todo
+    // ../../node_modules/@chakra-ui/menu/dist/declarations/src/use-menu.d.ts:986:61 - error TS2694: Namespace '"react-jsonschema-form/node_modules/csstype/index".Property' has no exported member 'ColorAdjust'.
+    "skipLibCheck": true


Are these an artifact of a copy from chakra-ui?

replace todo with a comment about skipLibCheck?

heath-freenome · 2023-07-28T15:00:33Z

packages/semantic-ui/tsconfig.json

+    // todo:
+    // ../../node_modules/semantic-ui-react/dist/commonjs/generic.d.ts(73,73): error TS2344: Type 'TProps' does not satisfy the constraint 'Record<string, any>'.


More explanation? It looks like semantic ui has a type issue?

replace todo with a comment about skipLibCheck

heath-freenome · 2023-08-02T16:42:51Z

@zxbodya Since I just released 5.11.1 you'll need to resolve your conflicts. Sorry

heath-freenome · 2023-08-02T20:27:23Z

CHANGELOG.md

+## Dev / playground
+
+- update playground vite config to use sources directly, allowing to reload changes in it without additional build step
+- moving from `dts-cli` to use individual dev tools directly, updating package publish config
+  - tsc for generating type definitions and esm modules
+  - esbuild for CJS bundle
+  - rollup for UMD bundle
+


Leave 5.11.2 and move this into 5.12.0. I needed to release the fix for #3805 to unblock my company

zxbodya mentioned this pull request Jul 21, 2023

typescript project references #3782

Merged

zxbodya force-pushed the tsc-build branch from 6bbc0a1 to bf61272 Compare July 21, 2023 16:42

zxbodya force-pushed the tsc-build branch from bf61272 to ea1d982 Compare July 25, 2023 09:22

zxbodya commented Jul 25, 2023

View reviewed changes

zxbodya marked this pull request as ready for review July 25, 2023 10:12

zxbodya commented Jul 25, 2023

View reviewed changes

packages/docs/main.js

@@ -1,41 +0,0 @@

$(function () {

Copy link

Contributor Author

zxbodya Jul 25, 2023

Choose a reason for hiding this comment

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

the file is not used anymore, and also has broken link to unpkg

zxbodya commented Jul 25, 2023

View reviewed changes

heath-freenome reviewed Jul 28, 2023

View reviewed changes

zxbodya force-pushed the tsc-build branch 3 times, most recently from b51483a to bbdffec Compare August 2, 2023 20:21

heath-freenome reviewed Aug 2, 2023

View reviewed changes

zxbodya added 14 commits August 2, 2023 22:57

cleanup tsconfig files

aa49f6a

replace dts-cli by using tsc, esbuild and rollup directly

4440162

remove jest-expect-message to avoid type errors in its definitions

df78d98

chakra-ui type fixes

aaf4537

chakra-ui skipLibCheck

2298436

fluent-ui type fixes

d1310c0

fluent-ui skipLibCheck

e234019

semantic-ui skipLibCheck

cd358c0

playground type fixes

dc9b1ed

update files in package.json to include lib and src folders

d0066e2

build publish config

8479841

change log note, config updates

c08c58b

update docs

f5395e5

remove skipLibCheck todos

5fabb5a

zxbodya force-pushed the tsc-build branch from bbdffec to 5fabb5a Compare August 2, 2023 20:58

heath-freenome approved these changes Aug 4, 2023

View reviewed changes

nickgros approved these changes Aug 4, 2023

View reviewed changes

heath-freenome merged commit c06b197 into rjsf-team:main Aug 4, 2023
4 checks passed

zxbodya deleted the tsc-build branch August 4, 2023 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update build configuration to not use dts-cli #3781

update build configuration to not use dts-cli #3781

zxbodya commented Jul 21, 2023 •

edited

Loading

heath-freenome commented Jul 24, 2023

zxbodya Jul 25, 2023

zxbodya Jul 25, 2023

zxbodya Jul 25, 2023

heath-freenome Jul 28, 2023

nickgros Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome Jul 28, 2023

heath-freenome commented Aug 2, 2023

heath-freenome Aug 2, 2023

zxbodya Aug 2, 2023

		@@ -39,24 +39,6 @@ import Form from '@rjsf/core';

		Our latest version requires React 16+. You can also install `react-jsonschema-form` (the 1.x version) which works with React 15+.

		### As a script served from a CDN

		// todo:
		// ../../node_modules/@chakra-ui/menu/dist/declarations/src/use-menu.d.ts:986:61 - error TS2694: Namespace '"node_modules/csstype/index".Property' has no exported member 'ColorAdjust'.

		// todo:
		// ../../node_modules/semantic-ui-react/dist/commonjs/generic.d.ts(73,73): error TS2344: Type 'TProps' does not satisfy the constraint 'Record<string, any>'.

update build configuration to not use dts-cli #3781

update build configuration to not use dts-cli #3781

Conversation

zxbodya commented Jul 21, 2023 • edited Loading

Reasons for making this change

Changes

Changes in exported artefacts

heath-freenome commented Jul 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heath-freenome commented Aug 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zxbodya commented Jul 21, 2023 •

edited

Loading