Skip to content

feat: remove eslint-disable line #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2021
Merged

feat: remove eslint-disable line #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export const aUser = (overrides?: Partial<User>): User => {

When disabled, underscores will be retained for type names when the case is changed. It has no effect if `typenames` is set to `keep`.

## Example of usage
## Examples of usage

**codegen.yml**

Expand All @@ -150,7 +150,30 @@ generates:
AWSTimestamp: unix_time # gets translated to casual.unix_time
```

## Example or generated code
### With `eslint-disable` rule

**codegen.yml**

```yaml
overwrite: true
schema: schema.graphql
generates:
src/generated-types.ts:
plugins:
- 'typescript'
src/mocks/generated-mocks.ts:
plugins:
- add:
content: '/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */'
- typescript-mock-data:
typesFile: '../generated-types.ts'
enumValues: upper-case#upperCase
typenames: keep
scalars:
AWSTimestamp: unix_time # gets translated to casual.unix_time
```

## Example of generated code

Given the following schema:

Expand Down
5 changes: 1 addition & 4 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,7 @@ const getImportTypes = ({
return self.indexOf(value) === index;
}

return typesFile
? `/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { ${typeImports.filter(onlyUnique).join(', ')} } from '${typesFile}';\n`
: '';
return typesFile ? `import { ${typeImports.filter(onlyUnique).join(', ')} } from '${typesFile}';\n` : '';
};

type ScalarGeneratorName = keyof Casual.Casual | keyof Casual.functions | string;
Expand Down
27 changes: 9 additions & 18 deletions tests/__snapshots__/typescript-mock-data.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,7 @@ export const aQuery = (overrides?: Partial<Query>): Query => {
`;

exports[`should add enumsPrefix to imports 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, Api } from './types/graphql';
"import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, Api } from './types/graphql';

export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
return {
Expand Down Expand Up @@ -216,8 +215,7 @@ export const aQuery = (overrides?: Partial<Query>): Query => {
`;

exports[`should add typesPrefix and enumsPrefix to imports 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Api } from './types/graphql';
"import { Api } from './types/graphql';

export const anAvatar = (overrides?: Partial<Api.Avatar>): Api.Avatar => {
return {
Expand Down Expand Up @@ -360,8 +358,7 @@ export const aQuery = (overrides?: Partial<Api.Query>): Api.Query => {
`;

exports[`should add typesPrefix to imports 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Api, AbcStatus, Status } from './types/graphql';
"import { Api, AbcStatus, Status } from './types/graphql';

export const anAvatar = (overrides?: Partial<Api.Avatar>): Api.Avatar => {
return {
Expand Down Expand Up @@ -859,8 +856,7 @@ export const aQuery = (overrides?: Partial<Query>): Query => {
`;

exports[`should generate mock data functions with external types file import 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, AbcStatus, Status } from './types/graphql';
"import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, AbcStatus, Status } from './types/graphql';

export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
return {
Expand Down Expand Up @@ -1216,8 +1212,7 @@ export const aQuery = (overrides?: Partial<Query>): Query => {
`;

exports[`should generate mock data with PascalCase types and enums by default 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, AbcStatus, Status } from './types/graphql';
"import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, AbcStatus, Status } from './types/graphql';

export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
return {
Expand Down Expand Up @@ -1652,8 +1647,7 @@ export const aQUERY = (overrides?: Partial<QUERY>): QUERY => {
`;

exports[`should generate mock data with upperCase types and imports if typenames is "upper-case#upperCase" 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { AVATAR, USER, WITHAVATAR, CAMELCASETHING, PREFIXED_RESPONSE, ABCTYPE, UPDATEUSERINPUT, MUTATION, QUERY, ABCSTATUS, STATUS } from './types/graphql';
"import { AVATAR, USER, WITHAVATAR, CAMELCASETHING, PREFIXED_RESPONSE, ABCTYPE, UPDATEUSERINPUT, MUTATION, QUERY, ABCSTATUS, STATUS } from './types/graphql';

export const anAVATAR = (overrides?: Partial<AVATAR>): AVATAR => {
return {
Expand Down Expand Up @@ -1725,8 +1719,7 @@ export const aQUERY = (overrides?: Partial<QUERY>): QUERY => {
`;

exports[`should not merge imports into one if enumsPrefix does not contain dots 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, ApiAbcStatus, ApiStatus } from './types/graphql';
"import { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, UpdateUserInput, Mutation, Query, ApiAbcStatus, ApiStatus } from './types/graphql';

export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
return {
Expand Down Expand Up @@ -1798,8 +1791,7 @@ export const aQuery = (overrides?: Partial<Query>): Query => {
`;

exports[`should not merge imports into one if typesPrefix does not contain dots 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { ApiAvatar, ApiUser, ApiWithAvatar, ApiCamelCaseThing, ApiPrefixedResponse, ApiAbcType, ApiUpdateUserInput, ApiMutation, ApiQuery, AbcStatus, Status } from './types/graphql';
"import { ApiAvatar, ApiUser, ApiWithAvatar, ApiCamelCaseThing, ApiPrefixedResponse, ApiAbcType, ApiUpdateUserInput, ApiMutation, ApiQuery, AbcStatus, Status } from './types/graphql';

export const anAvatar = (overrides?: Partial<ApiAvatar>): ApiAvatar => {
return {
Expand Down Expand Up @@ -1871,8 +1863,7 @@ export const aQuery = (overrides?: Partial<ApiQuery>): ApiQuery => {
`;

exports[`should preserve underscores if transformUnderscore is false 1`] = `
"/* eslint-disable @typescript-eslint/no-use-before-define,@typescript-eslint/no-unused-vars,no-prototype-builtins */
import { Avatar, User, WithAvatar, CamelCaseThing, Prefixed_Response, AbcType, UpdateUserInput, Mutation, Query, AbcStatus, Status } from './types/graphql';
"import { Avatar, User, WithAvatar, CamelCaseThing, Prefixed_Response, AbcType, UpdateUserInput, Mutation, Query, AbcStatus, Status } from './types/graphql';

export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
return {
Expand Down