feat: Add types and type guards for encodeable #201

kristw · 2019-08-13T01:10:44Z

🏆 Enhancements

Add new package @superset-ui/encodeable
Add basic types and type guards with new unit tests for type guards. (Migrated from @superset-ui-plugins/preset-chart-xy. This is a subset original work from feat: add encodeable utilities for chart superset-ui-plugins#15 + revision + unit tests

Define encoding config for a visualization

Each visualization has one or more channels that can be encoded, such as x, y, color, stroke, fill. These channels configurations should be consistent/sharable across all visualizations. For example, x and y usually have scales and axes. Scales have domain, range. Axes have label, format. Color can support categorical, sequential or fixed color. All channels can support fixed value, field name in the data, or sometimes aggregates (haven't implemented the aggregate yet).

Each encoding channel config is based on vega-lite encoding grammar. (See line chart example, vega-lite encoding documentation)

Only adopt a small subset of vega-lite encoding grammar for now as we don’t have enough time (and may not intend) to provide 100% feature of vega-lite.

🏠 Internal

The package is currently marked as private until completion.

codecov · 2019-08-13T01:16:23Z

Codecov Report

Merging #201 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #201      +/-   ##
==========================================
+ Coverage   99.91%   99.92%   +<.01%     
==========================================
  Files         102      107       +5     
  Lines        1222     1252      +30     
  Branches      293      309      +16     
==========================================
+ Hits         1221     1251      +30     
  Partials        1        1

Impacted Files	Coverage Δ
...ages/superset-ui-encodeable/src/utils/isEnabled.ts	`100% <100%> (ø)`
...ges/superset-ui-encodeable/src/utils/isDisabled.ts	`100% <100%> (ø)`
...ages/superset-ui-encodeable/src/typeGuards/Base.ts	`100% <100%> (ø)`
...uperset-ui-encodeable/src/typeGuards/ChannelDef.ts	`100% <100%> (ø)`
...kages/superset-ui-encodeable/src/utils/identity.ts	`100% <100%> (ø)`
...ckages/superset-ui-chart/src/models/ChartPlugin.ts	`100% <0%> (ø)`	⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 920d389...b06e9eb. Read the comment docs.

netlify · 2019-08-13T01:17:09Z

Deploy preview for superset-ui ready!

Built with commit cc9c369

https://deploy-preview-201--superset-ui.netlify.com

netlify · 2019-08-13T01:23:30Z

Deploy preview for superset-ui ready!

Built with commit b06e9eb

https://deploy-preview-201--superset-ui.netlify.com

williaster

LGTM overall! had a couple of small comments. Thanks for refactoring this to a new package!

williaster · 2019-08-14T16:21:09Z

packages/superset-ui-encodeable/src/index.ts

@@ -0,0 +1,2 @@
+const x = 1;


is this intentional?

It was templated. Now removed.

williaster · 2019-08-14T16:28:38Z

packages/superset-ui-encodeable/src/types/ChannelDef.ts

+  | TextFieldDef;
+
+/** Channel definitions that are not constant value */
+export type NonValueDef<Output extends Value = Value> = Exclude<


NonConstantValueDef for more clear naming?

There is ValueDef and this one is the opposite of it.

williaster · 2019-08-14T16:29:17Z

packages/superset-ui-encodeable/src/types/Inherit.ts

@@ -0,0 +1,6 @@
+// Types directly imported from vega-lite
+
+export { ValueDef, Value } from 'vega-lite/build/src/channeldef';


types/Vegalite.ts is more clear to me when seeing these imports elsewhere

williaster · 2019-08-14T16:30:10Z

packages/superset-ui-encodeable/test/index.test.ts

@@ -0,0 +1,5 @@
+describe('My Test', () => {


also not sure if you still need this one?

* NPM link docs (hat tip to Krist) * formatting changes in prior commit

kristw requested a review from a team as a code owner August 13, 2019 01:10

pull-request-size bot added the size/L label Aug 13, 2019

kristw added the WIP Work in progress label Aug 13, 2019

kristw added reviewable Ready for review and removed WIP Work in progress labels Aug 13, 2019

williaster approved these changes Aug 14, 2019

View reviewed changes

kristw added 5 commits August 14, 2019 10:15

feat: scaffold superset-ui-encodeable

b76edf9

feat: add type and typeguards

e0c50c0

fix: remove unused

5883880

docs: update comments

121b084

fix: address comments

b06e9eb

kristw force-pushed the kristw--encodeable branch from 9c06c34 to b06e9eb Compare August 14, 2019 17:37

kristw merged commit 6cff25f into master Aug 14, 2019

delete-merged-branch bot deleted the kristw--encodeable branch August 14, 2019 18:45

kristw pushed a commit that referenced this pull request Apr 17, 2020

docs: add npm link documentation for local development (#201)

323a995

* NPM link docs (hat tip to Krist) * formatting changes in prior commit

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add types and type guards for encodeable #201

feat: Add types and type guards for encodeable #201

kristw commented Aug 13, 2019 •

edited

Loading

codecov bot commented Aug 13, 2019 •

edited

Loading

netlify bot commented Aug 13, 2019

netlify bot commented Aug 13, 2019 •

edited

Loading

williaster left a comment

williaster Aug 14, 2019

kristw Aug 14, 2019

williaster Aug 14, 2019

kristw Aug 14, 2019

williaster Aug 14, 2019

williaster Aug 14, 2019

kristw Aug 14, 2019

		@@ -0,0 +1,6 @@
		// Types directly imported from vega-lite

		export { ValueDef, Value } from 'vega-lite/build/src/channeldef';

feat: Add types and type guards for encodeable #201

feat: Add types and type guards for encodeable #201

Conversation

kristw commented Aug 13, 2019 • edited Loading

Define encoding config for a visualization

codecov bot commented Aug 13, 2019 • edited Loading

Codecov Report

netlify bot commented Aug 13, 2019

netlify bot commented Aug 13, 2019 • edited Loading

williaster left a comment

Choose a reason for hiding this comment

williaster Aug 14, 2019

Choose a reason for hiding this comment

kristw Aug 14, 2019

Choose a reason for hiding this comment

williaster Aug 14, 2019

Choose a reason for hiding this comment

kristw Aug 14, 2019

Choose a reason for hiding this comment

williaster Aug 14, 2019

Choose a reason for hiding this comment

williaster Aug 14, 2019

Choose a reason for hiding this comment

kristw Aug 14, 2019

Choose a reason for hiding this comment

kristw commented Aug 13, 2019 •

edited

Loading

codecov bot commented Aug 13, 2019 •

edited

Loading

netlify bot commented Aug 13, 2019 •

edited

Loading