René's URL Explorer Experiment


Title: Auto-generate TypeScript Typings from Documentation by jvilk · Pull Request #38 · nodegit/nodegit.github.com · GitHub

Open Graph Title: Auto-generate TypeScript Typings from Documentation by jvilk · Pull Request #38 · nodegit/nodegit.github.com

X Title: Auto-generate TypeScript Typings from Documentation by jvilk · Pull Request #38 · nodegit/nodegit.github.com

Description: I am opening this PR to start a conversation. It should not be merged as-is until we determine how to integrate these typings into nodegit. Summary I have created a script that creates valid TypeScript typings for NodeGit from the documentation JSON. As NodeGit improves its documentation, the TypeScript typings will improve as well. This is what the working typings look like. Usage Run generate/index.js in the usual manner. It will generate ts/nodegit.d.ts. To create a new project that uses this file, do the following: npm install -g typescript tsd mkdir test_proj cd test_proj npm install nodegit tsd install node cp path/to/nodegit.github.com/ts/nodegit.d.ts node_modules/nodegit/lib/ Edit node_modules/nodegit/package.json to include a "typings": "lib/nodegit.d.ts" field. This tells the TypeScript compiler where to find typings for your package. Create tsconfig.json in test_proj: { "compilerOptions": { "target": "es3", "module": "commonjs", "noImplicitAny": true }, "files": [ "typings/node/node.d.ts", "test.ts" ] } Create the test.ts in test_proj: import Git = require('nodegit'); var getMostRecentCommit = function(repository: Git.Repository) { return repository.getBranchCommit("master"); }; var getCommitMessage = function(commit: Git.Commit) { return commit.message(); }; Git.Repository.open("nodegit") .then(getMostRecentCommit) .then(getCommitMessage) .then(function(message) { console.log(message); }); Compile test.ts: $ tsc Then, you can fiddle with the code in an editor that supports TypeScript, such as Visual Studio Code or Atom with the atom-typescript plugin. Simply open up the test_proj folder, and the editor will use tsconfig.json to orient itself and provide autocomplete using the typings. Limitations Currently, there are a number of weird type annotations that I have to smooth over or type to the 'any' type (see the getType function). Most of them are untyped callback functions. As you improve NodeGit's documentation, we can remove some of the logic in that function. Suggestions It would be ideal if: You included generated TypeScript declaration files in nodegit's NPM module, as illustrated in the example. You added a test to your testsuite that verifies that the produced declaration file compiles properly. If it does not, it likely indicates a documentation bug! If the script breaks, ping me. In the worst case, you can ship w/o decls for a release. In the best case, you'll fall in love with TypeScript and decide to maintain it yourselves! 😄 An alternative proposal is to put the types in the DefinitelyTyped repository, where they can be maintained separately. But I'd argue that including them into the NPM module directly would be mutually beneficial -- automatic checking of your docs, and typings for TypeScript users! Thoughts?

Open Graph Description: I am opening this PR to start a conversation. It should not be merged as-is until we determine how to integrate these typings into nodegit. Summary I have created a script that creates valid TypeSc...

X Description: I am opening this PR to start a conversation. It should not be merged as-is until we determine how to integrate these typings into nodegit. Summary I have created a script that creates valid TypeSc...

Opengraph URL: https://github.com/nodegit/nodegit.github.com/pull/38

X: @github

direct link

