Skip to content
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.

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

Enable JavaScript code autocomplete using jsconfig.json #2354

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

colinrotherham
Copy link
Contributor

@colinrotherham colinrotherham commented Oct 5, 2023

For recent contributions I've been running with a jsconfig.json file

It's helped me find and fix a few things but there's no necessity to merge

Code autocomplete

This PR will automatically pick up JSDoc annotations in IntelliJ, WebStorm, Visual Studio, Visual Studio Code and Sublime Text (via the TypeScript plugin) so you can see tooltips like:

JSDoc types in autocomplete

Code checking

Optionally you can enable "checkJs": true when needed as a good way to spot bugs

  {
    "compilerOptions": {
+    "checkJs": true,
      "module": "NodeNext",
      "resolveJsonModule": true
    }
  }

@colinrotherham colinrotherham force-pushed the jsdoc-checks branch 2 times, most recently from cf40074 to bc86613 Compare October 11, 2023 11:19
lib/session.js Outdated Show resolved Hide resolved
Automatically picks up JSDoc annotations and works with IntelliJ, WebStorm, Visual Studio, Visual Studio Code, Sublime Text (via the TypeScript plugin)

1. Adds module `NodeNext` for Node.js 16+
2. Adds resolveJsonModule for JSON autocomplete
Base automatically changed from jsdoc to main March 8, 2024 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs review 🔍
Development

Successfully merging this pull request may close these issues.

1 participant