Create the project.

artob · artob · commit 678d8f1edbad · 2025-04-18T13:10:26.000+02:00
diff --git a/.cargo/config.toml b/.cargo/config.toml
@@ -0,0 +1,5 @@
+# See: https://doc.rust-lang.org/cargo/reference/config.html
+# See: https://docs.shipyard.rs/configuration/git-fetch-with-cli.html
+
+[net]
+git-fetch-with-cli = true
diff --git a/.config/mise.toml b/.config/mise.toml
@@ -0,0 +1,4 @@
+# See: https://mise.jdx.dev/environments/
+
+[env]
+_.file = '.env'
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @artob
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,33 @@
+name: CI
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+  build-ubuntu:
+    name: Build on Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Build
+      run: cargo build --verbose
+    - name: Build examples
+      run: cargo build --verbose --examples
+    - name: Run tests
+      run: cargo test --verbose
+  build-windows:
+    name: Build on Windows
+    runs-on: windows-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Build
+      run: cargo build --verbose
+    - name: Build examples
+      run: cargo build --verbose --examples
+    - name: Run tests
+      run: cargo test --verbose
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,19 @@
+# macOS
+.DS_Store
+
+# Environment variables
+.env
+
+# Jetbrains
+.idea/
+
+# Visual Studio Code
+.vscode/
+
+# Editor backup files
+*~
+
+# Rust artifacts
+/Cargo.lock
+/rust-toolchain
+/target
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1 @@
+* Arto Bendiken <arto@bendiken.net>
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2025-04-18
diff --git a/CREDITS.md b/CREDITS.md
@@ -0,0 +1 @@
+# Credits
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,27 @@
+# See: https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[workspace]
+members = ["lib/*"]
+default-members = ["lib/*"]
+resolver = "2"
+
+[workspace.package]
+version = "0.0.1"
+authors = ["Arto Bendiken"]
+edition = "2021"
+rust-version = "1.81"
+description = "Getenv.rs"
+#documentation = "https://docs.rs/getenv/"
+readme = true
+homepage = "https://github.com/dryrust/getenv.rs"
+repository = "https://github.com/dryrust/getenv.rs"
+license = "Unlicense"
+keywords = ["env", "environment"]
+categories = ["command-line-interface", "config"]
+publish = true
+
+[workspace.dependencies]
+getenv = { path = "lib/getenv" }
+
+[patch.crates-io]
+getenv = { path = "lib/getenv" }
diff --git a/Makefile b/Makefile
@@ -0,0 +1,15 @@
+CARGO = cargo
+
+all: Cargo.toml
+	$(CARGO) build
+
+check: Cargo.toml
+	$(CARGO) test -- --nocapture
+
+clean: Cargo.toml
+	@rm -rf *~ target
+	$(CARGO) clean
+
+.PHONY: all check clean
+.SECONDARY:
+.SUFFIXES:
diff --git a/README.md b/README.md
@@ -0,0 +1,54 @@
+# Getenv.rs
+
+[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
+[![Compatibility](https://img.shields.io/badge/rust-1.81%2B-blue)](https://blog.rust-lang.org/2024/09/05/Rust-1.81.0.html)
+[![Package](https://img.shields.io/crates/v/getenv)](https://crates.io/crates/getenv)
+[![Documentation](https://docs.rs/getenv/badge.svg)](https://docs.rs/getenv/)
+
+🚧 _We are building in public. This is presently under heavy construction._
+
+## ✨ Features
+
+- Supports opting out of any feature using comprehensive feature flags.
+- Adheres to the Rust API Guidelines in its [naming conventions].
+- 100% free and unencumbered public domain software.
+
+## 🛠️ Prerequisites
+
+- [Rust](https://rust-lang.org) 1.81+
+
+## ⬇️ Installation
+
+### Installation via Cargo
+
+```bash
+cargo add getenv
+```
+
+## 👉 Examples
+
+### Importing the library
+
+```rust
+use getenv::*;
+```
+
+## 📚 Reference
+
+TBD
+
+## 👨‍💻 Development
+
+```bash
+git clone https://github.com/dryrust/getenv.rs.git
+```
+
+---
+
+[![Share on X](https://img.shields.io/badge/share%20on-x-03A9F4?logo=x)](https://x.com/intent/post?url=https://github.com/dryrust/getenv.rs&text=Getenv.rs)
+[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/dryrust/getenv.rs&title=Getenv.rs)
+[![Share on Hacker News](https://img.shields.io/badge/share%20on-hn-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/dryrust/getenv.rs&t=Getenv.rs)
+[![Share on Facebook](https://img.shields.io/badge/share%20on-fb-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/dryrust/getenv.rs)
+[![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/dryrust/getenv.rs)
+
+[naming conventions]: https://rust-lang.github.io/api-guidelines/naming.html
diff --git a/UNLICENSE b/UNLICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+0.0.1
diff --git a/doc/.gitkeep b/doc/.gitkeep
diff --git a/lib/getenv/Cargo.toml b/lib/getenv/Cargo.toml
@@ -0,0 +1,26 @@
+[package]
+name = "getenv"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+description.workspace = true
+#documentation.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
+keywords.workspace = true
+categories.workspace = true
+publish.workspace = true
+
+[features]
+default = ["all", "std"]
+all = []
+std = ["dogma/std"]
+unstable = []
+
+[dev-dependencies]
+
+[dependencies]
+dogma = { version = "0.1", default-features = false }
diff --git a/lib/getenv/src/features.rs b/lib/getenv/src/features.rs
@@ -0,0 +1,7 @@
+// This is free and unencumbered software released into the public domain.
+
+/// The set of features that are enabled in this build of the crate.
+pub static FEATURES: &[&str] = &[
+    #[cfg(feature = "unstable")]
+    "unstable",
+];
diff --git a/lib/getenv/src/lib.rs b/lib/getenv/src/lib.rs
@@ -0,0 +1,20 @@
+// This is free and unencumbered software released into the public domain.
+
+//! This crate provides environment variable wrappers.
+//!
+//! ```edition2021
+//! # use getenv::*;
+//! ```
+
+#![deny(unsafe_code)]
+#![allow(unused)]
+
+mod features;
+pub use features::*;
+
+#[cfg(feature = "std")]
+pub mod vars;
+
+#[doc = include_str!("../../../README.md")]
+#[cfg(doctest)]
+pub struct ReadmeDoctests;
diff --git a/lib/getenv/src/vars.rs b/lib/getenv/src/vars.rs
@@ -0,0 +1,46 @@
+// This is free and unencumbered software released into the public domain.
+
+pub mod cargo;
+pub use cargo::*;
+
+pub mod conda;
+pub use conda::*;
+
+pub mod git;
+pub use git::*;
+
+pub mod macos;
+pub use macos::*;
+
+pub mod openssl;
+pub use openssl::*;
+
+pub mod posix;
+pub use posix::*;
+
+pub mod python;
+pub use python::*;
+
+pub mod ruby;
+pub use ruby::*;
+
+pub mod windows;
+pub use windows::*;
+
+pub mod xdg;
+pub use xdg::*;
+
+#[cfg(feature = "std")]
+pub fn var(key: impl AsRef<std::ffi::OsStr>) -> Option<String> {
+    use std::env::VarError::*;
+    match std::env::var(key) {
+        Err(NotPresent | NotUnicode(_)) => None,
+        Ok(value) if value.trim().is_empty() => None,
+        Ok(value) => Some(String::from(value.trim())), // TODO: remove the extra allocation
+    }
+}
+
+#[cfg(not(feature = "std"))]
+pub fn var(_key: impl AsRef<std::ffi::OsStr>) -> Option<String> {
+    None // environment variables not supported
+}
diff --git a/lib/getenv/src/vars/cargo.rs b/lib/getenv/src/vars/cargo.rs
@@ -0,0 +1,13 @@
+// This is free and unencumbered software released into the public domain.
+
+use super::var;
+
+/// See: https://doc.rust-lang.org/cargo/reference/environment-variables.html
+pub fn cargo() -> Option<String> {
+    var("CARGO")
+}
+
+/// See: https://doc.rust-lang.org/cargo/reference/environment-variables.html
+pub fn cargo_home() -> Option<String> {
+    var("CARGO_HOME")
+}
diff --git a/lib/getenv/src/vars/conda.rs b/lib/getenv/src/vars/conda.rs
@@ -0,0 +1,12 @@
+// This is free and unencumbered software released into the public domain.
+
+use super::var;
+
+pub fn conda() -> Option<String> {
+    var("CONDA")
+}
+
+/// See: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
+pub fn conda_prefix() -> Option<String> {
+    var("CONDA_PREFIX")
+}
diff --git a/lib/getenv/src/vars/git.rs b/lib/getenv/src/vars/git.rs
@@ -0,0 +1,13 @@
+// This is free and unencumbered software released into the public domain.
+
+use super::var;
+
+/// See: https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables
+pub fn git() -> Option<String> {
+    var("GIT")
+}
+
+/// See: https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables
+pub fn git_dir() -> Option<String> {
+    var("GIT_DIR")
+}
diff --git a/lib/getenv/src/vars/macos.rs b/lib/getenv/src/vars/macos.rs
@@ -0,0 +1,18 @@
+// This is free and unencumbered software released into the public domain.
+
+use super::var;
+
+/// See: https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/DynamicLibraries/100-Articles/UsingDynamicLibraries.html
+pub fn ld_library_path() -> Option<String> {
+    var("LD_LIBRARY_PATH")
+}
+
+/// See: https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/DynamicLibraries/100-Articles/UsingDynamicLibraries.html
+pub fn dyld_library_path() -> Option<String> {
+    var("DYLD_LIBRARY_PATH")
+}
+
+/// See: https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/DynamicLibraries/100-Articles/UsingDynamicLibraries.html
+pub fn dyld_fallback_library_path() -> Option<String> {
+    var("DYLD_FALLBACK_LIBRARY_PATH")
+}
diff --git a/lib/getenv/src/vars/openssl.rs b/lib/getenv/src/vars/openssl.rs
@@ -0,0 +1,13 @@
+// This is free and unencumbered software released into the public domain.
+
+use super::var;
+
+/// See: https://github.com/rustls/rustls-native-certs/issues/16
+pub fn ssl_cert_file() -> Option<String> {
+    var("SSL_CERT_FILE")
+}
+
+/// See: https://github.com/rustls/rustls-native-certs/issues/16
+pub fn ssl_cert_dir() -> Option<String> {
+    var("SSL_CERT_DIR")
+}
diff --git a/lib/getenv/src/vars/posix.rs b/lib/getenv/src/vars/posix.rs
diff --git a/lib/getenv/src/vars/python.rs b/lib/getenv/src/vars/python.rs
diff --git a/lib/getenv/src/vars/ruby.rs b/lib/getenv/src/vars/ruby.rs
diff --git a/lib/getenv/src/vars/windows.rs b/lib/getenv/src/vars/windows.rs
diff --git a/lib/getenv/src/vars/xdg.rs b/lib/getenv/src/vars/xdg.rs
diff --git a/lib/getenv/tests/.gitkeep b/lib/getenv/tests/.gitkeep
diff --git a/rustfmt.toml b/rustfmt.toml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# See: https://mise.jdx.dev/environments/
++
 +[env]
 +_.file = '.env'