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

kubb-gen-scribe-cli

v0.0.2

Published

To install dependencies:

Downloads

5

Readme

kubb-gen-scribe-cli

To install dependencies:

bun install

To run:

bun run index.ts

This project was created using bun init in bun v1.0.33. Bun is a fast all-in-one JavaScript runtime.

OpenAPI Document Processor

This script loads an OpenAPI document from a YAML file, processes it by removing unmatched path parameters, and saves the updated document as a new YAML file.

Modules

The script uses the following modules:

bun.file: Node.js built-in module for file system operations. yaml: A module for parsing and stringifying YAML data.

Functions

The script defines and uses the following functions:

  • loadOpenApiDocument(filePath: string): Loads an OpenAPI document from a YAML file. It reads the file content using fs.readFileSync(), then parses the YAML content into a JavaScript object using yaml.load().

  • saveOpenApiDocument(filePath: string, document: OpenApiDocument): Saves an OpenAPI document to a YAML file. It stringifies the OpenAPI document into a YAML string using yaml.dump(), then writes the string to a file using fs.writeFileSync().

  • processDocument(document: OpenApiDocument): Processes an OpenAPI document by removing unmatched path parameters. It iterates over the paths and their operations in the document, and filters out any path parameters that are not included in the path string.

Execution

The script executes the following steps:

  1. Load the blacklist data from a JSON file.
  2. Load an OpenAPI document from a YAML file using loadOpenApiDocument().
  3. Process the OpenAPI document using processDocument().
  4. Save the processed OpenAPI document to a new YAML file using saveOpenApiDocument().

Usage

To use this script, update the path to your OpenAPI YAML file in the filePath variable, then run the script. The processed OpenAPI document will be saved as a new YAML file with _updated appended to the original file name.

Output

The script logs a message to the console when the OpenAPI document has been processed and saved.

Please note that this is a basic outline and you may need to add more details depending on the complexity of your project and the level of detail you want to provide in your documentation.