feat: switch package to module type (#1472)

BREAKING CHANGE: Hooks are now distrubutes as JS built form TS with target ESNext and ESM module resolution. There is no more sense to distribute CJS version as package is ESM-only.

Consequent of above - no more esm and cjs subfolders - hooks are importable from index.js or its own directory which don't have a prefix anymore, thanks to exports directive. All of below examples will lead to same result, choose any on your taste:

import { useFirstMountState } from '@react-hookz/web';
import { useFirstMountState } from '@react-hookz/web/';
import { useFirstMountState } from '@react-hookz/web/useFirstMountState/';
import { useFirstMountState } from '@react-hookz/web/useFirstMountState/index.js';
Thought is seems not to have subfolder, it is only due to exports directive, in real it is
@react-hookz/web/dist/useFirstMountState/index.js.

Pakage uses imports directive to define path alias #root - it stays so even in distributed code, thus, some may be affected in case their bundler configured to somehow handle such alias. Those developer shoud configure import rewriter not to handle node_modules or @react-hookz/web package exclusively.

Side-effect for current PR - documentation is broken, as storybook 6 is not working within ESM packages and I'm planning to switch to another domenting engine anyway.

Author: xobotyi

.eslintignore

@@ -1,11 +1,8 @@
 .idea
 node_modules
-esm
-cjs
+dist
 coverage
-storybook-build
 CHANGELOG.md
-!.eslintrc.js
-!.prettierrc.js
-!.storybook
+!.eslintrc.cjs
+!.prettierrc.cjs
 !.github

.eslintrc.js renamed to .eslintrc.cjs

@@ -3,9 +3,11 @@ const commonJSRules = {
 	'unicorn/prevent-abbreviations': 'off',
 	'unicorn/no-null': 'off',
 	'unicorn/no-array-for-each': 'off',
+
+	'@typescript-eslint/no-meaningless-void-operator': 'off',
+	'@typescript-eslint/no-confusing-void-expression': 'off',
 };
 
-// eslint-disable-next-line unicorn/prefer-module
 module.exports = {
 	root: true,
 

.github/workflows/ci-cd.yml

@@ -24,7 +24,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: bahmutov/npm-install@v1
         with:
@@ -45,7 +45,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: bahmutov/npm-install@v1
         with:
@@ -69,7 +69,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: bahmutov/npm-install@v1
         with:
@@ -115,7 +115,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: bahmutov/npm-install@v1
         with:

.github/workflows/gh-pages.yml

@@ -1,6 +1,4 @@
 /.idea
 node_modules
 /coverage
-/storybook-build
-/cjs
-/esm
+/dist

.gitignore

@@ -0,0 +1,3 @@
+const config = require('@react-hookz/eslint-config/.prettierrc.cjs');
+
+module.exports = config;