Enable "per project" configuration on VSCode (multi-root workspace)

[gian1200]

In the docs (https://github.com/htmlhint/vscode-htmlhint/tree/main/htmlhint#settings), it is mentioned that one can change settings in VSCode on different levels:

• Globally (user settings)
• Workspace

However, it is currently not possible to define it at project level (Folder settings) --> .vscode/settings.json file inside a project

It'd be a nice addition.

[coliff]

This is already supported.. you can copy the rules and settings to .vscode/settings.json

e.g.

[gian1200]

Oh, I noticed that the settings weren't being detected (grayed out and no suggestions), and docs didn't mention them. That's why I thought they weren't supported

Update:

Do they work in multi root workspace, too?

Update 2:

Could this help? microsoft/vscode#115482 (comment)

"scope": "resource", from https://code.visualstudio.com/api/references/contribution-points

I guess it should be added here:

vscode-htmlhint/htmlhint/package.json

Lines 43 to 76 in 826994c

	"configuration": {
	"type": "object",
	"title": "HTMLHint",
	"properties": {
	"htmlhint.enable": {
	"type": "boolean",
	"default": true,
	"description": "Control whether HTMLHint is enabled for HTML files or not."
	},
	"htmlhint.documentSelector": {
	"type": "array",
	"default": [
	"html",
	"htm"
	],
	"description": "The associated document types to be linted."
	},
	"htmlhint.options": {
	"type": "object",
	"default": {},
	"description": "The HTMLHint options object to provide args to the HTMLHint command."
	},
	"htmlhint.optionsFile": {
	"type": "string",
	"default": null,
	"description": "The HTMLHint options config file path."
	},
	"htmlhint.ignoreGitignore": {
	"type": "boolean",
	"default": false,
	"description": "Skip linting files that are ignored by .gitignore. This is useful to avoid linting generated files, dependencies, and other files that shouldn't be checked."
	}
	}
	},

[coliff]

I spent some time looking into this and couldn't figure it out. I don't use this feature and was unable to get it working. I guess you want a subfolder to a have a .vscode/settings.json with HTMLHint options in there and VS Code would automatically use those settings on the folder. If you could open a PR with the fix - or explain it more that'd be great :-)

[gian1200]

Not "necessarily" a subfolder. I have a VSCode workspace with multiple projects (added with "Add Folder with Workspace" VSCode feature) --> A multi-root workspace.

I thought that just adding "scope": "resource" to each option on that section of the code (like in the docs) was enough. Something like this:

 "configuration": {
   "type": "object",
   "title": "HTMLHint",
   "properties": { 
     "htmlhint.enable": { 
       "type": "boolean", 
       "default": true, 
       "scope": "resource", <-- THIS new line
       "description": "Control whether HTMLHint is enabled for HTML files or not." 
     }, 
     "htmlhint.documentSelector": { 
       "type": "array", 
       "default": [ 
         "html", 
         "htm" 
       ], 
       "scope": "resource", <-- THIS new line
       "description": "The associated document types to be linted." 
     }, 
     "htmlhint.options": { 
       "type": "object", 
       "default": {},
       "scope": "resource", <-- THIS new line
       "description": "The HTMLHint options object to provide args to the HTMLHint command." 
     }, 
     "htmlhint.optionsFile": { 
       "type": "string", 
       "default": null, 
       "scope": "resource", <-- THIS new line
       "description": "The HTMLHint options config file path." 
     }, 
     "htmlhint.ignoreGitignore": { 
       "type": "boolean", 
       "default": false, 
       "scope": "resource", <-- THIS new line
       "description": "Skip linting files that are ignored by .gitignore. This is useful to avoid linting generated files, dependencies, and other files that shouldn't be checked." 
     } 
   } 
}

---

I can do the PR, but I'm not sure how to test it locally. Haven't locally compiled a VSCode extension before.

I'll need some time to do a proper PR (with tests, docs and everything).

Reading the README, I need to

• Install https://github.com/microsoft/vscode-vsce
• Do my changes
• Run npm install on both folders,
• Run npm run compile on both folders
• Run vsce package
• Uninstall the official extension
• Install the extension using the generated VSIX

Right?

[coliff]

thanks for the quick reply. yes, those steps are technically correct... but you can actually do it from the root now... you can do npm run compile and npm run package from root to compile both folders.

I did try the above as you suggested (adding "scope": "resource",) but I was unsure how to test. I added a .vscode/settings subfolder with HTMLHint settings in but it didn't seem to pick them up.

[gian1200]

Ok, tested it and it failed. It is not able to read the configuration on multi-root- workspace. When doing it individually, it works.

Found this guide: https://github.com/microsoft/vscode-wiki/blob/main/Adopting-Multi-Root-Workspace-APIs.md. Specifically:

• https://github.com/microsoft/vscode-wiki/blob/main/Adopting-Multi-Root-Workspace-APIs.md#do-i-need-to-do-anything
• https://github.com/microsoft/vscode-wiki/blob/main/Adopting-Multi-Root-Workspace-APIs.md#language-client--language-server

Looks like one of the reasons is (not the only one):

Will pause now and will try to continue reading and testing in the next days.

PS: I also found some minor inconsistencies and improvements in the code, but they are not related to this

[coliff]

thanks for spotting that. Cursor says:

Looking at the error, rootPath is deprecated in the Language Server Protocol. The modern approach is to use workspaceFolders instead.

change:
let rootFolder = params.rootPath;
to:
let rootFolder = params.workspaceFolders?.[0]?.uri ? URI.parse(params.workspaceFolders[0].uri).fsPath : undefined;

The fix replaces the deprecated params.rootPath with params.workspaceFolders?.[0]?.uri and converts it to a filesystem path using the existing URI.parse() utility. This resolves the deprecation warning while maintaining the same functionality.