{"_id":"@aexol/socket-to-markdown","_rev":"11-19a1559dc0fcd2077d16db57a8c171c2","name":"@aexol/socket-to-markdown","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@aexol/socket-to-markdown","version":"0.1.0","keywords":["socket","markdown"],"author":{"name":"Aexol"},"license":"MIT","_id":"@aexol/socket-to-markdown@0.1.0","maintainers":[{"name":"aexol","email":"aexol@aexol.com"}],"homepage":"https://gitlab.com/Aexol/socket-to-markdown#README","bugs":{"url":"https://gitlab.com/Aexol/socket-to-markdown/issues"},"bin":{"socket2md":"bin/cli.js"},"dist":{"shasum":"03251a6e3ba6ca6d29edb8d75e69936e793cc3c9","tarball":"https://registry.npmjs.org/@aexol/socket-to-markdown/-/socket-to-markdown-0.1.0.tgz","fileCount":21,"integrity":"sha512-i/A0LBsDWeYbOYcezxWaexiNhQ+ctEdX/qDiVuAtP8o9YNnPaxF1S1JAX7e0tLQ0hLx4UbjbUPhrvUqOwfvTzw==","signatures":[{"sig":"MEYCIQCHto3ZEdt3akzAOv95WlLNNEedAl0WA0iGWc85lCSq/wIhAIC0fVN4VGZaonb2OAcXNkkjUFCWkpwc3trrRckA+b7I","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13950},"main":"lib/index.js","gitHead":"3293601eef7eb85e0952c5065ed61f7833358e8c","scripts":{"test":"jest","build":"rm -rf lib && babel src -d lib && cp -r src/partials lib/partials"},"_npmUser":{"name":"aexol","email":"aexol@aexol.com"},"repository":{"url":"git+https://gitlab.com/Aexol/socket-to-markdown.git","type":"git"},"_npmVersion":"5.7.1","description":"Document socket using markdown","directories":{},"_nodeVersion":"9.6.1","dependencies":{"js-yaml":"^3.10.0","handlebars":"^4.0.11","config-master":"^3.1.0","command-line-tool":"^0.8.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.4.2","eslint":"^4.18.1","babel-cli":"^6.26.0","babel-preset-env":"^1.6.1","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-strict-mode":"^6.24.1","babel-plugin-transform-class-properties":"^6.24.1","babel-plugin-transform-export-extensions":"^6.22.0","babel-plugin-transform-object-rest-spread":"^6.26.0"},"_npmOperationalInternal":{"tmp":"tmp/socket-to-markdown_0.1.0_1520001716567_0.035224750792421045","host":"s3://npm-registry-packages"}},"0.1.1":{"name":"@aexol/socket-to-markdown","version":"0.1.1","keywords":["socket","markdown"],"author":{"name":"Aexol"},"license":"MIT","_id":"@aexol/socket-to-markdown@0.1.1","maintainers":[{"name":"aexol","email":"aexol@aexol.com"}],"homepage":"https://gitlab.com/Aexol/socket-to-markdown#README","bugs":{"url":"https://gitlab.com/Aexol/socket-to-markdown/issues"},"bin":{"socket2md":"bin/cli.js"},"dist":{"shasum":"f2bb6b793b9f09bcda2f068c497bf4a34d800d54","tarball":"https://registry.npmjs.org/@aexol/socket-to-markdown/-/socket-to-markdown-0.1.1.tgz","fileCount":22,"integrity":"sha512-g+vqFuIqSlx6wCvJYBrVh2NsW/Gp1FWbEZUNusGxBgcIIsCzumY4QTad6ntlsmEBxkohyUl2TpYhQdRqO+XrpQ==","signatures":[{"sig":"MEYCIQCA1bJcJaIGL+uIb6mqCQv+EEEl5hC8DuDf7iUrSMJI4gIhAIyKrxR2mzUMHiFReMMxaBZCwv4xk+cZE8J47mlZJOAY","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14347},"main":"lib/index.js","gitHead":"e532737b748ada3ea55235cafd94dc2e7abcc506","scripts":{"test":"jest","build":"rm -rf lib && babel src -d lib && cp -r src/partials lib/partials"},"_npmUser":{"name":"aexol","email":"aexol@aexol.com"},"repository":{"url":"git+https://gitlab.com/Aexol/socket-to-markdown.git","type":"git"},"_npmVersion":"5.7.1","description":"Document socket using markdown","directories":{},"_nodeVersion":"9.6.1","dependencies":{"js-yaml":"^3.10.0","handlebars":"^4.0.11","config-master":"^3.1.0","command-line-tool":"^0.8.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.4.2","eslint":"^4.18.1","babel-cli":"^6.26.0","babel-preset-env":"^1.6.1","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-strict-mode":"^6.24.1","babel-plugin-transform-class-properties":"^6.24.1","babel-plugin-transform-export-extensions":"^6.22.0","babel-plugin-transform-object-rest-spread":"^6.26.0"},"_npmOperationalInternal":{"tmp":"tmp/socket-to-markdown_0.1.1_1520002387344_0.6802483231627592","host":"s3://npm-registry-packages"}},"0.1.2":{"name":"@aexol/socket-to-markdown","version":"0.1.2","keywords":["socket","markdown"],"author":{"name":"Aexol"},"license":"MIT","_id":"@aexol/socket-to-markdown@0.1.2","maintainers":[{"name":"aexol","email":"aexol@aexol.com"}],"homepage":"https://gitlab.com/Aexol/socket-to-markdown#README","bugs":{"url":"https://gitlab.com/Aexol/socket-to-markdown/issues"},"bin":{"socket2md":"bin/cli.js"},"dist":{"shasum":"f386c9c594ec27a27e434251c4a13f8f515267bf","tarball":"https://registry.npmjs.org/@aexol/socket-to-markdown/-/socket-to-markdown-0.1.2.tgz","fileCount":22,"integrity":"sha512-yelWHnwdiBvHhqhtO9Vu0nFWoGYevagIrk+JVrhzyZR2Sb8ILX/ZetZxTznlcS6iNB0fhtKFiusikVK8bFlpsA==","signatures":[{"sig":"MEQCIAEvq+K3zAB15UFRjn+5c4tQxK/gIO2t59G2AhuGJHFQAiBAq2ZMBHyQ0OyVdOGPsyJvpORnHvg2rED62vGGfDX/uA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14634},"main":"lib/index.js","gitHead":"6a3f599cd4fe12f2d57ac02b153739a9aadc91f6","scripts":{"test":"jest","build":"rm -rf lib && babel src -d lib && cp -r src/partials lib/partials"},"_npmUser":{"name":"aexol","email":"aexol@aexol.com"},"repository":{"url":"git+https://gitlab.com/Aexol/socket-to-markdown.git","type":"git"},"_npmVersion":"5.7.1","description":"Document socket using markdown","directories":{},"_nodeVersion":"9.6.1","dependencies":{"js-yaml":"^3.10.0","handlebars":"^4.0.11","config-master":"^3.1.0","command-line-tool":"^0.8.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.4.2","eslint":"^4.18.1","babel-cli":"^6.26.0","babel-preset-env":"^1.6.1","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-strict-mode":"^6.24.1","babel-plugin-transform-class-properties":"^6.24.1","babel-plugin-transform-export-extensions":"^6.22.0","babel-plugin-transform-object-rest-spread":"^6.26.0"},"_npmOperationalInternal":{"tmp":"tmp/socket-to-markdown_0.1.2_1520002979159_0.6614181609858341","host":"s3://npm-registry-packages"}},"0.1.3":{"name":"@aexol/socket-to-markdown","version":"0.1.3","keywords":["socket","markdown"],"author":{"name":"Aexol"},"license":"MIT","_id":"@aexol/socket-to-markdown@0.1.3","maintainers":[{"name":"aexol","email":"aexol@aexol.com"}],"homepage":"https://gitlab.com/Aexol/socket-to-markdown#README","bugs":{"url":"https://gitlab.com/Aexol/socket-to-markdown/issues"},"bin":{"socket2md":"bin/cli.js"},"dist":{"shasum":"93dc0c33d6607d135444dbd1154b9b1dc3f239ce","tarball":"https://registry.npmjs.org/@aexol/socket-to-markdown/-/socket-to-markdown-0.1.3.tgz","fileCount":26,"integrity":"sha512-JST5BQncLKMZiAefX7HDJhDVlXTBE9EvLlahNDYsZhcTpsjKZwxM83fhtp95z9j4eLAzDAGNb+GtDp/kWmtMfg==","signatures":[{"sig":"MEUCIFzrLA1FqkjYzYVPTelAd6E0elJ3IaT8+zmtGKhTOkgmAiEAqxsFX5tpxUFvK4oyhsSlsuSm0fwTOT7KvbwP2EgBIlU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16019},"main":"lib/index.js","gitHead":"e6403c72325cad386aa7efa511479718ade3e4fc","scripts":{"test":"jest","build":"rm -rf lib && babel src -d lib && cp -r src/partials lib/partials"},"_npmUser":{"name":"aexol","email":"aexol@aexol.com"},"repository":{"url":"git+https://gitlab.com/Aexol/socket-to-markdown.git","type":"git"},"_npmVersion":"5.7.1","description":"Document socket using markdown","directories":{},"_nodeVersion":"9.6.1","dependencies":{"js-yaml":"^3.10.0","handlebars":"^4.0.11","config-master":"^3.1.0","command-line-tool":"^0.8.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.4.2","eslint":"^4.18.1","babel-cli":"^6.26.0","babel-preset-env":"^1.6.1","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-strict-mode":"^6.24.1","babel-plugin-transform-class-properties":"^6.24.1","babel-plugin-transform-export-extensions":"^6.22.0","babel-plugin-transform-object-rest-spread":"^6.26.0"},"_npmOperationalInternal":{"tmp":"tmp/socket-to-markdown_0.1.3_1520005067217_0.5073729344066795","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"@aexol/socket-to-markdown","version":"0.2.0","keywords":["socket","markdown"],"author":{"name":"Aexol"},"license":"MIT","_id":"@aexol/socket-to-markdown@0.2.0","maintainers":[{"name":"aexol","email":"aexol@aexol.com"}],"homepage":"https://gitlab.com/Aexol/socket-to-markdown#README","bugs":{"url":"https://gitlab.com/Aexol/socket-to-markdown/issues"},"bin":{"socket2md":"bin/cli.js"},"dist":{"shasum":"6fa9b2bedfe63ded72c009932d579f9b9e2aa42b","tarball":"https://registry.npmjs.org/@aexol/socket-to-markdown/-/socket-to-markdown-0.2.0.tgz","fileCount":30,"integrity":"sha512-5nHGKkZJjcZH3RYn4k5+aGPY1oq6lwTTExOiPcy1l8RpEmBM34fSQDH/VdYQvRUObqkvoArAwRgJEzdGUWDvEA==","signatures":[{"sig":"MEYCIQCX5NLbZl4OY3xZOH8F5C/ct084MkkN6N4VSpWWhCwjRAIhAMd1XxWbVHgj8tYYSflTmWfwgOzu7fYjbooWr9hPjDum","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26565},"main":"lib/index.js","gitHead":"3e5d3287126a423f31b8361de0adcf9dff0ddc5a","scripts":{"test":"jest","build":"rm -rf lib && babel src -d lib && cp -r src/partials lib/partials"},"_npmUser":{"name":"aexol","email":"aexol@aexol.com"},"repository":{"url":"git+https://gitlab.com/Aexol/socket-to-markdown.git","type":"git"},"_npmVersion":"5.7.1","description":"Document socket using markdown","directories":{},"_nodeVersion":"9.6.1","dependencies":{"js-yaml":"^3.10.0","handlebars":"^4.0.11","lodash.get":"^4.4.2","lodash.has":"^4.5.2","lodash.merge":"^4.6.1","lodash.unset":"^4.5.2","config-master":"^3.1.0","json-merge-patch":"^0.2.3","lodash.camelcase":"^4.3.0","command-line-tool":"^0.8.0","json-schema-ref-parser":"^4.1.1"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.4.2","eslint":"^4.18.1","babel-cli":"^6.26.0","babel-preset-env":"^1.6.1","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-strict-mode":"^6.24.1","babel-plugin-transform-class-properties":"^6.24.1","babel-plugin-transform-export-extensions":"^6.22.0","babel-plugin-transform-object-rest-spread":"^6.26.0"},"_npmOperationalInternal":{"tmp":"tmp/socket-to-markdown_0.2.0_1520525968059_0.24069526360702698","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-03-02T14:41:56.498Z","modified":"2026-04-03T08:10:35.084Z","0.1.0":"2018-03-02T14:41:56.703Z","0.1.1":"2018-03-02T14:53:07.411Z","0.1.2":"2018-03-02T15:02:59.332Z","0.1.3":"2018-03-02T15:37:47.276Z","0.2.0":"2018-03-08T16:19:28.116Z"},"bugs":{"url":"https://gitlab.com/Aexol/socket-to-markdown/issues"},"author":{"name":"Aexol"},"license":"MIT","homepage":"https://gitlab.com/Aexol/socket-to-markdown#README","keywords":["socket","markdown"],"repository":{"url":"git+https://gitlab.com/Aexol/socket-to-markdown.git","type":"git"},"description":"Document socket using markdown","maintainers":[{"email":"aexol@aexol.com","name":"arturczemiel"},{"email":"ania@aexol.com","name":"ania-aexol"},{"email":"office@aexol.com","name":"aexol-office"},{"email":"kamil@aexol.com","name":"kamil-aexol"}],"readme":"# socket-to-markdown\n\nAnalyze socket.yml in current directory and print to `stdout` markdown with socket documentation. Project was inspired by jsdoc-to-markdown, though it's far simpler as my needs were simpler.\n\n## Installation\n\n```\n$ npm install --save-dev @aexol/socket-to-markdown\n```\n\n## Usage\n\nJust add this to your socket's package.json\n```json\n{\n    ...\n    \"scripts\": {\n        ...\n        \"docs\": \"socket2md > README.md; echo\"\n        ...\n    },\n    ...\n}\n```\n\nand then run\n```sh\n$ npm run docs\n```\n\n## Built in partials\n\n* class-row\n* classes-index\n* classes\n* config-index\n* config\n* endpoint\n* endpoints-index\n* endpoints\n* events\n* index\n* main\n* input\n* inputs\n* inputs-block\n* inputs-table\n\n## Extra partial\n\nYou can add any handlebars template file as partial template.\n\n## Built in helpers\n\n* socket - Get socket object\n* classes - Get classes obejct\n* config - Get config object\n* endpoints - Get endpoints obejct\n* events - Get events object\n* inputs - Get inputs for current endpoint\n* inputs-table - Create param table for current endpoint\n* reference-type - True if class type is reference or relation.\n\n## Extra helpers\nJust add javascript file exporting simple function, for example:\n```javascript\nmodule.exports = (context, options) => {\n    let out = 'HEADER!!!!\\n'\n    out += options.fn(this)\n    out += 'FOOTER!!!\\n'\n    return out:\n}\n```\n\nTODO:\n* Syncano events.","readmeFilename":"README.md"}