183dc40916
# Introduction
Lately encountering a lot of out of memory error when running
twenty-front in watch mode with both TypeScript and lint checkers
```ts
Error: Worker terminated due to reaching memory limit: JS heap out of memory
at new NodeError (node:internal/errors:405:5)
at [kOnExit] (node:internal/worker:287:26)
at Worker.<computed>.onexit (node:internal/worker:209:20)
```
The existing configuration looks like this:
```ts
// packages/twenty-front/vite.config.ts
'cd ../.. && eslint packages/twenty-front --report-unused-disable-directives --max-warnings 0 --config .eslintrc.cjs',
```
This is wrong as computing the root eslintrc completely omitting
twenty-front's one ***and its ignorePattern*** so will be checking in
`node_modules` etc checking for project-structure :).
For example this a
[snippet](https://gist.github.com/prastoin/d7f8ad4ef5eb2f7732209b756a38094c)
of the above commands errors. We can see rule that should be disabled by
`eslintrc.react.cjs` extension made from twenty-front `eslintrc` :
```ts
/Users/paulrastoin/ws/twenty-two/packages/twenty-front/src/modules/settings/data-model/fields/forms/components/__stories__/SettingsDataModelFieldSettingsFormCard.stories.tsx
23:27 warning Forbidden non-null assertion @typescript-eslint/no-non-null-assertion
```
## Fixes
- consume the `twenty-front` package eslint configuration within the
vite lint checker
- eslint overrides extends are getting merged based on glob inclusion of
their files declarations
- any linted files should be included in one of our `tsconfig`
- removed redundant and counter-productive negative `ignorePatterns`, as
eslint will naturally only lint files within configuration file
directory by default which will result making it go through local
`node_modules` project structure
## Now
Less cpu usage <3.5 gb and faster
```ts
// from packages/twenty-front
TIMING=1 npx eslint . --report-unused-disable-directives --max-warnings 0 --config .eslintrc.cjs --debug
#...
Rule | Time (ms) | Relative
:-----------------------------------------------|----------:|--------:
project-structure/folder-structure | 19578.927 | 20.2%
prettier/prettier | 13746.156 | 14.2%
no-redeclare | 9546.570 | 9.9%
@nx/workspace-explicit-boolean-predicates-in-if | 8167.805 | 8.4%
@typescript-eslint/no-unused-vars | 6872.803 | 7.1%
import/no-relative-packages | 6577.273 | 6.8%
@nx/enforce-module-boundaries | 6520.945 | 6.7%
import/no-duplicates | 4987.476 | 5.2%
react/no-direct-mutation-state | 2323.082 | 2.4%
react/require-render-return | 1155.261 | 1.2%
```
## Conclusion
Please note that `nx linter` might not be as strict as vite config
eslint runner
---------
Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com>
109 lines
3.1 KiB
JavaScript
109 lines
3.1 KiB
JavaScript
module.exports = {
|
|
plugins: ['@stylistic'],
|
|
extends: ['../../.eslintrc.global.cjs'],
|
|
ignorePatterns: [
|
|
'src/engine/workspace-manager/demo-objects-prefill-data/**',
|
|
'src/engine/seeder/data-seeds/**',
|
|
'src/engine/seeder/metadata-seeds/**',
|
|
'src/engine/core-modules/serverless/drivers/constants/base-typescript-project/src/index.ts',
|
|
],
|
|
overrides: [
|
|
{
|
|
files: ['**/*.ts'],
|
|
parserOptions: {
|
|
project: ['packages/twenty-server/tsconfig.json'],
|
|
},
|
|
rules: {
|
|
'no-restricted-imports': [
|
|
'error',
|
|
{
|
|
patterns: [
|
|
{
|
|
group: ['**../'],
|
|
message: 'Relative imports are not allowed.',
|
|
},
|
|
{
|
|
group: ['lodash'],
|
|
message:
|
|
"Please use the standalone lodash package (for instance: `import groupBy from 'lodash.groupby'` instead of `import { groupBy } from 'lodash'`)",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
|
|
'@stylistic/linebreak-style': ['error', 'unix'],
|
|
'@stylistic/lines-between-class-members': [
|
|
'error',
|
|
{
|
|
enforce: [{ blankLine: 'always', prev: 'method', next: 'method' }],
|
|
},
|
|
],
|
|
'@stylistic/padding-line-between-statements': [
|
|
'error',
|
|
{ blankLine: 'always', prev: '*', next: 'return' },
|
|
{ blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
|
|
{
|
|
blankLine: 'any',
|
|
prev: ['const', 'let', 'var'],
|
|
next: ['const', 'let', 'var'],
|
|
},
|
|
{ blankLine: 'always', prev: '*', next: ['interface', 'type'] },
|
|
],
|
|
|
|
'import/order': [
|
|
'error',
|
|
{
|
|
'newlines-between': 'always',
|
|
groups: [
|
|
'builtin',
|
|
'external',
|
|
'internal',
|
|
'type',
|
|
'parent',
|
|
'sibling',
|
|
'object',
|
|
'index',
|
|
],
|
|
pathGroups: [
|
|
{
|
|
pattern: '@nestjs/**',
|
|
group: 'builtin',
|
|
position: 'before',
|
|
},
|
|
{
|
|
pattern: '**/interfaces/**',
|
|
group: 'type',
|
|
position: 'before',
|
|
},
|
|
{
|
|
pattern: 'src/**',
|
|
group: 'parent',
|
|
position: 'before',
|
|
},
|
|
{
|
|
pattern: './*',
|
|
group: 'sibling',
|
|
position: 'before',
|
|
},
|
|
],
|
|
distinctGroup: true,
|
|
warnOnUnassignedImports: true,
|
|
pathGroupsExcludedImportTypes: ['@nestjs/**'],
|
|
},
|
|
],
|
|
'simple-import-sort/imports': 'off',
|
|
'unicorn/filename-case': 'off',
|
|
'prefer-arrow/prefer-arrow-functions': 'off',
|
|
'@nx/workspace-max-consts-per-file': 'off',
|
|
'@nx/workspace-inject-workspace-repository': 'warn',
|
|
},
|
|
},
|
|
{
|
|
files: ['scripts/**/*.ts'],
|
|
parserOptions: {
|
|
project: ['packages/twenty-server/tsconfig.scripts.json'],
|
|
},
|
|
},
|
|
],
|
|
};
|