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

shitgen

v0.0.25

Published

A shit PostgreSQL type generator

Downloads

1,714

Readme

shitgen

Stands for "shit PostgreSQL type generator". I simply couldn't miss the opportunity on the naming (even if a bit crass), so here we are. The primary motivation of this project is to

  • enable rapid prototyping on simple web applications
  • allow you to use Prisma-esque method without learning yet another intermediary schema langauge.

shitgen is a toy library that generates both types and models with basic DDL. It's basically a bad yet (barely) "functional enough" ORM with support for basic CRUD operations. You will likely have to write raw SQL slapped with type casting for more advanced applications and optimizations.

Currently uses postgres under the hood.

NOTE: I did not look at how other libraries achieve type generation, so the approach may differ substantially here. All I can say is this TypeScript is cursed and shockingly still works.

Installation

pnpm add shitgen -D

Usage

Nuke your database, clearing it of all data and schemas. Migrations are for the weak.

shitgen nuke

Push your schema to the database - you should probably nuke the database for changes to be applied.

shitgen push ./schema.sql
# ./schema.sql contains a series of DDL statements, like 'CREATE TABLE IF NOT EXISTS'

Generate types from your schema

shitgen generate ./schema.sql --out-file ./src/database.ts
# ./schema.sql contains a series of DDL statements, like 'CREATE TABLE IF NOT EXISTS'
# --out-file specifies where the generated client should be put

Here's what your package.json might look like:

{
  "scripts": {
    "db:generate": "shitgen generate ./schema.sql --out-file ./src/database.ts",
    "db:push": "shitgen push ./schema.sql",
    "db:nuke": "shitgen nuke --force"
  }
}

The full list of command documentation can be found with shitgen --help.

@todo adapters that implement a shared interface for different kinds of postgres clients?
@todo one to many relationships (auto create?)