perf: enable tree-shaking

Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/workflows/build.yml

@@ -10,19 +10,19 @@ jobs:
   build:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'Build Package'
         run: 'npm run build'
 
       - name: 'Build Example'
-        run: 'cd example && npm install && npm run build'
+        run: 'cd example && npm clean-install && npm run build'

.github/workflows/lint.yml

@@ -10,16 +10,16 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
       - run: 'npm run lint:editorconfig'

.github/workflows/release.yml

@@ -7,21 +7,29 @@ on:
 jobs:
   build:
     runs-on: 'ubuntu-latest'
+    permissions:
+      contents: 'write'
+      issues: 'write'
+      pull-requests: 'write'
+      id-token: 'write'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'Build Package'
         run: 'npm run build'
 
+      - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
+        run: 'npm audit signatures'
+
       - name: 'Release'
         run: 'npm run release'
         env:

.github/workflows/test.yml

@@ -10,16 +10,16 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'Test'
         run: 'npm run test'
@@ -27,22 +27,22 @@ jobs:
   test-e2e:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.5.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
         uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'Build Package'
         run: 'npm run build'
 
       - name: 'Build Example'
-        run: 'cd example && npm install && npm run build'
+        run: 'cd example && npm clean-install && npm run build'
 
       - name: 'End To End (e2e) Test Example'
         run: 'cd example && npm run test:e2e'

.markdownlint-cli2.jsonc

