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

@basketry/openapi-3

v0.1.2

Published

Basketry parser for OpenAPI 3.x service definitions

Downloads

621

Readme

main master

OpenAPI 3.x

Basketry parser for OpenAPI 3.x service definitions. This parser can be coupled with any Basketry generator to translate a OpenAPI 3.x document into other artifacts including servers, clients, and human-readable documentation.

Quick Start

The following example converts an OpenAPI doc into Typescript types:

  1. Save https://petstore.swagger.io/v2/swagger.json as petstore.json in the root of your project.
  2. Install packages: npm install -g basketry @basketry/openapi-3 @basketry/typescript
  3. Generate code: basketry --source petstore.json --parser @basketry/openapi-3 --generators @basketry/typescript --output src

When the last step is run, basketry will parse the source file (petstore.json) using the specified parser (@basketry/openapi-3) and then run each specified generator (in this case only @basketry/typescript) writing the output folder (src).


For contributors:

Run this project

  1. Install packages: npm ci
  2. Build the code: npm run build
  3. Run it! npm start

Note that the lint script is run prior to build. Auto-fixable linting or formatting errors may be fixed by running npm run fix.

Create and run tests

  1. Add tests by creating files with the .test.ts suffix
  2. Run the tests: npm t
  3. Test coverage can be viewed at /coverage/lcov-report/index.html

Publish a new package version

  1. Create new version
    1. Navigate to the version workflow from the Actions tab.
    2. Manually dispatch the action with the appropriate inputs
    3. This will create a PR with the new version
  2. Publish to NPM
    1. Review and merge the PR
    2. The publish workflow will create a git tag and publish the package on NPM

Generated with generator-ts-console