@oliasoft-open-source/charts-library 2.3.4 → 2.4.0

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@oliasoft-open-source/charts-library",
-  "version": "2.3.4",
+  "version": "2.4.0",
   "description": "React Chart Library (based on Chart.js and react-chart-js-2)",
   "main": "index.js",
+  "files": [
+    "index.js",
+    "LICENSE",
+    "README.md",
+    "release-notes.md",
+    "src/*"
+  ],
   "scripts": {
-    "build": "npm run build:storybook",
+    "build": "yarn run build:storybook",
     "build:storybook": "build-storybook --quiet --output-dir ./public",
     "dev:storybook": "start-storybook -p 6006",
     "preview:storybook": " http-server ./public -o -p 9002 -c-1",
-    "test": "npm run prettier:check && npm run lint:check && npm run test:unit",
+    "test": "yarn run prettier:check && yarn run lint:check && yarn run test:unit",
     "test:unit": "jest",
     "lint:check": "eslint \"**/*.{js,jsx}\"",
     "lint:fix": "eslint --fix \"**/*.{js,jsx}\"",

package/release-notes.md

@@ -1,5 +1,9 @@
 # Charts Library Release Notes
 
+## 2.4.0
+
+- Switch package manager from NPM to Yarn
+
 ## 2.3.4
 
 - RollBack changes regarding OW-4327

package/.eslintignore

@@ -1,2 +0,0 @@
-node_modules
-public

package/.eslintrc.js

@@ -1,129 +0,0 @@
-module.exports = {
-  env: {
-    browser: true,
-    es2021: true,
-    node: true,
-    jest: true,
-  },
-  extends: ['plugin:react/recommended', 'airbnb', 'prettier'],
-  parser: '@babel/eslint-parser',
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 12,
-    sourceType: 'module',
-  },
-  plugins: ['react'],
-  settings: {
-    'import/resolver': {
-      alias: {
-        map: [
-          ['~components', './src/components'],
-          ['~docs', './src/docs'],
-          ['~helpers', './src/helpers'],
-          ['~style', './src/style'],
-          ['~vendor', './src/vendor'],
-        ],
-        extensions: ['.js', '.jsx'],
-      },
-    },
-  },
-  rules: {
-    'arrow-parens': 0,
-    'array-callback-return': 0,
-    camelcase: 0,
-    'comma-dangle': 0,
-    'consistent-return': 0,
-    curly: 0,
-    'class-methods-use-this': 0,
-    'default-case': 0,
-    eqeqeq: 0,
-    'eol-last': 0,
-    'function-paren-newline': 0,
-    'max-len': 0,
-    'import/extensions': 0,
-    'import/prefer-default-export': 0,
-    'object-curly-newline': 0,
-    'object-curly-spacing': 0,
-    'one-var-declaration-per-line': 0,
-    'one-var': 0,
-    radix: 0,
-    'prefer-template': 0,
-    'prefer-const': 0,
-    'prefer-destructuring': [
-      'error',
-      {
-        VariableDeclarator: {
-          array: false,
-          object: true,
-        },
-        AssignmentExpression: {
-          array: false,
-          object: false,
-        },
-      },
-      {
-        enforceForRenamedProperties: false,
-      },
-    ],
-    'spaced-comment': 0,
-    'no-multi-spaces': 0,
-    'arrow-body-style': 0,
-    'no-shadow': 0,
-    'no-else-return': 0,
-    'no-param-reassign': 0,
-    'no-plusplus': 0,
-    'no-restricted-globals': 0,
-    'no-unused-vars': 0,
-    'no-unused-state': 0,
-    'no-case-declarations': 0,
-    'no-return-assign': 0,
-    'no-prototype-builtins': 0,
-    'no-restricted-syntax': 0,
-    'no-cond-assign': [2, 'except-parens'],
-    'no-console': 0,
-    'no-constant-condition': 0,
-    'no-underscore-dangle': 0,
-    'no-restricted-properties': 0,
-    'no-nested-ternary': 0,
-    'no-mixed-operators': 0,
-    'no-confusing-arrow': 0,
-    'no-lonely-if': 0,
-    'nonblock-statement-body-position': 0,
-    'react/jsx-tag-spacing': 0,
-    'react/jsx-one-expression-per-line': 0,
-    'react/no-array-index-key': 0,
-    'react/forbid-prop-types': 0,
-    'react/destructuring-assignment': 0,
-    'react/no-unused-state': 0,
-    'react/no-access-state-in-setstate': 0,
-    'react/no-did-update-set-state': 0,
-    'react/prop-types': 0,
-    'react/self-closing-comp': [
-      'error',
-      {
-        component: true,
-        html: false,
-      },
-    ],
-    'jsx-a11y/no-static-element-interactions': 0,
-    'jsx-a11y/click-events-have-key-events': 0,
-    'jsx-a11y/tabindex-no-positive': 0,
-    'jsx-a11y/label-has-associated-control': 0,
-    'jsx-a11y/label-has-for': 0,
-    'react/function-component-definition': [
-      2,
-      { namedComponents: 'arrow-function' },
-    ],
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: [
-          'src/components/**/*.stories.{js,jsx}',
-          'webpack/**/*.js',
-        ],
-      },
-    ],
-  },
-};

