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

Update Development instructions #149

Closed
sparks-alec opened this issue Sep 9, 2024 · 1 comment
Closed

Update Development instructions #149

sparks-alec opened this issue Sep 9, 2024 · 1 comment

Comments

@sparks-alec
Copy link

Working on #138 on a fork and struggling to get my development environment set up correctly. Currently on macOS Apple Silicon.

These are the places where readme.md seems to be outdated:

  • Use Node 20 as v1.9.0 calls
  • Rebuild using yarn rebuild not yarn electron-rebuild
  • Run using yarn dev:electron not yarn dev-electron

Additionally, many files I have not touched will not lint. It's unclear to me which files are supposed to lint and which ones are not- this error from VS Code suggests a mismatch between ESLint config and TS config. My ESLint plugin is v3.0.10.

Parsing error: ESLint was configured to run on `<tsconfigRootDir>/satellite/src/client.ts` using `parserOptions.project`: <tsconfigRootDir>/tsconfig.json
However, that TSConfig does not include this file. Either:
- Change ESLint's list of included files to not include this file
- Change that TSConfig to include this file
- Create a new TSConfig that includes this file and include it in your parserOptions.project
See the typescript-eslint docs for more info: https://typescript-eslint.io/troubleshooting/typed-linting#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file

Is there any other setup steps necessary? Plugins or local settings to apply? I have totally wiped my VS Code plugin settings so I do not think my local configuration is the issue.

@Julusian
Copy link
Member

I have updated the readme with those suggestions.

I didn't notice those eslint errors because my vscode hadn't updated itself since installing back in february 🤦 , and was too old for the plugin to work.
But the real 'error' was that the vscode plugin does not automatically understand mono-repos, and was getting confused when not finding an eslint config at the root of the repository. I've added that config now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants