setup guild eslint config (#8797)

* setup guild eslint config * remove unused eslint directives * sort imports * sort imports * sort imports
dotansimha · Jan 7, 2023 · 5ea74e3 · 5ea74e3
1 parent fe12b48
commit 5ea74e3
Show file tree

Hide file tree

Showing 103 changed files with 1,167 additions and 686 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -0,0 +1,67 @@
+module.exports = {
+  root: true,
+  extends: ['@theguild'],
+  rules: {
+    'no-empty': 'off',
+    'no-console': 'error',
+    'no-prototype-builtins': 'off',
+    'no-useless-constructor': 'off',
+    'no-unused-vars': 'off',
+    'object-shorthand': ['error', 'always'],
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    'no-unreachable-loop': 'error',
+    '@typescript-eslint/no-empty-interface': 'off',
+    'prefer-arrow-callback': 'error',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    'no-lonely-if': 'error',
+    'import/no-extraneous-dependencies': [
+      'error',
+      { devDependencies: ['**/*.test.ts', '**/*.spec.ts', '**/test/**/*.ts'] },
+    ],
+
+    // todo: enable
+    'unicorn/prefer-node-protocol': 'off',
+    'no-restricted-syntax': 'off',
+    'unicorn/filename-case': 'off',
+    'import/extensions': 'off',
+    'no-implicit-coercion': 'off',
+    'unicorn/numeric-separators-style': 'off',
+    'import/no-default-export': 'off',
+    'unicorn/no-lonely-if': 'off',
+    'unicorn/no-useless-spread': 'off',
+    'simple-import-sort/exports': 'off',
+    'unicorn/no-array-push-push': 'off',
+    'no-else-return': 'off',
+    'no-undef': 'off',
+    'import/first': 'off',
+    'n/no-restricted-import': 'off',
+    'import/no-duplicates': 'off',
+  },
+  env: {
+    es6: true,
+    node: true,
+  },
+  overrides: [
+    {
+      files: ['**/tests/**/*.ts', '**/graphql-codegen-testing/**/*.ts', '*.spec.ts'],
+      env: {
+        jest: true,
+      },
+      rules: {
+        'no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        'import/no-extraneous-dependencies': 'off',
+      },
+    },
+  ],
+  ignorePatterns: ['dist', 'node_modules', 'dev-test', 'website', 'test-files', 'examples/front-end', '.bob'],
+};
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/examples/programmatic-typescript/src/gql.generated.ts b/examples/programmatic-typescript/src/gql.generated.ts
@@ -1,5 +1,6 @@
-import type { GraphQLResolveInfo } from 'graphql';
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
+import type { GraphQLResolveInfo } from 'graphql';
+
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };

diff --git a/examples/programmatic-typescript/src/index.ts b/examples/programmatic-typescript/src/index.ts
@@ -1,19 +1,16 @@
 /* eslint-disable no-console */
-
 import { promises } from 'fs';
-import { getCachedDocumentNodeFromSchema } from '@graphql-codegen/plugin-helpers';
-import gql from 'graphql-tag';
-import prettier from 'prettier';
-
 import { codegen } from '@graphql-codegen/core';
+import { getCachedDocumentNodeFromSchema } from '@graphql-codegen/plugin-helpers';
 import * as typedDocumentNode from '@graphql-codegen/typed-document-node';
 import * as typescript from '@graphql-codegen/typescript';
 import * as typescriptOperations from '@graphql-codegen/typescript-operations';
 import * as typescriptResolvers from '@graphql-codegen/typescript-resolvers';
 import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
 import { loadDocuments } from '@graphql-tools/load';
 import { makeExecutableSchema } from '@graphql-tools/schema';
