I'm doing maintenance in a legacy project and there's many functions lacking JSDoc comments.
I'm wondering if is it possible to make the inspector of WebStorm show me an error if some JSDoc is missing for some function?
There are no such inspections in WebStorm; but you can use ESLint - it has rules for JSDoc checking - see http://eslint.org/docs/rules/require-jsdoc
See https://www.jetbrains.com/help/webstorm/2017.1/javascript-code-quality-tools.html#ESLint for details on using ESLint with WebStorm
Related
I'm using Eclipse Neon with C++ developer tools installed. Normally I work on Visual Studio + Visual Assist Plugin. Visual Assist has a feature called snippets, which I use to bind a shortcut key to "document a method", which essentially just applies a documentation header template to the top of the function I had selected. Example:
void MyTestFunction();
No documentation block on this. I can put my caret on MyTestFunction and execute my shortcut key, and it will insert a documentation block above it (I define this myself):
///////////////////////////////////////////////////////////////////////////////
///
///////////////////////////////////////////////////////////////////////////////
void MyTestFunction();
I can then fill in documentation using doxygen-style syntax.
I have read a few posts on SO and elsewhere on templates, enabling doxygen support, etc. But I have yet to find something that will allow me to use a shortcut key to add documentation like this OR some type of auto-complete behavior like inserting 3 slashes (///) and pressing ENTER to insert the block above.
Can someone help me figure out a way to do this in Eclipse in a way that is similar to the Visual Studio + Visual Assist method?
There are lots of Doxygen setup manuals for Eclipse.
You can refer to this manual: Doxygen+Graphviz setup in Eclipse
Briefly your steps are:
Install Eclipse plugin: Eclox
Activate Doxygen documentation tool here: Window->Preferences->C/C++->Editor->Documentation tool (you may have to activate advanced view of Eclipse preferences)
After that you can type /** above any function and hit Enter
I have some rules in my tslint.json that require the --type-check functionality. WebStorm doesn't give me a way to add the command-line argument and to the TSLint plugin. It also doesn't give me a way to enable it from the GUI.
As a result TSLint crashes and the TSLint plugin reports an error and I can't see the inspections.
It works when I run TSLint from the command-line with the --type-check argument, but I need the inspections in the IDE.
Does anyone have a workaround for this situation?
As of WebStorm 2017.2, this is now possible using a TypeScript language service plugin. You can install https://github.com/angelozerr/tslint-language-service and then add it to your tsconfig.json (see the instructions in the README), and it will make TSLint errors show up alongside normal TypeScript errors. You can then disable the built-in TSLint integration in WebStorm.
More background is in the relevant WebStorm issue: https://youtrack.jetbrains.com/issue/WEB-22778
I added an ESLint file to my project and now I have like 1,000 "warnings" and red lines in my code. Is there a way to configure webstorm to use ESLint file to refactor my code using that lint file?
There's no way that I know of to get Webstorm to automatically fix the warnings just from your eslint configuration.
You could configure Webstorm's formatting rules to fix issues related to indentation, but that's be about it...
ESLint has recently introduced a way to automatically fix some rules, but it's of course not exhaustive.
This is a rather easy matter in IntelliJ (and setting up PEP8 in PyCharm), but I have been googling and I couldn't find a configuration file (I presume in XML or whatever CLion uses) that I could use to configure it to adhere to the Google style guide.
Is this a "future feature" or am I missing something fundamental?
Of course, I can configure it manually, but it's a tedious and time-consuming operation; if someone has already done that, awesome and thanks for sharing!
CLion now supports this natively, as of v1.1. A blog post from JetBrains shows how to use pre-defined code styles here. Download the latest version of CLion here.
Go to Setting/Preferences | Editor | Code Style | C/C++ then click the button "Set from..." in the top right and select "Google."
You can try cpp-lint plugin. Code style support coming soon!
Whenever I try to add a new template or edit an existing one, the template editor window is not opened in Visual Studio and nothing happens.
This happens either for live templates, file templates and surround templates.
The export / import functionality works.
It's a knonw issue here: http://youtrack.jetbrains.com/issue/RSRP-329433.
The cause of this is, usually, a TeamCity plugin installed in the VS. Please try to remove all other JetrBrains addins, run 'Repair' on ReSharper after that and check if it helps.