Update eslint config and enable shopify ts rules #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wheelsandcogs
commented
Sep 20, 2024
| 'error', | ||
| { | ||
| selector: 'default', | ||
| format: ['camelCase', 'PascalCase', 'UPPER_CASE', 'snake_case'], |
There was a problem hiding this comment.
default seems to be ['camelCase', 'PascalCase', 'UPPER_CASE'] which gives us a lot of errors due to the DTOs.
wheelsandcogs
force-pushed
the
fix/linting
branch
from
4d6eb30 to
8cfccf6
Compare
wheelsandcogs
changed the title
wheelsandcogs
changed the title
wheelsandcogs
commented
Sep 27, 2024
| @@ -1,9 +1,7 @@ | |||
| /* eslint-disable no-shadow */ | |||
| /* eslint-disable no-unused-vars */ | |||
There was a problem hiding this comment.
Enums work fine now without these.
wheelsandcogs
force-pushed
the
fix/linting
branch
from
e9e7221 to
287297c
Compare
wheelsandcogs
commented
Sep 27, 2024
| Ci = 'ci', | ||
| Staging = 'staging', | ||
| Prod = 'production', | ||
| Default = 'default' |
There was a problem hiding this comment.
Shopify specifies PascalCase for enum keys for some reason so might as well stick with that. I've also converted all enum values to snake_case for consistency.
| @@ -42,7 +42,7 @@ function hashReadableStream(stream: Readable, algorithm: string = 'sha256'): Pro | |||
| }); | |||
| } | |||
|
|
|||
| function paginate<T>(array: Array<T>, page_number: number, page_size: number): Array<T> { | |||
| function paginate<T>(array: T[], page_number: number, page_size: number): T[] { | |||
There was a problem hiding this comment.
One of the shopify rules is use [] instead of Array for types.
| @@ -33,7 +33,7 @@ export class DatasetDTO { | |||
| static async fromDatasetShallow(dataset: Dataset): Promise<DatasetDTO> { | |||
| const dto = new DatasetDTO(); | |||
| dto.id = dataset.id; | |||
| dto.creation_date = dataset.creationDate.toISOString(); | |||
| dto.created_at = dataset.createdAt.toISOString(); | |||
There was a problem hiding this comment.
all timestamp fields are now xxx_at
| @@ -22,7 +19,7 @@ export class Dimension extends BaseEntity { | |||
| @JoinColumn({ name: 'dataset_id', foreignKeyConstraintName: 'FK_dimension_dataset_id' }) | |||
| dataset: Promise<Dataset>; | |||
|
|
|||
| @Column({ type: 'enum', enum: Object.keys(DimensionType), nullable: false }) | |||
| @Column({ type: 'enum', enum: Object.values(DimensionType), nullable: false }) | |||
There was a problem hiding this comment.
Everywhere else we were using the enum values rather than enum keys so changed this for consistency.
wheelsandcogs
force-pushed
the
fix/linting
branch
from
b9bee9c to
fafd997
Compare
wheelsandcogs
force-pushed
the
fix/linting
branch
from
fafd997 to
1ac4744
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the eslint config to use the newer 'flat' config style, turns on the shopify typescript rules and fixes any issues resulting from that.
It resolves the issue we were having with eslint not liking enums.
I've disabled
@typescript-eslint/member-orderingas it would involve reordering all the static methods in most of the DTOs and ain't nobody got time for that.