{"id":23978123,"url":"https://github.com/shiv-source/dynamic-package-update","last_synced_at":"2026-05-04T10:31:36.594Z","repository":{"id":202621026,"uuid":"707716482","full_name":"shiv-source/dynamic-package-update","owner":"shiv-source","description":"A simple node.js module for dynamic updating packages list in the markdown file.","archived":false,"fork":false,"pushed_at":"2025-06-23T05:09:33.000Z","size":44,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-29T07:03:09.524Z","etag":null,"topics":["dpu","dynamic-package-update","markdown","nodejs","readme","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/dynamic-package-update","language":"TypeScript","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/shiv-source.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-10-20T13:55:42.000Z","updated_at":"2023-10-20T14:32:21.000Z","dependencies_parsed_at":"2024-04-20T03:22:46.488Z","dependency_job_id":"43d3c714-f13d-424a-a9ad-bf861c873f90","html_url":"https://github.com/shiv-source/dynamic-package-update","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"ea67b3bdfcfbebfe8cfa3dc57276a2761279d113"},"previous_names":["shiv-source/dynamic-package-update"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/shiv-source/dynamic-package-update","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiv-source%2Fdynamic-package-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiv-source%2Fdynamic-package-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiv-source%2Fdynamic-package-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiv-source%2Fdynamic-package-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shiv-source","download_url":"https://codeload.github.com/shiv-source/dynamic-package-update/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiv-source%2Fdynamic-package-update/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32603916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["dpu","dynamic-package-update","markdown","nodejs","readme","typescript"],"created_at":"2025-01-07T08:16:34.781Z","updated_at":"2026-05-04T10:31:36.578Z","avatar_url":"https://github.com/shiv-source.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dynamic-package-update\n\n![NPM Version](https://img.shields.io/npm/v/dynamic-package-update.svg?style=flat)\n![NPM Downloads](https://img.shields.io/npm/dm/dynamic-package-update.svg)\n![GitHub release](https://img.shields.io/github/release/shiv-source/dynamic-package-update)\n![License](https://img.shields.io/github/license/shiv-source/dynamic-package-update)\n\nA simple node.js module for dynamic updating packages list in the markdown file.\n\n\n# Installation\n\n## Prerequisites\n\n- Node.js \u003e= 10.0.0\n\n\n## Install Package\n\n```sh\n\n# With NPM\n\nnpm install --save dynamic-package-update\n\n# With Yarn\n\nyarn add dynamic-package-update\n\n```\n\n```js\n// Available options\n\nconst dpu = require(\"dynamic-package-update\");\n\nconst option = {\n    outPutFileName: 'docs.md',              // Default is README.md\n    packageJsonFile: 'your json file',      // Default your root package.json file no need to set this option. \n    showNpmLinkColumn: true,                // Default is true.\n    showTypeColumn: true,                   // Default is true.\n    showDependencies: true,                 // Default is true.\n    showDevDependencies: true               // Default is true.\n}\n\n// Note: By default option is an optional parameter.\n\ndpu.generateTableMarkDown(readmefile, option);\n```\n\n# Examples\n\nCreate a readme.js file for updating README.md file.\n\n```\nFolder structure with readme.js:\n\n    +-- node_modules\n    +-- src\n    |   +-- index.js\n    |   +-- file1.js\n    |   +-- file1.js\n    +-- package.json\n    +-- package-lock.json\n    +-- readme.js\n    +-- README.md\n\n```\n\n```js\n// readme.js\n\nconst dpu = require(\"dynamic-package-update\");\nconst fs = require('fs');\nconst path = require('path');\n\nconst readmefile = fs.readFileSync(path.join(__dirname, \"README.md\"), \"utf8\");\ndpu.generateTableMarkDown(readmefile);\n\n```\n\n```\nNotes:\n- Add this below html code in anywhere in your README.md file.\n- Don't add anything inside this content div.\n- It will automatically inject package list from your package.json file.\n- Along with package list, It will automatically add  Package List as a title tag. Don't add it explicitely.\n\n```\n\n```html\n\u003c!--README.md--\u003e\n\n\u003cdiv id=\"content\"\u003e\n\u003c/div\u003e\n```\n\n```js\n// package.json\n\n  \"scripts\": {\n    \"start\": \"node src/index.js\",\n    \"readme:dpu\": \"node readme.js\"\n  },\n\n```\n\n```sh\n\nnpm run readme:dpu     #This will automatically update package list in the README.md file\n\n```\n\n# Package Insights\n\n## Build\n\n```sh\nnpm install             #For installing dependencies\n\nnpm build               #For making build\n```\n\n\u003cdiv id=\"content\"\u003e\n\n## Package List\n\n | Package Name | Version | Type | Npm Link |\n | ---- | ---- | ---- | ---- | \n | @types/node | ^20.8.7 | devDependencies | [@types/node](https://www.npmjs.com/package/@types/node) | \n | lint-staged | ^15.0.2 | devDependencies | [lint-staged](https://www.npmjs.com/package/lint-staged) | \n | prettier | ^3.0.3 | devDependencies | [prettier](https://www.npmjs.com/package/prettier) | \n | typescript | ^5.2.2 | devDependencies | [typescript](https://www.npmjs.com/package/typescript) | \n | husky | ^8.0.0 | devDependencies | [husky](https://www.npmjs.com/package/husky) | \n\n\u003c/div\u003e\n\n\n```sh\nNote: The build artifacts will be stored in the `dist/` directory.\n```\n\n# Contributors\n\n\u003ca href = \"https://github.com/shiv-source\"\u003e\n  \u003cimg \n    src = \"https://avatars.githubusercontent.com/u/56552766?v=4\" \n    width=\"100\" \n    height=\"100\"\n    style=\"border-radius: 50%; margin: 5px;\" \n  /\u003e\n\u003c/a\u003e\n\n# License\n\n[MIT](https://opensource.org/licenses/MIT)\n\n**Free Software**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiv-source%2Fdynamic-package-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshiv-source%2Fdynamic-package-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiv-source%2Fdynamic-package-update/lists"}