Skip to content

Commit

Permalink
Name artifact chart.umd.js, fixes #11455
Browse files Browse the repository at this point in the history
  • Loading branch information
fulldecent committed Sep 6, 2023
1 parent e74ee7b commit 699753f
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ body:
For typescript issues you can make use of [this TS Playground](https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAbzgYQBYENZwL5wGZQQhwDkAxhrAHQBWAziQNwCwAUGwG6ZxkwAecALxwAJhDIBXEAFMAdjCoBzaTACiAG2kz5AIQCeASREAKAEQg9aTDFMBKOOjpwAEgBUAsgBlk6WVzoaWnIwLKxcUHAWVljCstIA7iiUMMa8fAA0iGxwOXAwemDSAFyk6sBxJOnZuSLoMOglCNW5ueroAEbS6nQlANqmAErSIqaZpjrqEtKjcKYAml3qEPEzpgDiUNJyqwAKElBgmqsA8lC+yqYAulWsLS219XQqPXC9Tbd3n22d6iUkAMRwCB4OAANQgMGkDBun0+DwarwAjAAmTKIgCcmQAzJkAKyZVFwLHXZp3bCXUnYGG5CBgGDACCyF7vT50MjoTTM0ktPiNbl3fk5KmCuB6PkfWFwEXYfkyiU4NjYWyMIA) to make a reproducible sample.
If filing a bug against `master`, you may reference the latest code via
https://www.chartjs.org/dist/master/chart.umd.js (changing the filename to
https://www.chartjs.org/dist/master/chart.umd.min.js (changing the filename to
point at the file you need as appropriate). Do not rely on these files for
production purposes as they may be removed at any time.
validations:
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,6 @@ Guidelines for reporting bugs:

- Check the issue search to see if it has already been reported
- Isolate the problem to a simple test case
- Please include a demonstration of the bug on a website such as [JS Bin](https://jsbin.com/), [JS Fiddle](https://jsfiddle.net/), or [Codepen](https://codepen.io/pen/). ([Template](https://codepen.io/pen?template=wvezeOq)). If filing a bug against `master`, you may reference the latest code via <https://www.chartjs.org/dist/master/chart.umd.js> (changing the filename to point at the file you need as appropriate). Do not rely on these files for production purposes as they may be removed at any time.
- Please include a demonstration of the bug on a website such as [JS Bin](https://jsbin.com/), [JS Fiddle](https://jsfiddle.net/), or [Codepen](https://codepen.io/pen/). ([Template](https://codepen.io/pen?template=wvezeOq)). If filing a bug against `master`, you may reference the latest code via <https://www.chartjs.org/dist/master/chart.umd.min.js> (changing the filename to point at the file you need as appropriate). Do not rely on these files for production purposes as they may be removed at any time.

Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data.
6 changes: 3 additions & 3 deletions docs/getting-started/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If you're using a front-end framework (e.g., React, Angular, or Vue), please see
## Script Tag

```html
<script src="path/to/chartjs/dist/chart.umd.js"></script>
<script src="path/to/chartjs/dist/chart.umd.min.js"></script>
<script>
const myChart = new Chart(ctx, {...});
</script>
Expand Down Expand Up @@ -122,10 +122,10 @@ const { Chart } = await import('chart.js');

## RequireJS

**Important:** RequireJS can load only [AMD modules](https://requirejs.org/docs/whyamd.html), so be sure to require one of the UMD builds instead (i.e. `dist/chart.umd.js`).
**Important:** RequireJS can load only [AMD modules](https://requirejs.org/docs/whyamd.html), so be sure to require one of the UMD builds instead (i.e. `dist/chart.umd.min.js`).

```javascript
require(['path/to/chartjs/dist/chart.umd.js'], function(Chart){
require(['path/to/chartjs/dist/chart.umd.min.js'], function(Chart){
const myChart = new Chart(ctx, {...});
});
```
Expand Down
2 changes: 1 addition & 1 deletion docs/migration/v4-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A number of changes were made to the configuration options passed to the `Chart`
* Time and timeseries scales use `ticks.stepSize` instead of `time.stepSize`, which has been removed.
* `maxTickslimit` wont be used for the ticks in `autoSkip` if the determined max ticks is less then the `maxTicksLimit`.
* `dist/chart.js` has been removed.
* `dist/chart.min.js` has been renamed to `dist/chart.umd.js`.
* `dist/chart.min.js` has been renamed to `dist/chart.umd.min.js` (and before 4.5.0 `dist/chart.umd.js`).
* `dist/chart.esm.js` has been renamed to `dist/chart.js`.

#### Type changes
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
"sideEffects": [
"./auto/auto.js",
"./auto/auto.cjs",
"./dist/chart.umd.min.js",
"./dist/chart.umd.js"
],
"jsdelivr": "./dist/chart.umd.js",
"unpkg": "./dist/chart.umd.js",
"jsdelivr": "./dist/chart.umd.min.js",
"unpkg": "./dist/chart.umd.min.js",
"main": "./dist/chart.cjs",
"module": "./dist/chart.js",
"exports": {
Expand Down
16 changes: 15 additions & 1 deletion rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,21 @@ const plugins = (minify) =>

export default [
// UMD build
// dist/chart.umd.js
// dist/chart.umd.min.js
{
input: 'src/index.umd.ts',
plugins: plugins(true),
output: {
name: 'Chart',
file: 'dist/chart.umd.min.js',
format: 'umd',
indent: false,
sourcemap: true,
},
},

// UMD build
// dist/chart.umd.js (old filename)
{
input: 'src/index.umd.ts',
plugins: plugins(true),
Expand Down
2 changes: 1 addition & 1 deletion test/BasicChartWebWorker.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
// Sends messages with data of types: { type: 'success' } | { type: 'error', errorMessage: string }

// eslint-disable-next-line no-undef
importScripts('../src/chart.umd.js');
importScripts('../src/chart.umd.min.js');

onmessage = function(event) {
try {
Expand Down

0 comments on commit 699753f

Please sign in to comment.