{"id":17696720,"url":"https://github.com/andrewmaksimchuk/documentation-module","last_synced_at":"2026-05-17T00:06:29.311Z","repository":{"id":166054210,"uuid":"542700637","full_name":"AndrewMaksimchuk/documentation-module","owner":"AndrewMaksimchuk","description":"Documentation module pattern and tool for watch tham.","archived":false,"fork":false,"pushed_at":"2022-09-28T18:29:29.000Z","size":3,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-11T01:40:04.572Z","etag":null,"topics":["documentation","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AndrewMaksimchuk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-28T17:01:00.000Z","updated_at":"2025-04-30T06:30:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"2d758e7a-8d6b-40fc-a7d6-7e392d8f78c8","html_url":"https://github.com/AndrewMaksimchuk/documentation-module","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AndrewMaksimchuk/documentation-module","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewMaksimchuk%2Fdocumentation-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewMaksimchuk%2Fdocumentation-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewMaksimchuk%2Fdocumentation-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewMaksimchuk%2Fdocumentation-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndrewMaksimchuk","download_url":"https://codeload.github.com/AndrewMaksimchuk/documentation-module/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewMaksimchuk%2Fdocumentation-module/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005928,"owners_count":26083986,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","nodejs"],"created_at":"2024-10-24T14:45:06.701Z","updated_at":"2025-10-11T01:40:05.739Z","avatar_url":"https://github.com/AndrewMaksimchuk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Example of documentation the module and get quick that information.\n\n\n### Module:\n```\nimport { openSync, writeFileSync } from \"fs\";\n\nexport function log(tty, value) {\n\treturn writeFileSync(openSync(tty, \"w+\"), JSON.stringify(value) + \"\\n\");\n}\n\nexport const __doc__ =\n`\nParameters:\n    1. tty - The file name of the terminal connected to standart input (linux tty command).\n    2. value - Any data type that can be converted to a string type.\n\nReturn:\n    Function call \"writeFileSync\" from \"fs\" module.\n`;\n\nlog.__doc__ = __doc__;\n```\n\n`__doc__ ` - Is like protected property that store text description of module. All what developer whant to write.  \n\n`log.__doc__ = __doc__;` - It`s option, for your needs, available in runtime.  \n\n\nFor quick see the documentation, just write command `doc path_to_module` and the text will be displayed.  \n\n\n### Example:  \nWrite in terminal `doc ./example_module.js`  \nThen see:\n```\nDocumentation for the module:\n    example_module.js\n\nParameters:\n    1. tty - The file name of the terminal connected to standart input (linux tty command).\n    2. value - Any data type that can be converted to a string type.\n\nReturn:\n    Function call \"writeFileSync\" from \"fs\" module.\n```\n\n\n### Examples of launches:  \n`doc ./module.js`\n`./doc.js ./example_module.js`  \n`npm run doc ./example_module.js`  \n`node ./doc.js ./example_module.js`  \n\n\n### Install:  \n`npm run install`  \n\nInstalling - it`s just create symlink \"doc\" to package file doc.js.  \n\n\n### NPM scripts:  \n`doc` - See the documentation of module.  \n`install` - Install package.  \n`remove` - Remove package.  \n`check` - Check if package installed.  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewmaksimchuk%2Fdocumentation-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrewmaksimchuk%2Fdocumentation-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewmaksimchuk%2Fdocumentation-module/lists"}