tomaszs / hintly

Boost your development by providing custom tips displayed in the code in Visual Studio Code

Hi 👋, I'm Tom Smykowski

• 🔭 I’m currently working on Hinty

• 👯 And also Summon The JSON

• 🤝 I’m writing about software enginneering on Medium

• 👨‍💻 My official page is https://tomasz-smykowski.com/

• 📫 You can reach me at [email protected]

Blogs posts

• ‍ Are HTML’s Self-Closing Tags Discouraged?
• Node Modules Now Faster On Windows With Dev Drive
• James Gosling, Founder Of Java Is Retiring
• ️ VSCode Macros Saved Me From 1000s Of Seconds Of Misery

Connect with me:

Languages and Tools:

 

hintly's Issues

Handle multiple lines

eg.

Select column1,
column2,
column3
From tablename

Hinty for VSCode stopped working

Now when the regex rule is improperly formatted, the whole extension stops to work.

Workaround

To see what happens you have to go to CTRL+SHIFT+P -> Show Log -> Extension Host, fix the rule and restart VSCode to enable Assistant again

Minimal plan

• catch errors on a rule level, so that whole Hinty won't crash

Maximum plan

• show the error as a hint above the rule in settings.json or defaultSettings.json or workspace settings.

A way to read configuration from file

Sometimes it may be better to store configuration in a separate file, not in workspace or user profile settings. So there might be a need to store it in a separate file

Writing rules made easier

Currently rules can be written with RegEx. But sometimes all you need is a simple rules, and don't want to worry to escape all special characters used by RegEx.

So there should be away to add simple rules as text as it is, and also with asterix sign.

Define files to which the rule applies (eg. *.js, *.scss etc.)

A way to include Assistant linting in ng run start and ng run lint and ng run build

A way to automatically fix errors

It may be fully automated or semi automated feature (executed from CTRL+.). But there might be this feature available for users who dare to use automatic way of code handling ;)

Add licence

Prepend the message with "Assistant"

Currently it is confusing what extension shows messages inside Visual Studio Code. So the idea is to prepend the message from Assistant with "Assistant: ", so that the user will know what extension shows him the hint

Implementation for other IDE's

There was question about other IDE's like WebStorm

A command to execute all rules on all files in the project

1. You call a command
2. In console or somewhere there is a list of all places in the project that trigger rules with information what rules
3. You can go directly to that place with a single click

code review

src/CodelensProvider.ts

line 33, 40 : Why create a regex from an already created regex (line 23)

line 34: how likely is it that the text of the document changes while processing the regexes

line 37,38,39: document.positionAt() already gives you a complete Position

let position = document.positionAt(matches.index);

How do I enter a regex with the flag i

It is possible in package.json to specify the allowed format of the configuration, allowed field names and types.

code review

src/CodelensProvider.ts

see my comments to 7e340d5

If multiple files relate to the same issue commit them together, source files, package,json, README.md, ...

Integration with ESLint (etc.?)

There are two possible ways of integration:

1. Assistant gets ESLint messages and shows them to the user as lenses in the place where they occur

Maybe it should be a separate extension?

2. Assistant generates ESLint rules based on his rules. So that rules can be integrated into CI\CD

Or maybe we could go with a method to execute Assistant rules side by side with ESLint, something like ng run assistant ?

A way to read configurations from node modules

Every node module could come with Assistant rules. So there could be a way to read rules from node modules installed. If a node module contains such rules, it may be helpful to show it to the project developer

Updates of Readme

A small update of README.md

Each rule should contain:
* regex - a string with a regex rule
* message - text that should be displayed when the rule is triggered

Example workspace configuration:

```
{
    .....
    "settings": {
        "assistant": {
            "rules": [
                {
                    "regex": "@Input\\\\(\\\\) .*: false;",
                    "message": "Define property value with =, not with:"
                }
            ]
        }
    },
    .....
}
```