Add Priettier and CircleCI, improve README

jmarceli · jmarceli · commit 246bf7031a87 · 2020-01-19T01:20:13.000+01:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,19 @@
+version: 2.1
+
+jobs:
+  run_tests:
+    docker:
+      - image: circleci/node:10.18.1
+        environment:
+          TERM: xterm
+    steps:
+      - checkout
+      - run:
+          command: npm install
+      - run:
+          command: npm run ci:test
+
+workflows:
+  tests:
+    jobs:
+      - run_tests
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2018 Jan Grzegorowski
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -2,7 +2,11 @@
 
 > React useGoogleMaps hook
 
-[![NPM](https://img.shields.io/npm/v/react-hook-google-maps.svg)](https://www.npmjs.com/package/react-hook-google-maps)
+[![license](https://img.shields.io/github/license/react-hook-google-maps/react-hook-google-maps.svg)](https://opensource.org/licenses/MIT)
+[![version](https://img.shields.io/npm/v/react-hook-google-maps.svg)](https://www.npmjs.com/package/react-hook-google-maps)
+[![dependencies status](https://img.shields.io/david/react-hook-google-maps/react-hook-google-maps.svg)](https://david-dm.org/react-hook-google-maps/react-hook-google-maps)
+[![CI build](https://img.shields.io/circleci/project/github/react-hook-google-maps/react-hook-google-maps/master.svg)](https://circleci.com/gh/react-hook-google-maps/react-hook-google-maps)
+[![code coverage](https://img.shields.io/codecov/c/github/react-hook-google-maps/react-hook-google-maps.svg)](https://codecov.io/gh/react-hook-google-maps/react-hook-google-maps)
 
 Easiest way to use Google Maps in your React application.
 
@@ -28,8 +32,8 @@ const App = () => {
     // NOTE: even if you change options later
     {
       center: { lat: 0, lng: 0 },
-      zoom: 3
-    }
+      zoom: 3,
+    },
   );
   console.log(map); // instance of created Map object (https://developers.google.com/maps/documentation/javascript/reference/map)
   console.log(google); // google API object (easily get google.maps.LatLng or google.maps.Marker or any other Google Maps class)
@@ -45,8 +49,8 @@ export default App;
 
 ## License
 
-MIT
+[MIT](./LICENSE)
 
 ## Author
 
-Jan Grzegorowski [jmarceli](https://github.com/jmarceli)
+Jan Grzegorowski
diff --git a/example/src/Map.tsx b/example/src/Map.tsx
@@ -7,8 +7,8 @@ export const Map = React.memo(function Map() {
     "AIzaSyC4Z5Qz97EWcoCczNn2IcYvaYG0L9pe6Rk",
     {
       center: { lat: 0, lng: 0 },
-      zoom: 3
-    }
+      zoom: 3,
+    },
   );
   console.log("render Map");
 
diff --git a/example/src/MapWithMarker.tsx b/example/src/MapWithMarker.tsx
@@ -9,8 +9,8 @@ export const MapWithMarker = React.memo(function Map() {
     "AIzaSyC4Z5Qz97EWcoCczNn2IcYvaYG0L9pe6Rk",
     {
       zoom: 4,
-      center: uluru
-    }
+      center: uluru,
+    },
   );
   console.log("render MapWithMarkers");
 
diff --git a/example/tsconfig.json b/example/tsconfig.json
@@ -1,11 +1,7 @@
 {
   "compilerOptions": {
     "target": "es5",
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "esnext"
-    ],
+    "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
@@ -19,7 +15,5 @@
     "noEmit": true,
     "jsx": "react"
   },
-  "include": [
-    "src"
-  ]
+  "include": ["src"]
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,12 +2,24 @@
   "name": "react-hook-google-maps",
   "version": "0.0.2",
   "description": "React useGoogleMaps hook",
-  "author": "Jan Grzegorowski",
+  "author": "Jan Grzegorowski (https://www.grzegorowski.com)",
   "license": "MIT",
-  "repository": "jmarceli/react-hook-google-maps",
+  "private": false,
+  "repository": "https://github.com/jmarceli/react-hook-google-maps",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
   "jsnext:main": "dist/index.es.js",
+  "keywords": [
+    "react",
+    "google-maps",
+    "hook",
+    "useGoogleMaps",
+    "google-maps-api"
+  ],
+  "homepage": "https://github.com/jmarceli/react-hook-google-maps",
+  "bugs": {
+    "url": "https://github.com/jmarceli/react-hook-google-maps/issues"
+  },
   "engines": {
     "node": ">=8",
     "npm": ">=5"
@@ -36,6 +48,7 @@
     "@types/react-dom": "^16.9.4",
     "cross-env": "^6.0.3",
     "gh-pages": "^2.2.0",
+    "prettier": "^1.19.1",
     "react": "^16.12.0",
     "react-dom": "^16.12.0",
     "react-scripts": "3.3.0",
diff --git a/prettier.config.js b/prettier.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+  trailingComma: "all",
+  tabWidth: 2,
+};
diff --git a/rollup.config.js b/rollup.config.js
@@ -16,27 +16,27 @@ export default {
       file: pkg.main,
       format: "cjs",
       exports: "named",
-      sourcemap: true
+      sourcemap: true,
     },
     {
       file: pkg.module,
       format: "es",
       exports: "named",
-      sourcemap: true
-    }
+      sourcemap: true,
+    },
   ],
   plugins: [
     external(),
     postcss({
-      modules: true
+      modules: true,
     }),
     url(),
     svgr(),
     resolve(),
     typescript({
       rollupCommonJSResolveHack: true,
-      clean: true
+      clean: true,
     }),
-    commonjs()
-  ]
+    commonjs(),
+  ],
 };
diff --git a/src/__tests__/useGoogleMaps.test.ts b/src/__tests__/useGoogleMaps.test.ts
@@ -4,8 +4,8 @@ import { useGoogleMaps } from "..";
 const mapObject = { map: "object" };
 const googleMock = {
   maps: {
-    Map: jest.fn().mockImplementation(() => mapObject)
-  }
+    Map: jest.fn().mockImplementation(() => mapObject),
+  },
 };
 const windowMock = { ...window, google: googleMock };
 const loadEvent = new Event("load");
@@ -18,7 +18,7 @@ describe("useMap hook", () => {
 
     // when
     const { result } = renderHook(() =>
-      useGoogleMaps("GOOGLE_MAPS_API_KEY", mapOptions)
+      useGoogleMaps("GOOGLE_MAPS_API_KEY", mapOptions),
     );
     act(() => {
       windowSpy.mockImplementation(() => windowMock);
@@ -27,7 +27,7 @@ describe("useMap hook", () => {
 
     // then
     expect(document.querySelectorAll("script")[0].getAttribute("src")).toBe(
-      "https://maps.googleapis.com/maps/api/js?key=GOOGLE_MAPS_API_KEY"
+      "https://maps.googleapis.com/maps/api/js?key=GOOGLE_MAPS_API_KEY",
     );
     expect(result.current.google).toBe(googleMock);
     expect(result.current.map).toBe(mapObject);
diff --git a/src/__tests__/useGoogleMapsApi.test.ts b/src/__tests__/useGoogleMapsApi.test.ts
@@ -12,7 +12,7 @@ describe("useGoogleMapsApi hook", () => {
 
     // when
     const { result } = renderHook(() =>
-      useGoogleMapsApi("GOOGLE_MAPS_API_KEY")
+      useGoogleMapsApi("GOOGLE_MAPS_API_KEY"),
     );
     act(() => {
       windowSpy.mockImplementation(() => windowMock);
@@ -21,7 +21,7 @@ describe("useGoogleMapsApi hook", () => {
 
     // then
     expect(document.querySelectorAll("script")[0].getAttribute("src")).toBe(
-      "https://maps.googleapis.com/maps/api/js?key=GOOGLE_MAPS_API_KEY"
+      "https://maps.googleapis.com/maps/api/js?key=GOOGLE_MAPS_API_KEY",
     );
     expect(result.current).toBe(googleMock);
 
@@ -35,7 +35,7 @@ describe("useGoogleMapsApi hook", () => {
 
     // when
     const { result, rerender } = renderHook(() =>
-      useGoogleMapsApi("GOOGLE_MAPS_API_KEY")
+      useGoogleMapsApi("GOOGLE_MAPS_API_KEY"),
     );
     act(() => {
       windowSpy.mockImplementation(() => windowMock);
diff --git a/src/useGoogleMapsApi.ts b/src/useGoogleMapsApi.ts
@@ -36,7 +36,7 @@ export function useGoogleMapsApi(apiKey: string) {
       script.remove();
       initialized.splice(
         initialized.findIndex(el => el.src === src),
-        1
+        1,
       );
     };
   }, [apiKey]);
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,12 +3,7 @@
     "outDir": "build",
     "module": "esnext",
     "target": "es5",
-    "lib": [
-      "es6",
-      "dom",
-      "es2016",
-      "es2017"
-    ],
+    "lib": ["es6", "dom", "es2016", "es2017"],
     "sourceMap": true,
     "allowJs": false,
     "jsx": "react",
@@ -30,14 +25,6 @@
     "isolatedModules": true,
     "noEmit": true
   },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "node_modules",
-    "build",
-    "dist",
-    "example",
-    "rollup.config.js"
-  ]
+  "include": ["src"],
+  "exclude": ["node_modules", "build", "dist", "example", "rollup.config.js"]
 }
diff --git a/tsconfig.test.json b/tsconfig.test.json
@@ -3,4 +3,4 @@
   "compilerOptions": {
     "module": "commonjs"
   }
-}
+}
