Skip to content

Commit

Permalink
feat(build)!: pretty much complete overhaul (#88)
Browse files Browse the repository at this point in the history
* feat(build)!: pretty much complete overhaul

BREAKING CHANGE: This is no longer a drop in replacement for the old
4.21 Vis.js.

This brings this project inline with our other packages (except for TS
support, there is none).

I also removed the notice about this being a drop in replacement for the
old Vis and broke backwards compatibility by simply reexporting up to
date packages. I don't have the time to manage backwards compatibility
here and I don't even think it's worth it at all.

All the issues that have accumulated over the past 7 months (since the
last release) are resolved here.

* feat(build)!: use a compromise solution

BREAKING CHANGE: This basically reverts the most breaking parts of the
previosly commited overhaul.

Use a compromise solution between backwards compatibility and easy of
maintenance. The old exports are restored and so is the file listing in
the package. However the libraries themselves may still introduce
breaking changes in their features etc.

* chore(readmy): update copyright

It's 2020 already.

* chore(readme): use latest in usage

This way people will hopefully pick the latest version instead of
blindly copypasting 1.0.0.

* fix(build): also restore DOMutil
  • Loading branch information
Thomaash authored May 17, 2020
1 parent 9b3ed16 commit 5fc2cb2
Show file tree
Hide file tree
Showing 49 changed files with 9,077 additions and 84,741 deletions.
7 changes: 0 additions & 7 deletions .babelrc

This file was deleted.

15 changes: 14 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,16 @@ jobs:
- persist_to_workspace:
root: .
paths:
- 'dist'
- dist

test:
executor: node

steps:
- attach_workspace:
at: .

- run: npm run generate-examples-index

release:
executor: node
Expand Down Expand Up @@ -79,6 +88,10 @@ workflows:
requires:
- prepare

- test:
requires:
- build

- release:
requires:
- prepare
Expand Down
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,12 @@ coverage/
report.*.json
vis-charts-*.tgz
/.rpt2_cache/
/declarations/
/dist/
/esnext/
/examples/examples.css
/examples/generated/
/examples/index.html
/peer/
/standalone/
/styles/
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# vis-charts

**This is a "plug'n & play replacement" for [vis](https://github.com/almende/vis), wich is no longer maintained**
**This is mostly (same export structure) a "plug'n & play replacement" for [vis](https://github.com/almende/vis), wich is no longer maintained**

Vis.js is a dynamic, browser based visualization library.
The library is designed to be easy to use, handle large amounts
Expand Down Expand Up @@ -31,19 +31,17 @@ It also includes other external libraries:

## Badges

[![Greenkeeper badge](https://badges.greenkeeper.io/visjs/vis-charts.svg)](https://greenkeeper.io/)

[![Backers on Open Collective](https://opencollective.com/visjs/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/visjs/sponsors/badge.svg)](#sponsors)

## Usage

:warning: **This library is very big and should better not be used! Please use one of the libraries from the [visjs family](//github.com/visjs) instead!**

If you really want to, you can replace your old `almende/[email protected]` files with our new one:
If you really want to, you can replace your old `almende/[email protected]` files with our new one (replace `latest` by a specific version to prevent unexpected updates):

```html
<script src="//unpkg.com/vis-charts@1.0.0/dist/vis.min.js"></script>
<link href="//unpkg.com/vis-charts@1.0.0/dist/vis.min.css" rel="stylesheet" type="text/css">
<script src="//unpkg.com/vis-charts@latest/dist/vis.min.js"></script>
<link href="//unpkg.com/vis-charts@latest/dist/vis.min.css" rel="stylesheet" type="text/css">
```

## Contribute
Expand Down Expand Up @@ -73,7 +71,8 @@ Support this project by becoming a sponsor. Your logo will show up here with a l

## License

Copyright (C) 2010-2018 Almende B.V. and Contributors
Copyright (c) 2014-2017 Almende B.V. and contributors
Copyright (c) 2017-2020 vis.js contributors

Vis.js is dual licensed under both

Expand Down
4 changes: 4 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
exclude: require("vis-dev-utils").BABEL_IGNORE_RE,
presets: [["vis-dev-utils/babel-preset", { css: true }]]
};
2 changes: 2 additions & 0 deletions declarations/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export const advice =
"Please, don't use this with TypeScript. Use the individual packages, thanks.";
Loading

0 comments on commit 5fc2cb2

Please sign in to comment.