Merge pull request #28 from PiwikPRO/fix/eslint-and-proper-types

fix: enable eslint and follow it's errors

Author: auto200

.eslintrc

@@ -0,0 +1,16 @@
+/** @type {import('eslint').Linter.Config} */
+const config = {
+  parser: '@typescript-eslint/parser',
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended-type-checked',
+  ],
+  plugins: ['@typescript-eslint'],
+  ignorePatterns:[".eslintrc.cjs", "example"],
+  parserOptions: {
+    project:true,
+    tsconfigRootDir: __dirname,
+  },
+}
+
+module.exports = config

.eslintrc.cjs

@@ -0,0 +1 @@
+v18.19.0

.nvmrc

@@ -4,7 +4,7 @@
   "semi": false,
   "tabWidth": 2,
   "bracketSpacing": true,
-  "jsxBracketSameLine": false,
+  "bracketSameLine": false,
   "arrowParens": "always",
   "trailingComma": "none"
 }

.prettierrc

@@ -190,7 +190,7 @@ Custom events enable tracking visitor actions that are not predefined in the exi
 import { CustomEvent } from '@piwikpro/react-piwik-pro'
 ```
 #### Methods
-* `trackEvent(category: string, action: string, name?: string, value?: number) ` - Tracks a custom event, e.g. when a visitor interacts with the page.
+* `trackEvent(category: string, action: string, name?: string, value?: number, dimensions?: Object) ` - Tracks a custom event, e.g. when a visitor interacts with the page.
 
 ### Site search Service
 Site search tracking gives you insights into how visitors interact with the search engine on your website - what they search for and how many results they get back.

README.md

@@ -36,5 +36,8 @@ const App = () => (
 )
 
 const container = document.getElementById('root')
-// @ts-ignore
+if(!container){
+  throw new Error("#root element not found")
+}
+
 createRoot(container).render(<App />)

example/package-lock.json

@@ -45,9 +45,15 @@ const CustomEventPage: FunctionComponent = () => {
                   variant='contained'
                   onClick={() => {
                     setFinish(true)
-                    CustomEvent.trackEvent('user_data_form', 'submit')
+                    CustomEvent.trackEvent(
+                      'user_data_form',
+                      'submit',
+                      'success',
+                      10,
+                      { dimension1: 'value1' }
+                    )
                     enqueueSnackbar(
-                      "CustomEvent.trackEvent('user_data_form', 'submit')",
+                      "CustomEvent.trackEvent('user_data_form', 'submit', 'success', 10, { dimension1: 'value1' })",
                       { variant: 'success' }
                     )
                   }}

example/src/main.tsx

@@ -21,7 +21,10 @@
     "test:unit": "cross-env CI=1 react-scripts test --env=jsdom",
     "test:watch": "react-scripts test --env=jsdom",
     "predeploy": "cd example && yarn install && yarn run build",
-    "deploy": "gh-pages -d example/build"
+    "deploy": "gh-pages -d example/build",
+    "format":"prettier src/**/*.ts --list-different",
+    "format:fix":"npm run format -- --write",
+    "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
@@ -41,15 +44,6 @@
     "babel-eslint": "^10.1.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-config-standard-react": "^13.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^5.1.2",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.33.2",
-    "eslint-plugin-standard": "^5.0.0",
     "gh-pages": "^6.1.1",
     "microbundle-crl": "^0.13.11",
     "npm-run-all": "^4.1.5",

example/src/pages/CustomEventPage.tsx

@@ -1,5 +1,3 @@
-import { PiwikProWindow } from '../interfaces/piwikpro.window'
-
 function init(containerId: string, containerUrl: string, nonce?: string) {
   if (!containerId) {
     console.error('Empty tracking code for Piwik Pro.')
@@ -37,7 +35,7 @@ tags.async=!0,tags.src="${containerUrl}/"+id+".js"+qPString,scripts.parentNode.i
 
 export const IS_DEBUG =
   (typeof process !== 'undefined' && process.env.NODE_ENV === 'development') ||
-  (typeof window !== 'undefined' && (window as PiwikProWindow).IS_DEBUG) ||
+  (typeof window !== 'undefined' && window.IS_DEBUG) ||
   false
 
 export default {