{"id":20700375,"url":"https://github.com/s-a/deep-js","last_synced_at":"2025-06-16T04:32:45.863Z","repository":{"id":30276596,"uuid":"33828091","full_name":"s-a/deep-js","owner":"s-a","description":"Documenting JavaScript","archived":false,"fork":false,"pushed_at":"2015-04-29T20:26:22.000Z","size":300,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-18T12:45:45.957Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/s-a.png","metadata":{"files":{"readme":"readme.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-12T18:18:48.000Z","updated_at":"2023-07-10T13:05:56.000Z","dependencies_parsed_at":"2022-09-21T22:10:19.213Z","dependency_job_id":null,"html_url":"https://github.com/s-a/deep-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-a%2Fdeep-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-a%2Fdeep-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-a%2Fdeep-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-a%2Fdeep-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/s-a","download_url":"https://codeload.github.com/s-a/deep-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242967728,"owners_count":20214281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T00:35:07.189Z","updated_at":"2025-03-11T03:51:20.419Z","avatar_url":"https://github.com/s-a.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# deep-js\r\n[![Build Status](http://img.shields.io/travis/s-a/deep-js.svg?style=flat-square)](https://travis-ci.org/s-a/deep-js)\r\n[![Codacy Badge](https://www.codacy.com/project/badge/1ffcf7a0ed0341d8b21bb6c17655c013)](https://www.codacy.com/app/stephanahlf/deep-js)\r\n[![Coverage Status](https://coveralls.io/repos/s-a/deep-js/badge.svg?branch=master)](https://coveralls.io/r/s-a/deep-js?branch=master)\r\n[![NPM Version](http://img.shields.io/npm/v/deep-js.svg?style=flat-square)](https://www.npmjs.org/package/deep-js)\r\n[![Dependencies](https://img.shields.io/david/s-a/deep-js.svg)](#)\r\n[![Development Dependencies](https://img.shields.io/david/dev/s-a/deep-js.svg)](#)\r\n\r\n## About\r\nA commandline app documenting Javascript code. Inspired by JS Doc I thought it would be wonderful if a tool can understand my JavaScript code. It should be possible to generate a useful API documentation without learning any blocktags and without heavy syntax specifications. It should be light weight and simple to use for small JavaScript projects.\r\n// work is heavy @ progress ( feel free to contribute! )\r\n\r\n\r\n## Todo\r\n - pipe multiple JavaScript files for document output\r\n - identify and order namespaces\r\n - resolve ```this``` within functions\r\n\r\n## Installation\r\n\r\n - ```npm install -g deep-js```\r\n\r\n## Options\r\n\r\n - h, --help            output usage information\r\n - V, --version         output the version number\r\n - f, --file \u003cSting\u003e    JavaScript file to parse\r\n - d, --describe \u003citems\u003e comma seperated list of JavaScript names that should be described\r\n - o, --output \u003cSting\u003e  Documentation output file\r\n\r\n## Examples\r\n - ```deep --file=use-case-main.js --describe=* --output=lib-doc/use-case-main.js.MD``` will create [/lib-doc/use-case-main.js.MD](/lib-doc/use-case-main.js.MD)\r\n\r\n## Develpment setup\r\n  - ```npm install -g mocha```\r\n  - ```npm install -g coveralls```\r\n\r\n## Contributing\r\n\r\n - Fork it!\r\n - Create your feature branch: `git checkout -b my-new-feature`\r\n - Add a test for each new code\r\n - Check the coverage ```npm run cover-html``` will produce a file called ```coverage.html```\r\n - Add add your new code\r\n - Run the tests: `npm test`\r\n - Commit your changes: `git commit -am 'Add some feature'`\r\n - Push to the branch: `git push origin my-new-feature`\r\n - Submit a pull request :D\r\n\r\n\r\n## License\r\n\r\n### The MIT License (MIT)\r\nCopyright (C) 2015 Stephan Ahlf\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n\r\n### GPLv3\r\n\r\nCopyright (C) 2015  Stephan Ahlf\r\n\r\nThis program is free software: you can redistribute it and/or modify\r\nit under the terms of the GNU General Public License as published by\r\nthe Free Software Foundation, either version 3 of the License, or\r\n(at your option) any later version.\r\n\r\nThis program is distributed in the hope that it will be useful,\r\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\r\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r\nGNU General Public License for more details.\r\n\r\nYou should have received a copy of the GNU General Public License\r\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs-a%2Fdeep-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fs-a%2Fdeep-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs-a%2Fdeep-js/lists"}