adjust docs, ignore more directories, fix tests

Author: amannn

docs/src/pages/docs/usage/plugin.mdx

@@ -128,7 +128,7 @@ If your project is split into multiple folders, you can provide an array of path
 
 ```tsx
 // Not using a `src` folder
-srcPath: ['./app', './components'],
+srcPath: ['./'],
 ```
 
 ```tsx
@@ -141,6 +141,8 @@ srcPath: ['./src', '../ui'],
 srcPath: ['./src', './node_modules/@acme/components'],
 ```
 
+Note that the directories `node_modules`, `.next` and `.git` are automatically excluded from extraction, except for if they appear explicitly in the `srcPath` array.
+
 If you want to provide messages along with your package, you can also extract them [manually](/docs/usage/extraction#manual).
 
 **Note:** The `srcPath` option should be used together with [`extract`](#extract) and [`messages`](#messages).

packages/next-intl/src/extractor/ExtractionCompiler.test.tsx

@@ -2,12 +2,14 @@ import fs from 'fs/promises';
 import path from 'path';
 import {beforeEach, describe, expect, it, vi} from 'vitest';
 import ExtractionCompiler from './ExtractionCompiler.js';
-import SourceFileScanner from './source/SourceFileScanner.js';
 
 const filesystem: {
   project: {
     src: Record<string, string>;
     messages: Record<string, string> | undefined;
+    node_modules?: Record<'@acme', Record<'ui', Record<string, string>>>;
+    '.next'?: Record<string, Record<string, string>>;
+    '.git'?: Record<string, Record<string, string>>;
   };
 } = {
   project: {
@@ -16,19 +18,19 @@ const filesystem: {
   }
 };
 
-describe('json format', () => {
-  beforeEach(() => {
-    filesystem.project = {
-      src: {},
-      messages: {}
-    };
-    delete (filesystem as Record<string, unknown>).ui;
-    fileTimestamps.clear();
-    watchCallbacks.clear();
-    mockWatchers.clear();
-    vi.clearAllMocks();
-  });
+beforeEach(() => {
+  filesystem.project = {
+    src: {},
+    messages: {}
+  };
+  delete (filesystem as Record<string, unknown>).ui;
+  fileTimestamps.clear();
+  watchCallbacks.clear();
+  mockWatchers.clear();
+  vi.clearAllMocks();
+});
 
+describe('json format', () => {
   function createCompiler() {
     return new ExtractionCompiler(
       {
@@ -314,28 +316,28 @@ describe('json format', () => {
       `
     );
     expect(filesystem).toMatchInlineSnapshot(`
-    {
-      "project": {
-        "messages": {
-          "de.json": "{
-      "+YJVTi": "Hallo!"
-    }",
-          "en.json": "{
-      "+YJVTi": "Hey!"
-    }",
-        },
-        "src": {
-          "Greeting.tsx": "
-        import {useExtracted} from 'next-intl';
-        function Greeting() {
-          const t = useExtracted();
-          return <div>{t('Hey!')}</div>;
-        }
-        ",
+      {
+        "project": {
+          "messages": {
+            "de.json": "{
+        "+YJVTi": "Hallo!"
+      }",
+            "en.json": "{
+        "+YJVTi": "Hey!"
+      }",
+          },
+          "src": {
+            "Greeting.tsx": "
+          import {useExtracted} from 'next-intl';
+          function Greeting() {
+            const t = useExtracted();
+            return <div>{t('Hey!')}</div>;
+          }
+          ",
+          },
         },
-      },
-    }
-  `);
+      }
+    `);
 
     simulateManualFileEdit(
       'messages/de.json',
@@ -696,18 +698,6 @@ describe('json format', () => {
 });
 
 describe('po format', () => {
-  beforeEach(() => {
-    filesystem.project = {
-      src: {},
-      messages: {}
-    };
-    delete (filesystem as Record<string, unknown>).ui;
-    fileTimestamps.clear();
-    watchCallbacks.clear();
-    mockWatchers.clear();
-    vi.clearAllMocks();
-  });
-
   function createCompiler() {
     return new ExtractionCompiler(
       {
@@ -1159,83 +1149,103 @@ msgstr "Hallo!"
   });
 });
 
-describe('SourceFileScanner filtering', () => {
+describe('`srcPath` filtering', () => {
   beforeEach(() => {
-    filesystem.project = {
-      src: {},
-      messages: {}
-    };
-    delete (filesystem as Record<string, unknown>).ui;
-    fileTimestamps.clear();
-    watchCallbacks.clear();
-    mockWatchers.clear();
-    vi.clearAllMocks();
-  });
+    filesystem.project.src['Greeting.tsx'] = `
+    import {useExtracted} from 'next-intl';
+    import Panel from '@acme/ui/panel';
+    function Greeting() {
+      const t = useExtracted();
+      return <Panel>{t('Hey!')}</Panel>;
+    }
+    `;
 
-  it('skips node_modules unless requested', async () => {
-    (filesystem.project.src as Record<string, string>)['App.tsx'] =
-      'export default 1;';
-    (filesystem.project as Record<string, unknown>).node_modules = {
-      '@acme': {
-        'design-system': {
-          'Button.tsx': 'export default 1;'
-        }
+    function createNodeModule(moduleName: string) {
+      return `
+      import {useExtracted} from 'next-intl';
+      export default function Module({children}) {
+        const t = useExtracted();
+        return (
+          <div>
+            <h1>{t('${moduleName}')}</h1>
+            {children}
+          </div>
+        )
       }
-    };
-
-    const files = await SourceFileScanner.getSourceFiles([path.join('/project')]);
-
-    expect(files).toContain(path.join('/project', 'src', 'App.tsx'));
-    expect(files).not.toContain(
-      path.join(
-        '/project',
-        'node_modules',
-        '@acme',
-        'design-system',
-        'Button.tsx'
-      )
-    );
-  });
+      `;
+    }
 
-  it('includes explicit node_modules paths', async () => {
-    const designSystemDir = path.join(
-      '/project',
-      'node_modules',
-      '@acme',
-      'design-system'
-    );
-    (filesystem.project as Record<string, unknown>).node_modules = {
+    filesystem.project.node_modules = {
       '@acme': {
-        'design-system': {
-          'Button.tsx': 'export default 1;'
+        ui: {
+          'panel.tsx': createNodeModule('panel.source')
         }
       }
     };
-
-    const files = await SourceFileScanner.getSourceFiles([designSystemDir]);
-
-    expect(files).toEqual([path.join(designSystemDir, 'Button.tsx')]);
+    filesystem.project['.next'] = {
+      build: {
+        'panel.tsx': createNodeModule('panel.compiled')
+      }
+    };
+    filesystem.project['.git'] = {
+      config: {
+        'panel.tsx': createNodeModule('panel.config')
+      }
+    };
   });
 
-  it('skips node_modules in external directories', async () => {
-    const externalRoot = '/ui';
-    (filesystem as Record<string, unknown>).ui = {
-      'index.tsx': 'export default 1;',
-      node_modules: {
-        '@scope': {
-          'Widget.tsx': 'export default 1;'
+  function createCompiler(srcPath: string | Array<string>) {
+    return new ExtractionCompiler(
+      {
+        srcPath,
+        sourceLocale: 'en',
+        messages: {
+          path: './messages',
+          format: 'json',
+          locales: 'infer'
         }
-      }
-    };
+      },
+      {isDevelopment: true, projectRoot: '/project'}
+    );
+  }
 
-    const files = await SourceFileScanner.getSourceFiles([
-      path.join('/project', '../ui')
-    ]);
+  it('skips node_modules, .next and .git by default', async () => {
+    using compiler = createCompiler('./');
+    await compiler.compile(
+      '/project/src/Greeting.tsx',
+      filesystem.project.src['Greeting.tsx']
+    );
+    await waitForWriteFileCalls(1);
+    expect(vi.mocked(fs.writeFile).mock.calls).toMatchInlineSnapshot(`
+      [
+        [
+          "messages/en.json",
+          "{
+        "+YJVTi": "Hey!"
+      }",
+        ],
+      ]
+    `);
+  });
 
-    expect(files).toContain(path.join(externalRoot, 'index.tsx'));
-    expect(files).not.toContain(
-      path.join(externalRoot, 'node_modules', '@scope', 'Widget.tsx')
+  it('includes node_modules if explicitly requested', async () => {
+    using compiler = createCompiler(['./', './node_modules/@acme/ui']);
+    await compiler.compile(
+      '/project/src/Greeting.tsx',
+      filesystem.project.src['Greeting.tsx']
     );
+    await waitForWriteFileCalls(1);
+    expect(vi.mocked(fs.writeFile).mock.calls).toMatchInlineSnapshot(`
+      [
+        [
+          "messages/en.json",
+          "{
+        "JwjlWH": "panel.source",
+        "+YJVTi": "Hey!"
+      }",
+        ],
+      ]
+    `);
   });
 });
 

packages/next-intl/src/extractor/source/SourceFileFilter.tsx

@@ -1,8 +1,15 @@
 import path from 'path';
 
 export default class SourceFileFilter {
-  static readonly EXTENSIONS = ['ts', 'tsx', 'js', 'jsx'];
-  private static readonly IGNORED_DIRECTORIES = ['node_modules', '.next'];
+  public static readonly EXTENSIONS = ['ts', 'tsx', 'js', 'jsx'];
+
+  // Will not be entered, except if explicitly asked for
+  // TODO: At some point we should infer these from .gitignore
+  private static readonly IGNORED_DIRECTORIES = [
+    'node_modules',
+    '.next',
+    '.git'
+  ];
 
   static isSourceFile(filePath: string) {
     const ext = path.extname(filePath);
@@ -32,10 +39,7 @@ export default class SourceFileFilter {
     );
   }
 
-  private static isWithinPath(
-    targetPath: string,
-    basePath: string
-  ): boolean {
+  private static isWithinPath(targetPath: string, basePath: string): boolean {
     const relativePath = path.relative(basePath, targetPath);
     return relativePath === '' || !relativePath.startsWith('..');
   }