Commit Graph

10 Commits (ffd037dfa8e390a1a18e47aebcab4b1e17f1da19)

Author SHA1 Message Date
Travis Ralston 20a615396b Implementation of new potential skinning mechanism
With a switch to Only One Webpack™ we need a way to help developers generate the component index without a concurrent watch task. The best way to do this is to have developers import their components, but how do they do that when we support skins? The answer in this commit is to change skinning.

Skinning now expects to receive your list of overrides instead of the react-sdk+branded components. For Riot this means we send over *only* the Vector components and not Vector+react-sdk. 

Components can then be annotated with the `replaceComponent` decorator to have them be skinnable. The decorator must take a string with the dot path of the component because we can't reliably calculate it ourselves, sadly. 

The decorator does a call to `getComponent` which is where the important part of the branded components not including the react-sdk is important: if the branded app includes the react-sdk then the decorator gets executed before the skin has finished loading, leading to all kinds of fun errors. This is also why the skinner lazily loads the react-sdk components to avoid importing them too early, breaking the app.

The decorator will end up receiving null for a component because of the getComponent loop mentioned: the require() call is still in progress when the decorator is called, therefore we can't error out. All usages of getComponent() within the app are safe to not need such an error (the return won't be null, and developers shouldn't use getComponent() after this commit anyways).

The AuthPage, being a prominent component, has been converted to demonstrate this working. Changes to riot-web are required to have this work.

The reskindex script has also been altered to reflect these skinning changes - it no longer should set the react-sdk as a parent. The eventual end goal is to get rid of `getComponent()` entirely as it'll be easily replaced by imports.
2019-12-12 19:48:45 -07:00
Richard van der Hoff 4df51a2b0b Reskindex to a temp file, to confuse the babel watcher less (#908)
I'm seeing a lot of instances where the babel watcher picks up a half-written src/component-index,
and generates an empty lib file - which it then doesn't update when src/component-index is updated.

Empirically, this seems to make it better.
2017-05-19 11:44:04 +01:00
Luke Barnard 15201d86aa Prevent reskindex -w from running when file names have not changed 2017-05-15 10:16:47 +01:00
Luke Barnard 9af9603373 Only watch indexed files 2017-05-08 16:29:53 +01:00
Luke Barnard 2eaaa97451 Give `reskindex.js` a watch mode (-w)
`scripts/reskindex.js -w` will run reskindex in watch mode whereby FS events will cause a reskindex to occur.

This depends on `chokidar`
2017-05-08 15:07:05 +01:00
David Baker 923d2264dd Ignore components with no default export
InteractiveAuthEntryComponents is not a single component and
doesn't really fit into the structure: ignore it, otherwise
we crash when loading the skin.
2016-10-17 16:24:09 +01:00
David Baker 0931f746d8 Move scripts into scripts/ 2016-10-17 16:23:27 +01:00
David Baker 5b4b81f7dc Revert "Switch to babel 6" 2016-10-14 18:49:52 +01:00
David Baker 1336fe7490 Ignore components with no default export
InteractiveAuthEntryComponents is not a single component and
doesn't really fit into the structure: ignore it, otherwise
we crash when loading the skin.
2016-10-13 10:36:11 +01:00
David Baker 89ca18b556 Move scripts into scripts/ 2016-10-13 09:45:07 +01:00