Domain: redirect.github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:5ff54fc9-da89-5960-14f6-180670a6e4bb
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idD376:128588:B747B8:10872CF:6AFDA760
html-safe-nonce57046f408d00536b47a08e9f4b4bf823dd508bdaa7969d9461f2d89dcbb5a775
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMzc2OjEyODU4ODpCNzQ3Qjg6MTA4NzJDRjo2QUZEQTc2MCIsInZpc2l0b3JfaWQiOiI4OTA0ODQ0MzUzMzA2NzMyMzg0IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmaccf8386089429234f5b094336094fb1155081d447f9b38a61c1ee30fe0054c475
hovercard-subject-tagpull_request:58664490
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/nodegit/nodegit.github.com/pull/38/files
twitter:imagehttps://avatars.githubusercontent.com/u/1141042?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/1141042?s=400&v=4
og:image:altI am opening this PR to start a conversation. It should not be merged as-is until we determine how to integrate these typings into nodegit. Summary I have created a script that creates valid TypeSc...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Nonebc86424ef34a73b386237872800e922d149d65ba907f63d6f150a2dcb8433bea
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/nodegit/nodegit.github.com git https://github.com/nodegit/nodegit.github.com.git
octolytics-dimension-user_id657068
octolytics-dimension-user_loginnodegit
octolytics-dimension-repository_id1462352
octolytics-dimension-repository_nwonodegit/nodegit.github.com
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id1462352
octolytics-dimension-repository_network_root_nwonodegit/nodegit.github.com
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release0ddf53eb35c87f1f8df13dbf75c3bdadbfc6e969
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#start-of-content
https://redirect.github.com/
Sign inhttps://redirect.github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnodegit%2Fnodegit.github.com%2Fpull%2F38%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://redirect.github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnodegit%2Fnodegit.github.com%2Fpull%2F38%2Ffiles
Sign uphttps://redirect.github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=nodegit%2Fnodegit.github.com
Reloadhttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Reloadhttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Reloadhttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
nodegithttps://redirect.github.com/nodegit
nodegit.github.comhttps://redirect.github.com/nodegit/nodegit.github.com
Codehttps://redirect.github.com/nodegit/nodegit.github.com
Issues21 (21)https://redirect.github.com/nodegit/nodegit.github.com/issues
Pull requests12 (12)https://redirect.github.com/nodegit/nodegit.github.com/pulls
Actionshttps://redirect.github.com/nodegit/nodegit.github.com/actions
Projectshttps://redirect.github.com/nodegit/nodegit.github.com/projects
Wikihttps://redirect.github.com/nodegit/nodegit.github.com/wiki
Security and qualityhttps://redirect.github.com/nodegit/nodegit.github.com/security
Insightshttps://redirect.github.com/nodegit/nodegit.github.com/insights
Sign up for GitHub https://redirect.github.com/signup?return_to=%2Fnodegit%2Fnodegit.github.com%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://redirect.github.com/login?return_to=%2Fnodegit%2Fnodegit.github.com%2Fissues%2Fnew%2Fchoose
jvilkhttps://redirect.github.com/jvilk
nodegit:masterhttps://redirect.github.com/nodegit/nodegit.github.com/tree/master
jvilk:masterhttps://redirect.github.com/jvilk/nodegit.github.com/tree/master
Conversation 23 https://redirect.github.com/nodegit/nodegit.github.com/pull/38
Commits 6 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits
Checks 0 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/checks
Files changed https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Please reload this pagehttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Auto-generate TypeScript Typings from Documentation https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#top
Show all changes 6 commits https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
3826813 Adding code to generate TypeScript declarations. Feb 8, 2016 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits/382681388507a116677d50311e98a195d0e54115
c3daad4 [TS decls] Include [EXPERIMENTAL] in descriptions where appropriate. Feb 8, 2016 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits/c3daad48ecfcb509f5b74da5c295d966e98e9575
acb7b6b [TS Decls] Fixing enums, preventing bad things from entering declarat… Feb 8, 2016 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits/acb7b6bf766f7bbe74413b776d111c8dfdd35bf8
d0bc904 Typings now compile in TypeScript! Feb 8, 2016 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits/d0bc904a9268c534fcaa5e7e337b7344cebef711
f687656 Properly mark optional parameters to functions. Feb 10, 2016 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits/f687656d42f15c385daca8e0c97b29a7c1c5a8b3
5d0e1c2 [TS Decl] Correctly handle optional parameters in the middle of the p… Feb 10, 2016 https://redirect.github.com/nodegit/nodegit.github.com/pull/38/commits/5d0e1c26fbde5002fa1a4dfadf75bc983bf2ef8e
Clear filters https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Please reload this pagehttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Please reload this pagehttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
index.js https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-420d4693d72a8640155e2ff99af32927a8a20d683c54a60eb4a4ae7d6e5e4f16
write_ts_declarations.js https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-7d53ff11470c999a69475c39ef78c697a056ec76fc9ac0b25a41c78bd68bf829
generate/index.jshttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-420d4693d72a8640155e2ff99af32927a8a20d683c54a60eb4a4ae7d6e5e4f16
View file https://redirect.github.com/nodegit/nodegit.github.com/blob/5d0e1c26fbde5002fa1a4dfadf75bc983bf2ef8e/generate/index.js
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://redirect.github.com/nodegit/nodegit.github.com/pull/38/{{ revealButtonHref }}
https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-420d4693d72a8640155e2ff99af32927a8a20d683c54a60eb4a4ae7d6e5e4f16
https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-420d4693d72a8640155e2ff99af32927a8a20d683c54a60eb4a4ae7d6e5e4f16
https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-420d4693d72a8640155e2ff99af32927a8a20d683c54a60eb4a4ae7d6e5e4f16
generate/lib/write_ts_declarations.jshttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#diff-7d53ff11470c999a69475c39ef78c697a056ec76fc9ac0b25a41c78bd68bf829
View file https://redirect.github.com/nodegit/nodegit.github.com/blob/5d0e1c26fbde5002fa1a4dfadf75bc983bf2ef8e/generate/lib/write_ts_declarations.js
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://redirect.github.com/nodegit/nodegit.github.com/pull/38/{{ revealButtonHref }}
tbranyenhttps://redirect.github.com/tbranyen
Apr 28, 2016https://redirect.github.com/nodegit/nodegit.github.com/pull/38/files#r61360589
Please reload this pagehttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
Learn morehttps://docs.github.com/articles/managing-disruptive-comments/#hiding-a-comment
Please reload this pagehttps://redirect.github.com/nodegit/nodegit.github.com/pull/38/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.