package/.gitlab-ci.yml

@@ -1,80 +0,0 @@
-image: node:18
-
-stages:
-  - test
-  - release
-
-default:
-  tags:
-    - oliasoft
-    - kubernetes
-
-test:
-  stage: test
-  only:
-    - merge_requests
-  script:
-    - npm install --progress=false --no-save
-    - npm run build
-    - npm run test
-
-cache:
-  paths:
-    - node_modules/
-    - public/
-
-# Publish the Storybook to Gitlab pages upon merge to master
-pages:
-  stage: release
-  only:
-    - master
-  script:
-    - npm install --progress=false --no-save
-    - npm run build
-  artifacts:
-    paths:
-      - public
-
-# Push a tag and publish the release to the public NPM registry upon merge to master
-# Loosely inspired by:
-# - https://markswanderingthoughts.nl/tagging-in-gitlab-ci-pipeline-using-deploy-keys/
-# - https://www.garybell.co.uk/creating-a-release-with-gitlab-ci-and-composer/
-publish:
-  stage: release
-  only:
-    - master
-  script:
-    # Get the version from package.json
-    - VERSION=$(node -p "require('./package.json').version")
-    # Prepare MatterMost message
-    - MESSAGE="🤖 Charts Library version $VERSION released ([release notes](https://gitlab.com/oliasoft-open-source/charts-library/-/blob/master/release-notes.md))"
-    - chmod +x ./scripts/send-mattermost-message.sh
-    # Prepare .npmrc
-    - echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
-    # Configure git
-    - mkdir -p ~/.ssh
-    - echo "$SSH_PRIVATE_KEY_TOOLKIT" > ~/.ssh/id_rsa; chmod 0600 ~/.ssh/id_rsa
-    - echo "StrictHostKeyChecking no " > /root/.ssh/config
-    - git config --global http.sslVerify false
-    - git config --global user.email "$GITLAB_USER_EMAIL"
-    - git config --global user.name "🤖 GitLab CI/CD"
-    - echo "setting origin remote to 'git@$CI_SERVER_HOST:$CI_PROJECT_PATH.git'"
-    - git remote rm origin
-    - git remote add origin git@$CI_SERVER_HOST:$CI_PROJECT_PATH.git
-    - git fetch --quiet
-    - git checkout "$CI_BUILD_REF_NAME"
-    # Only complete pipeline if version does not already exist
-    - >
-      if [ $(git tag -l "$VERSION") ]; then
-        echo "Version $VERSION already exists"
-        exit 1
-      else
-        echo "Tagging release in git"
-        git tag $VERSION -m "🤖 Tagged by Gitlab CI/CD Pipeline" -m "For further reference see $CI_PIPELINE_URL" -m "[skip ci]"
-        echo "Pushing tag to remote repository"
-        git push origin $VERSION --no-verify
-        echo "Publishing package to NPM registry"
-        npm publish
-        echo "Notifying MatterMost"
-        ./scripts/send-mattermost-message.sh "$MATTERMOST_BOT_KEY" "$MESSAGE"
-      fi

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged

package/.prettierignore

@@ -1,3 +0,0 @@
-node_modules
-public
-dist

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  "singleQuote": true,
-  "trailingComma": "all"
-}

package/.storybook/main.js

@@ -1,36 +0,0 @@
-const { merge } = require('webpack-merge');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-const getRules = require('../webpack/webpack.common.rules.js');
-const resolve = require('../webpack/webpack.resolve.js').resolve;
-
-module.exports = {
-  stories: ['../src/components/**/*.stories.@(js|jsx|mdx)'],
-  addons: [
-    '@storybook/addon-actions',
-    {
-      name: '@storybook/addon-docs',
-      options: {
-        sourceLoaderOptions: {
-          injectStoryParameters: false,
-        },
-      },
-    },
-    'storybook-dark-mode',
-  ],
-  features: {
-    modernInlineRender: true,
-  },
-  core: {
-    builder: 'webpack5',
-  },
-  webpackFinal: (config) =>
-    merge(config, {
-      module: { rules: getRules('development') },
-      plugins: [
-        new MiniCssExtractPlugin({
-          filename: '[name].css',
-        }),
-      ],
-      resolve,
-    }),
-};

