Skip to content

Create TypeScript declarations from JSDoc #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 10, 2020
Merged

Create TypeScript declarations from JSDoc #45

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0b6d49c
remove manual typings
tinovyatkin Jun 8, 2020
a910983
create typings from JSDoc
tinovyatkin Jun 8, 2020
dad79d0
fix param name
tinovyatkin Jun 8, 2020
e0deec8
add typings to gitignore
tinovyatkin Jun 8, 2020
f9142ea
specify TypeScript minimum version
tinovyatkin Jun 8, 2020
f5213ec
move typescript into devDependencies
tinovyatkin Jun 10, 2020
45c301d
Merge branch 'master' into typings-from-jsdoc
tinovyatkin Jun 10, 2020
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
create typings from JSDoc
  • Loading branch information
@tinovyatkin
tinovyatkin committed Jun 8, 2020
commit a9109830298272b2ab285de3a3cf8d678c5e2283
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"lint": "xo",
"test": "xo && ava",
"report": "nyc ava",
"coverage": "nyc --reporter json --reporter text ava && codecov -f coverage/coverage-final.json"
"coverage": "nyc --reporter json --reporter text ava && codecov -f coverage/coverage-final.json",
"prepublishOnly": "npx typescript --declaration --emitDeclarationOnly --allowJs index.js"
Copy link
Member

@LinusU LinusU Jun 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will use the globally installed version if there is one, or download the latest version. I think it would be better if we could pin a version by adding typescript to our devDependencies, and then referring to that one here:

Suggested change
"prepublishOnly": "npx typescript --declaration --emitDeclarationOnly --allowJs index.js"
"prepublishOnly": "tsc --declaration --emitDeclarationOnly --allowJs index.js"
Copy link
Member Author

@tinovyatkin tinovyatkin Jun 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can pin TypeScript version at npx: npx typescript@latest ... if a lower version on a published system is the concern? We need it only before publishing, so, not sure if it better to include and maintain TypeScript as a dependency...
},
"repository": "https://github.com/node-fetch/fetch-blob.git",
"keywords": [
Expand Down