remove truthy helper function (#2797)

* yoyo * yoyo * yoyo * yoyo * yoyo * yoyo * fix * fix * a * modify test
graphql-hive · Dec 3, 2024 · b904515 · b904515
1 parent a27128f
commit b904515
Show file tree

Hide file tree

Showing 16 changed files with 122 additions and 131 deletions.
diff --git a/.changeset/thick-candles-peel.md b/.changeset/thick-candles-peel.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+remove `truthy` helper function
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -41,9 +41,6 @@ module.exports = {
     },
     {
       files: ['**/*.{spec,test}.ts'],
-      env: {
-        jest: true,
-      },
       extends: ['plugin:eslint-plugin/tests-recommended'],
       rules: {
         'eslint-plugin/test-case-shorthand-strings': 'error',

diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
     "tsup": "^8.3.5",
     "tsx": "4.19.2",
     "turbo": "2.3.3",
-    "typescript": "5.6.3",
+    "typescript": "5.7.2",
     "vitest": "2.1.8"
   },
   "pnpm": {

diff --git a/packages/plugin/__tests__/examples.spec.ts b/packages/plugin/__tests__/examples.spec.ts
@@ -60,6 +60,10 @@ function parseESLintOutput({
       /\(node:\d+\) ESLintRCWarning: You are using an eslintrc configuration file, which is deprecated and support will be removed in v10.0.0. Please migrate to an eslint.config.js file. See https:\/\/eslint.org\/docs\/latest\/use\/configure\/migration-guide for details./,
       '',
     )
+    .replace(
+      'An eslintrc configuration file is used because you have the ESLINT_USE_FLAT_CONFIG environment variable set to false. If you want to use an eslint.config.js file, remove the environment variable. If you want to find the location of the eslintrc configuration file, use the --debug flag.',
+      '',
+    )
     .replace('(Use `node --trace-deprecation ...` to show where the warning was created)', '')
     .replace('(Use `node --trace-warnings ...` to show where the warning was created)', '')
     .trimEnd();

diff --git a/...__tests__/mocks/using-config/test.graphql → ...__/mocks/using-config/nested/test.graphql b/...__tests__/mocks/using-config/test.graphql → ...__/mocks/using-config/nested/test.graphql
@@ -1,3 +1,3 @@
-query {
+{
   hello
 }
diff --git a/packages/plugin/__tests__/schema.spec.ts b/packages/plugin/__tests__/schema.spec.ts
@@ -114,10 +114,7 @@ describe('schema', async () => {
 
   it('should load the graphql-config rc file relative to the linted file', () => {
     const gqlConfig = loadGraphQLConfig({
-      graphQLConfig: {
-        schema: path.resolve(__dirname, 'mocks/using-config/schema-in-config.graphql'),
-      },
-      filePath: path.resolve(__dirname, 'mocks/using-config/test.graphql'),
+      filePath: path.resolve(__dirname, 'mocks/using-config/nested/test.graphql'),
     });
 
     const graphQLSchema = getSchema(gqlConfig.getDefault()) as GraphQLSchema;

diff --git a/packages/plugin/src/processor.ts b/packages/plugin/src/processor.ts
@@ -8,7 +8,7 @@ import {
 import { asArray } from '@graphql-tools/utils';
 import { loadOnDiskGraphQLConfig } from './graphql-config.js';
 import { version } from './meta.js';
-import { CWD, REPORT_ON_FIRST_CHARACTER, truthy } from './utils.js';
+import { CWD, REPORT_ON_FIRST_CHARACTER } from './utils.js';
 
 export type Block = Linter.ProcessorFile & {
   lineOffset: number;
@@ -50,15 +50,10 @@ export const processor = {
         gqlMagicComment = 'GraphQL',
       } = pluckConfig;
 
-      keywords = [
-        ...new Set(
-          [
-            ...modules.map(({ identifier }) => identifier),
-            ...asArray(globalGqlIdentifierName),
-            gqlMagicComment,
-          ].filter(truthy),
-        ),
-      ];
+      const mods = modules.map(({ identifier }) => identifier).filter((v): v is string => !!v);
+
+      const result = [...mods, ...asArray(globalGqlIdentifierName), gqlMagicComment];
+      keywords = [...new Set(result)];
     }
 
     if (keywords.every(keyword => !code.includes(keyword))) {

diff --git a/packages/plugin/src/rules/alphabetize/index.ts b/packages/plugin/src/rules/alphabetize/index.ts
@@ -22,7 +22,7 @@ import { FromSchema } from 'json-schema-to-ts';
 import lowerCase from 'lodash.lowercase';
 import { GraphQLESTreeNode } from '../../estree-converter/index.js';
 import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../../types.js';
-import { ARRAY_DEFAULT_OPTIONS, displayNodeName, truthy } from '../../utils.js';
+import { ARRAY_DEFAULT_OPTIONS, displayNodeName } from '../../utils.js';
 
 const RULE_ID = 'alphabetize';
 
@@ -348,7 +348,7 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
         Kind.INPUT_OBJECT_TYPE_EXTENSION,
       ],
     ]
-      .filter(truthy)
+      .filter(v => !!v)
       .flat();
 
     const fieldsSelector = kinds.join(',');

diff --git a/packages/plugin/src/rules/naming-convention/index.ts b/packages/plugin/src/rules/naming-convention/index.ts
@@ -7,7 +7,6 @@ import {
   convertCase,
   displayNodeName,
   englishJoinWords,
-  truthy,
   TYPES_KINDS,
 } from '../../utils.js';
 
@@ -511,7 +510,7 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
     }
 
     const selectors = new Set(
-      [types && TYPES_KINDS, Object.keys(restOptions)].flat().filter(truthy),
+      [types && TYPES_KINDS, Object.keys(restOptions)].filter(v => !!v).flat(),
     );
 
     for (const selector of selectors) {

diff --git a/packages/plugin/src/rules/no-root-type/index.ts b/packages/plugin/src/rules/no-root-type/index.ts
@@ -2,7 +2,7 @@ import { NameNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
 import { GraphQLESTreeNode } from '../../estree-converter/index.js';
 import { GraphQLESLintRule } from '../../types.js';
-import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchema, truthy } from '../../utils.js';
+import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchema } from '../../utils.js';
 
 const schema = {
   type: 'array',
@@ -66,7 +66,7 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
       disallow.has('mutation') && schema.getMutationType(),
       disallow.has('subscription') && schema.getSubscriptionType(),
     ]
-      .filter(truthy)
+      .filter(v => !!v)
       .map(type => type.name)
       .join('|');
 

diff --git a/packages/plugin/src/rules/require-nullable-result-in-root/index.ts b/packages/plugin/src/rules/require-nullable-result-in-root/index.ts
@@ -1,7 +1,7 @@
 import { Kind, ObjectTypeDefinitionNode } from 'graphql';
 import { GraphQLESTreeNode } from '../../estree-converter/index.js';
 import { GraphQLESLintRule } from '../../types.js';
-import { getNodeName, requireGraphQLSchema, truthy } from '../../utils.js';
+import { getNodeName, requireGraphQLSchema } from '../../utils.js';
 
 const RULE_ID = 'require-nullable-result-in-root';
 
@@ -43,7 +43,7 @@ export const rule: GraphQLESLintRule = {
   create(context) {
     const schema = requireGraphQLSchema(RULE_ID, context);
     const rootTypeNames = new Set(
-      [schema.getQueryType(), schema.getMutationType()].filter(truthy).map(type => type.name),
+      [schema.getQueryType(), schema.getMutationType()].filter(v => !!v).map(type => type.name),
     );
     const sourceCode = context.getSourceCode();
 

diff --git a/packages/plugin/src/rules/strict-id-in-types/index.ts b/packages/plugin/src/rules/strict-id-in-types/index.ts
@@ -7,7 +7,6 @@ import {
   displayNodeName,
   englishJoinWords,
   requireGraphQLSchema,
-  truthy,
 } from '../../utils.js';
 
 const RULE_ID = 'strict-id-in-types';
@@ -137,7 +136,7 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
       schema.getMutationType(),
       schema.getSubscriptionType(),
     ]
-      .filter(truthy)
+      .filter(v => !!v)
       .map(type => type.name);
     const selector = `ObjectTypeDefinition[name.value!=/^(${rootTypeNames.join('|')})$/]`;
 

diff --git a/packages/plugin/src/utils.ts b/packages/plugin/src/utils.ts
@@ -121,12 +121,6 @@ export const ARRAY_DEFAULT_OPTIONS = {
 export const englishJoinWords = (words: string[]): string =>
   new Intl.ListFormat('en-US', { type: 'disjunction' }).format(words);
 
-type Truthy<T> = T extends '' | 0 | false | null | undefined ? never : T; // from lodash
-
-export function truthy<T>(value: T): value is Truthy<T> {
-  return !!value;
-}
-
 const DisplayNodeNameMap: Record<Kind, string> = {
   [Kind.ARGUMENT]: 'argument',
   [Kind.BOOLEAN]: 'boolean',

diff --git a/packages/plugin/tsconfig.json b/packages/plugin/tsconfig.json
@@ -9,6 +9,7 @@
     "strict": true,
     "lib": ["ESNext", "dom"],
     "types": ["vitest/globals"],
+    "strictNullChecks": true,
     "resolveJsonModule": true,
     "skipLibCheck": true,
     "paths": {

diff --git a/packages/plugin/tsup.config.ts b/packages/plugin/tsup.config.ts
@@ -2,7 +2,7 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 import { defineConfig, Options } from 'tsup';
 import { CWD } from '@/utils.js';
-import packageJson from './package.json';
+import packageJson from './package.json' with { type: 'json' };
 
 const opts: Options = {
   entry: ['src/**/*.ts', '!src/index.browser.ts', '!src/**/*.test.ts'],
-Original file line number
+Diff line change
@@ -1,3 +1,3 @@
-    query {
+    {
       hello
     }