aa

dimaMachina · dimaMachina · commit af5784d9d07b · 2024-11-29T17:31:55.000+07:00
diff --git a/examples/custom-rules/eslint.config.js b/examples/custom-rules/eslint.config.js
diff --git a/examples/custom-rules/my-rule.js b/examples/custom-rules/my-rule.js
diff --git a/examples/custom-rules/package.json b/examples/custom-rules/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@graphql-eslint/example-custom-rule",
+  "name": "@graphql-eslint/example-custom-rules",
   "version": "0.0.0",
   "type": "module",
   "repository": "https://github.com/dimaMachina/graphql-eslint",
diff --git a/examples/custom-rules/test.graphql b/examples/custom-rules/test.graphql
diff --git a/packages/plugin/__tests__/examples.spec.ts b/packages/plugin/__tests__/examples.spec.ts
@@ -123,7 +123,7 @@ describe('Examples', () => {
   });
 
   it('should work with custom rules', () => {
-    const cwd = path.join(CWD, 'examples', 'custom-rule');
+    const cwd = path.join(CWD, 'examples', 'custom-rules');
     const flatResults = getFlatESLintOutput(cwd);
     expect(normalizeResults(flatResults)).toMatchSnapshot();
     expect(countErrors(flatResults)).toBe(1);
diff --git a/website/content/docs/usage/custom-rules.mdx b/website/content/docs/usage/custom-rules.mdx
@@ -0,0 +1,7 @@
+---
+sidebarTitle: Custom GraphQL Rules
+---
+
+# Usage with custom GraphQL rules
+
+<ESLintConfigs gitFolder="custom-rules" additionalFiles={{ 'My Rule': 'my-rule.js' }} />
diff --git a/website/content/docs/usage/graphql.mdx b/website/content/docs/usage/graphql.mdx
@@ -5,4 +5,4 @@ icon: GraphQLIcon
 
 # Usage with `.graphql` files
 
-<ESLintConfigs gitFolder="graphql-config" graphqlConfigFile="graphql.config.js" />
+<ESLintConfigs gitFolder="graphql-config" additionalFiles={{ 'GraphQL Config': 'graphql.config.js' }} />
diff --git a/website/content/docs/usage/js.mdx b/website/content/docs/usage/js.mdx
@@ -41,4 +41,4 @@ export default [
 
 ---
 
-<ESLintConfigs gitFolder="code-file" graphqlConfigFile="graphql.config.js" />
+<ESLintConfigs gitFolder="code-file" additionalFiles={{ 'GraphQL Config': 'graphql.config.js' }} />
diff --git a/website/content/docs/usage/multiple-projects.mdx b/website/content/docs/usage/multiple-projects.mdx
@@ -5,4 +5,4 @@ icon: StackIcon
 
 # Usage to lint different schemas
 
-<ESLintConfigs gitFolder="multiple-projects-graphql-config" graphqlConfigFile="graphql.config.ts" />
+<ESLintConfigs gitFolder="multiple-projects-graphql-config" additionalFiles={{ 'GraphQL Config': 'graphql.config.ts' }} />
diff --git a/website/content/docs/usage/schema-and-operations.mdx b/website/content/docs/usage/schema-and-operations.mdx
@@ -5,4 +5,4 @@ icon: HalfIcon
 
 # Usage to lint both schema/operations
 
-<ESLintConfigs gitFolder="monorepo" graphqlConfigFile="graphql.config.js" />
+<ESLintConfigs gitFolder="monorepo" additionalFiles={{ 'GraphQL Config': 'graphql.config.js' }} />
diff --git a/website/mdx-components.tsx b/website/mdx-components.tsx
@@ -8,42 +8,41 @@ import {
 } from '@theguild/components/server';
 
 const docsComponents = getDocsMDXComponents({
-  async ESLintConfigs({ gitFolder, graphqlConfigFile = '' }) {
+  async ESLintConfigs({ gitFolder, additionalFiles }: { gitFolder: string, additionalFiles: Record<string, string> }) {
     const user = 'dimaMachina';
     const repo = 'graphql-eslint';
     const branch = 'master';
     const docsPath = path.join(process.cwd(), '..', 'examples', gitFolder);
-    const { ext } = path.parse(graphqlConfigFile);
 
-    const graphqlConfig =
-      graphqlConfigFile &&
-      `
-## GraphQL Config
+    const promises = Object.entries({
+      ...additionalFiles,
+      'ESLint Flat Config': 'eslint.config.js'
+    }).map(async ([heading, filePath]) => {
+      const { ext } = path.parse(filePath);
+      return `## ${heading}
 
-\`\`\`${ext.slice(1)} filename="${graphqlConfigFile}"
-${(await fs.readFile(`${docsPath}/${graphqlConfigFile}`, 'utf8')).trim()}
-\`\`\`
-`;
+\`\`\`${ext.slice(1)} filename="${filePath}"
+${(await fs.readFile(`${docsPath}/${filePath}`, 'utf8')).trim()}
+\`\`\``
+    })
+    const files = await Promise.all(promises)
+
+    const hasLegacyConfig = await fs.access(`${docsPath}/.eslintrc.cjs`).then(() => true).catch(() => '')
 
     return (
       <MDXRemote
         compiledSource={await compileMdx(`
 > [!NOTE]
 >
 > Check out
-> [the official examples](https://github.com/${user}/${repo}/tree/${branch}/examples/${gitFolder})
+> [the official example${hasLegacyConfig && 's'}](https://github.com/${user}/${repo}/tree/${branch}/examples/${gitFolder})
 > for
 > [ESLint Flat Config](https://github.com/${user}/${repo}/blob/${branch}/examples/${gitFolder}/eslint.config.js)
-> or
-> [ESLint Legacy Config](https://github.com/${user}/${repo}/blob/${branch}/examples/${gitFolder}/.eslintrc.cjs)
-> .
+${hasLegacyConfig ? `> or [ESLint Legacy Config](https://github.com/${user}/${repo}/blob/${branch}/examples/${gitFolder}/.eslintrc.cjs).` : '>.'}
 
-${graphqlConfig}
-## ESLint Flat Config
-\`\`\`js filename="eslint.config.js"
-${(await fs.readFile(`${docsPath}/eslint.config.js`, 'utf8')).trim()}
-\`\`\`
+${files.join('\n')}
 
+${hasLegacyConfig && `
 ## ESLint Legacy Config
 
 > [!WARNING]
@@ -52,7 +51,8 @@ ${(await fs.readFile(`${docsPath}/eslint.config.js`, 'utf8')).trim()}
 
 \`\`\`js filename=".eslintrc.cjs"
 ${(await fs.readFile(`${docsPath}/.eslintrc.cjs`, 'utf8')).trim()}
-\`\`\``)}
+\`\`\``}
+`)}
       />
     );
   },

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "@graphql-eslint/example-custom-rule",`
	`2`	`+ "name": "@graphql-eslint/example-custom-rules",`
`3`	`3`	`"version": "0.0.0",`
`4`	`4`	`"type": "module",`
`5`	`5`	`"repository": "https://github.com/dimaMachina/graphql-eslint",`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ icon: GraphQLIcon`
`5`	`5`
`6`	`6`	# Usage with `.graphql` files
`7`	`7`
`8`		`-<ESLintConfigs gitFolder="graphql-config" graphqlConfigFile="graphql.config.js" />`
	`8`	`+<ESLintConfigs gitFolder="graphql-config" additionalFiles={{ 'GraphQL Config': 'graphql.config.js' }} />`
Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@ export default [`
`41`	`41`
`42`	`42`	`---`
`43`	`43`
`44`		`-<ESLintConfigs gitFolder="code-file" graphqlConfigFile="graphql.config.js" />`
	`44`	`+<ESLintConfigs gitFolder="code-file" additionalFiles={{ 'GraphQL Config': 'graphql.config.js' }} />`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ icon: StackIcon`
`5`	`5`
`6`	`6`	`# Usage to lint different schemas`
`7`	`7`
`8`		`-<ESLintConfigs gitFolder="multiple-projects-graphql-config" graphqlConfigFile="graphql.config.ts" />`
	`8`	`+<ESLintConfigs gitFolder="multiple-projects-graphql-config" additionalFiles={{ 'GraphQL Config': 'graphql.config.ts' }} />`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ icon: HalfIcon`
`5`	`5`
`6`	`6`	`# Usage to lint both schema/operations`
`7`	`7`
`8`		`-<ESLintConfigs gitFolder="monorepo" graphqlConfigFile="graphql.config.js" />`
	`8`	`+<ESLintConfigs gitFolder="monorepo" additionalFiles={{ 'GraphQL Config': 'graphql.config.js' }} />`