package/.storybook/preview.js

@@ -1,37 +0,0 @@
-import React from 'react';
-import { useDarkMode } from 'storybook-dark-mode';
-import { themes } from '@storybook/theming';
-import { DocsContainer } from '@storybook/addon-docs';
-import '@oliasoft-open-source/react-ui-library/dist/global.css';
-import './storybook.less';
-
-/**
- * Dark mode for GUI Library components (i.e. Controls)
- */
-export const decorators = [
-  (Story) => {
-    document.documentElement.setAttribute(
-      'data-theme',
-      useDarkMode() ? 'dark' : 'default',
-    );
-    return <Story />;
-  },
-];
-
-export const parameters = {
-  /**
-   * Fix for dark mode docs from https://github.com/hipstersmoothie/storybook-dark-mode/issues/180
-   */
-  docs: {
-    container: (props) => {
-      const isDark = useDarkMode();
-      const { id: storyId, storyById } = props.context;
-      const {
-        parameters: { docs = {} },
-      } = storyById(storyId);
-      docs.theme = isDark ? themes.dark : themes.light;
-
-      return React.createElement(DocsContainer, props);
-    },
-  },
-};

package/.storybook/storybook.less

@@ -1,8 +0,0 @@
-/**
-* Fix for Firefox story height bug
-*/
-@-moz-document url-prefix() {
-  .docs-story > div > div {
-    height: 100% !important;
-  }
-}

package/babel.config.js

@@ -1,29 +0,0 @@
-module.exports = (api) => {
-  api.cache(true);
-
-  const presets = [
-    [
-      '@babel/preset-env',
-      {
-        targets: {
-          browsers: ['defaults'],
-        },
-        useBuiltIns: 'usage',
-        corejs: 3,
-      },
-    ],
-    '@babel/preset-react',
-  ];
-
-  const plugins = [
-    [
-      'babel-plugin-webpack-aliases',
-      { config: './webpack/webpack.resolve.js' },
-    ],
-  ];
-
-  return {
-    presets,
-    plugins,
-  };
-};

package/jest.config.js

@@ -1,9 +0,0 @@
-module.exports = {
-  transform: {
-    '^.+\\.jsx?$': 'babel-jest',
-    '.+\\.(css|styl|less|sass|scss|png|jpg|ttf|woff|woff2)$':
-      'jest-transform-stub',
-  },
-  moduleFileExtensions: ['js', 'jsx'],
-  moduleDirectories: ['node_modules'],
-};

package/scripts/send-mattermost-message.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-set -eEuo pipefail
-
-# This script requires the following things to be installed:
-#  - bash
-#  - curl
-
-# Required inputs:
-MATTERMOST_BOT_KEY=$1
-MSG=$2
-
-# Optional inputs:
-CHANNEL=${3:-'#releases'}
-USERNAME=${4:-'Gitlab CI/CD'}
-ICON_URL=${5:-'https://oliasoftstaticwebsite.blob.core.windows.net/helpguideimages/robot-icon.png'}
-MATTERMOST_URL=${6:-'https://mm.oliasoft.com/hooks/'}
-
-curl -X POST \
-  --data-urlencode \
-  "payload={\"channel\": \"$CHANNEL\", \"username\": \"$USERNAME\", \"icon_url\": \"$ICON_URL\", \"text\": \"$MSG\"}" \
-  $MATTERMOST_URL$MATTERMOST_BOT_KEY

package/webpack/webpack.common.js

@@ -1,39 +0,0 @@
-const path = require('path');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-const HtmlWebPackPlugin = require('html-webpack-plugin');
-const { resolve } = require('./webpack.resolve.js');
-
-module.exports = {
-  resolve,
-  entry: {
-    app: './src/docs/start.jsx',
-  },
-  output: {
-    path: path.resolve(__dirname, '../public'),
-    filename: '[name].[contenthash].js',
-  },
-  plugins: [
-    new HtmlWebPackPlugin({
-      template: 'src/docs/html/index.html',
-      filename: './index.html',
-      favicon: 'src/docs/html/favicon.png',
-      cache: true,
-    }),
-    new MiniCssExtractPlugin({
-      filename: '[name].[contenthash].css',
-    }),
-  ],
-  optimization: {
-    runtimeChunk: 'single', // single runtime bundle for all chunks
-    // put node_modules into separate bundles
-    splitChunks: {
-      cacheGroups: {
-        vendors: {
-          test: /[\\/]node_modules[\\/]/,
-          name: 'vendors',
-          chunks: 'all',
-        },
-      },
-    },
-  },
-};

