Fix lint precommit issue #1555
Fix lint precommit issue #1555
Conversation
Fix issue where vite config files were excluded from tsconfig, which would cause them to break on precommit when trying to lint them. This issue still persists in synapse-react-client, where a handful of files are intentionally not included in the tsconfig because they have type errors
This reverts commit d46a726.
nickgros
force-pushed
the
fix-eslint-precommit
branch
from
059073d to
9b4ab07
Compare
eslint.config.mjs
Outdated
| projectService: { | ||
| // We must enumerate each file that we want to lint that is not explicitly captured by a project-specific tsconfig | ||
| // allowDefaultProject does not allow `**` globs. | ||
| // https://github.com/typescript-eslint/typescript-eslint/issues/9739 | ||
| allowDefaultProject: allProjectDirs.map(dir => `${dir}/*.ts`) | ||
| }, |
There was a problem hiding this comment.
This fixes the issue -- any top-level .ts file will be linted against the top-level tsconfig.json
| @@ -1,22 +1,25 @@ | |||
| import { render, screen, waitFor, within } from '@testing-library/react' | |||
There was a problem hiding this comment.
Changed a bunch of tests and stories -- for all of them, I fixed type + lint errors and moved them inside of synapse-react-client/src.
Now synapse-react-client has no more non-linted/non type-checked tests + stories!
| const getDirectories = source => | ||
| readdirSync(source, { withFileTypes: true }) | ||
| .filter(dirent => dirent.isDirectory()) | ||
| .map(dirent => dirent.name) | ||
|
|
||
| // TODO: Use Nx API to retrieve project directories | ||
| const appDirs = getDirectories(`${import.meta.dirname}/apps`).map( | ||
| app => `apps/${app}`, | ||
| ) | ||
| const portalDirs = getDirectories(`${import.meta.dirname}/apps/portals`).map( | ||
| app => `apps/portals/${app}`, | ||
| ) | ||
| const packageDirs = getDirectories(`${import.meta.dirname}/packages`).map( | ||
| pkg => `packages/${pkg}`, | ||
| ) | ||
| const allProjectDirs = [...appDirs, ...portalDirs, ...packageDirs] |
There was a problem hiding this comment.
Nx has a really friendly command-line API but an unintuitive JavaScript API for building things that are not plugins. Using Nx would be the right way to do this but I couldn't figure it out.
apps/SageAccountWeb/tsconfig.json
Outdated
| "baseUrl": "src", | ||
| "rootDir": "src", | ||
| "lib": ["dom", "dom.iterable", "esnext"], |
There was a problem hiding this comment.
Update rootDir to src to match other projects
| resetMocks: false, | ||
| }, | ||
| ], | ||
| reporters: [ | ||
| '<rootDir>/test/testutils/LogForFailedTestsOnlyReporter.ts', | ||
| '<rootDir>/src/testutils/LogForFailedTestsOnlyReporter.cjs', |
There was a problem hiding this comment.
This was always a CommonJS file (it used require and had no type annotations). Jest has not been configured to transform this file, so the extension was updated to denote that it is in fact a CommonJS file.
| @@ -0,0 +1,39 @@ | |||
| import { render } from '@testing-library/react' | |||
There was a problem hiding this comment.
Moved file and fixed type/lint issues, test logic itself is not new
| // allowDefaultProject does not allow `**` globs. | ||
| // https://github.com/typescript-eslint/typescript-eslint/issues/9739 | ||
| allowDefaultProject: [ | ||
| ...allProjectDirs.map(dir => `${dir}/*.ts`), |
There was a problem hiding this comment.
You don't need this entry?
...allProjectDirs.map(dir => ${dir}/*.tsx)
There was a problem hiding this comment.
I don't think we have any top-level tsx files. So we shouldn't need it for now
Fix issue where vite config files were excluded from tsconfig, which would cause them to break on precommit when trying to lint them.
This issue still persists in synapse-react-client, where a handful of files are intentionally not included in the tsconfig because they have type errors