twenty/packages/twenty-server/.eslintrc.cjs

104 lines
3.0 KiB
JavaScript
Raw Normal View History

module.exports = {
plugins: ['@stylistic'],
extends: ['../../.eslintrc.cjs'],
ignorePatterns: ['src/engine/workspace-manager/demo-objects-prefill-data/**'],
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',
feat: add eslint rule for enforcing WorkspaceService naming convention (#6308) ### Description This PR introduces a custom ESLint rule named `inject-workspace-repository`. The purpose of this rule is to enforce naming conventions for files and classes that use the `@InjectWorkspaceRepository` decorator or include services ending with `WorkspaceService` in their constructors. ### Rule Overview The new ESLint rule checks for the following conditions: 1. **File Naming**: - Only file ending with `.service.ts` or `.workspace-service.ts` are checked. - If a file contains a class using the `@InjectWorkspaceRepository` decorator or a service ending with `WorkspaceService` in the constructor, the file name must end with `.workspace-service.ts`. 2. **Class Naming**: - Classes that use the `@InjectWorkspaceRepository` decorator or include services ending with `WorkspaceService` in their constructors must have names that end with `WorkspaceService`. ### How It Works The rule inspects each TypeScript file to ensure that the naming conventions are adhered to. It specifically looks for: - Constructor parameters with the `@InjectWorkspaceRepository` decorator. - Constructor parameters with a type annotation ending with `WorkspaceService`. When such parameters are found, it checks the class name and the file name to ensure they conform to the expected patterns. ### Example Code #### Valid Cases 1. **Correct File and Class Name with Decorator**: ```typescript // Filename: my.workspace-service.ts class MyWorkspaceService { constructor(@InjectWorkspaceRepository() private repository) {} } ``` 2. **Service Dependency**: ```typescript // Filename: another.workspace-service.ts class AnotherWorkspaceService { constructor(private myWorkspaceService: MyWorkspaceService) {} } ``` #### Invalid Cases 1. **Incorrect Class Name**: ```typescript // Filename: my.workspace-service.ts class MyService { constructor(@InjectWorkspaceRepository() private repository) {} } // Error: Class name should end with 'WorkspaceService'. ``` 2. **Incorrect File Name**: ```typescript // Filename: my.service.ts class MyWorkspaceService { constructor(@InjectWorkspaceRepository() private repository) {} } // Error: File name should end with '.workspace-service.ts'. ``` 3. **Incorrect File and Class Name**: ```typescript // Filename: my.service.ts class MyService { constructor(@InjectWorkspaceRepository() private repository) {} } // Error: Class name should end with 'WorkspaceService'. // Error: File name should end with '.workspace-service.ts'. ``` 4. **Incorrect File Type**: ```typescript // Filename: another.service.ts class AnotherService { constructor(private myWorkspaceService: MyWorkspaceService) {} } // Error: Class name should end with 'WorkspaceService'. // Error: File name should end with '.workspace-service.ts'. ``` 5. **Incorrect Class Name with Dependency**: ```typescript // Filename: another.workspace-service.ts class AnotherService { constructor(private myWorkspaceService: MyWorkspaceService) {} } // Error: Class name should end with 'WorkspaceService'. ``` ### First step This rule is only a warning for now, and then we'll migrate all the code that need to be migrated and move from `warn` to `error`. Fix #6309 Co-authored-by: Charles Bochet <charles@twenty.com>
2024-07-19 20:17:57 +03:00
'@nx/workspace-inject-workspace-repository': 'warn',
},
},
{
files: ['scripts/**/*.ts'],
parserOptions: {
project: ['packages/twenty-server/tsconfig.scripts.json'],
},
},
],
};