Merge pull request #62 from mizdra/update-project-config

Update project config

Author: mizdra

.eslintignore

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint", "ZixuanChen.vitest-explorer"]
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint", "vitest.explorer"]
 }

.eslintrc.cjs

@@ -9,7 +9,7 @@ Create fixtures in the specified directory.
 **Signature:**
 
 ```typescript
-export type CreateIFF = <const T extends Directory, U extends Directory = {}>(directory: T, options?: CreateIFFOptions | undefined, __INTERNAL__prevIFF?: CreateIFFResult<U>) => Promise<CreateIFFResult<MergeDirectory<U, T>>>;
+export type CreateIFF = <const T extends Directory, U extends Directory = {}>(directory: T, options?: CreateIFFOptions, __INTERNAL__prevIFF?: CreateIFFResult<U>) => Promise<CreateIFFResult<MergeDirectory<U, T>>>;
 ```
 **References:** [Directory](./inline-fixture-files.directory.md)<!-- -->, [CreateIFFOptions](./inline-fixture-files.createiffoptions.md)<!-- -->, [CreateIFFResult](./inline-fixture-files.createiffresult.md)
 

.vscode/extensions.json

@@ -9,15 +9,15 @@ Change the root directory and take over the fixture you created.
 **Signature:**
 
 ```typescript
-fork<const U extends Directory>(additionalDirectory: U, forkOptions?: ForkOptions | undefined): Promise<CreateIFFResult<MergeDirectory<T, U>>>;
+fork<const U extends Directory>(additionalDirectory: U, forkOptions?: ForkOptions): Promise<CreateIFFResult<MergeDirectory<T, U>>>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  additionalDirectory | U | The definition of fixtures to be added. |
-|  forkOptions | [ForkOptions](./inline-fixture-files.forkoptions.md) \| undefined | _(Optional)_ The fork options. |
+|  forkOptions | [ForkOptions](./inline-fixture-files.forkoptions.md) | _(Optional)_ The fork options. |
 
 **Returns:**
 

docs/api/inline-fixture-files.createiff.md

@@ -0,0 +1,33 @@
+import mizdra from '@mizdra/eslint-config-mizdra';
+import tsdoc from 'eslint-plugin-tsdoc';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  { ignores: ['**/dist'] },
+  { plugins: { tsdoc } },
+  ...mizdra.baseConfigs,
+  ...mizdra.typescriptConfigs,
+  ...mizdra.nodeConfigs,
+  {
+    files: ['**/*.{ts,tsx,cts,mts}', '**/*.{js,jsx,cjs,mjs}'],
+    rules: {
+      'simple-import-sort/imports': ['error', { groups: [['^\\u0000', '^node:', '^@?\\w', '^', '^\\.']] }],
+      'n/no-unsupported-features/es-syntax': 'off', // temporary
+      'n/no-unsupported-features/node-builtins': 'off', // temporary
+    },
+  },
+  {
+    files: ['**/*.{ts,tsx,cts,mts}'],
+    rules: {
+      'tsdoc/syntax': 'error',
+      // In tsdoc, if you define a method type in a property style, it will not be determined as a method.
+      // Therefore, it forces methods to be defined in method shorthand syntax.
+      '@typescript-eslint/method-signature-style': ['error', 'method'],
+      // In tsdoc, properties of a type defined with `interface` are included in the document,
+      // whereas those defined with `type` are omitted from the document.
+      // So we force types to be defined with `interface` whenever possible.
+      '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+    },
+  },
+  mizdra.prettierConfig,
+];

docs/api/inline-fixture-files.createiffresult.fork.md

@@ -3,11 +3,12 @@ import { rm } from 'node:fs/promises';
 import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 import dedent from 'dedent';
-import { ESLint } from 'eslint';
+import { loadESLint } from 'eslint';
 import { expect, test } from 'vitest';
 import { defineIFFCreator } from '../src/index.js';
 
-// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+const LegacyESLint = await loadESLint({ useFlatConfig: false });
+
 const fixtureDir = join(tmpdir(), 'your-app-name', process.env['VITEST_POOL_ID']!);
 const createIFF = defineIFFCreator({ generateRootDir: () => join(fixtureDir, randomUUID()) });
 
@@ -26,13 +27,21 @@ test('eslint reports lint errors', async () => {
     // 'src/semi.js': dedent`...`,
   });
 
-  const eslint = new ESLint({ cwd: iff.rootDir, useEslintrc: true });
+  const eslint = new LegacyESLint({ cwd: iff.rootDir, useEslintrc: true });
   const results = await eslint.lintFiles([iff.paths['src/semi.js']]);
-  const formatter = await eslint.loadFormatter('unix');
-  const resultText = formatter.format(results);
-  expect(resultText).toStrictEqual(dedent`
-    ${iff.paths['src/semi.js']}:2:25: Missing semicolon. [Error/semi]
-
-    1 problem
-  `);
+  const formatter = await eslint.loadFormatter('json');
+  const resultText = await formatter.format(results);
+  expect(JSON.parse(resultText)).toStrictEqual([
+    expect.objectContaining({
+      filePath: iff.paths['src/semi.js'],
+      messages: [
+        expect.objectContaining({
+          ruleId: 'semi',
+          message: 'Missing semicolon.',
+          line: 2,
+          column: 25,
+        }),
+      ],
+    }),
+  ]);
 });

eslint.config.js

@@ -3,11 +3,12 @@ import { readFile, rm } from 'node:fs/promises';
 import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 import dedent from 'dedent';
-import { ESLint } from 'eslint';
+import { loadESLint } from 'eslint';
 import { describe, expect, it } from 'vitest';
 import { defineIFFCreator } from '../src/index.js';
 
-// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+const LegacyESLint = await loadESLint({ useFlatConfig: false });
+
 const fixtureDir = join(tmpdir(), 'your-app-name', process.env['VITEST_POOL_ID']!);
 const createIFF = defineIFFCreator({ generateRootDir: () => join(fixtureDir, randomUUID()) });
 
@@ -28,15 +29,23 @@ describe('eslint', async () => {
         `,
       },
     });
