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

ssg-api

v1.16.10

Published

Static Site Generation TypeScript API

Downloads

614

Readme

ssg-api CircleCI

TypeScript API to generate output files from input files.

It can be used to generate:

  • a static website from HTML templates (but those templates can include client-side JavaScript and CSS of course).
  • (and/or) other files such as configuration files (for instance converting an .htaccess file to a netlify.toml file)

To install ssg-api as a project dependency:

npm install --save ssg-api

Then import the required types to implement your own SSG code:

import { Ssg, SsgContextImpl, SsgConfig } from "ssg-api";

const config: SsgConfig = {
  getOutputPath(context: SsgContext): string {
    return path.join("out", context.file.name)
  }
};
const ssg = new Ssg(config)
  .add(firstStep)
  .add(nextStep); // Write your own SSG steps!

const context = new SsgContextImpl("fr");
try {
  const result = await ssg.start(context);
  context.log("Completed", result);
} catch (err) {
  context.error(err, context.inputFile.name, "=>", context.outputFile.name);
}

Data types

Steps

Steps can do anything. You can implement your owns, but there are predefined ones. Check the documentation for more.

Files

classDiagram
    namespace fileutil {
        class FileContents {
            name: string
            lastModified: Date
            contents: string
            encoding: BufferEncoding
            write(): Promise<void>
            read(fileName, declaredEncoding)$: FileContents
            readOrNew(fileName, declaredEncoding)$: FileContents
            getLang(filePath)$: FileContentsLang
            getContents(fileName, declaredEncoding)$
        }
        class FileContentsLang {
            lang: string | undefined
            variants: string[]
        }
    }
    FileContents --> FileContentsLang: lang
    namespace ssg-api {
        class HtmlFileContents {
            lang
            title: string
            contents: string
            document: Document
            read(fileName): HtmlFileContents
            serialize(): string
            create(FileContents)$: HtmlFileContents
            getMeta(name, document)$: string[]
            getLink(rek, document)$: Link[]
        }
        class HtmlMeta {
            url?: string
            author: string[]
            copyright?: string
            description?: string
            generator?: string
        }
        class HtmlLinks {
        }
        class Link {
            type: LinkType;
            text: string;
            url: string;
        }
    }
    HtmlFileContents --> HtmlMeta: meta
    HtmlFileContents --> HtmlLinks: links
    HtmlLinks --> Link: start?
    HtmlLinks --> Link: contents?
    HtmlLinks --> Link: prev?
    HtmlLinks --> Link: next?
    FileContents <|-- HtmlFileContents