Skip to content

Commit

Permalink
Update readme and dependencies (#1871)
Browse files Browse the repository at this point in the history
* chore(deps): bump @playwright/test, @types/node, publint, vite, vitest, react-router-dom, vue

* docs(readme): updates

* docs(readme): switch markup to html

* docs(readme): changes

* docs(core): readme update

* docs(angular,react,svelte,vue): readme update

* chore(dashboard): trim

* chore(deps): bump @carbon/react, react-router-dom, styled-components

* chore(deps): bump angular, zone.js

* chore(deps): bump eslint-plugin-jsdoc+svelte, husky, vue

* chore(deps): bump eslint-plugins, svelte-eslint-parser, lerna, jsdom, vitest, typedoc, vue-tsc

* chore(deps): bump vite, @playright, @types/node, angular, vue, typescript, @carbon/react

* chore(deps): bump eslint, husky, @types/node, @vitejs/plugin-vue

* chore(yarn): update lock

* chore(deps): bump eslint-plugin-jsdoc, husky, typescript-eslint, svelte-check, node

* chore(deps): bump eslint-plugin-jsdoc, @angular/dev-kit and cli, vitest, vue

* chore(deps): bump sveltekit, angular, typescript-eslint, @carbon packages, react-router-dom

* chore(deps): bump angular, sveltekit, vue, @carbon/react and devDependencies

* chore(deps): bump eslint, vite-plugin-dts, @types/node, @carbon/react, sveltekit, vue

* chore(deps): bump eslint-plugin-jsdoc

* chore(deps): bump typescript-eslint

* chore(deps): bump sveltekit

* chore(deps): bump lint-staged, eslint-plugin-jsdoc, move directly used types for core to dependencies

* chore(deps): yarn.lock update

* chore(deps): drop old node LTS

* chore(deps): bump dependencies

* chore(deps): bump yarn, @playright, @types/node, fix repo references, rebase tests

* chore(homepage): add where missing, consistent line
  • Loading branch information
nstuyvesant authored Aug 19, 2024
1 parent e162c52 commit 2d8666c
Show file tree
Hide file tree
Showing 24 changed files with 4,057 additions and 6,600 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
jobs:
build:
if: github.actor != 'carbon-bot' && !startsWith(github.event.head_commit.message, 'skip-release')
name: Create release - Node.js v20.15.0
name: Create release - Node.js v20.16.0
runs-on: ubuntu-latest

steps:
Expand All @@ -16,10 +16,10 @@ jobs:
with:
token: ${{ secrets.GH_TOKEN }}

- name: Use Node.js 20.15.0
- name: Use Node.js 20.16.0
uses: actions/setup-node@v4
with:
node-version: '20.15.0'
node-version: '20.16.0'

- name: Install dependencies 🔧
run: yarn install --immutable --check-cache
Expand Down
894 changes: 0 additions & 894 deletions .yarn/releases/yarn-4.3.1.cjs

This file was deleted.

925 changes: 925 additions & 0 deletions .yarn/releases/yarn-4.4.0.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-4.3.1.cjs
yarnPath: .yarn/releases/yarn-4.4.0.cjs
70 changes: 11 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
</a>
<h3 align="center">Carbon Charts</h3>
<p align="center">
A reusable framework-agnostic D3 charting library.
A component library of 26 charts for <a href="./packages/core" target="_blank">vanilla JavaScript</a>, <a href="./packages/svelte" target="_blank">Svelte</a>, <a href="./packages/react" target="_blank">React</a>, <a href="./packages/vue" target="_blank">Vue.js</a> and <a href="./packages/angular" target="_blank">Angular</a>.
<br /><br />
<a href="https://www.npmjs.com/package/@carbon/charts">
<img src="https://img.shields.io/npm/v/@carbon/charts.svg" />
</a>
<img alt="semantic-versioning" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--ver-e10079.svg" />
<img alt="semantic-versioning" src="https://img.shields.io/badge/downloads-+20k%2Fweek-green" />
<img alt="semantic-versioning" src="https://img.shields.io/badge/downloads-+60k%2Fweek-green" />
<a href="https://discord.gg/J7JEUEkTRX">
<img src="https://img.shields.io/discord/689212587170201628?color=5865F2" alt="Chat with us on Discord">
</a>
Expand All @@ -19,74 +19,26 @@

## Documentation

Includes StackBlitz examples of each chart type for Vanilla JavaScript, Svelte, React, Angular and Vue.js.
Includes StackBlitz examples of each chart type for supported frameworks.

<a href="https://charts.carbondesignsystem.com/" target="_blank">
<img src="./assets/dashboard.png" width=700 />
</a>

## Packages

- [Vanilla JavaScript](./packages/core)
- [React](./packages/react)
- [Angular](./packages/angular)
- [Svelte](./packages/svelte)
- [Vue](./packages/vue)

<a href="https://www.netlify.com" target="_blank">
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" />
</a>

## CHANGELOG

Read the release change logs [here](https://github.com/carbon-design-system/carbon-charts/releases)

## Component status

:white_check_mark: Stable :hourglass_flowing_sand: In progress

| Component | Vanilla | Angular | React | Vue | Svelte |
| -------------------- | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| Simple Bar | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Grouped Bar | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Stacked Bar | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Floating Bar | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Donut | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Line | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Curved Line | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Pie | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Step | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Scatter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Radar | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Area | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Gauge | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Meter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Sparkline | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Treemap | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Combo | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Wordcloud | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Bullet | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Circle Pack | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Network diagrams || :white_check_mark: | :white_check_mark: |||
| Proportional meter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Histogram | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Tree | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Alluvial | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Heatmap | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Choropleth | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Release change logs can be found [here](https://github.com/carbon-design-system/carbon-charts/releases).

## Bugs and feature requests

Have a bug or a feature request? First read the
Please read the
[issue guidelines](https://github.com/carbon-design-system/carbon-charts/blob/master/CONTRIBUTING.md#issue-guidelines)
and search for existing and closed issues. If your problem or idea is not addressed yet,
[open a new issue](https://github.com/carbon-design-system/carbon-charts/issues/new).
and search for existing and closed issues. If your problem or idea has not been addressed, [submit a bug report](https://github.com/carbon-design-system/carbon-charts/issues/new?assignees=&labels=bug+🐛&projects=&template=BUG_REPORT.yaml&title=%5BBug%5D%3A+) or [feature enhancement request](https://github.com/carbon-design-system/carbon-charts/issues/new?assignees=&labels=enhancement&projects=&template=ENHANCEMENT.yaml&title=%5BEnhancement%5D%3A+).

## Contributing

See our
[contributing guidelines](https://github.com/carbon-design-system/carbon-charts/blob/master/.github/CONTRIBUTING.md).
Included are instructions for opening issues, coding guidelines, and submitting pull requests.
[contributing guidelines](https://github.com/carbon-design-system/carbon-charts/blob/master/.github/CONTRIBUTING.md) - instructions for opening issues, coding guidelines, and submitting pull requests.

<!-- ## Community
Expand All @@ -97,10 +49,6 @@ Get updates on Charts' development and chat with the core team and community. --
We use the **semantic-release** library to automatically version our releases within the guidelines
of Semantic Versioning [Semantic Versioning guidelines](http://semver.org/).

See our
[release change logs](https://github.com/carbon-design-system/carbon-charts/blob/master/CHANGELOG.md)
for the changelog of each version of Charts.

## Core team

<!-- prettier-ignore -->
Expand Down Expand Up @@ -178,3 +126,7 @@ for the changelog of each version of Charts.
## Code of Conduct

Read our code of conduct [here](.github/CODE_OF_CONDUCT.md)

<a href="https://www.netlify.com" target="_blank">
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" />
</a>
Binary file modified assets/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 21 additions & 20 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,45 +16,46 @@
"packages/*"
],
"engines": {
"node": "^18.20.3 ^20.15.0 ^22.2.0"
"node": "^20.16.0 ^22.2.0"
},
"packageManager": "yarn@4.3.1",
"packageManager": "yarn@4.4.0",
"devDependencies": {
"@commitlint/cli": "^19.3.0",
"@commitlint/cli": "^19.4.0",
"@commitlint/config-conventional": "^19.2.2",
"@eslint/compat": "^1.1.1",
"@eslint/js": "^9.7.0",
"@playwright/test": "^1.45.1",
"@types/node": "^20.14.10",
"@eslint/js": "^9.9.0",
"@playwright/test": "^1.46.1",
"@types/node": "^22.4.0",
"@vue/eslint-config-prettier": "^9.0.0",
"@vue/eslint-config-typescript": "^13.0.0",
"eslint": "^9.7.0",
"eslint": "^9.9.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-jsdoc": "^48.7.0",
"eslint-plugin-prettier": "^5.1.3",
"eslint-plugin-react": "^7.34.3",
"eslint-plugin-jsdoc": "^50.2.2",
"eslint-plugin-prettier": "^5.2.1",
"eslint-plugin-react": "^7.35.0",
"eslint-plugin-react-hooks": "next",
"eslint-plugin-svelte": "^2.42.0",
"eslint-plugin-svelte": "^2.43.0",
"eslint-plugin-vue": "^9.27.0",
"globals": "^15.8.0",
"husky": "^9.0.11",
"lerna": "^8.1.6",
"lint-staged": "^15.2.7",
"globals": "^15.9.0",
"husky": "^9.1.4",
"lerna": "^8.1.8",
"lint-staged": "^15.2.9",
"prettier": "^3.3.3",
"prettier-config-carbon": "^0.11.0",
"prettier-plugin-svelte": "^3.2.5",
"prettier-plugin-svelte": "^3.2.6",
"svelte": "^4.2.18",
"svelte-eslint-parser": "^0.40.0",
"typescript": "^5.5.3",
"typescript-eslint": "^7.16.0",
"svelte-eslint-parser": "^0.41.0",
"typescript": "^5.5.4",
"typescript-eslint": "^8.1.0",
"vue-eslint-parser": "^9.4.3"
},
"release": {
"branch": "master"
},
"homepage": "https://github.com/carbon-design-system/carbon-charts#readme",
"repository": {
"type": "git",
"url": "git@github.com:carbon-design-system/carbon-charts.git"
"url": "git+https://github.com/carbon-design-system/carbon-charts.git"
},
"keywords": [
"charts",
Expand Down
22 changes: 18 additions & 4 deletions packages/angular/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
# Carbon Charts Angular

Carbon Charts Angular is a thin Angular wrapper around the vanilla JavaScript `@carbon/charts`
component library. This prerelease is for Angular 18 and higher.
<p align="center">
<a href="https://charts.carbondesignsystem.com/">
<img src="../../assets/dashboard.png" alt="Carbon Charts" />
</a>
<h3 align="center">Carbon Charts Angular</h3>
<p align="center">
A component library of 26 charts for Angular 18.
<br /><br />
<a href="https://www.npmjs.com/package/@carbon/charts">
<img src="https://img.shields.io/npm/v/@carbon/charts.svg" />
</a>
<img alt="semantic-versioning" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--ver-e10079.svg" />
<img alt="semantic-versioning" src="https://img.shields.io/badge/downloads-+60k%2Fweek-green" />
<a href="https://discord.gg/J7JEUEkTRX">
<img src="https://img.shields.io/discord/689212587170201628?color=5865F2" alt="Chat with us on Discord">
</a>
</p>
</p>

If you need support for older versions of Angular (or encounter problems with this module), please
revert to `@carbon/charts-angular@latest`. Distribution tags have been added for previous Angular
Expand Down
39 changes: 20 additions & 19 deletions packages/angular/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,38 +28,39 @@
},
"dependencies": {
"@carbon/charts": "workspace:*",
"@ibm/telemetry-js": "^1.6.0",
"@ibm/telemetry-js": "^1.6.1",
"tslib": "^2.6.3"
},
"devDependencies": {
"@angular-devkit/build-angular": "^18.1.0",
"@angular/cli": "^18.1.0",
"@angular/common": "^18.1.0",
"@angular/compiler": "^18.1.0",
"@angular/compiler-cli": "^18.1.0",
"@angular/core": "^18.1.0",
"@angular/platform-browser": "^18.1.0",
"@angular/platform-browser-dynamic": "^18.1.0",
"@carbon/icons": "^11.45.0",
"@playwright/test": "^1.45.1",
"angular-eslint": "^18.1.0",
"@angular-devkit/build-angular": "^18.2.0",
"@angular/cli": "^18.2.0",
"@angular/common": "^18.2.0",
"@angular/compiler": "^18.2.0",
"@angular/compiler-cli": "^18.2.0",
"@angular/core": "^18.2.0",
"@angular/platform-browser": "^18.2.0",
"@angular/platform-browser-dynamic": "^18.2.0",
"@carbon/icons": "^11.47.0",
"@playwright/test": "^1.46.1",
"angular-eslint": "^18.3.0",
"concurrently": "^8.2.2",
"eslint": "^9.7.0",
"ng-packagr": "^18.1.0",
"eslint": "^9.9.0",
"ng-packagr": "^18.2.0",
"prettier": "^3.3.3",
"typescript": "~5.4.5",
"typescript-eslint": "^8.0.0-0",
"zone.js": "~0.14.7"
"typescript": "~5.5.4",
"typescript-eslint": "^8.1.0",
"zone.js": "~0.14.10"
},
"publishConfig": {
"tag": "next",
"directory": "dist",
"access": "public"
},
"homepage": "https://github.com/carbon-design-system/carbon-charts#readme",
"repository": {
"type": "git",
"url": "git@github.com:carbon-design-system/carbon-charts.git",
"homepage": "https://charts.carbondesignsystem.com/angular/"
"url": "git+https://github.com/carbon-design-system/carbon-charts.git",
"directory": "packages/angular"
},
"license": "Apache-2.0",
"author": "IBM",
Expand Down
Loading

0 comments on commit 2d8666c

Please sign in to comment.