{"_id":"@basketry/sorbet-docs","_rev":"2-9555fa30a9e1502ffce8f5822db2a898","name":"@basketry/sorbet-docs","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@basketry/sorbet-docs","version":"0.0.1","description":"Basketry generator for documenting services that have a Sorbet language target.","main":"./lib/index.js","scripts":{"test":"jest","clean":"run-s -s clean:*","create-snapshot":"ts-node ./src/snapshot/create-snapshot.ts","lint":"run-s -s lint:*","fix":"run-s -s fix:*","clean:output":"rimraf lib","start":"node ./lib/index.js","prebuild":"run-s -s clean lint","build":"tsc","lint:eslint":"eslint src/**/*.*","fix:eslint":"eslint --fix src/**/*.*","lint:prettier":"prettier -c .","fix:prettier":"prettier -w .","clean:coverage":"rimraf coverage","pretest":"run-s -s clean","prepack":"run-s -s build"},"keywords":[],"author":{"name":"Steve Konves"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-docs.git"},"bugs":{"url":"https://github.com/basketry/sorbet-docs/issues"},"homepage":"https://github.com/basketry/sorbet-docs#readme","funding":"https://github.com/basketry/sorbet-docs?sponsor=1","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.8.1","@typescript-eslint/parser":"^5.8.1","eslint":"^8.5.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","jest":"^27.4.7","npm-run-all":"^4.1.5","rimraf":"^3.0.2","ts-jest":"^27.1.3","ts-node":"^10.4.0","typescript":"^4.5.5"},"dependencies":{"@basketry/sorbet":"^0.0.16","basketry":"^0.0.32","case":"^1.6.3","prettier":"^2.5.1"},"types":"./lib/index.d.ts","gitHead":"4fb997952ab0a958bd539e289e3e07b55b55cf40","_id":"@basketry/sorbet-docs@0.0.1","_nodeVersion":"18.9.0","_npmVersion":"8.19.1","dist":{"integrity":"sha512-RV6TjOzHpVD3Ckl40HvxqIl36wBSdDpz3JlIPnal5IJMVynDd+yiXkn2RSGpGshNjHu9+esLGVmtnBUHw5rrCw==","shasum":"a4d30f0a2e6168d8c92ee4ddde2ffa0cc54bde96","tarball":"https://registry.npmjs.org/@basketry/sorbet-docs/-/sorbet-docs-0.0.1.tgz","fileCount":15,"unpackedSize":32106,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG02LUdPVSZ/het6MjfcUf33XPdRM348MaLIikuuj10xAiEA7lXqrZNTgew/ozL6sYsBQ547Bsh0zhSv7jv1ARTVxho="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjI93NACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqiSQ/+MFGiPlkW8kAlWmGlqqgR1KlahzDuYtvtJb7rzf8RByzMJSrO\r\nfO5v+LaqdyTPd9r32emHm7lJQNwI/5pbOuNIgWFFk9w7fBQ9Ch8NVx9hLmBj\r\nCx9uoOfSPG3LM5LVAmIhTDP1HABaQeNuQO0faCK+A8kHZ4dEmM2e19WygxrW\r\ncVs6Y0Cokcwz8DNiZeKD6pzPRxSW2YnGZrQpDW+GaYPzaoXihpb30fXducsJ\r\nYFTZgQuvhXN2x4KaPN11zfgjTsq4qdLs5xuMx/BGGqr5pdGbEUI6BDKOyVIL\r\nJWJrhS5NUESh0CKjjmt01q5ELtOLORdhjbABCF5m8O1PTj0AegYSHoj0kwhC\r\nObfHqlnMmd2gxDvPgHnpv+A6P0IBGAhfnpzJBTogc13CfM2COiwGOKoDKxtQ\r\nsRnuEWRRPLZTTRyWFdj1TehgUO68kAU+qfAMLEqkwIboBjd6g9dU9LHQC63m\r\nEJt9pUt7gWRFcA0KxrFOk40u51thjCxh9Y3QnYvHoC19ls0dK1JOh9aTYdw3\r\nmkpqHZ3EUg+O2wURMd7fmBKCaq3qsVawrGMdJx3NrGCg0GFGywGew/YZGbYG\r\nk9GQRERKycR7DJg+Q69n4bqdhUcu4tgdc8sncvnSh7C0OxdV9Qrum8EzEgqj\r\nuEGoWQfqsS2pe9oxs/AHQVEhxWW/QZYrCYU=\r\n=m8RW\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"skonves","email":"stephen.konves@gmail.com"},"directories":{},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sorbet-docs_0.0.1_1663294925204_0.7109438378263437"},"_hasShrinkwrap":false},"0.0.2":{"name":"@basketry/sorbet-docs","version":"0.0.2","description":"Basketry generator for documenting services that have a Sorbet language target.","main":"./lib/index.js","scripts":{"test":"jest","clean":"run-s -s clean:*","create-snapshot":"ts-node ./src/snapshot/create-snapshot.ts","lint":"run-s -s lint:*","fix":"run-s -s fix:*","clean:output":"rimraf lib","start":"node ./lib/index.js","prebuild":"run-s -s clean lint","build":"tsc","lint:eslint":"eslint src/**/*.*","fix:eslint":"eslint --fix src/**/*.*","lint:prettier":"prettier -c .","fix:prettier":"prettier -w .","clean:coverage":"rimraf coverage","pretest":"run-s -s clean","prepack":"run-s -s build"},"keywords":[],"author":{"name":"Steve Konves"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-docs.git"},"bugs":{"url":"https://github.com/basketry/sorbet-docs/issues"},"homepage":"https://github.com/basketry/sorbet-docs#readme","funding":"https://github.com/basketry/sorbet-docs?sponsor=1","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.8.1","@typescript-eslint/parser":"^5.8.1","eslint":"^8.5.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","jest":"^27.4.7","npm-run-all":"^4.1.5","rimraf":"^3.0.2","ts-jest":"^27.1.3","ts-node":"^10.4.0","typescript":"^4.5.5"},"dependencies":{"@basketry/sorbet":"^0.0.16","basketry":"^0.0.32","case":"^1.6.3","prettier":"^2.5.1"},"types":"./lib/index.d.ts","gitHead":"333a3cd6f9c9b5169655e4e156d00f02c9c8b1d1","_id":"@basketry/sorbet-docs@0.0.2","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-HeiaM/pCC/JUbn1OUWYXDAZR+yapZQPrh96CnIZldzskEHNJz5Sd2Qb6WANk8sGH5Q9KWd2YsDoMXLZggyLhHw==","shasum":"adf0e593f20c088eda6b74c82d1f46828e9112ee","tarball":"https://registry.npmjs.org/@basketry/sorbet-docs/-/sorbet-docs-0.0.2.tgz","fileCount":15,"unpackedSize":33472,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDFTN4QmiQLPBhEhjp1+LeqsNTJ+eX1Nx+QVZUqwwG75wIhAJh5VG64NJBRCwv2OnVD3vafefDSc7lKx7wUZN9relYr"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjd8k8ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqrSA//c5260rNJNE5uKPMjDaF6nXkzE6ts2D3xUAqZMTn6IA6wRjjD\r\nKDHxbTTsTiGaD543b6CBXQFtdsJG6Nd0XvJ2NMz1kdWTxBLbCzDk350c8lhS\r\nYb1ocSO+FEAKAbVzybYtrC2qDAm0+ZmgoaZiqgKf/Tl2CD+1Xgl0YKoQxV3T\r\nWWEi6rZBVj/qe5MhwCNvFdfD1uyyN6lElFLkQgKv8J/QnRoBMKIULLreMS2P\r\nMe+M8vG6xDMYobZWasXGsaSZshZQn5Tedqpv/Y3kL5731X/E8tBfIW3EbRrC\r\nd4QBZMBrFB9XDQF3rO1FtT5c+lW1729R1/cYhBZyxDVO/l/2cKYzH3S1V8zx\r\nOkKfOc1EZ/Bvk9qnrsJc1e10QOzfOGIHCUgBOyTjxgPyThQ1VASf6MtYpgPL\r\nm44uL77dNgsVkvR1xk0XCrKPhEmJAWwMHmimvAdt+zw4L7XYLv7ArLEQNJyc\r\nyO9QWYwN3C5JvpRJQW4R5iaG6imTFy2SMM+qC9Tk0kr73+rIHphE2Oj2L5BK\r\nAFexy0GlrqwkPyvsS8pRA2GEtx0Cn078kqNkLf7dPjp5n92aQ2O2UvzHSZrH\r\nscL1Vj+oD/HbGkrIJNKljqYMc1XdZmjkp7NpgRHMLrD+9GRcc4Dl1ZSq3qMH\r\n7nXHh5XEUL1xNyCOUw3Umj1YUAoVaRZGzM0=\r\n=4XuJ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"skonves","email":"stephen.konves@gmail.com"},"directories":{},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sorbet-docs_0.0.2_1668794684600_0.15014443882472572"},"_hasShrinkwrap":false},"0.0.3":{"name":"@basketry/sorbet-docs","version":"0.0.3","description":"Basketry generator for documenting services that have a Sorbet language target.","main":"./lib/index.js","scripts":{"test":"jest","clean":"run-s -s clean:*","create-snapshot":"ts-node ./src/snapshot/create-snapshot.ts","lint":"run-s -s lint:*","fix":"run-s -s fix:*","clean:output":"rimraf lib","start":"node ./lib/index.js","prebuild":"run-s -s clean lint","build":"tsc","lint:eslint":"eslint src/**/*.*","fix:eslint":"eslint --fix src/**/*.*","lint:prettier":"prettier -c .","fix:prettier":"prettier -w .","clean:coverage":"rimraf coverage","pretest":"run-s -s clean","prepack":"run-s -s build"},"keywords":[],"author":{"name":"Steve Konves"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-docs.git"},"bugs":{"url":"https://github.com/basketry/sorbet-docs/issues"},"homepage":"https://github.com/basketry/sorbet-docs#readme","funding":"https://github.com/basketry/sorbet-docs?sponsor=1","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@typescript-eslint/eslint-plugin":"^5.8.1","@typescript-eslint/parser":"^5.8.1","eslint":"^8.5.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","jest":"^27.4.7","npm-run-all":"^4.1.5","rimraf":"^3.0.2","ts-jest":"^27.1.3","ts-node":"^10.4.0","typescript":"^4.5.5"},"dependencies":{"@basketry/sorbet":"^0.0.16","basketry":"^0.0.32","case":"^1.6.3","prettier":"^2.5.1"},"types":"./lib/index.d.ts","gitHead":"942d71ad8bc3b1585575e6b9914bf40b840d662d","_id":"@basketry/sorbet-docs@0.0.3","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-nkm2JBiWrxzlnPackbj2Oh2hfUOAlIrA6JQOSOSLDZLHWC7s1CRn0uAkaORsMqfGMkSEzvptwB6ofMHy4F4SUA==","shasum":"027e8c775387c80bc0fe78749586fa1908d36431","tarball":"https://registry.npmjs.org/@basketry/sorbet-docs/-/sorbet-docs-0.0.3.tgz","fileCount":15,"unpackedSize":33472,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@basketry%2fsorbet-docs@0.0.3","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCytDJVv6mU5a9vF+qKJSRH3MnkGYM8DyJv6OB2LHJ4BAIhAL4Xv8TBwGLEbAJo8/y5/wiz0wAKQ59hYJUqvFBIhPx6"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkQWZcACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrnUQ/+Nuo1CwSk5Ary1yaq9J4FRODV1wRxLn4rzp+LHjCk8JkQJrPv\r\nC7FeEX+Wmd+cUFUwDuXdKscDdt9npnwvsZhfUNT0QE0q0FpdZfAMrCFO5agA\r\nEmaJeLxnEv5v9FuqVtZ+TfVCha3XFYwoSq6M/uDskMf6xrSDwEdZtgexX5BK\r\n9c2LSLwC8R9jnLs9vFlN4Ah7VEG2/pybA0v9DmGDbjnomsIgBTjY0ZpWhJNx\r\nGxMDSZR9/ffN9NAVEL8dZ/c+AhfaCfVmYwjZnxYl+MG8g4H4q4fXZGZybjus\r\nIBmo8EDyPezPOBv46sqtnJyPTS2EHD7xp+TbMwGRpUlLgrAJwvjzbkoh3ysy\r\nO+kR2vcwsMDyyR/95f+J2uhrBnp4kcOJGBiOTuZH3tLIimV8ro0uBo5F5QmJ\r\ndFiXBCagV4/wJ1GJv90O6vNgstpOTHq2oeYIJ9ckYvDZE0b6KfceNOe5exfz\r\nfyCmxrxjOKw+U1YjxjwxHIGMzcZd/uJVMBgeLb+zsmMfRrnQ6E6SR5MEU9PO\r\nXFnIiAMs+Se5sIoPsmQRJ1U6zXs+zcXcG+A6NvrEpEz0UcFciWixgHy0IABm\r\nhDkHgTSRvVo+k8sfxb6FGP8m1j/Pz7xyyY+bUg5Xhzc2H/0zVN3iHrbIdMqq\r\n+Jh5Hsohj92AVUsLLlwKw9WsRT4uJWLMK30=\r\n=7LNk\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"skonves","email":"stephen.konves@gmail.com"},"directories":{},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sorbet-docs_0.0.3_1682007644192_0.854064020297221"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-16T02:22:05.138Z","0.0.1":"2022-09-16T02:22:05.373Z","modified":"2023-04-20T16:20:44.826Z","0.0.2":"2022-11-18T18:04:44.755Z","0.0.3":"2023-04-20T16:20:44.488Z"},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"description":"Basketry generator for documenting services that have a Sorbet language target.","homepage":"https://github.com/basketry/sorbet-docs#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-docs.git"},"author":{"name":"Steve Konves"},"bugs":{"url":"https://github.com/basketry/sorbet-docs/issues"},"license":"MIT","readme":"[![main](https://github.com/basketry/sorbet-docs/workflows/build/badge.svg?branch=main&event=push)](https://github.com/basketry/sorbet-docs/actions?query=workflow%3Abuild+branch%3Amain+event%3Apush)\n[![master](https://img.shields.io/npm/v/@basketry/sorbet-docs)](https://www.npmjs.com/package/@basketry/sorbet-docs)\n\n# Sorbet Docs\n\n[Basketry generator](https://github.com/basketry) for documenting services that have a [Sorbet](https://sorbet.org/) language target. This parser can be coupled with any Basketry parser. It is recommended to use this generator alongside the [`@basketry/sorbet`](https://github.com/basketry/sorbet) generator.\n\n## Quick Start\n\nThe following example converts a \"Swagger\" doc into [Sorbet](https://sorbet.org/) types:\n\n1. Save `https://petstore.swagger.io/v2/swagger.json` as `petstore.json` in the root of your project.\n1. Install packages: `npm install -g basketry @basketry/swagger-2 @basketry/sorbet @basketry/sorbet-docs`\n1. Generate code: `basketry --source petstore.json --parser @basketry/swagger-2 --generators @basketry/sorbet @basketry/sorbet-docs --output src`\n\nWhen the last step is run, basketry will parse the source file (`petstore.json`) using the specified parser (`@basketry/swagger-2`) and then run each specified generator writing the output folder (`src`).\n\n## Folder Structure\n\nTODO!!!!!!!!!!!!\n\n## Options\n\nTODO!!!!!!!!!!!!\n\n---\n\n## For contributors:\n\n### Run this project\n\n1.  Install packages: `npm ci`\n1.  Build the code: `npm run build`\n1.  Run it! `npm start`\n\nNote that the `lint` script is run prior to `build`. Auto-fixable linting or formatting errors may be fixed by running `npm run fix`.\n\n### Create and run tests\n\n1.  Add tests by creating files with the `.test.ts` suffix\n1.  Run the tests: `npm t`\n1.  Test coverage can be viewed at `/coverage/lcov-report/index.html`\n\n### Publish a new package version\n\n1. Ensure latest code is published on the `main` branch.\n1. Create the new version number with `npm version {major|minor|patch}`\n1. Push the branch and the version tag: `git push origin main --follow-tags`\n\nThe [publish workflow](https://github.com/basketry/sorbet-docs/actions/workflows/publish.yml) will build and pack the new version then push the package to NPM. Note that publishing requires write access to the `main` branch.\n\n---\n\nGenerated with [generator-ts-console](https://www.npmjs.com/package/generator-ts-console)\n","readmeFilename":"README.md"}