Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme and dependencies #1871

Merged
merged 28 commits into from
Aug 19, 2024
Merged

Update readme and dependencies #1871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
9cd89c5
chore(deps): bump @playwright/test, @types/node, publint, vite, vites…
nstuyvesant Jul 17, 2024
b8c09c3
docs(readme): updates
nstuyvesant Jul 17, 2024
3a33bbc
docs(readme): switch markup to html
nstuyvesant Jul 17, 2024
8138d93
docs(readme): changes
nstuyvesant Jul 17, 2024
9b2fc5b
docs(core): readme update
nstuyvesant Jul 17, 2024
a8eb528
docs(angular,react,svelte,vue): readme update
nstuyvesant Jul 17, 2024
123877d
chore(dashboard): trim
nstuyvesant Jul 17, 2024
db6ec6d
chore(deps): bump @carbon/react, react-router-dom, styled-components
nstuyvesant Jul 17, 2024
9e41251
chore(deps): bump angular, zone.js
nstuyvesant Jul 17, 2024
babda2d
chore(deps): bump eslint-plugin-jsdoc+svelte, husky, vue
nstuyvesant Jul 19, 2024
a4685ac
chore(deps): bump eslint-plugins, svelte-eslint-parser, lerna, jsdom,…
nstuyvesant Jul 22, 2024
d2ba953
chore(deps): bump vite, @playright, @types/node, angular, vue, typesc…
nstuyvesant Jul 25, 2024
3b35523
chore(deps): bump eslint, husky, @types/node, @vitejs/plugin-vue
nstuyvesant Jul 28, 2024
88ac6fa
chore(yarn): update lock
nstuyvesant Jul 28, 2024
f3752ed
chore(deps): bump eslint-plugin-jsdoc, husky, typescript-eslint, svel…
nstuyvesant Jul 30, 2024
0127977
chore(deps): bump eslint-plugin-jsdoc, @angular/dev-kit and cli, vite…
nstuyvesant Jul 31, 2024
ea9821a
chore(deps): bump sveltekit, angular, typescript-eslint, @carbon pack…
nstuyvesant Aug 1, 2024
02611c5
chore(deps): bump angular, sveltekit, vue, @carbon/react and devDepen…
nstuyvesant Aug 8, 2024
d9124d4
chore(deps): bump eslint, vite-plugin-dts, @types/node, @carbon/react…
nstuyvesant Aug 10, 2024
8143c2d
chore(deps): bump eslint-plugin-jsdoc
nstuyvesant Aug 11, 2024
81c4467
chore(deps): bump typescript-eslint
nstuyvesant Aug 12, 2024
4a7454f
chore(deps): bump sveltekit
nstuyvesant Aug 12, 2024
48b2e18
chore(deps): bump lint-staged, eslint-plugin-jsdoc, move directly use…
nstuyvesant Aug 13, 2024
a84d110
chore(deps): yarn.lock update
nstuyvesant Aug 13, 2024
2f5360f
chore(deps): drop old node LTS
nstuyvesant Aug 13, 2024
2b515d9
chore(deps): bump dependencies
nstuyvesant Aug 15, 2024
661906b
chore(deps): bump yarn, @playright, @types/node, fix repo references,…
nstuyvesant Aug 18, 2024
9719a19
chore(homepage): add where missing, consistent line
nstuyvesant Aug 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

925 changes: 925 additions & 0 deletions .yarn/releases/yarn-4.4.0.cjs
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .yarnrc.yml
View file
Open in desktop
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
View file
Open in desktop
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" />
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the latest sum of downloads for all the packages - 60, 161

<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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already stated above with links to the packages.


<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)
Comment on lines -28 to -34
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links provided higher up.


<a href="https://www.netlify.com" target="_blank">
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" />
</a>
Comment on lines -36 to -38
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved this to the bottom.


## 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: |
Comment on lines -42 to -76
Copy link
Contributor Author

@nstuyvesant nstuyvesant Jul 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I pulled these out is because all chart types are available for all frameworks except Network Diagrams. The documentation website clearly covers this and presents the list of chart types in a better way. It is better to drive users to the Docs site than repeat info here. Also, the list isn't well-organized so you really have to know what you're looking for. The docs site lists charts alphabetically on the side nav and by function on the introduction page with the tiles.

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.

Comment on lines -100 to -103
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already stated above.

## 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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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>

Comment on lines +1 to +18
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes the read me more visually interesting over what we had especially important for npmjs page.

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
View file
Open in desktop
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
Loading