{"id":16222140,"url":"https://github.com/hugodf/jsdoc-type-d-ts-node-pkg","last_synced_at":"2026-05-15T22:33:30.240Z","repository":{"id":38813528,"uuid":"264692707","full_name":"HugoDF/jsdoc-type-d-ts-node-pkg","owner":"HugoDF","description":"A Node.js package setup with types.d.ts (TypeScript typings) generated from JSDoc annotations","archived":false,"fork":false,"pushed_at":"2023-02-03T07:21:18.000Z","size":1074,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T00:46:28.712Z","etag":null,"topics":["jsdoc","jsdoc-template","node-module","nodejs","typescript-definitions","typings"],"latest_commit_sha":null,"homepage":"https://codewithhugo.com/jsdoc-typescript-typings-types-d-ts/","language":"JavaScript","has_issues":false,"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/HugoDF.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}},"created_at":"2020-05-17T15:03:17.000Z","updated_at":"2022-03-18T18:29:43.000Z","dependencies_parsed_at":"2023-02-04T13:30:36.512Z","dependency_job_id":null,"html_url":"https://github.com/HugoDF/jsdoc-type-d-ts-node-pkg","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":"HugoDF/node-mit-boilerplate","purl":"pkg:github/HugoDF/jsdoc-type-d-ts-node-pkg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HugoDF%2Fjsdoc-type-d-ts-node-pkg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HugoDF%2Fjsdoc-type-d-ts-node-pkg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HugoDF%2Fjsdoc-type-d-ts-node-pkg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HugoDF%2Fjsdoc-type-d-ts-node-pkg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HugoDF","download_url":"https://codeload.github.com/HugoDF/jsdoc-type-d-ts-node-pkg/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HugoDF%2Fjsdoc-type-d-ts-node-pkg/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275062970,"owners_count":25398889,"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-09-14T02:00:10.474Z","response_time":75,"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":["jsdoc","jsdoc-template","node-module","nodejs","typescript-definitions","typings"],"created_at":"2024-10-10T12:11:23.208Z","updated_at":"2025-10-04T03:54:04.998Z","avatar_url":"https://github.com/HugoDF.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![test](https://github.com/HugoDF/jsdoc-type-d-ts-node-pkg/workflows/test/badge.svg)\n\n# Node.js module with TypeScript typings (types.d.ts) generated from JSDoc\n\nExample repo for a Node.js module with TypeScript typings ([./types.d.ts](./types.d.ts)) generated from JSDoc annotations.\n\nProject setup, files/directories of interest are [./src/main.js](./src/main.js), [./tests](./tests) and [./types.d.ts](./types.d.ts).\n\n```\n├── LICENSE\n├── README.md\n├── node_modules\n│   └── ...\n├── package.json\n├── src\n│   └── main.js\n├── tests\n│   └── ping.js\n├── types.d.ts\n└── yarn.lock\n```\n\nComes ready to develop with: \n\n- [ava](https://avajs.dev) for testing\n- [jsdoc](https://github.com/jsdoc/jsdoc) and [tsd-jsdoc](https://github.com/englercj/tsd-jsdoc) to generate the [./types.d.ts](./types.d.ts) file.\n- [xo](https://github.com/xojs/xo#readme) for linting/formatting\n\n## Quickstart\n\nUse the GitHub \"Template\" functionality or clone the repo (take care to remove the `.git` folder in that case).\n\n# Contributing\n\n## Requirements\n\n- Node 12\n- Yarn 1.x or npm\n\n## Setup\n\n1. Clone the repository\n2. Run `yarn` or `npm install` installs all required dependencies.\n\n## npm scripts\n\n\u003e Equivalent `npm run \u003cscript\u003e` should also work\n\n- `yarn test` run tests with [ava](https://github.com/avajs/ava).\n- `yarn build` will run JSDoc -\u003e TypeScript typing conversion with [jsdoc](https://github.com/jsdoc/jsdoc) and [tsd-jsdoc](https://github.com/englercj/tsd-jsdoc), changes to [./types.d.ts](./types.d.ts) shoud be committed.\n- `yarn lint` will lint all of the files with [xo](https://github.com/xojs/xo)\n- `yarn format` will run lint with `--fix` option on all the examples files (and tests).\n\n# About\n\nThis package is maintained by Hugo from [Code with Hugo](https://codewithhugo.com) and [Alpine.js Weekly](https://alpinejs.codewithhugo.com/newsletter).\n\n## Acknowledgments\n\n\nSpecial thanks to:\n\n- The developers behind\n  - [ava](https://avajs.dev)\n  - [jsdoc](https://github.com/jsdoc/jsdoc)\n  - [tsd-jsdoc](https://github.com/englercj/tsd-jsdoc)\n  - [xo](https://github.com/xojs/xo#readme)\n\n# LICENSE\n\nCode is licensed under the [MIT License](./LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugodf%2Fjsdoc-type-d-ts-node-pkg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugodf%2Fjsdoc-type-d-ts-node-pkg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugodf%2Fjsdoc-type-d-ts-node-pkg/lists"}