Skip to content

Commit e274d2e

Browse files
chenesanchenesan
authored
Merge pull request #26 from iCHEF/release/0.0.2
Release/0.0.2
2 parents e7cc1d9 + 0627ad2 commit e274d2e

File tree

90 files changed

+11782
-768
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+11782
-768
lines changed

‎.editorconfig‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
# Unix-style newlines with a newline ending every file
8+
charset = utf-8
9+
indent_size = 2
10+
indent_style = space
11+
end_of_line = lf
12+
insert_final_newline = true
13+
trim_trailing_whitespace = true
14+
15+
[*.json]
16+
indent_size = 2
17+
18+
[*.js]
19+
trim_trailing_whitespace = true

‎.github/main.workflow‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
workflow "Push workflow" {
2+
on = "push"
3+
resolves = ["type-check"]
4+
}
5+
6+
action "install" {
7+
uses = "borales/actions-yarn@master"
8+
args = "install"
9+
}
10+
11+
action "type-check" {
12+
uses = "borales/actions-yarn@master"
13+
needs = ["install"]
14+
args = "type-check"
15+
}

‎.github/pull_request_template.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Purpose
2+
3+
Added a new Awesome feature? Fixed an annoying bug? Made this repo better?
4+
5+
Showing GIF for FE changes will be awesome.
6+
Links to API doc on Spotlight is cool too.
7+
8+
# Changes
9+
10+
- What has been done
11+
- Maybe some code change
12+
13+
# Screenshots
14+
15+
Please provide some screenshots if there are some notable changes to the UI.
16+
17+
# Risks
18+
19+
Usually, there are none, if you have any please write them down.
20+
21+
# TODOs
22+
23+
- [ ] Describe what should be done outside of this PR
24+
- [ ] Maybe in other PRs or some manual actions.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ build/
77
deploy/
88
public/
99
tmp/
10+
.docz/
1011
.cache/
1112
.DS_Store
1213
*-debug.log

‎.prettierrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"singleQuote": true,
3+
"trailingComma": "es5"
4+
}

‎CHANGELOG.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [0.0.2]
10+
11+
### Added
12+
- Add Apache License. (#23)
13+
- Add release script. (#21)
14+
- Add auto type check with github action. (#20)
15+
- Add webpack bundle build. (#19)
16+
- Add `test` and `test:watch` scripts in root directory and every single package.(#17)
17+
- Add `jest`, `ts-jest`, `enzyme`, `enzyme-adapter-react-16` dependency.(#17)
18+
- Add a sample test of `ResponsiveLayer`. (#17)
19+
- Add a custom effect `useChartDimensions` to calculate the outer and inner dimension of the chart. (#16)
20+
- Add `useCartesianEncodings` to calculate the processed data and the visual encodings that we need in order to draw the graph. (#16)
21+
- Add a <SvgWithAxisFrame> component to deal with the size of the chart container, SVG, and the axes that generally used across different charts. (#16)
22+
- Add `type-check` and `type-check:watch` script in package.json. (#15)
23+
- Add legend setting in color encoding and show `<Legend>` in `<LineChart>`. (#14)
24+
- Add `getColorScale` to receive color encoding in charts. (#11)
25+
- Extract the animation frame controls as a custom effect hook. (#10)
26+
- Add `tslint-react-hooks` rules to lint React Hooks. (#8)
27+
- Add `ThemeProvider` and color / xy axis themes config for customize theme. (#6)
28+
- Create an animation package, and add a simple SVG clipping animation: `<AnimatedClipRect>`. (#4)
29+
- Add `<HoverLayer>` to reuse the hovering interactions logic across different graphs. (#3)
30+
- Add the tooltip and hovered effects in `<LineChart>`. (#3)
31+
- Add the hovering information in `<DataLayer>`. (#3)
32+
- Add `getSelectorsByField` in `<DataLayer>` to select and convert the data value in a record. (#3)
33+
- Add a simple `<LineChart>`. (#2)
34+
- Add `<DataLayer>` to reuse the data calculations (such as domain and range computations) logic. (#2)
35+
- Add `<AxisLayer>` to reuse the axes on the charts. (#2)
36+
- Sets up the development environment for developing React components using `Typescript`. (#1)
37+
- Integrates the `docz` documentation system to develop the graphics components and help developers use the library we develop. (#1)
38+
- Makes simple components such as `<Foo>` and `<ResponsiveLayer>` as an experiment to see if the project settings go well. (#1)
39+
40+
# Changed
41+
- Reset `private: true` in root package.json. (#24)
42+
- Remove author field in package.json. (#23)
43+
- Replace `lodash-es` with `lodash`.(#17)
44+
- Remove `selectors` from `AxisScale` and `ColorScale`. (#16)
45+
- Modify the config of `tslint` so that it won't continuing warning about the lack of dangling commas in functions. (#16)
46+
- Fix `HoverLayer` default props. (#14)
47+
- Fix color too light / deep with ordinal data field. (#14)
48+
- Rewrite `<HoverLayer>` using Hooks. (#10)
49+
- Remove `AxisConfig` type. Add new `Encoding` (`AxisEncoding`) and `Scale` (`AxisScale`) type for `getAxisScale`. (#9)
50+
- Replace `fieldX` `fieldY` `scaleX` `scaleY` with `x` and `y` props in `LineChart`. (#9)
51+
- Rewrite functionality of `<DataLayer>` by hooks. (#9)
52+
- Use Hooks to rewrite functionalities of `<ResponsiveLayer>`. (#8)
53+
- Refactor the way getting width and height in `<LineChart>`. (#8)
54+
- Fix `yarn lint` command. (#7)
55+
- Upgrade React to 16.8. (#4)
56+
- Upgrade react-spring to the latest version which uses hooks. (#4)

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2017 iCHEF Co., Ltd.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# transchart
2-
Chart library built with React
1+
# Transchart
2+
3+
`Transchart` is a highly customizable React data visualization library made by iCHEF.
4+
5+
It provides:
6+
* Ready-to-use charts
7+
* Composable `layers` to make the custom charts that suit your needs.
8+
9+
10+
## Develop
11+
12+
To install all dependencies before you start, simply run `yarn install`.
13+
14+
To run the `docs` and start developing the graph components, use the `yarn start` script.
15+
16+
### Releasing
17+
18+
Steps:
19+
20+
1. Create a release branch release/x.y.z
21+
22+
2. (Optionally) release beta builds with yarn release:beta.
23+
24+
3. Bump version for package.json and CHANGELOG.
25+
26+
4. Bump children packages version with script:
27+
28+
```
29+
yarn bumpversion
30+
```
31+
32+
This will run `lerna version`, which updates all package.json files in packages/.
33+
34+
5. Commit above changes, then create a pull request for this release branch.
35+
36+
6. Once it's merged into master, run `yarn release` to manually release. (TODO: add auto release when merged into master on github)
37+
38+
7. Backport changes from master back to develop by creating a backport/x.y.y branch and create a pull request for that.
39+
40+
## LICENSE
41+
42+
This project is licensed under the terms of the [Apache License 2.0](https://github.com/iCHEF/transcharts/blob/develop/LICENSE).

‎config/jest.config.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
module.exports = {
2+
preset: 'ts-jest',
3+
testEnvironment: 'node',
4+
globals: {
5+
'ts-jest': {
6+
tsConfig: '<rootDir>/config/tsconfig.base.json',
7+
},
8+
},
9+
setupFilesAfterEnv: ['<rootDir>/setupTests.js'],
10+
rootDir: '../',
11+
};

0 commit comments

Comments
 (0)