GitHub - futurGH/ts-to-jsdoc: Transpile TypeScript code to fully compatible JavaScript + JSDoc comments.You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
ESLint を使ã£ã¦ JSDoc / TSDoc ã®è¨˜è¿°ã‚’å¿…é ˆåŒ–ã™ã‚‹
ã“ã‚Œã¯ãªã« コードベースã«å¯¾ã— JSDoc ã®è¨˜è¿°ã‚’å¿…é ˆåŒ–ã™ã‚‹ãŸã‚ã® ESLint è¨å®šæ‰‹é †ã‚’ã¾ã¨ã‚ãŸã‚‚ã®ã§ã™ã€‚ JSDoc を始ã‚ã¨ã™ã‚‹ Doc コメントã¯ã‚³ãƒ¼ãƒ‰ã«æœ€ã‚‚è¿‘ã„ドã‚ュメントã§ã‚ã‚Šã€ã“ã‚ŒãŒã‚ã‚‹ã®ã¨ç„¡ã„ã®ã¨ã§ã¯ã‚³ãƒ¼ãƒ‰ãƒ™ãƒ¼ã‚¹ã®ä¿å®ˆæ€§ã«å¤©ã¨åœ°ã»ã©ã®å·®ãŒç”Ÿã¾ã‚Œã¾ã™ã€‚ãん㪠JSDoc ã§ã™ãŒã€OSS ãªã‚‰ã¨ã‚‚ã‹ã（内製・å—託をå•ã‚ãšï¼‰å•†æ¥ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢é–‹ç™ºã®ç¾å ´ã§ã¯è»½è¦–ã•ã‚ŒãŒã¡ã§ã™ã€‚後ã‹ã‚‰ã‚³ãƒ¼ãƒ‡ã‚£ãƒ³ã‚°è¦ç´„を定ã‚ãŸã¨ã“ã‚ã§é–‹ç™ºãƒ¡ãƒ³ãƒãƒ¼ã«ãƒ‰ã‚ュメントを書ãç¿’æ…£ãŒå‚™ã‚ã£ã¦ã„ãªã‘ã‚Œã°æ›¸ãæ¼ã‚ŒãŒé »ç™ºã™ã‚‹ã®ãŒé–¢ã®å±±ã§ã™ã€‚ コードレビューã§éƒ½åº¦æŒ‡æ‘˜ã™ã‚‹ã«ã¯ã‚ã¾ã‚Šã«ã‚³ã‚¹ãƒˆãŒã‹ã‹ã‚‹ãŸã‚ã€ESLint ã«å§”ãã‚‹ã®ãŒæœ›ã¾ã—ã„ã§ã™ã€‚ å‰æ フレームワーク㯠React（or Next.js）を使ã£ã¦ã„る。 TypeScript を主体ã¨ã—ã¦ã„る。 ビルドスクリプトやè¨å®šãƒ•ã‚¡ã‚¤ãƒ«ã¯ JavaScript も併用ã—
TypeScriptã®JSDocサãƒãƒ¼ãƒˆã§ã§ãã‚‹ã“ã¨ã€ã§ããªã„ã“ã¨
TypeScriptã®ä¸»è¦ãªå…¥åŠ›ãƒ•ã‚¡ã‚¤ãƒ«ã¯ .ts, .tsx, .mts, .cts ã§ã™ãŒã€JavaScriptファイル (.js, .jsx, .mjs, .cjs) ã‚‚èªã¿è¾¼ã‚“ã§å‡¦ç†ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚JSDocã«ã‚ˆã‚‹åž‹ã‚¢ãƒŽãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã‚’èªè˜ã™ã‚‹ãŸã‚ã€ç”Ÿã®JavaScriptã§ã‚‚ãã‚Œãªã‚Šã«åž‹ã‚’ã¤ã‘ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ 本稿ã§ã¯ã‚¿ã‚¤ãƒˆãƒ«é€šã‚Šã€TypeScriptã®JSDocサãƒãƒ¼ãƒˆã§ã§ãã‚‹ã“ã¨ã¨ã§ããªã„ã“㨠(.ts ã§ã—ã‹ã§ããªã„ã“ã¨) ã‚’ã¾ã¨ã‚ã¾ã™ã€‚ ãŠã“ã¨ã‚ã‚Š 本記事ã¯TypeScript 4.4時点ã§ã®å®Ÿè£…状æ³ã«åŸºã¥ã„ã¦ã„ã¾ã™ã€‚ãªã‚‹ã¹ãソースコードä¸ã®é–¢ä¿‚ã™ã‚‹ç®‡æ‰€ã‚’å‚ç…§ã™ã‚‹ã‚ˆã†ã«ã—ãŸã®ã§ã€ä»Šå¾Œã®å¤‰æ›´ã¯ã”自分ã§æ¤œè¨¼ã—ã¦ãã ã•ã„。 (TypeScript Playgroundã§è©¦ã™ã ã‘ã§ã‚‚有用ã§ã™ JavaScriptモードã§é–‹å§‹ã§ãるリンク) JSDocã®æ©Ÿèƒ½ä¸€è¦§ãƒ»TypeScri
ã‚‚ã†TypeScriptã®è£œåŠ©è¼ªã‚’外ãㆠ明日ã¯//@ts-checkを使ã†
※近所（åŒã˜æ¸¯åŒºå†…）ã®ã‚ã®ITä¼æ¥ã•ã‚“ã‹ã‚‰ãŠå£°ã‚’ã‹ã‘ã¦ã„ãŸã ãã¾ã—ãŸã€‚登壇予定ã§ã™ã€‚ ※æŸå•†æ¥èªŒã•ã‚“ã‹ã‚‰åŸ·ç†ä¾é ¼ãŒã‚ã‚Šã¾ã—ãŸãŒã€æœ‰æ–™ã§ã™ã¨æ°—ãŒå¼•ã‘ã‚‹ã®ã§ãŠæ–ã‚Šã—ã¾ã—ãŸã€‚ Vimã§æ›¸ã„ã¦ã„る人ã¯ã‚‚ã†ã„ãªã„ã‹ã‚‰ã€ãã‚ãã‚TypeScript（自転車ã®è£œåŠ©è¼ªï¼‰ã‚’外ã—ã¦ã„ã“ã†ã¨ã„ã†è©±ã€‚ Visual Studio Code ã¯ä¸‹ã®ãƒªãƒ³ã‚¯ã‹ã‚‰ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã§ãる。ã“ã‚ŒãŒå‰æ。 VS Code 㧠// @ts-check ãŒåˆ©ç”¨ã§ãる。 ※Denoã®è©±ã‚’知らãªã„人ã¯ã€ã“れをèªã‚€ã¨è‰¯ã„。 DenoãŒTypeScriptã®ä½¿ç”¨ã‚’ã‚„ã‚ã‚‹5ã¤ã®ç†ç”± （Denoã¯ã€Node.jsã®ä½œè€…ã§ã‚るライアン・ダールã«ã‚ˆã£ã¦ä½œæˆã•ã‚Œã€V8 JavaScriptエンジンåŠã³Rustプãƒã‚°ãƒ©ãƒŸãƒ³ã‚°è¨€èªžã«åŸºã¥ã„ãŸã€JavaScriptåŠã³TypeScriptã®ãƒ©ãƒ³ã‚¿ã‚¤ãƒ 環境ã§ã‚る。セã‚ュリティã¨ç”Ÿç”£æ€§ã«ç„¦ç‚¹ã‚’当ã¦ã¦ã„る） ※T
JSDocã§åž‹ã‚’定義ã—ã¦TypeScriptã®æ©æµã‚’å—ã‘ã‚‹
普段ã‹ã‚‰ TypeScript ã§é–‹ç™ºã•ã‚Œã¦ã„ã‚‹ã»ã†ãªã‚‰ã°ã€TypeScript ã®æ©æµã‚’å分ã«å ªèƒ½ã•ã‚Œã¦ã„ã‚‹ã“ã¨ã¨æ€ã„ã¾ã™ã€‚ 特ã«ç§ã¯ VS Code ã®ã‚¤ãƒ³ãƒ†ãƒªã‚»ãƒ³ã‚¹ã«ã¯é ¼ã‚Šã£ã±ãªã—ã§ã“ã‚ŒãŒãªã‘ã‚Œã°ã¾ã¨ã‚‚ã«ã‚³ãƒ¼ãƒ‡ã‚£ãƒ³ã‚°ãŒã§ããªã„体ã«ãªã£ã¦ã—ã¾ã„ã¾ã—ãŸã€‚ ã—ã‹ã—時ã«ã¯ã€TypeScript ã¨ã„ã†æ¦‚念ãŒå˜åœ¨ã—ãªã„退屈ãªä¸–ç•Œã§é–‹ç™ºã‚’è¡Œã‚ãªã‘らã°ãªã‚‰ãªã„状æ³ã¯ã‚ã‚‹ã§ã—ょã†ã€‚ç§ã¯ã‚‚ã¯ã‚„ã‚ーボードã§ã‚¿ã‚¤ãƒ”ングã™ã‚‹ã“ã¨ã™ã‚‰ã¾ã¾ãªã‚Šã¾ã›ã‚“。 ãん㪠JavaScript ã—ã‹åˆ©ç”¨ã§ããªã„状æ³ã§ä»£æ›¿æ‰‹æ®µã¨ãªã‚‹ã®ãŒã€JSDoc ã§ã™ã€‚JSDoc ã®ã‚¢ãƒŽãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã«ã‚ˆã£ã¦åž‹ã‚’付与ã™ã‚‹ã“ã¨ã«ã‚ˆã£ã¦æœ€ä½Žé™ã®æ”¯æ´ã‚’å—ã‘ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ @Type @Type タグを使用ã™ã‚‹ã¨ã€TypeScript ã§åž‹ã‚’ã¤ã‘ã‚‹ã¨ãã¨åŒã˜ã‚ˆã†ã«åž‹ã‚’宣言ã§ãã¾ã™ã€‚
ã„ã‚ã„ã‚㪠.config.js ã§åž‹ã®è£œå®Œã‚’効ã‹ã›ã‚‹æ–¹æ³•ã¾ã¨ã‚
ã„ã‚ã„ã‚㪠JavaScript 系ライブラリã®è¨å®šãƒ•ã‚¡ã‚¤ãƒ«ã§åž‹ã®è£œå®ŒãŒåŠ¹ãよã†ã«ã™ã‚‹ãŸã‚ã® JSDoc アノテーションã¾ã¨ã‚ã§ã™ã€‚VSCode ã§ç¢ºèªã—ã¦ã„ã¾ã™ã€‚ リンクã®ã¤ã„ã¦ã„ãªã„ã‚‚ã®ã¯è‡ªåˆ†ã§åž‹å®šç¾©ã‚’探ã—ãŸã‚‚ã®ãªã®ã§é–“é•ã£ã¦ã„ã‚‹å ´åˆã¯ã‚³ãƒ¡ãƒ³ãƒˆã„ãŸã ã‘ã‚‹ã¨åŠ©ã‹ã‚Šã¾ã™ã€‚ ä»–ã®ãƒ©ã‚¤ãƒ–ラリã®æƒ…å ±ã‚‚ã‚³ãƒ¡ãƒ³ãƒˆå¤§æ“è¿Žã§ã™ï¼
GitHub - geut/jsdast: JSDoc Abstract Syntax Tree
const unified = require('unified') const { parser } = require('@geut/jsdast') const tree = unified().use(parser).parse(` /** * @param {number} a * @param {number} b * @returns {number} */ function sum(a, b) { return a + b } `) console.log(JSON.stringify(tree, null, 2)) /* { "type": "Root", "children": [ { "type": "Module", "name": "Index", "doc": { "description": "", "tags": [] }, "children": [ {
Type Safe JavaScript with JSDoc
Generally developers believe that you need TypeScript or Flow if you want type safety for JavaScript. This article we will explore a third alternative to achieve those same goals using just JSDoc comments and Visual Studio Code as your editor. Technically, we are going to use TypeScript but not for compiling our code. Instead we’ll use it to check the types of our JavaScript code during code time
ESLint ã®çµ„ã¿è¾¼ã¿ JSDoc サãƒãƒ¼ãƒˆãŒçµ‚了ã—ã¾ã™ - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? ã“ã®è¨˜äº‹ã¯å…¬å¼ã‚¢ãƒŠã‚¦ãƒ³ã‚¹ "End-of-Life for Built-in JSDoc Support in ESLint" ã®ç¿»è¨³ã§ã™ã€‚ ã“ã“数年㧠ESLint プãƒã‚¸ã‚§ã‚¯ãƒˆã®ã‚µã‚¤ã‚ºã¨ã‚¹ã‚³ãƒ¼ãƒ—ã¯å¢—大ã—ã¾ã—ãŸã€‚ã‚‚ã¨ã‚‚ã¨ã¯å˜ä¸€ã®å®Ÿè¡Œå¯èƒ½ãƒ‘ッケージã§æ§‹æˆã•ã‚Œã¦ã„ã¾ã—ãŸãŒã€ä»Šã‚„複数ã®ãƒ‘ーサーやユーティリティをå«ã‚€å¤šæ•°ã®ãƒ‘ッケージã‹ã‚‰æ§‹æˆã•ã‚Œã‚‹ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã¸æˆé•·ã—ã¾ã—ãŸã€‚プãƒã‚¸ã‚§ã‚¯ãƒˆã¯æˆé•·ã—ã¾ã—ãŸãŒé–‹ç™ºãƒãƒ¼ãƒ ã®è¦æ¨¡ã¯ãã‚Œã»ã©å¤§ãããªãã€å…¨å“¡ãŒãƒœãƒ©ãƒ³ãƒ†ã‚£ã‚¢ã§ã‚る開発ãƒãƒ¼ãƒ ãŒã“ã®ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã‚’メンテナンスã—ã¦ã„ããŸã‚ã«ã€åŽ³ã—ã„決定を下ã™å¿…è¦ãŒã‚
メンテナンス
ランã‚ング
ãŠçŸ¥ã‚‰ã›
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
GitHub - jsdoc-type-pratt-parser/jsdoc-type-pratt-parser: A pratt parser for jsdoc types
GitHub - es-joy/jsdoccomment
Release v16.1.1 · gajus/eslint-plugin-jsdoc
GitHub - jsdoctypeparser/jsdoctypeparser: Parser module for JsDoc or Closure Compiler format type-annotation.
v10.3.0-11.2.0 are broken due to missing dependency escape-regex-string · Issue #314 · gajus/eslint-plugin-jsdoc
Template tag allows specification of constraints by sandersn · Pull Request #24600 · microsoft/TypeScript
Parentheses for closure compiler type casting not handled well · Issue #4124 · prettier/prettier
JavaScript: fix edge cases in type cast comment detection regex by yangsu · Pull Request #5793 · prettier/prettier
"require-returns" requires useless return statements for return type "undefined" · Issue #142 · gajus/eslint-plugin-jsdoc
TSDoc Playground
Only functions can be constructor functions by sandersn · Pull Request #27369 · microsoft/TypeScript
{{#tags}}- {{label}}
{{/tags}}