package/webpack/webpack.common.rules.js

@@ -1,107 +0,0 @@
-const path = require('path');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-
-module.exports = function getRules(env) {
-  const styleLoader = MiniCssExtractPlugin.loader;
-
-  return [
-    {
-      test: /\.jsx$|\.es6$|\.js$/,
-      exclude: /node_modules/,
-      use: {
-        loader: 'babel-loader',
-        options: {
-          cacheDirectory: false,
-          presets: ['@babel/react'],
-        },
-      },
-    },
-    {
-      test: /\.(ttf|eot|woff|woff2)$/,
-      type: 'asset/resource',
-      generator: {
-        filename: './fonts/[name].[contenthash][ext]',
-      },
-    },
-    {
-      test: /\.(svg|gif|png|jpg)$/,
-      type: 'asset/resource',
-      generator: {
-        filename: './images/[name].[contenthash][ext]',
-      },
-    },
-    {
-      test: /^(?!.*?(\.module)).*\.css$/, //all *.css except for *.module.css
-      exclude: /node_modules/,
-      use: [
-        styleLoader,
-        {
-          loader: 'css-loader',
-          options: {
-            sourceMap: env === 'development',
-          },
-        },
-      ],
-    },
-    {
-      test: /^(?!.*?(\.module)).*\.less$/, //all *.less except for *.module.less
-      use: [
-        styleLoader,
-        {
-          loader: 'css-loader',
-          options: {
-            sourceMap: env === 'development',
-          },
-        },
-        'less-loader',
-      ],
-    },
-    {
-      test: /\.module\.css$/, //*.module.css
-      use: [
-        styleLoader,
-        {
-          loader: 'css-loader',
-          options: {
-            sourceMap: env === 'development',
-            modules: {
-              mode: 'local',
-              localIdentName: '[name]-[local]-[hash:base64:5]', //friendly module classNames
-            },
-          },
-        },
-      ],
-    },
-    {
-      test: /\.module\.less$/, //*.module.less
-      use: [
-        styleLoader,
-        {
-          loader: 'css-loader',
-          options: {
-            sourceMap: env === 'development',
-            modules: {
-              mode: 'local',
-              localIdentName: '[name]-[local]-[hash:base64:5]', //friendly module classNames
-            },
-          },
-        },
-        'less-loader',
-      ],
-    },
-    {
-      test: /\.stories\.jsx?$/,
-      loader: require.resolve('@storybook/source-loader'),
-      include: [path.resolve(__dirname, '../src')],
-      enforce: 'pre',
-    },
-    {
-      test: /\.mdx?$/,
-      use: ['babel-loader', '@mdx-js/loader'],
-    },
-    {
-      resourceQuery: /raw/,
-      type: 'asset/source',
-    },
-  ];
-};

package/webpack/webpack.dev.js

@@ -1,22 +0,0 @@
-const { merge } = require('webpack-merge');
-const common = require('./webpack.common.js');
-const getRules = require('./webpack.common.rules.js');
-
-module.exports = merge(common, {
-  mode: 'development',
-  devtool: 'eval-cheap-module-source-map',
-  output: {
-    publicPath: '/',
-  },
-  devServer: {
-    port: 9001,
-    open: true,
-    historyApiFallback: true,
-    client: {
-      overlay: true,
-    },
-  },
-  module: {
-    rules: getRules('development'),
-  },
-});

package/webpack/webpack.prod.js

@@ -1,23 +0,0 @@
-const { merge } = require('webpack-merge');
-const TerserPlugin = require('terser-webpack-plugin');
-const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');
-const common = require('./webpack.common.js');
-const getRules = require('./webpack.common.rules.js');
-
-module.exports = merge(common, {
-  mode: 'production',
-  output: {
-    publicPath: '/line-chart-library/',
-  },
-  optimization: {
-    minimizer: [
-      new TerserPlugin({
-        parallel: true,
-      }),
-      new CssMinimizerPlugin(),
-    ],
-  },
-  module: {
-    rules: getRules('production'),
-  },
-});

package/webpack/webpack.resolve.js

@@ -1,22 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  resolve: {
-    extensions: ['.js', '.jsx'],
-    alias: {
-      '~components': path.resolve(__dirname, '../src/components'),
-      '~docs': path.resolve(__dirname, '../src/docs'),
-      '~helpers': path.resolve(__dirname, '../src/helpers'),
-      '~style': path.resolve(__dirname, '../src/style'),
-      '~vendor': path.resolve(__dirname, '../src/vendor'),
-    },
-    fallback: {
-      fs: false,
-      net: false,
-      repl: false,
-      tls: false,
-      path: false,
-      crypto: false,
-    },
-  },
-};