-
+import gql from 'graphql-tag';
+import prettier from 'prettier';
 import type { Resolvers } from './gql.generated.js';
 
 const schema = makeExecutableSchema({

diff --git a/examples/typescript-esm/src/executeOperation.ts b/examples/typescript-esm/src/executeOperation.ts
@@ -1,7 +1,7 @@
+import * as https from 'node:https';
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import type { ExecutionResult } from 'graphql';
 import { print } from 'graphql';
-import * as https from 'node:https';
 
 export function executeOperation<TResult, TVariables>(
   url: string,

diff --git a/examples/typescript-esm/src/gql/gql.ts b/examples/typescript-esm/src/gql/gql.ts
@@ -1,6 +1,5 @@
-/* eslint-disable */
-import * as graphql from './graphql.js';
 import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
+import * as graphql from './graphql.js';
 
 const documents = {
   '\n  query AllPeopleQuery {\n    allPeople(first: 5) {\n      edges {\n        node {\n          name\n          homeworld {\n            name\n          }\n        }\n      }\n    }\n  }\n':

diff --git a/examples/typescript-esm/src/gql/graphql.ts b/examples/typescript-esm/src/gql/graphql.ts
@@ -1,5 +1,5 @@
-/* eslint-disable */
 import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
+
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };

diff --git a/examples/typescript-resolvers/src/type-defs.d.ts b/examples/typescript-resolvers/src/type-defs.d.ts
@@ -1,4 +1,5 @@
 import { GraphQLResolveInfo } from 'graphql';
+
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };

diff --git a/package.json b/package.json
@@ -39,6 +39,7 @@
     "@graphql-typed-document-node/core": "3.1.1",
     "@reduxjs/toolkit": "1.8.5",
     "@tanstack/react-query": "4.2.3",
+    "@theguild/eslint-config": "0.4.2",
     "@theguild/prettier-config": "0.1.1",
     "@types/common-tags": "1.8.1",
     "@types/jest": "28.1.8",

diff --git a/packages/graphql-cli-codegen-plugin/src/index.ts b/packages/graphql-cli-codegen-plugin/src/index.ts
@@ -1,10 +1,10 @@
 import { defineCommand } from '@graphql-cli/common';
 import {
-  CodegenExtension,
+  buildOptions,
   CodegenContext,
+  CodegenExtension,
   generate,
   updateContextWithCliFlags,
-  buildOptions,
   YamlCliFlags,
 } from '@graphql-codegen/cli';
 

diff --git a/packages/graphql-codegen-cli/src/cli.ts b/packages/graphql-codegen-cli/src/cli.ts
@@ -1,7 +1,7 @@
-import { generate } from './generate-and-save.js';
-import { init } from './init/index.js';
 import { createContext } from './config.js';
+import { generate } from './generate-and-save.js';
 import { lifecycleHooks } from './hooks.js';
+import { init } from './init/index.js';
 
 export async function runCli(cmd: string): Promise<number> {
   await ensureGraphQlPackage();

diff --git a/packages/graphql-codegen-cli/src/codegen.ts b/packages/graphql-codegen-cli/src/codegen.ts
@@ -1,25 +1,23 @@
+import fs from 'fs';
+import { createRequire } from 'module';
+import { cpus } from 'os';
+import path from 'path';
+import { codegen } from '@graphql-codegen/core';
 import {
-  Types,
   CodegenPlugin,
-  normalizeOutputParam,
-  normalizeInstanceOrArray,
-  normalizeConfig,
   getCachedDocumentNodeFromSchema,
+  normalizeConfig,
+  normalizeInstanceOrArray,
+  normalizeOutputParam,
+  Types,
 } from '@graphql-codegen/plugin-helpers';
-import { codegen } from '@graphql-codegen/core';
-
 import { AggregateError } from '@graphql-tools/utils';
-
-import { GraphQLError, GraphQLSchema, DocumentNode } from 'graphql';
+import { DocumentNode, GraphQLError, GraphQLSchema } from 'graphql';
+import { Listr, ListrTask } from 'listr2';
+import { CodegenContext, ensureContext, shouldEmitLegacyCommonJSImports } from './config.js';
 import { getPluginByName } from './plugins.js';
 import { getPresetByName } from './presets.js';
 import { debugLog, printLogs } from './utils/debugging.js';
-import { CodegenContext, ensureContext, shouldEmitLegacyCommonJSImports } from './config.js';
-import fs from 'fs';
-import path from 'path';
-import { cpus } from 'os';
-import { createRequire } from 'module';
-import { Listr, ListrTask } from 'listr2';
 
 /**
  * Poor mans ESM detection.

diff --git a/packages/graphql-codegen-cli/src/config.ts b/packages/graphql-codegen-cli/src/config.ts
@@ -1,23 +1,23 @@
-import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
-import { TypeScriptLoader } from 'cosmiconfig-typescript-loader';
+import { createHash } from 'crypto';
+import { promises } from 'fs';
+import { createRequire } from 'module';
 import { resolve } from 'path';
 import {
-  Types,
-  Profiler,
-  createProfiler,
   createNoopProfiler,
+  createProfiler,
   getCachedDocumentNodeFromSchema,
+  Profiler,
+  Types,
 } from '@graphql-codegen/plugin-helpers';
+import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
+import { TypeScriptLoader } from 'cosmiconfig-typescript-loader';
+import { GraphQLSchema, GraphQLSchemaExtensions, print } from 'graphql';
+import { GraphQLConfig } from 'graphql-config';
 import { env } from 'string-env-interpolation';
+import yaml from 'yaml';
 import yargs from 'yargs';
-import { GraphQLConfig } from 'graphql-config';
 import { findAndLoadGraphQLConfig } from './graphql-config.js';
-import { loadSchema, loadDocuments, defaultSchemaLoadOptions, defaultDocumentsLoadOptions } from './load.js';
-import { GraphQLSchema, print, GraphQLSchemaExtensions } from 'graphql';
-import yaml from 'yaml';
-import { createRequire } from 'module';
-import { promises } from 'fs';
-import { createHash } from 'crypto';
+import { defaultDocumentsLoadOptions, defaultSchemaLoadOptions, loadDocuments, loadSchema } from './load.js';
 
 const { lstat } = promises;
 

diff --git a/packages/graphql-codegen-cli/src/generate-and-save.ts b/packages/graphql-codegen-cli/src/generate-and-save.ts
@@ -1,12 +1,12 @@
-import { lifecycleHooks } from './hooks.js';
+import { createHash } from 'crypto';
+import { dirname, isAbsolute, join } from 'path';
 import { Types } from '@graphql-codegen/plugin-helpers';
 import { executeCodegen } from './codegen.js';
-import { createWatcher } from './utils/watcher.js';
-import { readFile, writeFile, unlinkFile, mkdirp } from './utils/file-system.js';
-import { dirname, join, isAbsolute } from 'path';
-import { debugLog } from './utils/debugging.js';
 import { CodegenContext, ensureContext } from './config.js';
-import { createHash } from 'crypto';
+import { lifecycleHooks } from './hooks.js';
+import { debugLog } from './utils/debugging.js';
+import { mkdirp, readFile, unlinkFile, writeFile } from './utils/file-system.js';
+import { createWatcher } from './utils/watcher.js';
 
 const hash = (content: string): string => createHash('sha1').update(content).digest('base64');
 

diff --git a/packages/graphql-codegen-cli/src/graphql-config.ts b/packages/graphql-codegen-cli/src/graphql-config.ts
@@ -1,9 +1,9 @@
-import { loadConfig, GraphQLExtensionDeclaration, GraphQLConfig } from 'graphql-config';
 import { ApolloEngineLoader } from '@graphql-tools/apollo-engine-loader';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { GitLoader } from '@graphql-tools/git-loader';
 import { GithubLoader } from '@graphql-tools/github-loader';
 import { PrismaLoader } from '@graphql-tools/prisma-loader';
+import { GraphQLConfig, GraphQLExtensionDeclaration, loadConfig } from 'graphql-config';
 
 export const CodegenExtension: GraphQLExtensionDeclaration = (api: any) => {
   // Schema

diff --git a/packages/graphql-codegen-cli/src/hooks.ts b/packages/graphql-codegen-cli/src/hooks.ts
@@ -1,8 +1,8 @@
-import { Types } from '@graphql-codegen/plugin-helpers';
-import { debugLog } from './utils/debugging.js';
 import { exec } from 'child_process';
 import { delimiter, sep } from 'path';
+import { Types } from '@graphql-codegen/plugin-helpers';
 import { quote } from 'shell-quote';
+import { debugLog } from './utils/debugging.js';
 
 const DEFAULT_HOOKS: Types.LifecycleHooksDefinition = {
   afterStart: [],

diff --git a/packages/graphql-codegen-cli/src/init/helpers.ts b/packages/graphql-codegen-cli/src/init/helpers.ts
@@ -1,13 +1,13 @@
-import chalk from 'chalk';
-import { resolve, relative } from 'path';
-import { writeFileSync, readFileSync } from 'fs';
+import { readFileSync, writeFileSync } from 'fs';
+import { relative, resolve } from 'path';
+import generate from '@babel/generator';
+import template from '@babel/template';
+import * as t from '@babel/types';
 import { Types } from '@graphql-codegen/plugin-helpers';
+import chalk from 'chalk';
 import detectIndent from 'detect-indent';
-import { Answers, Tags } from './types.js';
 import { getLatestVersion } from '../utils/get-latest-version.js';
-import template from '@babel/template';
-import generate from '@babel/generator';
-import * as t from '@babel/types';
+import { Answers, Tags } from './types.js';
 
 function jsObjectToBabelObjectExpression<T extends object>(obj: T): ReturnType<typeof t.objectExpression> {
   const objExp = t.objectExpression([]);

diff --git a/packages/graphql-codegen-cli/src/init/index.ts b/packages/graphql-codegen-cli/src/init/index.ts
@@ -1,9 +1,9 @@
-import inquirer from 'inquirer';
 import { Types } from '@graphql-codegen/plugin-helpers';
+import inquirer from 'inquirer';
+import { bold, writeConfig, writePackage } from './helpers.js';
 import { getQuestions } from './questions.js';
 import { guessTargets } from './targets.js';
 import { Answers, Tags } from './types.js';
-import { writeConfig, writePackage, bold } from './helpers.js';
 
 function log(...msgs: string[]) {
   // eslint-disable-next-line no-console

diff --git a/packages/graphql-codegen-cli/src/init/questions.ts b/packages/graphql-codegen-cli/src/init/questions.ts
@@ -1,7 +1,7 @@
 import inquirer from 'inquirer';
 import { grey } from './helpers.js';
-import { Tags, Answers } from './types.js';
 import { plugins } from './plugins.js';
+import { Answers, Tags } from './types.js';
 
 export function getQuestions(possibleTargets: Record<Tags, boolean>): inquirer.QuestionCollection {
   return [

diff --git a/packages/graphql-codegen-cli/src/init/targets.ts b/packages/graphql-codegen-cli/src/init/targets.ts
@@ -1,5 +1,5 @@
-import { resolve } from 'path';
 import { readFileSync } from 'fs';
+import { resolve } from 'path';
 import { Tags } from './types.js';
 
 export async function guessTargets(): Promise<Record<Tags, boolean>> {