-    const eslint = new ESLint({ cwd: iff.rootDir, useEslintrc: true });
+    const eslint = new LegacyESLint({ cwd: iff.rootDir, useEslintrc: true });
     const results = await eslint.lintFiles([iff.paths['src/semi.js']]);
-    const formatter = await eslint.loadFormatter('unix');
-    const resultText = formatter.format(results);
-    expect(resultText).toStrictEqual(dedent`
-      ${iff.paths['src/semi.js']}:2:25: Missing semicolon. [Error/semi]
-  
-      1 problem
-    `);
+    const formatter = await eslint.loadFormatter('json');
+    const resultText = await formatter.format(results);
+    expect(JSON.parse(resultText)).toStrictEqual([
+      expect.objectContaining({
+        filePath: iff.paths['src/semi.js'],
+        messages: [
+          expect.objectContaining({
+            ruleId: 'semi',
+            message: 'Missing semicolon.',
+            line: 2,
+            column: 25,
+          }),
+        ],
+      }),
+    ]);
   });
   it('fix lint errors', async () => {
     const iff = await baseIFF.fork({
@@ -46,11 +55,11 @@ describe('eslint', async () => {
         `,
       },
     });
-    const eslint = new ESLint({ cwd: iff.rootDir, useEslintrc: true, fix: true });
+    const eslint = new LegacyESLint({ cwd: iff.rootDir, useEslintrc: true, fix: true });
     const results = await eslint.lintFiles([iff.paths['src/semi.js']]);
 
     expect(await readFile(iff.paths['src/semi.js'], 'utf8')).toMatchInlineSnapshot('"var withoutSemicolon = 2"');
-    await ESLint.outputFixes(results);
+    await LegacyESLint.outputFixes(results);
     expect(await readFile(iff.paths['src/semi.js'], 'utf8')).toMatchInlineSnapshot('"var withoutSemicolon = 2;"');
   });
 });