[Feature] move stories to TS #223

joshuaellis · 2021-01-09T12:05:14Z

What

Move the storybook stories files to Typescript.

Why

This will help us catch errors such as the import wasn't put in the index file. It'll also help us check our TS errors when using the library practically since there are no tests.

This will probably end up closing the following issues

resolves [Idea] Stories should be written in TS #220
resolves Type for useTexture #219
resolves Contact shadows example is broken #226

Other

I think this would compliment #222 well, so ideally this could be merged into a beta too and both launched together. This is still WIP, hence the draft, but thought it would be useful to track for the wider team since it's a large change and there might be some suggestions to the TS writing of the stories.

I think these were TS problems that were missed.

joshuaellis · 2021-01-09T18:18:36Z

src/Reflector.tsx

@@ -16,7 +16,7 @@ declare global {
  }
 }

-type Props = ReflectorOptions & { children: React.ReactElement<any> }
+type Props = ReflectorOptions & Omit<JSX.IntrinsicElements['mesh'], 'args'> & { children: React.ReactElement<any> }


The THREE class Reflector extends Mesh so the story failed, although I find the TS for R3F confusing (becuase im no master) so this might be wrong?

joshuaellis · 2021-01-09T18:19:01Z

src/MeshWobbleMaterial.tsx

@@ -4,7 +4,8 @@ import { useFrame } from 'react-three-fiber'

 type WobbleMaterialType = JSX.IntrinsicElements['meshStandardMaterial'] & {
  time?: number
-  factor: number
+  factor?: number
+  speed?: number


the Ref example was proof that these args are optional in the props.

joshuaellis · 2021-01-09T18:19:06Z

src/MeshDistortMaterial.tsx

-  distort: number
-  radius: number
+  distort?: number
+  radius?: number


the Ref example was proof that these args are optional in the props.

joshuaellis · 2021-01-11T16:22:56Z

will resolve #226

Two errors linked to three.js: mrdoob/three.js#21058 mrdoob/three.js#21059

joshuaellis · 2021-01-11T20:47:13Z

will resolve #176

…s-DREI220

fixed using DefinitelyTyped/DefinitelyTyped#44572 (comment) because microsoft/TypeScript#14729

also useGLTF does not need to declare it's type

.storybook/stories/useGLTF.stories.tsx

accidentally committed a WIP change

joshuaellis · 2021-01-12T17:55:56Z

Hi @gsimone,

So there are a few changes left:

useGLTF needs this PR to merged to R3F although im not sure it's the best solution so I put in a temp fix for now.

useCamera is throwing TS errors in relation to this issue pmndrs/react-three-fiber#925 (comment) which i'm going to start looking at now.

But I thought it might be good to get the review process started whilst those to issues are going on.

gsimone · 2021-01-12T18:34:56Z

Fixed a couple of minor things in useNormalTexture and useMatcapTexture, and removed js and jsx linting, since we are not going to have those anymore (and it was giving me error when running the linting script 🤷 )

joshuaellis · 2021-01-12T18:46:52Z

Fixed a couple of minor things in useNormalTexture and useMatcapTexture

Ah yeah, thank you! hopefully we won't need to declare Texture anymore as it should be fixed in pmndrs/react-three-fiber#930

Required for Types

there was issues with useAsset not understanding it's types....

joshuaellis · 2021-01-14T18:11:39Z

This is ready for merge, codebox CI is complaining because of pkg being private? Had to make tweeks to src files as I was going in regards to the TS impl, just to make you aware.

…-Stories-DREI220

vercel · 2021-01-15T08:59:30Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/pmndrs/drei/9q1f4wccv
✅ Preview: https://drei-git-fork-joshuaellis-feature-ts-stories-drei220.pmndrs.vercel.app

codesandbox-ci · 2021-01-15T09:01:07Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 48c8e2a:

Sandbox	Source
currying-butterfly-1r76i	Configuration

* feat: setup TS for stories * fix: eslint was ignore .storybook * feat: add TS to storybook * refactor: move stories to TS (WIP) * refactor: move more stories to TS (WIP) * refactor: src changes for TS move over I think these were TS problems that were missed. * fix: ContactShadows story * refactor: move more stories to TS * refactor: add MapControls.tsx after raising issues in three Two errors linked to three.js: mrdoob/three.js#21058 mrdoob/three.js#21059 * fix: TS errors for passing refs & children * refactor: add more stories (WIP) * fix: useContextBridge TS to accept array of children fixed using DefinitelyTyped/DefinitelyTyped#44572 (comment) because microsoft/TypeScript#14729 * refactor: convert more stories to TS also useGLTF does not need to declare it's type * chore: update storybook * fix: revert useTexture accidentally committed a WIP change * refactor: move stories to TS (WIP) * refactor: revert useGLTF story * Minor type fixes * chore: update react-three-fiber to latest Required for Types * refactor: move stories to TS * fix: shaderMaterial on init returns void, not null * refactor: remove unnecessary type in useFBX * refactor: type Environment stronger there was issues with useAsset not understanding it's types.... * Fixes CSB CI (#230) Co-authored-by: Gianmarco Simone <[email protected]> Co-authored-by: Josh <[email protected]>

* change: move components into core folder * feat: add import types web & native index points to web to avoid breaking changes(?) but also cause that's a good default. * refactor: rollup so it looks for ts not tsx * refactor: move Html & Loader to web folder, make folders for native & web index points to web * Fixes CSB CI (#230) * [Feature] move stories to TS (#223) (#231) * feat: setup TS for stories * fix: eslint was ignore .storybook * feat: add TS to storybook * refactor: move stories to TS (WIP) * refactor: move more stories to TS (WIP) * refactor: src changes for TS move over I think these were TS problems that were missed. * fix: ContactShadows story * refactor: move more stories to TS * refactor: add MapControls.tsx after raising issues in three Two errors linked to three.js: mrdoob/three.js#21058 mrdoob/three.js#21059 * fix: TS errors for passing refs & children * refactor: add more stories (WIP) * fix: useContextBridge TS to accept array of children fixed using DefinitelyTyped/DefinitelyTyped#44572 (comment) because microsoft/TypeScript#14729 * refactor: convert more stories to TS also useGLTF does not need to declare it's type * chore: update storybook * fix: revert useTexture accidentally committed a WIP change * refactor: move stories to TS (WIP) * refactor: revert useGLTF story * Minor type fixes * chore: update react-three-fiber to latest Required for Types * refactor: move stories to TS * fix: shaderMaterial on init returns void, not null * refactor: remove unnecessary type in useFBX * refactor: type Environment stronger there was issues with useAsset not understanding it's types.... * Fixes CSB CI (#230) Co-authored-by: Gianmarco Simone <[email protected]> Co-authored-by: Josh <[email protected]> * 2.2.16 * chore: add templates (#232) * chore: add react-dom as optional peer depency if you're using react-native you don't need it. * docs: update readme * fix: fix storybook imports that should have been done before my bad. Co-authored-by: Gianmarco <[email protected]>

* [Feature] move stories to TS (#223) (#231) * feat: setup TS for stories * fix: eslint was ignore .storybook * feat: add TS to storybook * refactor: move stories to TS (WIP) * refactor: move more stories to TS (WIP) * refactor: src changes for TS move over I think these were TS problems that were missed. * fix: ContactShadows story * refactor: move more stories to TS * refactor: add MapControls.tsx after raising issues in three Two errors linked to three.js: mrdoob/three.js#21058 mrdoob/three.js#21059 * fix: TS errors for passing refs & children * refactor: add more stories (WIP) * fix: useContextBridge TS to accept array of children fixed using DefinitelyTyped/DefinitelyTyped#44572 (comment) because microsoft/TypeScript#14729 * refactor: convert more stories to TS also useGLTF does not need to declare it's type * chore: update storybook * fix: revert useTexture accidentally committed a WIP change * refactor: move stories to TS (WIP) * refactor: revert useGLTF story * Minor type fixes * chore: update react-three-fiber to latest Required for Types * refactor: move stories to TS * fix: shaderMaterial on init returns void, not null * refactor: remove unnecessary type in useFBX * refactor: type Environment stronger there was issues with useAsset not understanding it's types.... * Fixes CSB CI (#230) Co-authored-by: Gianmarco Simone <[email protected]> Co-authored-by: Josh <[email protected]> * 2.2.16 * chore: add templates (#232) * chore: add react-dom as optional peer depency if you're using react-native you don't need it. * docs: update readme * fix: fix storybook imports that should have been done before * BREAKING CHANGE: refactor internal to solve react-native imports my bad. Co-authored-by: Gianmarco <[email protected]> * 2.3.0-beta.0 * fix: edit transformOutputPath to remove .ts from files * 2.3.0-beta.1 * fix: useAnimations ref type & chore: add storybook entry for useAnimations * Added THREE.Group to useAnimations types * Small refactor * Added useAnimations story * Clean up storybook * Fix null ref typing on useAnimations * Forgot to change typing on useAnimations api * chore: add storybook entry to README Co-authored-by: Josh Ellis <[email protected]> * [fix] Blob is undefined when using SSR (#239) * fix: #233 Blob is undefined in SSR * refactor: it appears Billboard is fixed Looks like Typescript does not suck. * 2.3.0-beta.2 * fix: create polyfill for atob * 2.3.0-beta.3 * chore: update readme in response to #240 * fix: #242 Frustum has incorrect spelling in softshadows (#243) * fix: suggestion for fixing #242 * refactor: default should be other way round * chore: update readme with correct spelling * 2.3.0-beta.4 * feat: Add MeshoptDecoder support to useGLTF (#246) * Add MeshoptDecoder support to useGLTF * chore: move center Co-authored-by: Josh Ellis <[email protected]> * 2.3.0-beta.5 * feat: #181 – adding points to line (#247) * feat: re-create geometry on new points * refactor: useMemo the geometry instead of useEffect * 2.3.0-beta.6 * 3.0.0-beta.1 * 3.0.0-beta.2 * feat: update troika with new features (#255) * 3.0.0-beta.3 * feat: add ability to add custom scene as prop (#256) * feat: add ability to add custom scene as prop * docs: update Environment with new feats * 3.0.0-beta.4 * refactor: shuffle imports for beta * 3.0.0-beta.5 * docs: clearly specify name of package & old has been deprecated * BREAKING CHANGE: Upgrade Three.js to r125 (#262) * chore: update Three.js dependency * refactor: remove subdivision modifier * fix: remove use of FaceNormalsHelper as it no longer exists in Three * fix: update typings for THREE * fix: update modifiers to work without THREE.Geometry * docs: update README * chore: add Three.js peer dependency * fix: change install instructions to use yarn instead of npm (#265) * repurpose reflector, make it capable to blur (#260) * repurpose reflector, make it capable to blur * refactor: move materials out to reduce noise & fix types * refactor: merge beta * fix: add child propType * refactor: update reflector story & fix children type * changes * fix: shuffle types so reflectorProps come from what the material expects * docs Co-authored-by: Josh Ellis <[email protected]> * chore: add workflows to beta release * BREAKING CHANGE force build * 3.0.0-beta.6 Co-authored-by: Gianmarco Simone <[email protected]> Co-authored-by: Tanner Hartwig <[email protected]> Co-authored-by: Matt Rossman <[email protected]> Co-authored-by: Renaud Rohlinger <[email protected]> Co-authored-by: Jure Triglav <[email protected]> Co-authored-by: Jason Bixon <[email protected]> Co-authored-by: Paul Henschel <[email protected]>

joshuaellis added 4 commits January 8, 2021 13:03

feat: setup TS for stories

c2bb1b6

fix: eslint was ignore .storybook

500b4e5

feat: add TS to storybook

5f73107

refactor: move stories to TS (WIP)

a46a9ea

joshuaellis mentioned this pull request Jan 9, 2021

Feat/react-native-exports #222

Merged

joshuaellis added 2 commits January 9, 2021 18:10

refactor: move more stories to TS (WIP)

6a23ee4

refactor: src changes for TS move over

566c87d

I think these were TS problems that were missed.

joshuaellis commented Jan 9, 2021

View reviewed changes

fix: ContactShadows story

bf855ad

refactor: move more stories to TS

593506a

joshuaellis mentioned this pull request Jan 11, 2021

Contact shadows example is broken #226

Closed

refactor: add MapControls.tsx after raising issues in three

678a795

Two errors linked to three.js: mrdoob/three.js#21058 mrdoob/three.js#21059

joshuaellis mentioned this pull request Jan 11, 2021

createPortal return type is not a valid JSX element pmndrs/react-three-fiber#925

Closed

joshuaellis added 5 commits January 12, 2021 09:53

Merge remote-tracking branch 'upstream/master' into feature/TS-Storie…

b3f7111

…s-DREI220

fix: TS errors for passing refs & children

5f07765

refactor: add more stories (WIP)

4ab1879

fix: useContextBridge TS to accept array of children

b0a1e95

fixed using DefinitelyTyped/DefinitelyTyped#44572 (comment) because microsoft/TypeScript#14729

refactor: convert more stories to TS

df3eb07

also useGLTF does not need to declare it's type

joshuaellis commented Jan 12, 2021

View reviewed changes

.storybook/stories/useGLTF.stories.tsx Outdated Show resolved Hide resolved

joshuaellis added 4 commits January 12, 2021 16:02

chore: update storybook

b876a1d

fix: revert useTexture

9cc340c

accidentally committed a WIP change

refactor: move stories to TS (WIP)

08eb038

refactor: revert useGLTF story

3ea7304

joshuaellis requested a review from gsimone January 12, 2021 17:53

joshuaellis changed the base branch from master to beta January 12, 2021 18:08

Minor type fixes

bd0d1ec

joshuaellis mentioned this pull request Jan 14, 2021

Loading multiple textures with useTexture #176

Closed

joshuaellis added 5 commits January 14, 2021 16:39

chore: update react-three-fiber to latest

7b04a05

Required for Types

refactor: move stories to TS

f64cd54

fix: shaderMaterial on init returns void, not null

d191df6

refactor: remove unnecessary type in useFBX

4d3cf11

refactor: type Environment stronger

8b59dcb

there was issues with useAsset not understanding it's types....

joshuaellis marked this pull request as ready for review January 14, 2021 18:10

gsimone added 2 commits January 15, 2021 09:22

Fixes CSB CI (#230)

1ceb3bd

Merge branch 'master' of github.com:react-spring/drei into feature/TS…

48c8e2a

…-Stories-DREI220

vercel bot deployed to Preview January 15, 2021 08:59 View deployment

gsimone merged commit e61d0e9 into pmndrs:beta Jan 15, 2021

joshuaellis deleted the feature/TS-Stories-DREI220 branch January 15, 2021 10:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] move stories to TS #223

[Feature] move stories to TS #223

joshuaellis commented Jan 9, 2021 •

edited by gsimone

Loading

joshuaellis Jan 9, 2021

joshuaellis Jan 9, 2021

joshuaellis Jan 9, 2021

joshuaellis commented Jan 11, 2021

joshuaellis commented Jan 11, 2021

joshuaellis commented Jan 12, 2021

gsimone commented Jan 12, 2021

joshuaellis commented Jan 12, 2021

joshuaellis commented Jan 14, 2021

vercel bot commented Jan 15, 2021 •

edited

Loading

codesandbox-ci bot commented Jan 15, 2021

[Feature] move stories to TS #223

[Feature] move stories to TS #223

Conversation

joshuaellis commented Jan 9, 2021 • edited by gsimone Loading

What

Why

Other

joshuaellis Jan 9, 2021

Choose a reason for hiding this comment

joshuaellis Jan 9, 2021

Choose a reason for hiding this comment

joshuaellis Jan 9, 2021

Choose a reason for hiding this comment

joshuaellis commented Jan 11, 2021

joshuaellis commented Jan 11, 2021

joshuaellis commented Jan 12, 2021

gsimone commented Jan 12, 2021

joshuaellis commented Jan 12, 2021

joshuaellis commented Jan 14, 2021

vercel bot commented Jan 15, 2021 • edited Loading

codesandbox-ci bot commented Jan 15, 2021

joshuaellis commented Jan 9, 2021 •

edited by gsimone

Loading

vercel bot commented Jan 15, 2021 •

edited

Loading