Format all code

Author: davwheat

.github/CONTRIBUTING.md

@@ -5,16 +5,16 @@ welcome, from issue reports to PRs and documentation / write-ups.
 
 Before you open a PR:
 
-* If you're planning to add or change a major feature in a PR, please ensure
-the change is aligned with the project roadmap by opening an issue first,
-especially if you're going to spend a lot of time on it.
-* In development, run `yarn start` to build (+watch) the project source, and run
-the [development server](http://localhost:8000).
-* Please ensure all the examples work correctly after your change. If you're
-adding a major new use-case, add a new example demonstrating its use.
-* Please **DO NOT** commit the build files. Make sure **ONLY** your changes to
-`/src/` and `/examples/src` are included in your PR.
-* Be careful to follow the code style of the project. Run `yarn run lint` after
-your changes and ensure you do not introduce any new errors or warnings.
-* All new features and changes need documentation.
-* Make sure yarn.lock is updated when you add or upgrade dependencies.
+- If you're planning to add or change a major feature in a PR, please ensure
+  the change is aligned with the project roadmap by opening an issue first,
+  especially if you're going to spend a lot of time on it.
+- In development, run `yarn start` to build (+watch) the project source, and run
+  the [development server](http://localhost:8000).
+- Please ensure all the examples work correctly after your change. If you're
+  adding a major new use-case, add a new example demonstrating its use.
+- Please **DO NOT** commit the build files. Make sure **ONLY** your changes to
+  `/src/` and `/examples/src` are included in your PR.
+- Be careful to follow the code style of the project. Run `yarn run lint` after
+  your changes and ensure you do not introduce any new errors or warnings.
+- All new features and changes need documentation.
+- Make sure yarn.lock is updated when you add or upgrade dependencies.

.github/HISTORY.md

@@ -1,12 +1,15 @@
 # React-Images
 
 ### v1.0.0 / 2019-06-05
+
 - v1 release
 
 ### v0.5.19 / 2018-07-19
+
 - Fix babel lib output not transpiling
 
 ### v0.5.18 / 2018-07-19
+
 - LightBox srcSet support for string and array #236 thanks to [lordoffreaks](https://github.com/lordoffreaks)
 - Upgrade react-transition-group to v2 #238 thanks to [filipecosta01](https://github.com/filipecosta01)
 - Add zindex to close button to bring it in front of spinner #225 thanks to [seanpascoe](https://github.com/seanpascoe)
@@ -15,148 +18,176 @@
 - Fix Lightbox srcSet prop type validation #209 thanks to [kripod](https://github.com/kripod)
 
 ### v0.5.17 / 2018-02-07
+
 - fix for "srcSet" inconsistency #204 thanks to [kripod](https://github.com/kripod) and [wmertens](https://github.com/wmertens)
 - fix for preload bug when mounted with `isOpen` set to true thanks to [mkalygin](https://github.com/mkalygin)
 - removed `react-spinners` dependency which was bloating the bundle, and implemented a simple loading component, thanks [kripod](https://github.com/kripod)
 - support for conditional ScrollLock via new property `preventScroll` thanks to [Josh-a-e](https://github.com/Josh-a-e)
 
 ### v0.5.16 / 2018-01-30
+
 - add preloadImage call to componentDidMount PR #200 thanks to [ilker0](https://github.com/ilker0)
 - Changes some docs to clarify that yarn is the preferred package manager for this project. Removes package-lock.json. PR #191 Thanks to [jorrit](https://github.com/jorrit)
-- Unmount the component tree before removing the portal node from DOM PR #180 thanks to  [pleunv](https://github.com/pleunv)
+- Unmount the component tree before removing the portal node from DOM PR #180 thanks to [pleunv](https://github.com/pleunv)
 - Fix react warnings by updating react-scrolllock version [jorrit](https://github.com/jorrit))
 
 ### v0.5.15 / 2018-01-25
+
 - spinner functionality pull request #187 thanks to [mkalygin](https://github.com/mkalygin)
 
 ### v0.5.13 / 2017-11-29
+
 - change srcset to srcSet to fix intermittent warning: Invalid DOM property `srcset`. Did you mean `srcSet`?
 
 ### v0.5.12 / 2017-11-29
--  Fix React warning issue #171 thanks to [kachkaev](https://github.com/kachkaev)
+
+- Fix React warning issue #171 thanks to [kachkaev](https://github.com/kachkaev)
 
 ### v0.5.10 / 2017-10-18
+
 - New build
 
 ### v0.5.8 / 2017-10-06
+
 - Incorrect peer dependency in package.json file
 
 ### v0.5.7 / 2017-10-04
+
 - Fix warnings for React 16.0.0 and update dependencies
 
 ### v0.5.6 / 2017-09-20
+
 - Update: Let user pass in srcSet as prop in addition to srcset thanks to [smeijer](https://github.com/smeijer)
 - Fix: default arrow bg color is none
 - Fix: make content div, figure, image respond to theme props #127
 - Fix: caption extending and disabling backdropClosesModal click issue #156
 - Fix: alignment in safari issue #105
 
 ### v0.5.5 / 2017-07-28
+
 - Fix: let user override all possible properties with theme object thanks to [clintharris](https://github.com/clintharris)
 - Fix: clicking on image closes lightbox when backdropClosesModal is set to true #152
 - Fix: clicking close lightbox button fired onClose handler twice #155
 
 ### v0.5.4 / 2017-05-31
+
 - Update: separate out prop-types for React 16 thanks to [hiyamamo](https:github.com/hiyamamo)
 - Update: update react-addons-css-transition-group to react-transition-group thanks to [neptunian](https://github.com/neptunian)
 - Fix: React warnings in React v15.5.0
 
 ### v0.5.2 / 2016-11-17
+
 - Fix: keydown listeners thanks to [aknuds1](https:github.com/aknuds1) [archr](https:github.com/archr)
 - Fix: thumbnail click propagation thanks to [GregoryPotdevin](https://github.com/GregoryPotdevin)
 - Update: use abstracted ScrollLock component
 
 ### v0.5.1 / 2016-08-21
-* Feature: Support theming with aphrodite classes
-* Examples: Update options with new new prop details
+
+- Feature: Support theming with aphrodite classes
+- Examples: Update options with new new prop details
 
 ### v0.5.0 / 2016-08-20
-* Feature: Added a thumbnail preview beneath the lightbox thanks to [GregoryPotdevin](https://github.com/GregoryPotdevin)
-* Feature: Re-implemented the layout using `flexbox`
-* Examples: Replaced local images with hot-linked Unsplash photographs
 
-* * *
+- Feature: Added a thumbnail preview beneath the lightbox thanks to [GregoryPotdevin](https://github.com/GregoryPotdevin)
+- Feature: Re-implemented the layout using `flexbox`
+- Examples: Replaced local images with hot-linked Unsplash photographs
+
+---
 
 ### v0.4.11 / 2016-08-15
-* Feature: Pre-load the next image based on user intention, uses new prop `preloadNextImage`
-* Fix: bug with `enableKeyboardInput` where images fail to render thanks to [benhowell](https://github.com/benhowell)
-* Bump dev dependencies for `react` and `react-dom` to `15.3.0`
-* Increase the default max-width of the Lightbox to `1024px`
+
+- Feature: Pre-load the next image based on user intention, uses new prop `preloadNextImage`
+- Fix: bug with `enableKeyboardInput` where images fail to render thanks to [benhowell](https://github.com/benhowell)
+- Bump dev dependencies for `react` and `react-dom` to `15.3.0`
+- Increase the default max-width of the Lightbox to `1024px`
 
 ### v0.4.10 / 2016-08-11
-* Fix react PropTypes warning. See [fixing-the-false-positive](https://facebook.github.io/react/warnings/dont-call-proptypes.html#fixing-the-false-positive-in-third-party-proptypes)
-* Simplify fade transition using `react-css-addons-transition-group`
+
+- Fix react PropTypes warning. See [fixing-the-false-positive](https://facebook.github.io/react/warnings/dont-call-proptypes.html#fixing-the-false-positive-in-third-party-proptypes)
+- Simplify fade transition using `react-css-addons-transition-group`
 
 ### v0.4.9 / 2016-07-28
-* Resolve react "no-unused-prop" warnings [benhowell](https://github.com/benhowell)
+
+- Resolve react "no-unused-prop" warnings [benhowell](https://github.com/benhowell)
 
 ### v0.4.7 / 2016-07-14
-* Custom controls thanks to [robintail](https://github.com/robintail)
-* dependency fix for `react-addons-transition-group` thanks to [fend25](https://github.com/fend25)
+
+- Custom controls thanks to [robintail](https://github.com/robintail)
+- dependency fix for `react-addons-transition-group` thanks to [fend25](https://github.com/fend25)
 
 ### v0.4.6 / 2016-05-17
-* General cleanup
+
+- General cleanup
 
 ### v0.4.5 / 2016-05-16
-* Added `imageCountSeparator` prop to replace " of " in the image count
+
+- Added `imageCountSeparator` prop to replace " of " in the image count
 
 ### v0.4.4 / 2016-05-16
-* Account for scrollbar width when opening/closing the lightbox
-* Remove required flag on `onClickNext` and `onClickPrev` - may only render a single image
-* Increase dialog z-index to `2001` thanks to [newsiberian](https://github.com/newsiberian)
+
+- Account for scrollbar width when opening/closing the lightbox
+- Remove required flag on `onClickNext` and `onClickPrev` - may only render a single image
+- Increase dialog z-index to `2001` thanks to [newsiberian](https://github.com/newsiberian)
 
 ### v0.4.3 / 2016-05-16
-* Resolve peer-dependency issues thanks to [jedwatson](https://github.com/jedwatson)
+
+- Resolve peer-dependency issues thanks to [jedwatson](https://github.com/jedwatson)
 
 ### v0.4.2 / 2016-05-14
-* Update dependencies
+
+- Update dependencies
 
 ### v0.4.1 / 2016-05-12
-* Update peer dependencies
+
+- Update peer dependencies
 
 ### v0.4.0 / 2016-05-12
-* Bump all applicable dependencies
-* Remove peer dependencies
 
-* * *
+- Bump all applicable dependencies
+- Remove peer dependencies
+
+---
 
 ### v0.3.3 / 2016-05-12
-* Updated website with more info + new design
-* Introduction of `onClickImage` prop thanks to [pradel](https://github.com/pradel)
-* Documentation for `showImageCount` thanks to [neptunian](https://github.com/neptunian)
+
+- Updated website with more info + new design
+- Introduction of `onClickImage` prop thanks to [pradel](https://github.com/pradel)
+- Documentation for `showImageCount` thanks to [neptunian](https://github.com/neptunian)
 
 ### v0.3.2 / 2016-01-20
-* Fix backdropClosesModal behaviour
-* Update defaults: backdropClosesModal `false`, showCloseButton `true`
+
+- Fix backdropClosesModal behaviour
+- Update defaults: backdropClosesModal `false`, showCloseButton `true`
 
 ### v0.3.1 / 2016-01-15
-* Updated react dependencies
-* Better handling of lightbox positioning
+
+- Updated react dependencies
+- Better handling of lightbox positioning
 
 ### v0.3.0 / 2016-01-06
 
-* Update to use ES6
-* Update to use JSS
-* Layout refactor:
-	- Moved away from CSS transforms for centering
-	- Improved responsiveness, performance
-* Update example images to Gratisography
-* Optional captions below images thanks to [@ko](https://github.com/ko)
-* Optional count below images e.g. "3 of 12"
-* Move close button top right of frame, and replace with × icon
+- Update to use ES6
+- Update to use JSS
+- Layout refactor:
+  - Moved away from CSS transforms for centering
+  - Improved responsiveness, performance
+- Update example images to Gratisography
+- Optional captions below images thanks to [@ko](https://github.com/ko)
+- Optional count below images e.g. "3 of 12"
+- Move close button top right of frame, and replace with × icon
 
-* * *
+---
 
 ### v0.2.1 / 2015-11-29
 
-* Fix bug in examples with `goto` functions
+- Fix bug in examples with `goto` functions
 
 ### v0.2.0 / 2015-11-29
 
-* Make the component stateless, now uses functions `onClickPrev`/`onClickNext`
+- Make the component stateless, now uses functions `onClickPrev`/`onClickNext`
 
-* * *
+---
 
 ### v0.1.0 / 2015-11-20
 
-* Support for `srcset` thanks to [@neptunian](https://github.com/neptunian)
+- Support for `srcset` thanks to [@neptunian](https://github.com/neptunian)

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,10 +6,8 @@
 
 **Description of changes:**
 
-
 **Related issues (if any):**
 
-
 **Checks:**
 
 - [ ] Please confirm `yarn run lint` ran successfully

.github/workflows/main.yml

@@ -1,5 +1,6 @@
 name: CI
 on: [push, pull_request]
+
 jobs:
   lint:
     name: ✔️ Lint
@@ -12,10 +13,25 @@ jobs:
       - uses: borales/actions-yarn@v2.0.0
         with:
           cmd: run lint
+
+  check-formatting:
+    name: ✔️ Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: borales/actions-yarn@v2.0.0
+        with:
+          cmd: install
+      - uses: borales/actions-yarn@v2.0.0
+        with:
+          cmd: run format:check
+
   build:
     name: 🛠️ Build
     runs-on: ubuntu-latest
-    needs: lint
+    needs:
+      - lint
+      - check-formatting
     steps:
       - uses: actions/checkout@v1
       - uses: borales/actions-yarn@v2.0.0

README.md

@@ -5,6 +5,7 @@
 **Don't use this in a new project.** This package hasn't been properly maintained in a long time and there are much better options available.
 
 **Instead, try...**
+
 - [React Responsive Carousel](http://react-responsive-carousel.js.org/)
 
 ---
@@ -22,7 +23,9 @@ Start by installing `react-images`
 ```bash
 npm install react-images
 ```
+
 or
+
 ```bash
 yarn add react-images
 ```
@@ -38,14 +41,14 @@ Import the carousel from `react-images` at the top of a
 component and then use it in the render function.
 
 ```jsx
-import React from 'react';
-import Carousel from 'react-images';
+import React from 'react'
+import Carousel from 'react-images'
 
-const images = [{ source: 'path/to/image-1.jpg' }, { source: 'path/to/image-2.jpg' }];
+const images = [{ source: 'path/to/image-1.jpg' }, { source: 'path/to/image-2.jpg' }]
 
 class Component extends React.Component {
   render() {
-    return <Carousel views={images} />;
+    return <Carousel views={images} />
   }
 }
 ```
@@ -60,18 +63,18 @@ The `ModalGateway` will insert the modal just before the
 end of your `<body />` tag.
 
 ```jsx
-import React from 'react';
-import Carousel, { Modal, ModalGateway } from 'react-images';
+import React from 'react'
+import Carousel, { Modal, ModalGateway } from 'react-images'
 
-const images = [{ source: 'path/to/image-1.jpg' }, { source: 'path/to/image-2.jpg' }];
+const images = [{ source: 'path/to/image-1.jpg' }, { source: 'path/to/image-2.jpg' }]
 
 class Component extends React.Component {
-  state = { modalIsOpen: false };
+  state = { modalIsOpen: false }
   toggleModal = () => {
-    this.setState(state => ({ modalIsOpen: !state.modalIsOpen }));
-  };
+    this.setState(state => ({ modalIsOpen: !state.modalIsOpen }))
+  }
   render() {
-    const { modalIsOpen } = this.state;
+    const { modalIsOpen } = this.state
 
     return (
       <ModalGateway>
@@ -81,7 +84,7 @@ class Component extends React.Component {
           </Modal>
         ) : null}
       </ModalGateway>
-    );
+    )
   }
 }
 ```
@@ -91,7 +94,7 @@ class Component extends React.Component {
 The simplest way to define a list of images for the carousel looks like:
 
 ```jsx
-const images = [{ source: 'path/to/image-1.jpg' }, { source: 'path/to/image-2.jpg' }];
+const images = [{ source: 'path/to/image-1.jpg' }, { source: 'path/to/image-2.jpg' }]
 ```
 
 However, react-images supports several other properties on each image object than just `source`. For example: