Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dotenv: v0.1.0 (new) #631

Merged
merged 3 commits into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/preview/dotenv/0.1.0/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This is a comment
FOO_IN_ROOT= bar # this is also a comment
21 changes: 21 additions & 0 deletions packages/preview/dotenv/0.1.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 chillcicada <2210227279@qq.com>

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.
25 changes: 25 additions & 0 deletions packages/preview/dotenv/0.1.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Dotenv

Load environment variables from a .env file.

## Example

![Example](./example.png)

```typ
#import "@preview/dotenv.typ": env_load

#let env = env_load("/.env")

#let env_example = env_load("/example/.env.example")
```

with the following .env file:

```ini
# .env
FOO_IN_ROOT=bar

# .env.example
FOO_IN_EXAMPLE=baz
```
21 changes: 21 additions & 0 deletions packages/preview/dotenv/0.1.0/dotenv.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#let env_load(path) = {
let arr = read(path).split(regex("#.*\r?\n|\r?\n")).filter(it => it.trim() != "").map(line => {
let parts = line.split("=")
let key = parts.at(0).trim()
if (key != "") {
if (parts.len() > 1) {
(key, parts.at(1).trim())
} else {
(key, "")
}
}
}).dedup()

let obj = (:)

for item in arr {
obj.insert(item.at(0), item.at(1))
}

obj
}
Binary file added packages/preview/dotenv/0.1.0/example.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions packages/preview/dotenv/0.1.0/example/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This is a comment
FOO_IN_EXAMPLE=baz # this is also a comment
Binary file added packages/preview/dotenv/0.1.0/example/example.pdf
Binary file not shown.
1,028 changes: 1,028 additions & 0 deletions packages/preview/dotenv/0.1.0/example/example.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions packages/preview/dotenv/0.1.0/example/example.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#import "../dotenv.typ": *

#let env = env_load("/.env")

#let env_example = env_load("/example/.env.example")

```typ
#import "@preview/dotenv.typ": env_load

#let env = env_load("/.env")

#let env_example = env_load("/example/.env.example")
```

Load the environment variable `FOO_IN_ROOT` from the `.env` file in the root of the project: #env.FOO_IN_ROOT

Below is the content of the `/.env` file:

```ini
# /.env

# This is a comment
FOO_IN_ROOT= bar # this is also a comment
```

It will be loaded as:

#env

Load the environment variable `FOO_IN_EXAMPLE` from the `.env.example` file of the project: #env_example.FOO_IN_EXAMPLE

Below is the content of the `.env.example` file:

```ini
# .env.example

# This is a comment
FOO_IN_EXAMPLE=baz # this is also a comment
```

It will be loaded as:

#env_example
11 changes: 11 additions & 0 deletions packages/preview/dotenv/0.1.0/typst.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[package]
name = "dotenv"
version = "0.1.0"
entrypoint = "dotenv.typ"
authors = ["chillcicada"]
license = "MIT"
description = "Load environment variables from a .env file."
homepage = "https://github.com/chillcicada/typst-dotenv#readme"
repository = "https://github.com/chillcicada/typst-dotenv"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two links feel redundant, I think having only repository would be less confusing.

keywords = ["dotenv", "environment", "utility"]
exclude = ["example/*", ".*", "example.png"]