Improve is plain object typings (#1231)

* ci: remove bench exclude * chore: move bench in their respective packages * chore(deps): to latest * chore: rename bench-dist into bench * chore: rename bench-dist into bench * feat: add compartive benchmarks * chore: add benchmark config * chore: remove bench workspace * feat: improve isPlainObject * feat: improve isPlainObject * chore(deps): nx to latest * fix(bench): typecheck shouldn't choke for benchmarks * fix(bench): typecheck shouldn't choke for benchmarks
belgattitude · May 24, 2024 · fd2ecd3 · fd2ecd3
1 parent 702f8a7
commit fd2ecd3
Show file tree

Hide file tree

Showing 124 changed files with 1,118 additions and 1,082 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -8,6 +8,5 @@
   "linked": [],
   "access": "public",
   "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": ["@bench/*"]
+  "updateInternalDependencies": "patch"
 }
diff --git a/.changeset/quick-coats-mix.md b/.changeset/quick-coats-mix.md
@@ -0,0 +1,40 @@
+---
+"@httpx/assert": minor
+---
+
+Improve PlainObject convenience typings when passing a generic.
+
+```typescript
+import { isPlainObject, assertPlainObject } from '@httpx/assert';
+
+type TValue = {
+  key: string,
+  deep: {
+    connected: boolean
+  }
+}
+const value = {
+  key: 'hello',
+  deep: {
+    connected: true 
+  }  
+} as unknown;
+
+// Without generic
+
+assertPlainObject(value);
+// value is Record<string, unknown>
+// -> no typing
+
+value.key; // unknown, no runtime error
+value.anything; // unknown, no runtime error
+// value.deep.connected // not possible without explicit typing 
+
+// With generic
+
+assertPlainObject<TValue>(value);
+
+value.key; // unknown, no runtime error
+value.anything; // unknown, no runtime error
+value.deep?.connected; // connected is 'unknown', typescript suggest the type
+```
diff --git a/.github/workflows/ci-packages.yml b/.github/workflows/ci-packages.yml
@@ -63,11 +63,11 @@ jobs:
 
       - name: 🕵️ Typecheck
         if: matrix.node-version == '20.x'
-        run: yarn nx run-many --target=typecheck --exclude='examples/**' --exclude='bench/**' --exclude='docs'
+        run: yarn nx run-many --target=typecheck --exclude='examples/**' --exclude='docs'
 
       - name: 🔬 ESLint checks
         if: matrix.node-version == '20.x'
-        run: yarn nx run-many --target=lint --exclude='examples/**' --exclude='bench/**' --exclude='docs'
+        run: yarn nx run-many --target=lint --exclude='examples/**' --exclude='docs'
 
       - name: 🧪 Unit tests (no-coverage - node !== 20.x)
         if: matrix.node-version != '20.x'

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,24 +33,24 @@ If applicable:
 
 ## Local scripts
 
-| Name                         | Description                                                                                                                         |
-|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
-| `yarn g:changeset`           | Add a changeset to declare a new version                                                                                            |
-| `yarn g:typecheck`           | Run typechecks in all workspaces                                                                                                    |
-| `yarn g:lint`                | Display linter issues in all workspaces                                                                                             |
-| `yarn g:lint --fix`          | Attempt to run linter auto-fix in all workspaces                                                                                    |
-| `yarn g:test-unit`           | Run unit tests in all workspaces                                                                                                    |
-| `yarn g:build`               | Run build in all workspaces                                                                                                         |
-| `yarn g:clean`               | Clean builds in all workspaces                                                                                                      |
-| `yarn g:check-dist`          | Ensure build dist files passes es2017 (run `g:build` first).                                                                        |
-| `yarn g:check-size`          | Ensure build files are within size limit (run `g:build` first).                                                                     |
-| `yarn g:docgen`              | Build documentation (generally api doc)                                                                                             |
-| `yarn g:bench-dist`          | Run comparative benchmarks of latest                                                                                                |
-| `yarn clean:global-cache`    | Clean tooling caches (eslint, jest...)                                                                                              |
-| `yarn deps:check --dep dev`  | Will print what packages can be upgraded globally (see also [.ncurc.yml](https://github.com/belgattitude/httpx/blob/main/.ncurc.yml)) |
-| `yarn deps:update --dep dev` | Apply possible updates (run `yarn install && yarn dedupe` after)                                                                    |
-| `yarn check:install`         | Verify if there's no peer-deps missing in packages                                                                                  |
-| `yarn dedupe`                | Built-in yarn deduplication of the lock file                                                                                        |
+| Name                         | Description                                                                                                                             |
+|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `yarn g:changeset`           | Add a changeset to declare a new version                                                                                                |
+| `yarn g:typecheck`           | Run typechecks in all workspaces                                                                                                        |
+| `yarn g:lint`                | Display linter issues in all workspaces                                                                                                 |
+| `yarn g:lint --fix`          | Attempt to run linter auto-fix in all workspaces                                                                                        |
+| `yarn g:test-unit`           | Run unit tests in all workspaces                                                                                                        |
+| `yarn g:build`               | Run build in all workspaces                                                                                                             |
+| `yarn g:clean`               | Clean builds in all workspaces                                                                                                          |
+| `yarn g:check-dist`          | Ensure build dist files passes es2017 (run `g:build` first).                                                                            |
+| `yarn g:check-size`          | Ensure build files are within size limit (run `g:build` first).                                                                         |
+| `yarn g:docgen`              | Build documentation (generally api doc)                                                                                                 |
+| `yarn g:bench`               | Run benchmarks for all workspaces.                                                                                                      |
+| `yarn clean:global-cache`    | Clean tooling caches (eslint, jest...)                                                                                                  |
+| `yarn deps:check --dep dev`  | Will print what packages can be upgraded globally (see also [.ncurc.yml](https://github.com/belgattitude/httpx/blob/main/.ncurc.yml))   |
+| `yarn deps:update --dep dev` | Apply possible updates (run `yarn install && yarn dedupe` after)                                                                        |
+| `yarn check:install`         | Verify if there's no peer-deps missing in packages                                                                                      |
+| `yarn dedupe`                | Built-in yarn deduplication of the lock file                                                                                            |
 
 ## Git message format
 

diff --git a/bench/assert/.eslintignore b/bench/assert/.eslintignore
diff --git a/bench/assert/.eslintrc.cjs b/bench/assert/.eslintrc.cjs
diff --git a/bench/assert/.gitignore b/bench/assert/.gitignore
diff --git a/bench/assert/bench/benchmark-results.json b/bench/assert/bench/benchmark-results.json
diff --git a/bench/assert/package.json b/bench/assert/package.json
diff --git a/bench/assert/src/benchmarks.ts b/bench/assert/src/benchmarks.ts