Vuepress docs

.codeclimate.yml

@@ -7,6 +7,10 @@ plugins:
         - javascript
   fixme:
     enabled: true
+checks:
+  method-complexity:
+    config:
+      threshold: 6
 exclude_patterns:
   - "dist/"
   - "docs/"

.editorconfig

@@ -2,21 +2,13 @@
 root = true
 
 [*]
-indent_style = tab
-indent_size = 4
+indent_style = space
+indent_size = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.yml]
-indent_style = space
-indent_size = 2
-
-[*.json]
-indent_style = space
-indent_size = 2
-
-[*.mdx]
-indent_style = space
-indent_size = 2
+[*.html]
+indent_style = tab
+indent_size = 4

.eslintrc.yml

@@ -1,6 +1,7 @@
 extends:
   - chartjs
-  - plugin:es/no-2019
+  - plugin:es/no-new-in-es2019
+  - plugin:markdown/recommended
 
 env:
   es6: true

.github/workflows/ci.yml

@@ -14,6 +14,9 @@ jobs:
   build:
     runs-on: ${{ matrix.os }}
 
+    outputs:
+      coveralls: ${{ steps.changes.outputs.src }}
+
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
@@ -23,9 +26,36 @@ jobs:
     - uses: actions/checkout@v2
     - name: Use Node.js
       uses: actions/setup-node@v1
-    - name: Build and Test
+      with:
+        node-version: '14'
+    - uses: dorny/paths-filter@v2
+      id: changes
+      with:
+        filters: |
+          docs:
+            - 'docs/**'
+            - 'package.json'
+            - 'tsconfig.json'
+          src:
+            - 'src/**'
+            - 'package.json'
+          test:
+            - 'test/**'
+            - 'karma.conf.js'
+            - 'package.json'
+          types:
+            - 'types/**'
+            - 'package.json'
+            - 'tsconfig.json'
+    - name: Install
+      run: npm ci
+    - name: Build
+      run: npm run build
+    - name: Test
+      if: |
+        steps.changes.outputs.src == 'true' ||
+        steps.changes.outputs.test == 'true'
       run: |
-        npm ci
         npm run build
         if [ "${{ runner.os }}" == "Windows" ]; then
           npm test
@@ -35,19 +65,24 @@ jobs:
           xvfb-run --auto-servernum npm test
         fi
       shell: bash
+    - name: Lint
+      run: npm run lint
     - name: Package
+      if: steps.changes.outputs.docs == 'true'
       run: |
         npm run docs
         npm run typedoc
         npm pack
     - name: Coveralls Parallel - Chrome
+      if: steps.changes.outputs.src == 'true'
       uses: coverallsapp/github-action@master
       with:
         github-token: ${{ secrets.github_token }}
         path-to-lcov: './coverage/chrome/lcov.info'
         flag-name: ${{ matrix.os }}-chrome
         parallel: true
     - name: Coveralls Parallel - Firefox
+      if: steps.changes.outputs.src == 'true'
       uses: coverallsapp/github-action@master
       with:
         github-token: ${{ secrets.github_token }}
@@ -61,6 +96,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Coveralls Finished
+      if: needs.build.outputs.coveralls == 'true'
       uses: coverallsapp/github-action@master
       with:
         github-token: ${{ secrets.github_token }}

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Chart.js Contributors
+Copyright (c) 2014-2021 Chart.js Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

MAINTAINING.md

@@ -1,5 +1,7 @@
 # Maintaining
+
 ## Release Process
