forked from elm/compiler
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Brand as a npm package fork instead of as experimental
- Loading branch information
Showing
13 changed files
with
27 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,12 @@ | ||
# Elm | ||
# UNOFFICIAL ELM PACKAGE | ||
|
||
A delightful language for reliable webapps. | ||
**This is not the official `elm` repository!** | ||
|
||
Check out the [Home Page](http://elm-lang.org/), [Try Online](http://elm-lang.org/try), or [The Official Guide](http://guide.elm-lang.org/) | ||
This fork defaults to a branch with _no changes_ to the Elm compiler, _only to the npm package._ | ||
|
||
The npm package of this fork contains the _same binaries_ as the official package installs. The changes are: | ||
|
||
<br> | ||
- This package has no dependencies. | ||
- This package also contains binaries for macOS ARM 64-bit and Linux ARM 64-bit, [compiled by Mario Rogic](https://github.com/supermario/elm-tooling-compiler/commit/3af7f31a0ad5c4c7fe6df51220b3ec3e1d62a643). | ||
|
||
## Install | ||
|
||
✨ [Install](https://guide.elm-lang.org/install/elm.html) ✨ | ||
|
||
For multiple versions, previous versions, and uninstallation, see the instructions [here](https://github.com/elm/compiler/blob/master/installers/README.md). | ||
|
||
<br> | ||
|
||
## Help | ||
|
||
If you are stuck, ask around on [the Elm slack channel][slack]. Folks are friendly and happy to help with questions! | ||
|
||
[slack]: http://elmlang.herokuapp.com/ | ||
👉 [Official elm repository](https://github.com/elm/compiler) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,10 @@ | ||
# EXPERIMENTAL PACKAGE | ||
# UNOFFICIAL ELM PACKAGE | ||
|
||
**This is not the official `elm` npm package!** | ||
|
||
This is an experiment to package Elm as a dependency free npm package. If you want to try that out, go ahead and install this package. | ||
This is a fork of the Elm _npm package._ It contains the _same binaries_ as the official package installs. The changes are: | ||
|
||
👉 [Official elm package](https://www.npmjs.com/package/elm) | ||
|
||
|
||
# Elm Installer | ||
|
||
[Elm](https://elm-lang.org) is a functional programming language that compiles to JavaScript. | ||
|
||
Head over to [The Official Guide](https://guide.elm-lang.org/) to start learning Elm! | ||
|
||
|
||
<br/> | ||
|
||
## What is this package for? | ||
|
||
**Normal installs** ❌ | ||
|
||
Use the instructions [here](https://guide.elm-lang.org/install/elm.html) instead. | ||
|
||
**Multiple versions** ✅ | ||
|
||
People using Elm at work may use different versions of Elm in different projects. They can run `npm install [email protected]` in each project and use the binary at `./node_modules/.bin/elm` for compilation. | ||
|
||
**Continuous integration** ⚠️ | ||
|
||
This works, but there are usually faster and more reliable options: | ||
|
||
1. You can download `elm` directly from GitHub with [this script](https://github.com/elm/compiler/blob/master/installers/linux/README.md). This is all the `npm` installer does, but with extra HTTP requests to `npmjs.com` servers, making it slower and adding more failure points. | ||
2. Many continuous integration have ways to cache files ([example](https://docs.travis-ci.com/user/caching/)) to make builds faster and more reliable. | ||
|
||
That said, it will definitely work to use the `npm` installer on CI if you prefer that option. | ||
|
||
|
||
<br/> | ||
|
||
## Install Locally | ||
|
||
The following command should download the latest Elm 0.19.1 binary: | ||
|
||
``` | ||
npm install [email protected] | ||
``` | ||
|
||
You should be able to run `./node_modules/bin/elm --version` within your project and see `0.19.1`. Now you can compile with `./node_modules/bin/elm make src/Main.elm` and not disrupt other packages. | ||
|
||
Use `npm install [email protected]` or `npm install [email protected]` for earlier versions. | ||
|
||
**Note:** The `latest-X.Y.Z` convention is used in case we need to publish patches for the `npm` installer within a given Elm release. For example, say `npm` decides that some transitive dependency is not secure. Nothing is changing about Elm or the binaries, but we need to publish a new `npm` installer that fixes this issue. | ||
- This package has no dependencies. | ||
- This package also contains binaries for macOS ARM 64-bit and Linux ARM 64-bit, [compiled by Mario Rogic](https://github.com/supermario/elm-tooling-compiler/commit/3af7f31a0ad5c4c7fe6df51220b3ec3e1d62a643). | ||
|
||
👉 [Official elm package](https://www.npmjs.com/package/elm) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,12 @@ | ||
{ | ||
"name": "@lydell/elm", | ||
"version": "0.19.1-9", | ||
"description": "EXPERIMENTAL Installer for Elm: just downloads the binary into node_modules", | ||
"description": "Unofficial installer for Elm", | ||
"license": "BSD-3-Clause", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/lydell/compiler.git" | ||
}, | ||
"homepage": "https://github.com/lydell/compiler/tree/master/installers/npm", | ||
"bugs": "https://github.com/lydell/compiler/issues", | ||
"author": { | ||
"name": "Evan Czaplicki", | ||
"email": "[email protected]", | ||
"url": "https://github.com/evancz" | ||
}, | ||
"engines": { | ||
"node": ">=7.0.0" | ||
}, | ||
"repository": "lydell/compiler", | ||
"author": "Simon Lydell", | ||
"type": "commonjs", | ||
"exports": {}, | ||
"scripts": { | ||
"install": "node install.js" | ||
}, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Elm | ||
|
||
EXPERIMENTAL: This is the macOS ARM 64-bit binary for [Elm](https://elm-lang.org/). | ||
This is the macOS ARM 64-bit binary for [Elm](https://elm-lang.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Elm | ||
|
||
EXPERIMENTAL: This is the macOS 64-bit binary for [Elm](https://elm-lang.org/). | ||
This is the macOS 64-bit binary for [Elm](https://elm-lang.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Elm | ||
|
||
EXPERIMENTAL: This is the Linux ARM 64-bit binary for [Elm](https://elm-lang.org/). | ||
This is the Linux ARM 64-bit binary for [Elm](https://elm-lang.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Elm | ||
|
||
EXPERIMENTAL: This is the Linux 64-bit binary for [Elm](https://elm-lang.org/). | ||
This is the Linux 64-bit binary for [Elm](https://elm-lang.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Elm | ||
|
||
EXPERIMENTAL: This is the Windows 64-bit binary for [Elm](https://elm-lang.org/). | ||
This is the Windows 64-bit binary for [Elm](https://elm-lang.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters