@curtissimo/elm-hot 1.1.7

package/CHANGELOG

@@ -0,0 +1,40 @@
+# Changelog
+
+## 1.1.7
+- Remove the use of `eval` in the code
+- Format JavaScript files
+- Fix warnings in Elm files
+
+## 1.1.6
+- more lenient search for Browser.Navigation.Key in the generated JS
+- updated dependencies
+
+## 1.1.5
+- update dependencies
+
+## 1.1.4
+- fixed a bug where HMR failed because `Browser.Navigation.Key` changed location
+- fixed a crash when the app's `Model` contains `Json.Encode.null`
+
+## 1.1.3
+- fixed a crash when using Elm debugger and elm/browser 1.0.2
+
+## 1.1.2
+- fixed a bug where HMR would not work for very small ("toy") Elm projects
+
+## 1.1.1
+- added support for Elm 0.19.1
+
+## 1.0.1
+- bug fixes
+
+## 1.0.0
+- improved Browser.application support (Browser.Navigation.Key can be stored
+  anywhere in your model now) 
+
+## 0.9.1
+- separated the Webpack loader out into its own package
+- exposed core API
+
+## 0.9.0
+- first release

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at coc@curtissimo.com. All complaints
+will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated to
+maintain confidentiality with regard to the reporter of an incident. Further
+details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

package/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Welcome, we really appreciate if you're considering to contribute, the joint
+effort of our contributors make projects like this possible!
+
+The goal of this document is to provide guidance on how you can get involved.
+
+## Asking questions
+
+Have a question or feature request? Feel free to open a new issue on the
+[Issue](https://gitlab.com/curtissimo/elm-hot/-/issues) board.
+
+Please be polite and take the time to write a well-worded request or question so
+our community members can easily assist you.
+
+## Prerequisites
+
+Before starting make sure you have the following installed:
+
+- [git](https://git-scm.com)
+- [Node](https://nodejs.org) at LTS (with NPM)
+
+## Pull requests
+
+For significant changes, it is recommended that you first [propose your
+solution](https://gitlab.com/curtissimo/elm-hot/-/issues) and gather feedback.
+
+**Before submitting a pull request,** you can follow this step by step guide:
+
+1. [Fork](https://docs.gitlab.com/user/project/repository/forking_workflow/)
+   the repository and setup a new branch to work in.
+1. [Create a new
+   branch](https://docs.gitlab.com/user/project/repository/branches/#create-a-branch∑)
+   for your changes. 
+2. Run `npm install` to install dependencies.
+3. If you fix a bug or introduce a new feature, add tests or ask for help if the
+   use-case is more complex.
+4. Commit the `package-lock.json` file if it has changed.
+
+⚠️ Don't modify the `package.json` versioning
+
+Once you are ready to create a pull request, provide relevant details about the
+change; examples; and test cases. All submissions require review, so please be
+patient!
+
+## Credits
+
+### Contributors
+
+Thanks to [Keith Lazuka](https://github.com/klazuka) (GitHub) for intitially
+creating this.

package/LICENSE.txt

@@ -0,0 +1,33 @@
+Copyright 2018 Keith Lazuka
+
+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.
+
+---------------------------------------
+
+Based on fluxxu/elm-hot-loader (https://github.com/fluxxu/elm-hot-loader)
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Flux Xu
+
+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.

package/README.md

@@ -0,0 +1,84 @@
+# @curtissimo/elm-hot
+
+This package provides the core infrastructure needed for doing hot code swapping
+in Elm. It supports Elm 0.19.0 and 0.19.1 only.
+
+**This low-level package is intended for authors of Elm application servers.**
+
+This package is primarily maintained for use with
+[Parcel](https://parceljs.org/) and its [built-in support for
+Elm](https://parceljs.org/elm.html) which uses this package.
+
+The goal of this package is to provide a reusable core that can be used to
+provide hot code swapping support in a variety of environments.
+
+### Installing `elm-hot` core API
+
+This really should only be a development dependency.
+
+```bash
+$ npm install --save-dev elm-hot
+```
+
+-------------------------------------------
+
+### Testing
+
+These tests run against both Elm 0.19.0 and 0.19.1. Switching out binaries
+and modifying the `elm.json` file is a little bit of a chore, but do-able.
+
+These integration tests are _sloooooow_, like it takes five minutes slow.
+
+Our goals with testing are:
+
+- Provide dockerized testing environments to isolate the various versions of the
+  Elm compiler
+- Increase the speed of the tests because ... well, five minutes ... that's a
+  long time
+
+-------------------------------------------
+
+### Core API
+
+**`function inject(str)`**
+
+Injects the hot code swapping functionality into a compiled Elm app.
+
+- Takes the Javascript code emitted by the Elm compiler as an input string
+- Returns a string containing the injected code ready to be evaluated in the
+  browser.  
+
+### Example of how the core API could be used 
+
+```javascript
+const elmHot = require('elm-hot');
+const {compileToStringSync} = require('node-elm-compiler');
+const injectedCode = elmHot.inject(compileToStringSync(["src/Main.elm"], {}));
+```
+
+In order to provide something similar to `webpack-dev-server` with hot module
+reloading, an application server could be developed to do the following:
+
+- Serve a modified version of the developer's `index.html` to receive push
+  events from the server
+- Watch `.elm` files on disk for changes
+- Push a "file changed" event to the client notifying it that it should fetch
+  new code from the server
+- When the client receives the event:
+    - Fetch the new code (the server will re-compile the Elm code and use
+      `elm-hot` to inject the hot-code-swapping logic)
+    - The client deletes the old `Elm` object and injects the new code
+      from the server
+    
+Keith Lazuka implemented something similar to this for the integration tests.
+See [test/server.js]() and [test/client.js]() for inspiration.
+
+-------------------------------------------
+
+### Attribution
+
+This is an active fork of Keith Lazuka's
+[elm-hot](https://github.com/klazuka/elm-hot/) GitHub repository.
+
+Elm hot code swapping is based on the work of Flux Xu's
+[elm-hot-loader](https://github.com/fluxxu/elm-hot-loader).

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@curtissimo/elm-hot",
+  "version": "1.1.7",
+  "description": "Hot code swapping for Elm",
+  "keywords": [
+    "Elm",
+    "HMR",
+    "hot",
+    "reload"
+  ],
+  "author": "Keith Lazuka",
+  "maintainers": [
+    "Curtis Schlak <696163-realistschuckle@users.noreply.gitlab.com>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/curtissimo/elm-hot.git"
+  },
+  "license": "MIT",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "./test.sh"
+  },
+  "ava": {
+    "files": [
+      "test/test.js"
+    ]
+  },
+  "devDependencies": {
+    "ava": "^6.4.1",
+    "chokidar": "^5.0.0",
+    "elm-format": "^0.8.8",
+    "express": "^5.2.1",
+    "puppeteer": "^24.34.0",
+    "tap-xunit": "^2.4.1"
+  }
+}