💡 scaffold .vscode/settings.json with checkJS enabled when creating repository

[oscard0m]

.vscode/settings.json

{
  "js/ts.implicitProjectConfig.checkJs": true
}

Do you think it could be intereting for users? Maybe making it optional under a prompt({type: "confirm"})?

[gr2m]

How about we add

// @ts-check

to the first line of the script.js file (docs)? That will make it work for all editors that support it?

I also wonder if we should run the tsc --checkJs check with npx on CI, as part of the "test" step in test.yml? What do you think?

[oscard0m]

How about we add

// @ts-check

to the first line of the script.js file (docs)? That will make it work for all editors that support it?

I can give it a try but... this would leave responsibility to developers adding on each js file they create this comment and, with settings.json would be for every .js file by default right?

[gr2m]

I can give it a try but... this would leave responsibility to developers adding on each js file they create this comment and, with settings.json would be for every .js file by default right?

yes, but that way we don't force yet another file on people, and they can enable / disable it as they like. Also not everyone is using VS Code, I don't want to add editor-specific settings. The alternative would be to add jsconfig.json, but I think I would prefer to just adding the // @ts-check for now. I think most scripts will be a single file anyway

[oscard0m]

Yes, you are right:
settings.json would be Specific to VS Code and we don't want to be close to it so in case we need to scaffold a configuration, would be better to be .editorconfig (if they support the js check part) or jsconfig.json

---

Tried in script-renovate-setup and it works fine to me so... I would say to go for this solution for the moment.

[oscard0m]

If you like the solution, I would create an Octoherd script to add //ts-check to script.js for already existing files in the org

[gr2m]

Yes, let's add it to the npm init octoherd-script and create an @octoherd script that will add it to existing scripts that do not have it yet

[oscard0m]

Yes, let's add it to the npm init octoherd-script and create an @octoherd script that will add it to existing scripts that do not have it yet

Already scaffolded in #17
I would wait for a need to scaffold it for existing ones. When it really becomes a problem.

Should we close this issue? @gr2m

[gr2m]

yeah let's close 👍🏼