npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@golostos/env-to-ts

v1.0.3

Published

Generate type definitions from env file

Downloads

451

Readme

ENV file parser for Typescript type definitions

Installation:

$ npm i @golostos/env-to-js

Usage:

Usage: env-to-ts [OPTIONS]...

Options:
  -v, --version           output the version number
  -e, --envfile <value>   Envfile name (default: ".env")
  -t, --types <value>     Name of a file with TS types for environment variables
  -d, --declare <value>   Name of a file with global env type declarations (default:
                          "environment.d.ts")
  -w, --watch             Watch mode (default: false)
  -ni, --no-infer-number  No infer number type from the env variable
  -ne, --no-node-env      This prevents of using NODE_ENV variable in the types definitions
  -nd, --no-declare-file  This prevents the creation of a file with global env type declarations        
  -h, --help              display help for command

Input file example (.env):

# POSTGRES
POSTGRES_USER=prisma
POSTGRES_PASSWORD=topsecret
POSTGRES_DB=vdc
DB_HOST=localhost
DB_PORT=5432
DB_SCHEMA=public

# Prisma database connection
DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}?schema=${DB_SCHEMA}&sslmode=prefer

Example of the command:

$ npx env-to-ts -e test/.env -t test/EnvironmentVariables.ts -w

Output file example (EnvironmentVariables.ts):

export interface EnvironmentVariables {
  POSTGRES_USER: string;
  POSTGRES_PASSWORD: string;
  POSTGRES_DB: string;
  DB_HOST: string;
  DB_PORT: number;
  DB_SCHEMA: string;
  DATABASE_URL: string;
  NODE_ENV: "production" | "development" | "testing";
}

Output file example (environment.d.ts):

/* eslint-disable prettier/prettier */
declare module 'process' {
  global {
    namespace NodeJS {
      interface ProcessEnv {
        POSTGRES_USER: string;
        POSTGRES_PASSWORD: string;
        POSTGRES_DB: string;
        DB_HOST: string;
        DB_PORT: number;
        DB_SCHEMA: string;
        DATABASE_URL: string;
        NODE_ENV: 'production' | 'development' | 'testing';
      }
    }
  }
}