refactor: rename encodeable to encodable (apache#214)

zhaoyongjie · Nov 26, 2021 · 7467962 · 7467962
1 parent 024b318
commit 7467962
Show file tree

Hide file tree

Showing 55 changed files with 35 additions and 34 deletions.
diff --git a/superset-frontend/temporary_superset_ui/superset-ui/CHANGELOG.md b/superset-frontend/temporary_superset_ui/superset-ui/CHANGELOG.md
@@ -28,7 +28,7 @@
 
 * add control panel support to chart plugin ([#203](https://github.com/apache-superset/superset-ui/issues/203)) ([920d389](https://github.com/apache-superset/superset-ui/commit/920d389))
 * add functions for parsing formatters from encoding ([#205](https://github.com/apache-superset/superset-ui/issues/205)) ([8906aa0](https://github.com/apache-superset/superset-ui/commit/8906aa0))
-* Add types and type guards for encodeable ([#201](https://github.com/apache-superset/superset-ui/issues/201)) ([6cff25f](https://github.com/apache-superset/superset-ui/commit/6cff25f))
+* Add types and type guards for encodable ([#201](https://github.com/apache-superset/superset-ui/issues/201)) ([6cff25f](https://github.com/apache-superset/superset-ui/commit/6cff25f))
 
 
 ### BREAKING CHANGES

diff --git a/...tend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/README.md b/...tend/temporary_superset_ui/superset-ui/packages/superset-ui-encodable/README.md
@@ -0,0 +1,24 @@
+## @superset-ui/encodable
+
+[![Version](https://img.shields.io/npm/v/@superset-ui/encodable.svg?style=flat)](https://img.shields.io/npm/v/@superset-ui/encodable.svg?style=flat)
+[![David (path)](https://img.shields.io/david/apache-superset/superset-ui.svg?path=packages%2Fsuperset-ui-encodable&style=flat-square)](https://david-dm.org/apache-superset/superset-ui?path=packages/superset-ui-encodable)
+
+This package provides standardized API for encodable components and adopts the grammar from `vega-lite` grammar and copy their logic for determining  smart defaults (e.g. choosing scale type based on data type, etc.)
+In addition, it leverages sibling `superset-ui` packages to use the number and time formatters as well as color scales.
+
+#### Example usage
+
+```js
+import { xxx } from '@superset-ui/encodable';
+```
+
+#### API
+
+`fn(args)`
+
+- Do something
+
+### Development
+
+`@data-ui/build-config` is used to manage the build configuration for this package including babel
+builds, jest testing, eslint, and prettier.
diff --git a/...kages/superset-ui-encodeable/package.json → ...ckages/superset-ui-encodable/package.json b/...kages/superset-ui-encodeable/package.json → ...ckages/superset-ui-encodable/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@superset-ui/encodeable",
+  "name": "@superset-ui/encodable",
   "version": "0.12.1",
-  "description": "Superset UI encodeable",
+  "description": "Superset UI encodable",
   "sideEffects": false,
   "main": "lib/index.js",
   "module": "esm/index.js",

diff --git a/...kages/superset-ui-encodeable/src/index.ts → ...ckages/superset-ui-encodable/src/index.ts b/...kages/superset-ui-encodeable/src/index.ts → ...ckages/superset-ui-encodable/src/index.ts
diff --git a/...src/parsers/createGetterFromChannelDef.ts → ...src/parsers/createGetterFromChannelDef.ts b/...src/parsers/createGetterFromChannelDef.ts → ...src/parsers/createGetterFromChannelDef.ts
diff --git a/.../parsers/createFormatterFromChannelDef.ts → ...s/format/createFormatterFromChannelDef.ts b/.../parsers/createFormatterFromChannelDef.ts → ...s/format/createFormatterFromChannelDef.ts
@@ -1,5 +1,5 @@
-import { ChannelDef } from '../types/ChannelDef';
-import { isTypedFieldDef } from '../typeGuards/ChannelDef';
+import { ChannelDef } from '../../types/ChannelDef';
+import { isTypedFieldDef } from '../../typeGuards/ChannelDef';
 import fallbackFormatter from './fallbackFormatter';
 import createFormatterFromFieldTypeAndFormat from './createFormatterFromFieldTypeAndFormat';
 

diff --git a/.../createFormatterFromFieldTypeAndFormat.ts → .../createFormatterFromFieldTypeAndFormat.ts b/.../createFormatterFromFieldTypeAndFormat.ts → .../createFormatterFromFieldTypeAndFormat.ts
@@ -1,7 +1,7 @@
 import { getNumberFormatter } from '@superset-ui/number-format';
 import { getTimeFormatter } from '@superset-ui/time-format';
-import { Type } from '../types/VegaLite';
-import { Formatter } from '../types/ChannelDef';
+import { Type } from '../../types/VegaLite';
+import { Formatter } from '../../types/ChannelDef';
 import fallbackFormatter from './fallbackFormatter';
 
 export default function createFormatterFromFieldTypeAndFormat(

diff --git a/...codeable/src/parsers/fallbackFormatter.ts → ...e/src/parsers/format/fallbackFormatter.ts b/...codeable/src/parsers/fallbackFormatter.ts → ...e/src/parsers/format/fallbackFormatter.ts
diff --git a/...i-encodeable/src/parsers/parseDateTime.ts → ...ui-encodable/src/parsers/parseDateTime.ts b/...i-encodeable/src/parsers/parseDateTime.ts → ...ui-encodable/src/parsers/parseDateTime.ts
diff --git a/...ncodeable/src/parsers/scale/applyAlign.ts → ...encodable/src/parsers/scale/applyAlign.ts b/...ncodeable/src/parsers/scale/applyAlign.ts → ...encodable/src/parsers/scale/applyAlign.ts
diff --git a/...ncodeable/src/parsers/scale/applyClamp.ts → ...encodable/src/parsers/scale/applyClamp.ts b/...ncodeable/src/parsers/scale/applyClamp.ts → ...encodable/src/parsers/scale/applyClamp.ts
diff --git a/...codeable/src/parsers/scale/applyDomain.ts → ...ncodable/src/parsers/scale/applyDomain.ts b/...codeable/src/parsers/scale/applyDomain.ts → ...ncodable/src/parsers/scale/applyDomain.ts
diff --git a/...ble/src/parsers/scale/applyInterpolate.ts → ...ble/src/parsers/scale/applyInterpolate.ts b/...ble/src/parsers/scale/applyInterpolate.ts → ...ble/src/parsers/scale/applyInterpolate.ts
diff --git a/...encodeable/src/parsers/scale/applyNice.ts → ...-encodable/src/parsers/scale/applyNice.ts b/...encodeable/src/parsers/scale/applyNice.ts → ...-encodable/src/parsers/scale/applyNice.ts
diff --git a/...odeable/src/parsers/scale/applyPadding.ts → ...codable/src/parsers/scale/applyPadding.ts b/...odeable/src/parsers/scale/applyPadding.ts → ...codable/src/parsers/scale/applyPadding.ts
diff --git a/...ncodeable/src/parsers/scale/applyRange.ts → ...encodable/src/parsers/scale/applyRange.ts b/...ncodeable/src/parsers/scale/applyRange.ts → ...encodable/src/parsers/scale/applyRange.ts
diff --git a/...ncodeable/src/parsers/scale/applyRound.ts → ...encodable/src/parsers/scale/applyRound.ts b/...ncodeable/src/parsers/scale/applyRound.ts → ...encodable/src/parsers/scale/applyRound.ts
diff --git a/...encodeable/src/parsers/scale/applyZero.ts → ...-encodable/src/parsers/scale/applyZero.ts b/...encodeable/src/parsers/scale/applyZero.ts → ...-encodable/src/parsers/scale/applyZero.ts
diff --git a/...rsers/scale/createScaleFromScaleConfig.ts → ...rsers/scale/createScaleFromScaleConfig.ts b/...rsers/scale/createScaleFromScaleConfig.ts → ...rsers/scale/createScaleFromScaleConfig.ts
diff --git a/...parsers/scale/createScaleFromScaleType.ts → ...parsers/scale/createScaleFromScaleType.ts b/...parsers/scale/createScaleFromScaleType.ts → ...parsers/scale/createScaleFromScaleType.ts
diff --git a/...rs/scale/getScaleCategoryFromScaleType.ts → ...rs/scale/getScaleCategoryFromScaleType.ts b/...rs/scale/getScaleCategoryFromScaleType.ts → ...rs/scale/getScaleCategoryFromScaleType.ts
diff --git a/...eable/src/parsers/scale/inferScaleType.ts → ...dable/src/parsers/scale/inferScaleType.ts b/...eable/src/parsers/scale/inferScaleType.ts → ...dable/src/parsers/scale/inferScaleType.ts
diff --git a/...s/scale/isPropertySupportedByScaleType.ts → ...s/scale/isPropertySupportedByScaleType.ts b/...s/scale/isPropertySupportedByScaleType.ts → ...s/scale/isPropertySupportedByScaleType.ts
diff --git a/...able/src/parsers/scale/scaleCategories.ts → ...able/src/parsers/scale/scaleCategories.ts b/...able/src/parsers/scale/scaleCategories.ts → ...able/src/parsers/scale/scaleCategories.ts
diff --git a/...rset-ui-encodeable/src/typeGuards/Base.ts → ...erset-ui-encodable/src/typeGuards/Base.ts b/...rset-ui-encodeable/src/typeGuards/Base.ts → ...erset-ui-encodable/src/typeGuards/Base.ts
diff --git a/...i-encodeable/src/typeGuards/ChannelDef.ts → ...ui-encodable/src/typeGuards/ChannelDef.ts b/...i-encodeable/src/typeGuards/ChannelDef.ts → ...ui-encodable/src/typeGuards/ChannelDef.ts
diff --git a/...set-ui-encodeable/src/typeGuards/Scale.ts → ...rset-ui-encodable/src/typeGuards/Scale.ts b/...set-ui-encodeable/src/typeGuards/Scale.ts → ...rset-ui-encodable/src/typeGuards/Scale.ts
diff --git a/.../superset-ui-encodeable/src/types/Axis.ts → ...s/superset-ui-encodable/src/types/Axis.ts b/.../superset-ui-encodeable/src/types/Axis.ts → ...s/superset-ui-encodable/src/types/Axis.ts
diff --git a/.../superset-ui-encodeable/src/types/Base.ts → ...s/superset-ui-encodable/src/types/Base.ts b/.../superset-ui-encodeable/src/types/Base.ts → ...s/superset-ui-encodable/src/types/Base.ts
diff --git a/...perset-ui-encodeable/src/types/Channel.ts → ...uperset-ui-encodable/src/types/Channel.ts b/...perset-ui-encodeable/src/types/Channel.ts → ...uperset-ui-encodable/src/types/Channel.ts
diff --git a/...set-ui-encodeable/src/types/ChannelDef.ts → ...rset-ui-encodable/src/types/ChannelDef.ts b/...set-ui-encodeable/src/types/ChannelDef.ts → ...rset-ui-encodable/src/types/ChannelDef.ts
diff --git a/.../superset-ui-encodeable/src/types/Data.ts → ...s/superset-ui-encodable/src/types/Data.ts b/.../superset-ui-encodeable/src/types/Data.ts → ...s/superset-ui-encodable/src/types/Data.ts
diff --git a/...uperset-ui-encodeable/src/types/Legend.ts → ...superset-ui-encodable/src/types/Legend.ts b/...uperset-ui-encodeable/src/types/Legend.ts → ...superset-ui-encodable/src/types/Legend.ts
diff --git a/...superset-ui-encodeable/src/types/Scale.ts → .../superset-ui-encodable/src/types/Scale.ts b/...superset-ui-encodeable/src/types/Scale.ts → .../superset-ui-encodable/src/types/Scale.ts
@@ -48,7 +48,7 @@ export interface CombinedScaleConfig<Output extends Value = Value>
   /**
    * name of the color scheme.
    * vega-lite also support SchemeParams object
-   * but encodeable only accepts string at the moment
+   * but encodable only accepts string at the moment
    */
   scheme?: string;
   /**

diff --git a/...erset-ui-encodeable/src/types/VegaLite.ts → ...perset-ui-encodable/src/types/VegaLite.ts b/...erset-ui-encodeable/src/types/VegaLite.ts → ...perset-ui-encodable/src/types/VegaLite.ts
diff --git a/...erset-ui-encodeable/src/utils/identity.ts → ...perset-ui-encodable/src/utils/identity.ts b/...erset-ui-encodeable/src/utils/identity.ts → ...perset-ui-encodable/src/utils/identity.ts
diff --git a/.../inferElementTypeFromUnionOfArrayTypes.ts → .../inferElementTypeFromUnionOfArrayTypes.ts b/.../inferElementTypeFromUnionOfArrayTypes.ts → .../inferElementTypeFromUnionOfArrayTypes.ts
diff --git a/...set-ui-encodeable/src/utils/isDisabled.ts → ...rset-ui-encodable/src/utils/isDisabled.ts b/...set-ui-encodeable/src/utils/isDisabled.ts → ...rset-ui-encodable/src/utils/isDisabled.ts
diff --git a/...rset-ui-encodeable/src/utils/isEnabled.ts → ...erset-ui-encodable/src/utils/isEnabled.ts b/...rset-ui-encodeable/src/utils/isEnabled.ts → ...erset-ui-encodable/src/utils/isEnabled.ts
diff --git a/...arsers/createGetterFromChannelDef.test.ts → ...arsers/createGetterFromChannelDef.test.ts b/...arsers/createGetterFromChannelDef.test.ts → ...arsers/createGetterFromChannelDef.test.ts
diff --git a/...ers/createFormatterFromChannelDef.test.ts → ...mat/createFormatterFromChannelDef.test.ts b/...ers/createFormatterFromChannelDef.test.ts → ...mat/createFormatterFromChannelDef.test.ts
@@ -1,4 +1,4 @@
-import createFormatterFromChannelDef from '../../src/parsers/createFormatterFromChannelDef';
+import createFormatterFromChannelDef from '../../../src/parsers/format/createFormatterFromChannelDef';
 
 describe('createFormatterFromChannelDef(type, format)', () => {
   it('handles when format is defined', () => {

diff --git a/...teFormatterFromFieldTypeAndFormat.test.ts → ...teFormatterFromFieldTypeAndFormat.test.ts b/...teFormatterFromFieldTypeAndFormat.test.ts → ...teFormatterFromFieldTypeAndFormat.test.ts
@@ -1,4 +1,4 @@
-import createFormatterFromFieldTypeAndFormat from '../../src/parsers/createFormatterFromFieldTypeAndFormat';
+import createFormatterFromFieldTypeAndFormat from '../../../src/parsers/format/createFormatterFromFieldTypeAndFormat';
 
 describe('createFormatterFromFieldTypeAndFormat(type, format)', () => {
   it('handles quantitative field type', () => {

diff --git a/...le/test/parsers/fallbackFormatter.test.ts → .../parsers/format/fallbackFormatter.test.ts b/...le/test/parsers/fallbackFormatter.test.ts → .../parsers/format/fallbackFormatter.test.ts
@@ -1,4 +1,4 @@
-import fallbackFormatter from '../../src/parsers/fallbackFormatter';
+import fallbackFormatter from '../../../src/parsers/format/fallbackFormatter';
 
 describe('fallbackFormatter(v: any)', () => {
   it('handles primitive types', () => {

diff --git a/...deable/test/parsers/parseDateTime.test.ts → ...odable/test/parsers/parseDateTime.test.ts b/...deable/test/parsers/parseDateTime.test.ts → ...odable/test/parsers/parseDateTime.test.ts
diff --git a/.../scale/createScaleFromScaleConfig.test.ts → .../scale/createScaleFromScaleConfig.test.ts b/.../scale/createScaleFromScaleConfig.test.ts → .../scale/createScaleFromScaleConfig.test.ts
diff --git a/...ale/getScaleCategoryFromScaleType.test.ts → ...ale/getScaleCategoryFromScaleType.test.ts b/...ale/getScaleCategoryFromScaleType.test.ts → ...ale/getScaleCategoryFromScaleType.test.ts
diff --git a/...test/parsers/scale/inferScaleType.test.ts → ...test/parsers/scale/inferScaleType.test.ts b/...test/parsers/scale/inferScaleType.test.ts → ...test/parsers/scale/inferScaleType.test.ts
diff --git a/...le/isPropertySupportedByScaleType.test.ts → ...le/isPropertySupportedByScaleType.test.ts b/...le/isPropertySupportedByScaleType.test.ts → ...le/isPropertySupportedByScaleType.test.ts
diff --git a/...i-encodeable/test/typeGuards/Base.test.ts → ...ui-encodable/test/typeGuards/Base.test.ts b/...i-encodeable/test/typeGuards/Base.test.ts → ...ui-encodable/test/typeGuards/Base.test.ts
diff --git a/...deable/test/typeGuards/ChannelDef.test.ts → ...odable/test/typeGuards/ChannelDef.test.ts b/...deable/test/typeGuards/ChannelDef.test.ts → ...odable/test/typeGuards/ChannelDef.test.ts
diff --git a/...-encodeable/test/typeGuards/Scale.test.ts → ...i-encodable/test/typeGuards/Scale.test.ts b/...-encodeable/test/typeGuards/Scale.test.ts → ...i-encodable/test/typeGuards/Scale.test.ts
diff --git a/...ui-encodeable/test/utils/identity.test.ts → ...-ui-encodable/test/utils/identity.test.ts b/...ui-encodeable/test/utils/identity.test.ts → ...-ui-encodable/test/utils/identity.test.ts
diff --git a/...-encodeable/test/utils/isDisabled.test.ts → ...i-encodable/test/utils/isDisabled.test.ts b/...-encodeable/test/utils/isDisabled.test.ts → ...i-encodable/test/utils/isDisabled.test.ts
diff --git a/...i-encodeable/test/utils/isEnabled.test.ts → ...ui-encodable/test/utils/isEnabled.test.ts b/...i-encodeable/test/utils/isEnabled.test.ts → ...ui-encodable/test/utils/isEnabled.test.ts
diff --git a/...end/temporary_superset_ui/superset-ui/packages/superset-ui-encodeable/README.md b/...end/temporary_superset_ui/superset-ui/packages/superset-ui-encodeable/README.md