@chouquette/gleam 1.0.0

package/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "semi": false,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "es5",
+  "importOrder": ["^\\@.*$", "^[^@\\.].*$", "^\\..*$"],
+  "importOrderSortSpecifiers": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "proseWrap": "always"
+}

package/LICENCE

@@ -0,0 +1,7 @@
+Copyright 2024 Guillaume Hivert
+
+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,48 @@
+# Gleam Lang
+
+[Gleam](https://gleam.run) is a functional language that compiles to JavaScript!
+More information can be found
+[in the documentation](https://gleam.run/documentation/) directly, to get you
+started!
+
+## What is this package for?
+
+For stantard development purposes, a classic gleam installation should be done,
+[following the official instructions](https://gleam.run/getting-started/installing/).
+However, having a gleam package on NPM allows everyone to embed gleam directly
+from a `package.json`, for certain scenarios:
+
+- When running on CI, and dependent on the `package.json`.
+- When you can't install softwares directly.
+- When you want to maintain multiple versions of gleam with NPM.
+
+## Installation
+
+```
+yarn add @chouquette/gleam
+```
+
+## Usage
+
+```
+yarn gleam --help
+```
+
+## Goal of the package
+
+This package will mimic main releases of gleam, meaning all intermediates
+versions (1.1.0-rc1 for instance) will not be taken into account. Expect a new
+version of this package to ship soon after the official releases lands on
+GitHub.
+
+## Limitations
+
+Because gleam compiles both to JS and Erlang, the gleam compiler can output both
+code. However, do not expect this package to help in Erlang development. This
+package is mainly aimed to use in the JS ecosystem, and do not ship Erlang
+runtime neither rebar3. Follow the classical installation of gleam and Erlang to
+get started with Erlang development!
+
+In case you succeed to use this package in an Erlang workflow, congrats! You
+achieved a strong engineering achievement! Do not ask for help if it bug though!
+😇

package/bin/cli.mjs

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import * as installer from '#chouquette/installer'
+import * as childProcess from 'node:child_process'
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+
+// Replaces __dirname.
+const { cache, dirname } = installer.directories()
+const data = await installer.prepareDownload(dirname, cache)
+
+// User can run install with ignore scripts, compiler should be
+// downloaded before using it.
+const isExec = fs.existsSync(data.binPath)
+if (!isExec) await installer.install()
+
+// Run the compiler.
+const args = process.argv.slice(2)
+const options = { stdio: 'inherit' }
+childProcess.spawn(data.binPath, args, options).on('exit', process.exit)

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@chouquette/gleam",
+  "version": "1.0.0",
+  "author": "Guillaume Hivert <hivert.is.coming@gmail.com>",
+  "license": "MIT",
+  "type": "module",
+  "bin": "bin/cli.mjs",
+  "repository": "https://github.com/ghivert/gleam-lang-npm",
+  "packageManager": "yarn@4.6.0",
+  "imports": {
+    "#chouquette/*": "./src/*.mjs"
+  },
+  "scripts": {
+    "install": "node src/main.mjs"
+  },
+  "keywords": [
+    "beam",
+    "bin",
+    "binary",
+    "build",
+    "bundler",
+    "cli",
+    "compile",
+    "compiler",
+    "erlang",
+    "fallback",
+    "gleam",
+    "install",
+    "installation",
+    "lustre",
+    "wrapper"
+  ],
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "prettier": "^3.2.5"
+  },
+  "dependencies": {
+    "tar": "^7.1.0"
+  }
+}

package/src/environment/cachedir.mjs

@@ -0,0 +1,37 @@
+import * as os from 'node:os'
+import * as path from 'node:path'
+
+function posix(id) {
+  const xdgCache = process.env.XDG_CACHE_HOME
+  const cacheHome = xdgCache || path.join(os.homedir(), '.cache')
+  return path.join(cacheHome, id)
+}
+
+function darwin(id) {
+  return path.join(os.homedir(), 'Library', 'Caches', id)
+}
+
+function win32(id) {
+  const local = process.env.LOCALAPPDATA
+  const appData = local || path.join(os.homedir(), 'AppData', 'Local')
+  return path.join(appData, id, 'Cache')
+}
+
+export function cachedir(id) {
+  switch (process.platform) {
+    case 'darwin':
+      return darwin(id)
+    case 'win32':
+      return win32(id)
+    case 'aix':
+    case 'android':
+    case 'freebsd':
+    case 'linux':
+    case 'netbsd':
+    case 'openbsd':
+    case 'sunos':
+      return posix(id)
+    default:
+      return null
+  }
+}

package/src/environment.mjs

@@ -0,0 +1,54 @@
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+
+export { cachedir } from './environment/cachedir.mjs'
+
+export async function infos(dirname) {
+  const arch = getArch()
+  const platform = getPlatform()
+  const version = await getVersion(dirname)
+  return { arch, platform, version }
+}
+
+export function dirname() {
+  const file = new URL(import.meta.url)
+  const dirname = path.dirname(file.pathname)
+  return dirname
+}
+
+async function getVersion(dirname) {
+  const pack = path.resolve(dirname, '../package.json')
+  const content = await fs.promises.readFile(pack, 'utf-8')
+  const package_ = JSON.parse(content)
+  return `v${package_.version}`
+}
+
+function getArch() {
+  switch (process.arch) {
+    case 'arm64':
+      return 'aarch64'
+    case 'x64':
+      return 'x86_64'
+    default:
+      return null
+  }
+}
+
+function getPlatform() {
+  switch (process.platform) {
+    case 'darwin':
+      return 'apple-darwin'
+    case 'win32':
+      return 'pc-windows-msvc'
+    case 'aix':
+    case 'android':
+    case 'freebsd':
+    case 'linux':
+    case 'netbsd':
+    case 'openbsd':
+    case 'sunos':
+      return 'unknown-linux-musl'
+    default:
+      return null
+  }
+}

package/src/gleam/compiler.mjs

@@ -0,0 +1,15 @@
+import * as fs from 'node:fs'
+
+function endpoint(version, arch, platform) {
+  const base = 'https://github.com/gleam-lang/gleam/releases/download'
+  return `${base}/${version}/gleam-${version}-${arch}-${platform}.tar.gz`
+}
+
+export async function download({ tgzPath, version, arch, platform }) {
+  if (fs.existsSync(tgzPath)) return
+  const endpt = endpoint(version, arch, platform)
+  const res = await fetch(endpt)
+  if (!res.ok) throw new Error('Unreachable')
+  const tgz = await res.arrayBuffer()
+  await fs.promises.writeFile(tgzPath, Buffer.from(tgz))
+}

package/src/gleam.mjs

@@ -0,0 +1 @@
+export * as compiler from './gleam/compiler.mjs'

package/src/installer.mjs

@@ -0,0 +1,51 @@
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import * as tar from 'tar'
+import * as environment from './environment.mjs'
+import * as gleam from './gleam.mjs'
+
+export async function install(options) {
+  const { dirname, cache } = directories()
+  const data = await prepareDownload(dirname, cache)
+  try {
+    await fs.promises.mkdir(cache, { recursive: true })
+    await fs.promises.mkdir(data.binDir, { recursive: true })
+    await gleam.compiler.download(data)
+    await tar.extract({ file: data.tgzPath, cwd: data.binDir })
+  } catch (error) {
+    const isBadArchive = error.message.includes('TAR_BAD_ARCHIVE')
+    const shouldRetry = !(options?.propagateErrors ?? false)
+    const archiveExists = fs.existsSync(data.tgzPath)
+    if (isBadArchive && shouldRetry && archiveExists) {
+      await fs.promises.rm(data.tgzPath)
+      return install({ propagateErrors: true })
+    }
+    console.error(error)
+    console.error(
+      [
+        '--- ERROR -----------------------------------------------------',
+        'It looks like your operating system does not support Gleam yet.',
+        'Currently, Gleam supports macOS, Linux and Windows.            ',
+        '---------------------------------------------------------------',
+      ].join('\n')
+    )
+  }
+}
+
+export function directories() {
+  const dirname = environment.dirname()
+  const cache = environment.cachedir('gleam-npm')
+  if (!cache) throw new Error()
+  return { dirname, cache }
+}
+
+export async function prepareDownload(dirname, cache) {
+  const { arch, version, platform } = await environment.infos(dirname)
+  if (!arch || !platform) throw new Error('Impossible to detect the env.')
+  const archiveName = `gleam-${version}-${arch}-${platform}.tgz`
+  const binName = `gleam-${version}-${arch}-${platform}`
+  const tgzPath = path.resolve(cache, archiveName)
+  const binDir = path.resolve(cache, binName)
+  const binPath = path.resolve(binDir, 'gleam')
+  return { tgzPath, binDir, binPath, arch, version, platform }
+}

package/src/main.mjs

@@ -0,0 +1,3 @@
+import * as installer from './installer.mjs'
+
+installer.install()