+
 Chart.js relies on [Travis CI](https://travis-ci.org/) to automate the library [releases](https://github.com/chartjs/Chart.js/releases).
 
 ### Releasing a New Version
@@ -11,7 +13,7 @@ Chart.js relies on [Travis CI](https://travis-ci.org/) to automate the library [
 Creation of this tag triggers a new build:
 
 * `Chart.js.zip` package is generated, containing dist files and examples
-* `dist/*.js` and `Chart.js.zip` are attached to the GitHub release (downloads)
+* `dist/*.js`, `types/*.ts`, and `Chart.js.zip` are attached to the GitHub release (downloads)
 * A new npm package is published on [npmjs](https://www.npmjs.com/package/chart.js)
 
 Finally, [cdnjs](https://cdnjs.com/libraries/Chart.js) is automatically updated from the npm release.

README.md

@@ -13,15 +13,22 @@
 
 ## Documentation
 
-- [Introduction](https://www.chartjs.org/docs/latest/)
-- [Getting Started](https://www.chartjs.org/docs/latest/getting-started/)
-- [General](https://www.chartjs.org/docs/latest/general/)
-- [Configuration](https://www.chartjs.org/docs/latest/configuration/)
-- [Charts](https://www.chartjs.org/docs/latest/charts/)
-- [Axes](https://www.chartjs.org/docs/latest/axes/)
-- [Developers](https://www.chartjs.org/docs/latest/developers/)
-- [Popular Extensions](https://github.com/chartjs/awesome)
-- [Samples](https://www.chartjs.org/samples/)
+Currently, there are two versions of the library (2.9.4 and 3.x.x). Version 2 is the latest stable version while 3 is the next (currently beta) version. As such bear the following in mind:
+
+* Current docs points to version 2.9.4
+* Npm/CDN/etc point to version 2.9.4 (unless you explicitly set newer version, e.g. npm next)
+* Source currently points to 3.x.x version. 2.9.4 source is available [here](https://github.com/chartjs/Chart.js/tree/2.9)
+* Docs for version 3.x.x are available [here](https://www.chartjs.org/docs/master/)
+
+* [Introduction](https://www.chartjs.org/docs/latest/)
+* [Getting Started](https://www.chartjs.org/docs/latest/getting-started/)
+* [General](https://www.chartjs.org/docs/latest/general/)
+* [Configuration](https://www.chartjs.org/docs/latest/configuration/)
+* [Charts](https://www.chartjs.org/docs/latest/charts/)
+* [Axes](https://www.chartjs.org/docs/latest/axes/)
+* [Developers](https://www.chartjs.org/docs/latest/developers/)
+* [Popular Extensions](https://github.com/chartjs/awesome)
+* [Samples](https://www.chartjs.org/samples/)
 
 ## Contributing
 

auto/auto.esm.d.ts

@@ -0,0 +1,4 @@
+import { Chart } from '../dist/chart.esm';
+
+export * from '../dist/chart.esm';
+export default Chart;

auto/auto.esm.js

@@ -0,0 +1,5 @@
+import {Chart, registerables} from '../dist/chart.esm';
+
+Chart.register(...registerables);
+
+export default Chart;

auto/auto.js

@@ -0,0 +1 @@
+module.exports = require('../dist/chart');

auto/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "chart.js-auto",
+    "private": true,
+    "description": "auto registering package",
+    "main": "auto.js",
+    "module": "auto.esm.js",
+    "types": "auto.esm.d.ts"
+}

docs/.vuepress/config.js

@@ -0,0 +1,163 @@
+const path = require('path');
+const docsVersion = "VERSION";
+const base = process.env.NODE_ENV === "development" ? '' : `/docs/${docsVersion}/`;
+
+module.exports = {
+  title: 'Chart.js',
+  description: 'Open source HTML5 Charts for your website',
+  theme: 'chartjs',
+  base,
+  dest: path.resolve(__dirname, '../../dist/docs'),
+  head: [
+    ['link', {rel: 'icon', href: '/favicon.ico'}],
+  ],
+  plugins: [
+    'tabs',
+    [
+      '@vuepress/google-analytics',
+      {
+        'ga': 'UA-28909194-3'
+      }
+    ],
+  ],
+  chainWebpack(config) {
+    config.merge({
+      resolve: {
+        alias: {
+          'chart.js': path.resolve(__dirname, '../../dist/chart.esm.js'),
+        }
+      }
+    })
+  },
+  markdown: {
+    extendMarkdown: md => {
+      md.use(require('markdown-it-include'), path.resolve(__dirname, '../'));
+    }
+  },
+  themeConfig: {
+    repo: 'chartjs/Chart.js',
+    logo: '/favicon.ico',
+    lastUpdated: 'Last Updated',
+    searchPlaceholder: 'Search...',
+    editLinks: false,
+    docsDir: 'docs',
+    chart: {
+      imports: [
+        ['scripts/register.js'],
+        ['scripts/utils.js', 'Utils'],
+      ]
+    },
+    nav: [
+      {text: 'Home', link: '/'},
+      // TODO: Make local when samples moved to vuepress
+      {text: 'Samples', link: `https://www.chartjs.org/samples/${docsVersion}/`},
+      {
+        text: 'Ecosystem',
+        ariaLabel: 'Community Menu',
+        items: [
+          { text: 'Awesome', link: 'https://github.com/chartjs/awesome' },
+          { text: 'Slack', link: 'https://chartjs-slack.herokuapp.com/' },
+          { text: 'Stack Overflow', link: 'https://stackoverflow.com/questions/tagged/chart.js' }
+        ]
+      }
+    ],
+    sidebar: {
+      '/': [
+        '',
+        {
+          title: 'Getting Started',
+          children: [
+            'getting-started/',
+            'getting-started/installation',
+            'getting-started/integration',
+            'getting-started/usage',
+            'getting-started/v3-migration'
+          ]
+        },
+        {
+          title: 'General',
+          children: [
+            'general/data-structures',
+            'general/accessibility',
+            'general/options',
+            'general/colors',
+            'general/fonts',
+            'general/padding',
+            'general/performance'
+          ]
+        },
+        {
+          title: 'Configuration',
+          children: [
+            'configuration/',
+            'configuration/responsive',
+            'configuration/device-pixel-ratio',
+            'configuration/locale',
+            'configuration/interactions',
+            'configuration/canvas-background',
+            'configuration/animations',
+            'configuration/layout',
+            'configuration/legend',
+            'configuration/title',
+            'configuration/tooltip',
+            'configuration/elements',
+            'configuration/decimation'
+          ]
+        },
+        {
+          title: 'Chart Types',
+          children: [
+            'charts/line',
+            'charts/bar',
+            'charts/radar',
+            'charts/doughnut',
+            'charts/polar',
+            'charts/bubble',
+            'charts/scatter',
+            'charts/area',
+            'charts/mixed'
+          ]
+        },
+        {
+          title: 'Axes',
+          children: [
+            'axes/',
+            {
+              title: 'Cartesian',
+              children: [
+                'axes/cartesian/',
+                'axes/cartesian/category',
+                'axes/cartesian/linear',
+                'axes/cartesian/logarithmic',
+                'axes/cartesian/time',
+                'axes/cartesian/timeseries'
+              ],
+            },
+            {
+              title: 'Radial',
+              children: [
+                'axes/radial/linear'
+              ],
+            },
+            'axes/labelling',
+            'axes/styling'
+          ]
+        },
+        {
+          title: 'Developers',
+          children: [
+            'developers/',
+            'developers/api',
+            [`https://chartjs.org/docs/${docsVersion}/typedoc/`, 'TypeDoc'],
+            'developers/updates',
+            'developers/plugins',
+            'developers/charts',
+            'developers/axes',
+            'developers/contributing',
+            'developers/publishing'
+          ]
+        },
+      ],
+    }
+  }
+};