Recreate docs and update readme info

Fixes #236

Author: mauriciopoppe

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+    "root": true,
+    "extends": ["react-app", "standard"],
+    "rules": {
+        "space-before-function-paren": ["error", {
+            "anonymous": "ignore",
+            "named": "ignore",
+            "asyncArrow": "ignore"
+        }],
+        "no-unused-vars": "off",
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-unused-vars": "error"
+    }
+}

.storybook/main.js

@@ -1,10 +1,15 @@
+// prettier-ignore
 module.exports = {
   "stories": [
     "../src/**/*.stories.mdx",
     "../src/**/*.stories.@(js|jsx|ts|tsx)"
   ],
   "addons": [
     "@storybook/addon-links",
+    "@storybook/addon-postcss",
     "@storybook/addon-essentials"
-  ]
-}
+  ],
+  features: {
+    postcss: false,
+  },
+}

README.md

@@ -45,11 +45,11 @@ import functionPlot from 'function-plot'
 functionPlot(options)
 ```
 
-[`All the available options are described in the docs`](https://mauriciopoppe.github.io/function-plot/docs/interfaces/_src_types_.functionplotoptions.html)
+[`All the available options are described in the docs`](https://mauriciopoppe.github.io/function-plot/functions/functionPlot-1)
 
 ## License
 
-2015-2022 MIT © Mauricio Poppe
+2015-2023 MIT © Mauricio Poppe
 
 
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmauriciopoppe%2Ffunction-plot.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmauriciopoppe%2Ffunction-plot?ref=badge_large)

package-lock.json

@@ -22,10 +22,10 @@
     "build:types": "tsc",
     "build:site": "cp dist/function-plot.js site/js/function-plot.js",
     "start": "webpack-dev-server",
-    "docs": "typedoc --out site/docs src/index.ts",
+    "docs": "typedoc --excludeExternals --externalPattern \"**/node_modules/**\" --out site/docs src/index.ts",
     "test": "jest",
     "storybook": "start-storybook -p 6006",
-    "build-storybook": "build-storybook",
+    "build-storybook": "NODE_OPTIONS=--openssl-legacy-provider build-storybook",
     "chromatic": "npx chromatic"
   },
   "files": [
@@ -72,6 +72,7 @@
     "@storybook/addon-actions": "^6.5.12",
     "@storybook/addon-essentials": "^6.5.12",
     "@storybook/addon-links": "^6.5.12",
+    "@storybook/addon-postcss": "^2.0.0",
     "@storybook/react": "^6.5.12",
     "@types/d3": "^7.4.0",
     "@types/events": "^3.0.0",
@@ -112,12 +113,6 @@
     "webpack-cli": "^4.10.0",
     "webpack-dev-server": "^4.11.0"
   },
-  "eslintConfig": {
-    "rules": {
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": "error"
-    }
-  },
   "standardx": {
     "parser": "@typescript-eslint/parser",
     "plugins": [

package.json

@@ -17,7 +17,7 @@ const evalTypeFn = {
  * @param {Object} d An item from `data`
  * @returns {Array}
  */
-function computeEndpoints (scale: any, d: any): [number, number] {
+function computeEndpoints(scale: any, d: any): [number, number] {
   const range = d.range || [-Infinity, Infinity]
   const start = Math.max(scale.domain()[0], range[0])
   const end = Math.min(scale.domain()[1], range[1])
@@ -30,15 +30,12 @@ function computeEndpoints (scale: any, d: any): [number, number] {
  *
  * @param {Object} chart Chart instance which is orchestrating this sampling operation
  * @param {Object} d a.k.a a single item from `data`
- * @returns {Array}
+ * @returns [number, number]
  */
-function evaluate (chart: Chart, d: FunctionPlotDatum) {
+function evaluate(chart: Chart, d: FunctionPlotDatum) {
   const range = computeEndpoints(chart.meta.xScale, d)
   const evalFn = evalTypeFn[d.sampler]
-  const nSamples = d.nSamples || Math.min(
-    globals.MAX_ITERATIONS,
-    globals.DEFAULT_ITERATIONS || (chart.meta.width * 2)
-  )
+  const nSamples = d.nSamples || Math.min(globals.MAX_ITERATIONS, globals.DEFAULT_ITERATIONS || chart.meta.width * 2)
 
   const data = evalFn(chart, d, range, nSamples)
   // NOTE: it's impossible to listen for the first eval event

src/evaluate.ts

@@ -21,4 +21,3 @@ declare module 'interval-arithmetic-eval' {
 
   export const policies: any
 }
-

src/external.d.ts

@@ -10,16 +10,16 @@ const samplers = {
 function getMathJS(): { compile: any } | null {
   if (typeof global === 'object' && 'math' in global) {
     // @ts-ignore
-    return global['math'] as any
+    return global.math as any
   }
   if (typeof window === 'object' && 'math' in window) {
     // @ts-ignore
-    return window['math']
+    return window.math
   }
   return null
 }
 
-let mathJS = getMathJS()
+const mathJS = getMathJS()
 if (mathJS) {
   // override the built-in module with mathjs's compile
   samplers.builtIn = mathJS.compile
@@ -48,7 +48,7 @@ function generateEvaluator(samplerName: 'interval' | 'builtIn') {
     //      eval: expression
     //    }
     //
-    // othewise throw an error
+    // otherwise throw an error
     if (typeof expression === 'string') {
       const compiled = samplers[samplerName](expression)
       if (mathJS && samplerName === 'builtIn') {
@@ -88,13 +88,12 @@ function generateEvaluator(samplerName: 'interval' | 'builtIn') {
    * - Evaluates the resulting function with the merge of meta.scope and
    *   `variables`
    *
-   * @param {Object} meta
-   * @param {String} property
-   * @param {Object} variables
-   * @returns {Number|Array} The builtIn evaluator returns a number, the
-   * interval evaluator an array
+   * @param meta
+   * @param property
+   * @param variables
+   * @returns The builtIn evaluator returns a number, the interval evaluator an array
    */
-  function evaluate(meta: any, property: string, variables: any) {
+  function evaluate(meta: any, property: string, variables: object) {
     // e.g.
     //
     //  meta: {

src/helpers/eval.ts

@@ -1,12 +1,11 @@
-// const d3 = window.d3
-import {select as d3Select, Selection} from 'd3-selection'
+import { select as d3Select, Selection } from 'd3-selection'
 import derivative from './derivative'
 import secant from './secant'
 
 import { Chart } from '../index'
 
 export default function helpers(chart: Chart) {
-  function helper (selection: Selection<any, any, any, any>) {
+  function helper(selection: Selection<any, any, any, any>) {
     selection.each(function () {
       const el = d3Select(this)
       el.call(derivative(chart))