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

@superbogy/zly

v1.0.2

Published

yaml refer

Downloads

15

Readme

:dango: zly is a yaml assembly parser. You can split a large yaml file into small fragments. It is very useful for writing a swagger API document. You can import yaml piece from relative path or absolute path.

Install

npm i -g @superbogy/zly

Get-started

Usage: zly [options]

Options:
  -V, --version        output the version number
  -o, --output <path>  put the result to file
  -w, --workspace      yaml file root path
  -f, --format <type>  format output style, yaml or json (default: "yaml")
  -p, --pretty         pretty out put
  -s, --server         start a swagger ui
  -e, --extname <ext>  extend name, split with comma
  -h, --help           output usage information

Get-started

  • preview a swagger yaml file: zly -s api-spec.yaml

  • import yaml file: $ref: relative/path/some.yaml

Demo

clone this project and run zly -s test/example/index.yaml

zly

structure

├── definitions
│   ├── Error.yaml
│   ├── Pet.yaml
│   └── index.yaml
├── entry.yaml
└── routers
    ├── index.yaml
    └── pets
        ├── $id.yaml
        └── list.yaml

The entry file refer two file from definitions/index.yaml and routers/index.yaml

paths:
  $ref: routers/index.yaml
components:
  $ref: definitions/index.yaml

for routers/index.yaml:

/pets:
  $ref: pets/list.yaml
/pets/{petId}:
  $ref: pets/$id.yaml