@@ -1,4 +1,10 @@
 {
+  "config": {
+    "extends": "markdownlint/style/prettier",
+    "relative-links": true,
+    "default": true,
+    "MD033": false
+  },
   "globs": ["**/*.{md,mdx}"],
   "ignores": ["**/node_modules"],
   "customRules": ["markdownlint-rule-relative-links"]

.markdownlint.json

@@ -1,7 +0,0 @@
-{
-  "default": true,
-  "relative-links": true,
-  "extends": "markdownlint/style/prettier",
-  "MD033": false,
-  "MD041": false
-}

.npmrc

@@ -1 +1,2 @@
 save-exact=true
+provenance=true

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
+<contact@divlo.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -6,6 +6,10 @@ Thanks a lot for your interest in contributing to **react-component-form**! 🎉
 
 **react-component-form** has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
 
+## Open Development
+
+All work on **react-component-form** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
+
 ## Types of contributions
 
 - Reporting a bug.
@@ -25,28 +29,4 @@ If you're adding new features to **react-component-form**, please include tests.
 
 ## Commits
 
-The commit message guidelines respect
-[@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
-and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.

example/components/FormExample.tsx

@@ -1,3 +1,5 @@
+'use client'
+
 import { Form, useForm } from 'react-component-form'
 import type { HandleUseFormCallback } from 'react-component-form'
 import useTranslation from 'next-translate/useTranslation'
@@ -8,7 +10,7 @@ import { useFormTranslation } from '../hooks/useFormTranslation'
 import { userSchema } from '../models/User'
 import { FormState } from './design/FormState'
 
-const simulateServerRequest = async (ms: number): Promise<void> => {
+const fakeServerRequest = async (ms: number): Promise<void> => {
   return await new Promise((resolve) => {
     setTimeout(resolve, ms)
   })
@@ -23,7 +25,7 @@ export const FormExample: React.FC = () => {
     formData,
     formElement
   ) => {
-    await simulateServerRequest(2_000)
+    await fakeServerRequest(2_000)
     console.log('onSubmit:', formData)
     formElement.reset()
     return {

example/package.json

@@ -11,28 +11,28 @@
     "test:dev": "start-server-and-test \"dev\" \"http://127.0.0.1:3000\" \"cypress open\""
   },
   "dependencies": {
-    "@sinclair/typebox": "0.26.8",
+    "@sinclair/typebox": "0.28.10",
     "clsx": "1.2.1",
     "next": "13.2.4",
     "next-themes": "0.2.1",
-    "next-translate": "2.0.4",
+    "next-translate": "2.0.5",
     "react": "18.2.0",
     "react-component-form": "file:..",
     "react-dom": "18.2.0"
   },
   "devDependencies": {
-    "@tsconfig/strictest": "2.0.0",
-    "@types/node": "18.15.11",
-    "@types/react": "18.0.32",
-    "@types/react-dom": "18.0.11",
+    "@tsconfig/strictest": "2.0.1",
+    "@types/node": "20.1.4",
+    "@types/react": "18.2.6",
+    "@types/react-dom": "18.2.4",
     "autoprefixer": "10.4.14",
-    "cypress": "12.9.0",
-    "eslint": "8.37.0",
+    "cypress": "12.12.0",
+    "eslint": "8.40.0",
     "eslint-config-next": "13.2.4",
-    "next-translate-plugin": "2.0.4",
-    "postcss": "8.4.21",
+    "next-translate-plugin": "2.0.5",
+    "postcss": "8.4.23",
     "start-server-and-test": "2.0.0",
-    "tailwindcss": "3.3.1",
-    "typescript": "5.0.3"
+    "tailwindcss": "3.3.2",
+    "typescript": "5.0.4"
   }
 }

package.json

@@ -18,11 +18,15 @@
     "url": "https://github.com/Divlo/react-component-form/issues"
   },
   "homepage": "https://react-component-form.vercel.app/",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "files": [
-    "dist"
+    "build"
   ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
     "build": "tsup",
     "test": "jest",
@@ -37,39 +41,39 @@
     "react": ">=18.2.0"
   },
   "dependencies": {
-    "@sinclair/typebox": "0.26.8",
+    "@sinclair/typebox": "0.28.10",
     "ajv": "8.12.0",
     "ajv-formats": "2.1.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.5.1",
-    "@commitlint/config-conventional": "17.4.4",
+    "@commitlint/cli": "17.6.3",
+    "@commitlint/config-conventional": "17.6.3",
     "@testing-library/react": "14.0.0",
-    "@tsconfig/strictest": "2.0.0",
-    "@types/jest": "29.5.0",
-    "@types/react": "18.0.32",
-    "@types/react-dom": "18.0.11",
-    "@typescript-eslint/eslint-plugin": "5.57.0",
-    "@typescript-eslint/parser": "5.57.0",
+    "@tsconfig/strictest": "2.0.1",
+    "@types/jest": "29.5.1",
+    "@types/react": "18.2.6",
+    "@types/react-dom": "18.2.4",
+    "@typescript-eslint/eslint-plugin": "5.59.5",
+    "@typescript-eslint/parser": "5.59.5",
     "editorconfig-checker": "5.0.1",
-    "esbuild": "0.17.15",
+    "esbuild": "0.17.19",
     "esbuild-jest": "0.5.0",
-    "eslint": "8.37.0",
-    "eslint-config-conventions": "8.0.0",
+    "eslint": "8.40.0",
+    "eslint-config-conventions": "9.0.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "46.0.0",
+    "eslint-plugin-unicorn": "47.0.0",
     "jest": "29.5.0",
     "jest-environment-jsdom": "29.5.0",
-    "markdownlint-cli2": "0.6.0",
-    "markdownlint-rule-relative-links": "1.1.2",
-    "prettier": "2.8.7",
+    "markdownlint-cli2": "0.7.1",
+    "markdownlint-rule-relative-links": "1.2.0",
+    "prettier": "2.8.8",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "semantic-release": "21.0.1",
+    "semantic-release": "21.0.2",
     "tsup": "6.7.0",
-    "typescript": "5.0.3"
+    "typescript": "5.0.4"
   }
 }

src/__test__/index.test.tsx

@@ -29,14 +29,14 @@ describe('<Form />', () => {
     const text = 'some random text'
 
     fireEvent.change(inputForm, { target: { value: text } })
-    expect(formData.inputName).toEqual(text)
+    expect(formData['inputName']).toEqual(text)
     expect(formElement instanceof HTMLFormElement).toBeTruthy()
     formData = {}
     formElement = null
 
     fireEvent.click(buttonSubmit)
     expect(Object.keys(formData).length).toEqual(1)
-    expect(formData.inputName).toEqual(text)
+    expect(formData['inputName']).toEqual(text)
     expect(formElement instanceof HTMLFormElement).toBeTruthy()
   })
 })

tsup.config.js

@@ -1,12 +1,13 @@
 import { defineConfig } from 'tsup'
 
 export default defineConfig({
-  entry: ['src/index.ts'],
-  sourcemap: true,
+  entry: ['src/**/*.{ts,tsx}', '!src/**/*.test.{ts,tsx}'],
+  sourcemap: false,
   clean: true,
   platform: 'browser',
   target: 'esnext',
   format: ['esm'],
-  minify: true,
+  minify: false,
+  outDir: 'build',
   dts: true
 })