Merge branch 'canary/typescript'

giorgiabosello · Sep 29, 2023 · 0dac84a · 0dac84a
2 parents f593ad4 + efa080e
commit 0dac84a
Show file tree

Hide file tree

Showing 95 changed files with 8,616 additions and 6,960 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/.babelrc.json b/.babelrc.json
@@ -0,0 +1,16 @@
+{
+	"sourceType": "unambiguous",
+	"presets": [
+		[
+			"@babel/preset-env",
+			{
+				"targets": {
+					"chrome": 100
+				}
+			}
+		],
+		"@babel/preset-typescript",
+		"@babel/preset-react"
+	],
+	"plugins": []
+}
diff --git a/.commitlintrc.json b/.commitlintrc.json
@@ -0,0 +1,3 @@
+{
+	"extends": ["@commitlint/config-conventional"]
+}
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,46 +1,59 @@
 {
 	"root": true,
-	"extends": [
-		"eslint:recommended",
-		"plugin:prettier/recommended",
-		"plugin:react-hooks/recommended",
-		"plugin:import/recommended",
-		"plugin:react/recommended",
-		"prettier"
-	],
-	"plugins": ["react-hooks", "prettier", "typescript", "jsx"],
-	"rules": {
-		"import/no-unresolved": 0,
-		"import/first": "error",
-		"import/newline-after-import": "error",
-		"import/no-duplicates": "error",
-		"react/react-in-jsx-scope": "off",
-		"react-hooks/rules-of-hooks": "error",
-		"react-hooks/exhaustive-deps": "warn",
-		"react/prop-types": "warn",
-		"react/no-unknown-property": "warn"
-	},
 	"env": {
+		"browser": true,
+		"es2021": true,
 		"es6": true,
-		"node": true,
-		"browser": true
-	},
-	"settings": {
-		"react": {
-			"version": "detect"
-		}
+		"node": true
 	},
-	"parser": "@babel/eslint-parser",
+	"extends": ["plugin:react/recommended", "airbnb", "prettier"],
+	"parser": "@typescript-eslint/parser",
 	"parserOptions": {
-		"sourceType": "module",
-		"ecmaVersion": 2022,
-		"requireConfigFile": false,
-		"babelOptions": {
-			"presets": ["@babel/preset-react"]
-		}
+		"ecmaFeatures": {
+			"jsx": true
+		},
+		"ecmaVersion": "latest",
+		"sourceType": "module"
+	},
+	"plugins": ["react", "@typescript-eslint", "typescript-sort-keys", "unused-imports", "prettier", "prefer-arrow", "sort-class-members"],
+	"rules": {
+		"@typescript-eslint/no-unused-vars": "error",
+		"import/extensions": "off",
+		"import/no-extraneous-dependencies": "off",
+		"import/no-unresolved": "off",
+		"import/prefer-default-export": "off",
+		"no-nested-ternary": "off",
+		"no-plusplus": "off",
+		"no-unused-vars": "off",
+		"no-use-before-define": "off",
+		"prettier/prettier": "error",
+		"react/destructuring-assignment": "off",
+		"react/function-component-definition": "off",
+		"react/jsx-filename-extension": "off",
+		"react/jsx-props-no-spreading": "off",
+		"react/react-in-jsx-scope": "off",
+		"react/require-default-props": "off",
+		"typescript-sort-keys/interface": "error",
+		"typescript-sort-keys/string-enum": "error",
+		"unused-imports/no-unused-imports": "error",
+		"prefer-arrow/prefer-arrow-functions": [
+			"error",
+			{
+				"disallowPrototype": true,
+				"singleReturnOnly": true,
+				"classPropertiesAllowed": false
+			}
+		],
+		"sort-class-members/sort-class-members": [
+			"error",
+			{
+				"order": ["[static-properties]", "[properties]", "[conventional-private-properties]", "constructor", "[static-methods]", "[methods]", "[conventional-private-methods]"],
+				"accessorPairPositioning": "getThenSet"
+			}
+		]
 	},
-	"ignorePatterns": ["**/dist/**/*"],
 	"globals": {
-		"globalThis": "readonly"
+		"globalThis": "readonly",
+		"google": "readonly"
 	}
 }
diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml
@@ -1,59 +1,59 @@
 name: Bug Report
 description: Create a bug report for Google Maps React Markers
-labels: ["template: bug"]
+labels: ['template: bug']
 body:
