@rescript/react - npm Package Compare versions

Comparing version 0.10.3 to 0.11.0-alpha.1

CHANGELOG.md

+# Changelog
+
+## master
+
+## 0.11.0-alpha.1
+
+- `RescriptReactErrorBoundary` component now implemented using `@react.component`, so it is compatible with JSX V4.
+- `ReactV3` module added for backward compatibility to JSX V3. See [the V3 compatibility mode](https://github.com/rescript-lang/syntax/blob/master/cli/JSXV4.md)
+- Fixed `react-dom/server` and `react-dom/test-utils` imports.
+- Fixed `createRoot` bindings.
+- Added `Keyboard.code` binding.
+- Renamed `Changes.md` to `CHANGELOG.md` to align with the rescript-compiler repo.
+
+**Breaking:**
+
+- **IMPORTANT** The `React` module has been modified in a breaking way to support the new JSX PPX V4.
+
+- Removed the deprecation attribute from apis of the new jsx transform (introduced in React v17).
+
+- New version requirements:
+  - ReScript compiler V10.1+
+  - ReactJS v18.2.0+
+
+## v0.10.3
+
+- Temporarily remove peerDependency for bs-platform, so we can gracefully do the transition to our new `rescript` package
+
+## v0.10.2
+
+- Added `.js` extension to externals to comply to ES6 module conventions
+- Bump peerDependencies versions
+
+## v0.10.1
+
+This is the initial version of `rescript-react`, a port of `reason-react@0.9` that will be almost equivalent, except for a few long needed minor breaking changes.
+
+It is intended to be used with our newest ReScript React-JSX transformations (> JSX v3) and React v16.8.
+
+For history on previous evolution of the code, check out the original [reason-react history](https://github.com/reasonml/reason-react/blob/master/HISTORY.md)
+
+**Breaking:**
+
+- **IMPORTANT:** Currently, old third-party packages that are still dependent on `reason-react` will not mix with other `@rescript/react` based code due to a build system problem. Which means that every third-party dependency needs to be upgraded to `@rescript/react` first to make it compatible. See [this forum discussion](https://forum.rescript-lang.org/t/discussion-reason-react-rescript-react-migration-path/1086) for more details.
+
+- Removed legacy modules ("record api"):
+
+  - `ReasonReactCompat`
+  - `ReactDOMServerRe`
+  - `ReactEventRe`
+  - `ReasonReactOptimizedCreateClass`
+
+- Renamed existing modules:
+
+  - `ReasonReactErrorBoundary` -> `RescriptReactErrorBoundary`
+  - `ReasonReactRouter` -> `RescriptReactRouter`
+  - (Note: Usually the two only valid styles would be `ReScript` or `rescript`, the latter being the version for technical writing. We are using `Rescript` here, since it is essentially the capitalized version of `rescript`)
+
+- Removed all functionality from `ReasonReact` and `ReactDOMRe` that is not needed for react-jsx v3 compatibility
+- Moved `React.SuspenseList` to `React.Experimental.SuspenseList` to be more consistent with our Experimental features
+
+**Misc:**
+
+- Renamed `HISTORY.md` to `Changes.md` (aligning with other core projects, like genType)

bsconfig.json

 {
   "name": "@rescript/react",
-  "reason": { "react-jsx": 3 },
-  "sources": [
-    {"dir": "src", "subdirs": true},
-    { "dir": "test", "type": "dev" }
-  ],
+  "jsx": {
+    "version": 4,
+    "mode": "classic"
+  },
+  "sources": [{ "dir": "src", "subdirs": true }],
   "package-specs": [{ "module": "commonjs", "in-source": true }],
   "suffix": ".bs.js",
-  "bs-dev-dependencies": ["reason-test-framework"],
+  "bs-dev-dependencies": [],
   "bsc-flags": []
 }

package.json

 {
   "name": "@rescript/react",
-  "version": "0.10.3",
+  "version": "0.11.0-alpha.1",
   "description": "React bindings for ReScript",
   "files": [
     "README.md",
-    "Changes.md",
+    "CHANGELOG.md",
     "LICENSE",
@@ -14,5 +14,5 @@ "bsconfig.json",
   "scripts": {
-    "build": "bsb -make-world",
-    "start": "bsb -make-world -w",
-    "clean": "bsb -clean-world",
+    "build": "rescript build",
+    "start": "rescript build -w",
+    "clean": "rescript clean -with-deps",
     "test": "echo 'tests disabled for now'"
@@ -32,26 +32,10 @@ },
   "devDependencies": {
-    "bs-platform": "8.3.0",
-    "jest": "^26.0.1",
-    "react": "^16.8.1",
-    "react-dom": "^16.8.1",
-    "reason-test-framework": "^0.3.2"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rescript": "^10.1.0-alpha.2"
   },
   "peerDependencies": {
-    "react": ">=16.8.1",
-    "react-dom": ">=16.8.1"
-  },
-  "jest": {
-    "moduleDirectories": [
-      "node_modules"
-    ],
-    "roots": [
-      "test"
-    ],
-    "testMatch": [
-      "**/*__test.bs.js"
-    ],
-    "transformIgnorePatterns": [
-      "node_modules/(?!(bs-platform|reason-react|reason-react-compat|reason-react-update|bs-webapi|bs-css|bs-css-emotion|reason-test-framework)/)"
-    ]
+    "react": ">=18.2.0",
+    "react-dom": ">=18.2.0"
   }
 }

README.md

@@ -1,2 +0,2 @@
-## rescript-react 
+## rescript-react
 
@@ -9,3 +9,3 @@ > The Official ReScript Bindings for ReactJS
 
-- Existing users want to upgrade from `reason-react@0.9` to `rescript-react@0.10` (should be a smooth transition, check out the [Changes.md](./Changes.md) for minor breaking changes)
+- Existing users want to upgrade from `reason-react@0.9` to `rescript-react@0.10` (should be a smooth transition, check out the [CHANGELOG.md](./CHANGELOG.md) for minor breaking changes)
 - Make sure that all community libraries that are still on `reason-react` publish a new `@rescript/react` version as well (for compatibility reasons)
@@ -16,2 +16,8 @@ - We will soon publish our `v1.0` changes, with a new `react-jsx` version and some other cool features! Check out our [RFC post](https://forum.rescript-lang.org/t/rfc-rescript-react/901) for more infos.
 
+#### React-JSX transformation V4
+
+- [Documentation](https://github.com/rescript-lang/syntax/blob/master/cli/JSXV4.md)
+
+The ReScript compiler V10.1+ is required.
+
 ```
@@ -25,3 +31,3 @@ npm install @rescript/react --save
 {
-  "reason": { "react-jsx": 3 },
+  "jsx": { "version": 4, "mode": "classic" },
   "bs-dependencies": ["@rescript/react"]
@@ -31,2 +37,6 @@ }
 
+If you want to try [the new jsx transform](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) which was introduced in React v17, set the `"mode": "automatic"`.
+
+If you want to try build your project with JSX v3, see [the V3 compatibility mode](https://github.com/rescript-lang/syntax/blob/master/cli/JSXV4.md)
+
 **Quick Links:**
@@ -38,6 +48,13 @@
 
-- bs-platform v8.3+
-- ReactJS v16.8.1+
-- **Optimized for ReScript syntax usage**
+- v0.11.0+
 
+  - ReScript Compiler v10.1+
+  - ReactJS v18.2.0+
+
+- v0.10.3
+
+  - bs-platform v8.3+
+  - ReactJS v16.8.1+
+  - **Optimized for ReScript syntax usage**
+
 ### Development
@@ -44,0 +61,0 @@

Changes.md

-# Changelog
-
-## master
-
-- Nothing yet
-
-## v0.10.3
-
-- Temporarily remove peerDependency for bs-platform, so we can gracefully do the transition to our new `rescript` package
-
-## v0.10.2
-
-- Added `.js` extension to externals to comply to ES6 module conventions
-- Bump peerDependencies versions
-
-## v0.10.1
-
-This is the initial version of `rescript-react`, a port of `reason-react@0.9` that will be almost equivalent, except for a few long needed minor breaking changes.
-
-It is intended to be used with our newest ReScript React-JSX transformations (> JSX v3) and React v16.8.
-
-For history on previous evolution of the code, check out the original [reason-react history](https://github.com/reasonml/reason-react/blob/master/HISTORY.md)
-
-**Breaking:**
-
-- **IMPORTANT:** Currently, old third-party packages that are still dependent on `reason-react` will not mix with other `@rescript/react` based code due to a build system problem. Which means that every third-party dependency needs to be upgraded to `@rescript/react` first to make it compatible. See [this forum discussion](https://forum.rescript-lang.org/t/discussion-reason-react-rescript-react-migration-path/1086) for more details.
-
-- Removed legacy modules ("record api"):
-  - `ReasonReactCompat`
-  - `ReactDOMServerRe`
-  - `ReactEventRe`
-  - `ReasonReactOptimizedCreateClass`
-
-- Renamed existing modules:
-  - `ReasonReactErrorBoundary` -> `RescriptReactErrorBoundary`
-  - `ReasonReactRouter` -> `RescriptReactRouter`
-  - (Note: Usually the two only valid styles would be `ReScript` or `rescript`, the latter being the version for technical writing. We are using `Rescript` here, since it is essentially the capitalized version of `rescript`)
-
-- Removed all functionality from `ReasonReact` and `ReactDOMRe` that is not needed for react-jsx v3 compatibility
-- Moved `React.SuspenseList` to `React.Experimental.SuspenseList` to be more consistent with our Experimental features
-
-**Misc:**
-
-- Renamed `HISTORY.md` to `Changes.md` (aligning with other core projects, like genType)

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

239728

83.78%

Dev dependency count

3

-40%

Number of package files

25

31.58%

Number of lines in readme file

67

34%

Worsened metrics

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes