1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86
87. 87
88. 88
89. 89
90. 90
91. 91
92. 92
93. 93
94. 94
95. 95
96. 96
97. 97
98. 98
99. 99
100. 100
101. 101
102. 102
103. 103
104. 104

<!--
SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
SPDX-License-Identifier: Apache-2.0
-->

# rollup-plugin-gleam

A [Rollup](https://rollupjs.org/) plugin that add supports for [Gleam](https://gleam.run/) language. Also compatible with [Vite](https://vite.dev/).

- Source code is available at [github.com:pocka/rollup-plugin-gleam](https://github.com/pocka/rollup-plugin-gleam)
- Package is available as [npm:`@pocka/rollup-plugin-gleam`](https://npmjs.com/package/@pocka/rollup-plugin-gleam)

## Requirements

This plugin requires Rollup >= v1.12.0 and a working Gleam executable (`gleam`).

## Usage

Import the plugin in your `rollup.config.js` or `vite.config.js`:

```js
import { gleam } from "@pocka/rollup-plugin-gleam";

export default {
	// ...
	plugins: [gleam()],
};
```

Then you can import `.gleam` files:

```gleam
// hello.gleam
pub fn hello(name: String) -> String {
  "Hello, " <> name
}
```

```js
import { hello } from "./hello.gleam";

console.log(hello("World"));
```

## Options

### `gleamToml`

- Type: `URL` or String
- Default: `"./gleam.toml"`

File path or file URL to `gleam.toml`.
If the value is relative path string, this plugin resolves the path from current working directory.

```js
gleam({
	gleamToml: new URL("./gleam.toml", import.meta.url),
});
```

### `bin`

- Type: String
- Default: `"gleam"`

Binary name or path to Gleam executable file.
This plugin builds Gleam file using this value.

```js
gleam({
	bin: "/path/to/gleam",
});
// > /path/to/gleam build --target javascript
```

### `buildOptions.warningAsErrors`

- Type: Boolean
- Default: `false`

This option activates `--warning-as-errors` compiler flag.
If this option is enabled, warning made by Gleam compiler will be treated as a build error.

```js
gleam({
	buildOptions: {
		warningAsErrors: true,
	},
});
```

```gleam
// This won't compile with the flag on, due to an unused variable warning.
pub fn hello(name: String) -> String {
  "Hello World!"
}
```

## License

This software is licensed under [Apache License Version 2.0](./LICENSES/Apache-2.0.txt).

This project adheres to [REUSE Specification](https://reuse.software/spec-3.3/).
Every checked-in file has copyright and license information inside a comment header, adjacent `*.license` file, or [REUSE.toml](./REUSE.toml) file.