-    - type: markdown
-      attributes:
-          value: If you leave out sections there is a high likelihood it will be moved to the GitHub Discussions ["Help" section](https://github.com/giorgiabosello/google-maps-react-markers/discussions/categories/help).
-    - type: checkboxes
-      attributes:
-          label: Verify latest release
-          description: "Verify that your issue reproduces in the [latest release](https://github.com/giorgiabosello/google-maps-react-markers/releases) before opening a new issue."
-          options:
-              - label: I verified that the issue exists in the latest release
-                required: true
-    - type: dropdown
-      attributes:
-          label: I know how to solve the bug
-          description: If you don't know how to solve the bug, the GitHub repository or the CodeSandbox example is required.
-          multiple: false
-          options:
-              - "I know how to solve the bug"
-              - "I don't know how to solve the bug and I will provide an example."
-    - type: input
-      attributes:
-          label: Link to the code that reproduces this issue
-          description: A link to a GitHub repository or a [CodeSandbox](https://codesandbox.io/) minimal reproduction. You can find a minimal reproduction example [here](https://github.com/giorgiabosello/google-maps-react-markers/tree/master/docs/src) and it should include only changes that contribute to the issue.
-      validations:
+  - type: markdown
+    attributes:
+      value: If you leave out sections there is a high likelihood it will be moved to the GitHub Discussions ["Help" section](https://github.com/giorgiabosello/google-maps-react-markers/discussions/categories/help).
+  - type: checkboxes
+    attributes:
+      label: Verify latest release
+      description: 'Verify that your issue reproduces in the [latest release](https://github.com/giorgiabosello/google-maps-react-markers/releases) before opening a new issue.'
+      options:
+        - label: I verified that the issue exists in the latest release
           required: true
-    - type: textarea
-      attributes:
-          label: To Reproduce
-          description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
-      validations:
-          required: true
-    - type: textarea
-      attributes:
-          label: Describe the Bug
-          description: A clear and concise description of what the bug is.
-      validations:
-          required: true
-    - type: textarea
-      attributes:
-          label: Expected Behavior
-          description: A clear and concise description of what you expected to happen.
-      validations:
-          required: true
-    - type: markdown
-      attributes:
-          value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
-    - type: markdown
-      attributes:
-          value: Contributors should be able to follow the steps provided in order to reproduce the bug.
-    - type: markdown
-      attributes:
-          value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
-    - type: input
-      attributes:
-          label: Which browser are you using? (if relevant)
-          description: "Please specify the exact version. For example: Chrome 100.0.4878.0"
+  - type: dropdown
+    attributes:
+      label: I know how to solve the bug
+      description: If you don't know how to solve the bug, the GitHub repository or the CodeSandbox example is required.
+      multiple: false
+      options:
+        - 'I know how to solve the bug'
+        - "I don't know how to solve the bug and I will provide an example."
+  - type: input
+    attributes:
+      label: Link to the code that reproduces this issue
+      description: A link to a GitHub repository or a [CodeSandbox](https://codesandbox.io/) minimal reproduction. You can find a minimal reproduction example [here](https://github.com/giorgiabosello/google-maps-react-markers/tree/master/docs/src) and it should include only changes that contribute to the issue.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
+  - type: markdown
+    attributes:
+      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
+  - type: input
+    attributes:
+      label: Which browser are you using? (if relevant)
+      description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml
@@ -1,6 +1,6 @@
 name: Feature Request
 description: Create a bug report for Google Maps React Markers
-labels: ["template: enhancement"]
+labels: ['template: enhancement']
 body:
   - type: markdown
     attributes:
@@ -25,4 +25,4 @@ body:
       label: Describe alternatives you've considered
       description: A clear and concise description of any alternative solutions or features you've considered.
     validations:
-      required: true
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-    - name: Ask a question
-      url: https://github.com/giorgiabosello/google-maps-react-markers/discussions
-      about: Ask questions and discuss with other community members
+  - name: Ask a question
+    url: https://github.com/giorgiabosello/google-maps-react-markers/discussions
+    about: Ask questions and discuss with other community members
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
diff --git a/.github/workflows/STALE_ISSUE.yml b/.github/workflows/STALE_ISSUE.yml
@@ -1,22 +1,22 @@
 name: Close inactive issues
 on:
-    schedule:
-        - cron: "30 1 * * *"
+  schedule:
+    - cron: '30 1 * * *'
 
 jobs:
-    close-issues:
-        runs-on: ubuntu-latest
-        permissions:
-            issues: write
-            pull-requests: write
-        steps:
-            - uses: actions/stale@v5
-              with:
-                  days-before-issue-stale: 30
-                  days-before-issue-close: 14
-                  stale-issue-label: "stale"
-                  stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
-                  close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
-                  days-before-pr-stale: -1
-                  days-before-pr-close: -1
-                  repo-token: ${{ secrets.GITHUB_TOKEN }}
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v5
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 14
+          stale-issue-label: 'stale'
+          stale-issue-message: 'This issue is stale because it has been open for 30 days with no activity.'
+          close-issue-message: 'This issue was closed because it has been inactive for 14 days since being marked as stale.'
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,29 @@
-#dependencies
-node_modules
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-docs/certificates
-docs/.env
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# JetBrains IDE files
+.idea/
+
+# testing
+/coverage
+
+# production
+# /dist
+
+# misc
+.DS_Store
+*.pem
+tsconfig.tsbuildinfo
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+#docs
+/docs/node_modules
+/docs/build
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+yarn commitlint --edit $1
diff --git a/.husky/common.sh b/.husky/common.sh
@@ -0,0 +1,8 @@
+command_exists () {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# Workaround for Windows 10, Git Bash and Yarn
+if command_exists winpty && test -t 1; then
+  exec < /dev/tty
+fi
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+yarn lint-staged
diff --git a/.npmignore b/.npmignore