Skip to content

Commit c4731d0

Browse files
authored
chore: typed jest conf + remove version from compose file + fix typo (#337)
Just some chores like getting rid of this warning in terminal each time you run e2e tests: ```shell WARN[0000] /home/kasir/projects/nestjs-query/examples/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion ``` Typed jest conf file for better dev exp when you need to modify it. Some typos that where here an there. BTW I also like to ask @TriPSs why he has increased the `printWidth` of prettier to 130! I mean the recommended length is 70. So if your OK with it I am gonna change it to 70. TBH it is really long and hard to make sense of a lot of stuff. But I am also open to not touch it since it is growing on me too (as of lately I feel more comfortable around it :sweat_smile:). One thing that bothers me though is that if I save `docker-compose.yml` or any `JSON` conf file my IDE format it and I was thinking if possible either override them in `.prettierrc` or decrease the `printWidth` to 70 since the only configuration that causes VSCode to format them in my case.
2 parents dd94855 + 11d7558 commit c4731d0

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

documentation/docs/introduction/example.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@ npx nest g cl todo-item.create.dto todo-item --flat
270270

271271

272272
```ts title="todo-item/todo-item.create.dto.ts"
273+
import { Field, InputType } from '@nestjs/graphql';
273274
import { IsBoolean, IsString } from 'class-validator';
274275

275276
@InputType('CreateTodoItem')
@@ -453,6 +454,7 @@ import { TodoItemModule } from './todo-item/todo-item.module';
453454
type: 'postgres',
454455
database: 'gettingstarted',
455456
username: 'gettingstarted',
457+
password: 'gettingstarted',
456458
autoLoadEntities: true,
457459
synchronize: true,
458460
logging: true,
@@ -567,17 +569,16 @@ export class AppModule {}
567569
</TabItem>
568570
</Tabs>
569571

570-
Create a `docker-compose.yml` file in the root of the project
572+
Create a `compose.yml` file in the root of the project
571573

572574
```dockerfile
573-
version: "3"
574-
575575
services:
576576
postgres:
577-
image: "postgres:11.5"
577+
image: "postgres:17"
578578
environment:
579579
- "POSTGRES_USER=gettingstarted"
580580
- "POSTGRES_DB=gettingstarted"
581+
- "POSTGRES_PASSWORD=gettingstarted"
581582
expose:
582583
- "5432"
583584
ports:

examples/docker-compose.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
version: "3"
2-
31
services:
42
postgres:
53
image: "postgres:14"

jest.e2e.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
/* eslint-disable */
1+
import type { Config } from 'jest'
2+
23
export default {
34
displayName: 'examples',
45
preset: './jest.preset.js',
@@ -16,4 +17,4 @@ export default {
1617
testMatch: ['**/examples/**/e2e/**/*.spec.ts'],
1718
setupFilesAfterEnv: ['jest-extended'],
1819
coverageDirectory: './coverage/examples'
19-
}
20+
} satisfies Config

packages/query-graphql/__tests__/resolvers/crud.resolver.spec.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import * as updateResolver from '../../src/resolvers/update.resolver'
99
describe('CrudResolver', () => {
1010
const creatableSpy = jest.spyOn(createResolver, 'Creatable')
1111
const readableSpy = jest.spyOn(readResolver, 'Readable')
12-
const updateableSpy = jest.spyOn(updateResolver, 'Updateable')
12+
const updatableSpy = jest.spyOn(updateResolver, 'Updatable')
1313
const deleteResolverSpy = jest.spyOn(deleteResolver, 'DeleteResolver')
1414

1515
beforeEach(() => jest.clearAllMocks())
@@ -49,8 +49,8 @@ describe('CrudResolver', () => {
4949
expect(readableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
5050
expect(readableSpy).toHaveBeenCalledTimes(1)
5151

52-
expect(updateableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
53-
expect(updateableSpy).toHaveBeenCalledTimes(1)
52+
expect(updatableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
53+
expect(updatableSpy).toHaveBeenCalledTimes(1)
5454

5555
expect(deleteResolverSpy).toHaveBeenCalledWith(TestResolverDTO, {})
5656
expect(deleteResolverSpy).toHaveBeenCalledTimes(1)
@@ -65,8 +65,8 @@ describe('CrudResolver', () => {
6565
expect(readableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
6666
expect(readableSpy).toHaveBeenCalledTimes(1)
6767

68-
expect(updateableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
69-
expect(updateableSpy).toHaveBeenCalledTimes(1)
68+
expect(updatableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
69+
expect(updatableSpy).toHaveBeenCalledTimes(1)
7070

7171
expect(deleteResolverSpy).toHaveBeenCalledWith(TestResolverDTO, {})
7272
expect(deleteResolverSpy).toHaveBeenCalledTimes(1)
@@ -81,8 +81,8 @@ describe('CrudResolver', () => {
8181
expect(readableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
8282
expect(readableSpy).toHaveBeenCalledTimes(1)
8383

84-
expect(updateableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
85-
expect(updateableSpy).toHaveBeenCalledTimes(1)
84+
expect(updatableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
85+
expect(updatableSpy).toHaveBeenCalledTimes(1)
8686

8787
expect(deleteResolverSpy).toHaveBeenCalledWith(TestResolverDTO, {})
8888
expect(deleteResolverSpy).toHaveBeenCalledTimes(1)
@@ -96,8 +96,8 @@ describe('CrudResolver', () => {
9696
expect(readableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
9797
expect(readableSpy).toHaveBeenCalledTimes(1)
9898

99-
expect(updateableSpy).toHaveBeenCalledWith(TestResolverDTO, { UpdateDTOClass: UpdateTestResolverDTO })
100-
expect(updateableSpy).toHaveBeenCalledTimes(1)
99+
expect(updatableSpy).toHaveBeenCalledWith(TestResolverDTO, { UpdateDTOClass: UpdateTestResolverDTO })
100+
expect(updatableSpy).toHaveBeenCalledTimes(1)
101101

102102
expect(deleteResolverSpy).toHaveBeenCalledWith(TestResolverDTO, {})
103103
expect(deleteResolverSpy).toHaveBeenCalledTimes(1)
@@ -111,8 +111,8 @@ describe('CrudResolver', () => {
111111
expect(readableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
112112
expect(readableSpy).toHaveBeenCalledTimes(1)
113113

114-
expect(updateableSpy).toHaveBeenCalledWith(TestResolverDTO, { UpdateDTOClass: UpdateTestResolverDTO, guards: [] })
115-
expect(updateableSpy).toHaveBeenCalledTimes(1)
114+
expect(updatableSpy).toHaveBeenCalledWith(TestResolverDTO, { UpdateDTOClass: UpdateTestResolverDTO, guards: [] })
115+
expect(updatableSpy).toHaveBeenCalledTimes(1)
116116

117117
expect(deleteResolverSpy).toHaveBeenCalledWith(TestResolverDTO, {})
118118
expect(deleteResolverSpy).toHaveBeenCalledTimes(1)
@@ -127,8 +127,8 @@ describe('CrudResolver', () => {
127127
expect(readableSpy).toHaveBeenCalledWith(TestResolverDTO, { pagingStrategy: PagingStrategies.OFFSET })
128128
expect(readableSpy).toHaveBeenCalledTimes(1)
129129

130-
expect(updateableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
131-
expect(updateableSpy).toHaveBeenCalledTimes(1)
130+
expect(updatableSpy).toHaveBeenCalledWith(TestResolverDTO, {})
131+
expect(updatableSpy).toHaveBeenCalledTimes(1)
132132

133133
expect(deleteResolverSpy).toHaveBeenCalledWith(TestResolverDTO, {})
134134
expect(deleteResolverSpy).toHaveBeenCalledTimes(1)

packages/query-graphql/src/resolvers/crud.resolver.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { Referenceable, ReferenceResolverOpts } from './reference.resolver'
1111
import { Relatable } from './relations'
1212
import { RelatableOpts } from './relations/relations.resolver'
1313
import { MergePagingStrategyOpts, ResolverClass } from './resolver.interface'
14-
import { Updateable, UpdateResolver, UpdateResolverOpts } from './update.resolver'
14+
import { Updatable, UpdateResolver, UpdateResolverOpts } from './update.resolver'
1515

1616
export interface CRUDResolverOpts<
1717
DTO,
@@ -129,13 +129,13 @@ export const CRUDResolver = <
129129
DTOClass: Class<DTO>,
130130
opts: CRUDResolverOpts<DTO, C, U, R, PS> = {}
131131
): ResolverClass<DTO, QueryService<DTO, C, U>, CRUDResolver<DTO, C, U, MergePagingStrategyOpts<DTO, R, PS>>> => {
132-
const referencable = Referenceable(DTOClass, opts.referenceBy ?? {})
132+
const referenceable = Referenceable(DTOClass, opts.referenceBy ?? {})
133133
const relatable = Relatable(DTOClass, extractRelatableOpts(opts))
134134
const aggregateable = Aggregateable(DTOClass, extractAggregateResolverOpts(opts))
135135
const creatable = Creatable(DTOClass, extractCreateResolverOpts(opts))
136136
const readable = Readable(DTOClass, extractReadResolverOpts(opts))
137-
const updatable = Updateable(DTOClass, extractUpdateResolverOpts(opts))
137+
const updatable = Updatable(DTOClass, extractUpdateResolverOpts(opts))
138138
const deleteResolver = DeleteResolver(DTOClass, extractDeleteResolverOpts(opts))
139139

140-
return referencable(relatable(aggregateable(creatable(readable(updatable(deleteResolver))))))
140+
return referenceable(relatable(aggregateable(creatable(readable(updatable(deleteResolver))))))
141141
}

packages/query-graphql/src/resolvers/update.resolver.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ const defaultUpdateManyInput = <DTO, U>(
8888
* @internal
8989
* Mixin to add `update` graphql endpoints.
9090
*/
91-
export const Updateable =
91+
export const Updatable =
9292
<DTO, U, QS extends QueryService<DTO, unknown, U>>(DTOClass: Class<DTO>, opts: UpdateResolverOpts<DTO, U>) =>
9393
<B extends Class<ServiceResolver<DTO, QS>>>(BaseClass: B): Class<UpdateResolver<DTO, U, QS>> & B => {
9494
const dtoNames = getDTONames(DTOClass, opts)
@@ -233,4 +233,4 @@ export const UpdateResolver = <
233233
>(
234234
DTOClass: Class<DTO>,
235235
opts: UpdateResolverOpts<DTO, U> = {}
236-
): ResolverClass<DTO, QS, UpdateResolver<DTO, U, QS>> => Updateable(DTOClass, opts)(BaseServiceResolver)
236+
): ResolverClass<DTO, QS, UpdateResolver<DTO, U, QS>> => Updatable(DTOClass, opts)(BaseServiceResolver)

0 commit comments

Comments
 (0)