Add page visibility state functionality (#79)

* Add document visibility state

* Add `purs-tidy`

* Use `EffectFn`s for `HTMLDocument` FFI

* Update CHANGELOG.md

* Fix `print` for `VisibilityState`

Author: garyb

.tidyrc.json

@@ -0,0 +1,10 @@
+{
+  "importSort": "ide",
+  "importWrap": "source",
+  "indent": 2,
+  "operatorsFile": null,
+  "ribbon": 1,
+  "typeArrowPlacement": "first",
+  "unicode": "never",
+  "width": null
+}

CHANGELOG.md

@@ -8,10 +8,13 @@ Breaking changes:
 
 New features:
 - Added `close` function for `Window` (#78 by @jmp-0x7C0)
+- Added `visibilityState` for `HTMLDocument` (#79 by @garyb)
 
 Bugfixes:
 
 Other improvements:
+- Added `purs-tidy` config and format checking (#79 by @garyb)
+- `HTMLDocument`'s FFI is now implemented in terms of `EffectFn` (#79 by @garyb)
 
 ## [v4.0.0](https://github.com/purescript-web/purescript-web-html/releases/tag/v4.0.0) - 2022-04-27
 

package.json

@@ -2,12 +2,13 @@
   "private": true,
   "scripts": {
     "clean": "rimraf output && rimraf .pulp-cache",
-    "build": "eslint src && pulp build -- --censor-lib --strict"
+    "build": "eslint src && purs-tidy check --config-require src && pulp build -- --censor-lib --strict"
   },
   "devDependencies": {
     "eslint": "^7.15.0",
     "pulp": "16.0.0-0",
     "purescript-psa": "^0.8.2",
+    "purs-tidy": "^0.9.2",
     "rimraf": "^3.0.2"
   }
 }

src/Web/HTML.purs

@@ -4,44 +4,42 @@ module Web.HTML
   ) where
 
 import Effect (Effect)
-import Web.HTML.Window (Window)
-import Web.HTML.Common (PropName, AttrName, ClassName) as Exports
-import Web.HTML.History (History) as Exports
+import Web.HTML.Common (AttrName, ClassName, PropName) as Exports
 import Web.HTML.HTMLAnchorElement (HTMLAnchorElement) as Exports
 import Web.HTML.HTMLAreaElement (HTMLAreaElement) as Exports
 import Web.HTML.HTMLAudioElement (HTMLAudioElement) as Exports
+import Web.HTML.HTMLBRElement (HTMLBRElement) as Exports
 import Web.HTML.HTMLBaseElement (HTMLBaseElement) as Exports
 import Web.HTML.HTMLBodyElement (HTMLBodyElement) as Exports
-import Web.HTML.HTMLBRElement (HTMLBRElement) as Exports
 import Web.HTML.HTMLButtonElement (HTMLButtonElement) as Exports
 import Web.HTML.HTMLCanvasElement (HTMLCanvasElement) as Exports
+import Web.HTML.HTMLDListElement (HTMLDListElement) as Exports
 import Web.HTML.HTMLDataElement (HTMLDataElement) as Exports
 import Web.HTML.HTMLDataListElement (HTMLDataListElement) as Exports
 import Web.HTML.HTMLDivElement (HTMLDivElement) as Exports
-import Web.HTML.HTMLDListElement (HTMLDListElement) as Exports
 import Web.HTML.HTMLDocument (HTMLDocument) as Exports
 import Web.HTML.HTMLElement (HTMLElement) as Exports
 import Web.HTML.HTMLEmbedElement (HTMLEmbedElement) as Exports
 import Web.HTML.HTMLFieldSetElement (HTMLFieldSetElement) as Exports
 import Web.HTML.HTMLFormElement (HTMLFormElement) as Exports
+import Web.HTML.HTMLHRElement (HTMLHRElement) as Exports
 import Web.HTML.HTMLHeadElement (HTMLHeadElement) as Exports
 import Web.HTML.HTMLHeadingElement (HTMLHeadingElement) as Exports
-import Web.HTML.HTMLHRElement (HTMLHRElement) as Exports
 import Web.HTML.HTMLIFrameElement (HTMLIFrameElement) as Exports
 import Web.HTML.HTMLImageElement (HTMLImageElement) as Exports
 import Web.HTML.HTMLInputElement (HTMLInputElement) as Exports
 import Web.HTML.HTMLKeygenElement (HTMLKeygenElement) as Exports
+import Web.HTML.HTMLLIElement (HTMLLIElement) as Exports
 import Web.HTML.HTMLLabelElement (HTMLLabelElement) as Exports
 import Web.HTML.HTMLLegendElement (HTMLLegendElement) as Exports
-import Web.HTML.HTMLLIElement (HTMLLIElement) as Exports
 import Web.HTML.HTMLLinkElement (HTMLLinkElement) as Exports
 import Web.HTML.HTMLMapElement (HTMLMapElement) as Exports
 import Web.HTML.HTMLMediaElement (HTMLMediaElement) as Exports
 import Web.HTML.HTMLMetaElement (HTMLMetaElement) as Exports
 import Web.HTML.HTMLMeterElement (HTMLMeterElement) as Exports
 import Web.HTML.HTMLModElement (HTMLModElement) as Exports
-import Web.HTML.HTMLObjectElement (HTMLObjectElement) as Exports
 import Web.HTML.HTMLOListElement (HTMLOListElement) as Exports
+import Web.HTML.HTMLObjectElement (HTMLObjectElement) as Exports
 import Web.HTML.HTMLOptGroupElement (HTMLOptGroupElement) as Exports
 import Web.HTML.HTMLOptionElement (HTMLOptionElement) as Exports
 import Web.HTML.HTMLOutputElement (HTMLOutputElement) as Exports
@@ -70,8 +68,10 @@ import Web.HTML.HTMLTitleElement (HTMLTitleElement) as Exports
 import Web.HTML.HTMLTrackElement (HTMLTrackElement) as Exports
 import Web.HTML.HTMLUListElement (HTMLUListElement) as Exports
 import Web.HTML.HTMLVideoElement (HTMLVideoElement) as Exports
+import Web.HTML.History (History) as Exports
 import Web.HTML.Location (Location) as Exports
 import Web.HTML.Navigator (Navigator) as Exports
+import Web.HTML.Window (Window)
 import Web.HTML.Window (Window) as Exports
 
 foreign import window :: Effect Window

src/Web/HTML/Event/DataTransfer.purs

@@ -72,6 +72,7 @@ foreign import _setDragImage :: DataTransfer -> Element -> Int -> Int -> Effect
 -- | The x and y coordinates define where the image appears relative to the mouse.
 setDragImage :: DataTransfer -> Element -> Int -> Int -> Effect Unit
 setDragImage = _setDragImage
+
 foreign import _dropEffect :: DataTransfer -> Effect String
 
 data DropEffect = Copy | Link | Move | None

src/Web/HTML/HTMLAnchorElement.purs

@@ -8,8 +8,8 @@ import Web.DOM (ChildNode, Element, Node, NonDocumentTypeChildNode, ParentNode)
 import Web.DOM.DOMTokenList (DOMTokenList)
 import Web.Event.EventTarget (EventTarget)
 import Web.HTML.HTMLElement (HTMLElement)
-import Web.Internal.FFI (unsafeReadProtoTagged)
 import Web.HTML.HTMLHyperlinkElementUtils (HTMLHyperlinkElementUtils)
+import Web.Internal.FFI (unsafeReadProtoTagged)
 
 foreign import data HTMLAnchorElement :: Type
 

src/Web/HTML/HTMLBaseElement.purs

@@ -53,7 +53,6 @@ toParentNode = unsafeCoerce
 toEventTarget :: HTMLBaseElement -> EventTarget
 toEventTarget = unsafeCoerce
 
-
 foreign import href :: HTMLBaseElement -> Effect String
 foreign import setHref :: String -> HTMLBaseElement -> Effect Unit
 

src/Web/HTML/HTMLCanvasElement.purs

@@ -53,7 +53,6 @@ toParentNode = unsafeCoerce
 toEventTarget :: HTMLCanvasElement -> EventTarget
 toEventTarget = unsafeCoerce
 
-
 -- typedef (CanvasRenderingContext2D or WebGLRenderingContext) RenderingContext;
 
 foreign import width :: HTMLCanvasElement -> Effect Int

src/Web/HTML/HTMLDataElement.purs

@@ -53,6 +53,5 @@ toParentNode = unsafeCoerce
 toEventTarget :: HTMLDataElement -> EventTarget
 toEventTarget = unsafeCoerce
 
-
 foreign import value :: HTMLDataElement -> Effect String
 foreign import setValue :: String -> HTMLDataElement -> Effect Unit

src/Web/HTML/HTMLDataListElement.purs

@@ -53,5 +53,4 @@ toParentNode = unsafeCoerce
 toEventTarget :: HTMLDataListElement -> EventTarget
 toEventTarget = unsafeCoerce
 
-
 foreign import options :: HTMLDataListElement -> Effect HTMLCollection