fix: lcp should not be a file path (#71)

fi3ework · web-flow · commit 109a00aa4c43 · 2024-08-08T03:35:33.000Z
diff --git a/biome.json b/biome.json
@@ -21,6 +21,7 @@
     "ignoreUnknown": true
   },
   "formatter": {
+    "ignore": ["**/.rslib/*"],
     "indentStyle": "space"
   },
   "javascript": {
diff --git a/e2e/cases/bundle-false/index.test.ts b/e2e/cases/bundle-false/index.test.ts
@@ -2,12 +2,40 @@ import { join } from 'node:path';
 import { buildAndGetResults } from '@e2e/helper';
 import { expect, test } from 'vitest';
 
-test('bundle: false', async () => {
+test('basic', async () => {
   const fixturePath = join(__dirname, 'basic');
   const { files } = await buildAndGetResults(fixturePath);
 
-  // TODO: record file paths with inline snapshot
-  // need to add path serialization
-  expect(files.esm?.length).toBe(4);
-  expect(files.cjs?.length).toBe(4);
+  expect(files.esm).toMatchInlineSnapshot(`
+    [
+      "./dist/esm/index.js",
+      "./dist/esm/sum.js",
+      "./dist/esm/utils/numbers.js",
+      "./dist/esm/utils/strings.js",
+    ]
+  `);
+  expect(files.cjs).toMatchInlineSnapshot(`
+    [
+      "./dist/cjs/index.js",
+      "./dist/cjs/sum.js",
+      "./dist/cjs/utils/numbers.js",
+      "./dist/cjs/utils/strings.js",
+    ]
+  `);
+});
+
+test('single file', async () => {
+  const fixturePath = join(__dirname, 'single-file');
+  const { files } = await buildAndGetResults(fixturePath);
+
+  expect(files.esm).toMatchInlineSnapshot(`
+    [
+      "./dist/esm/index.js",
+    ]
+  `);
+  expect(files.cjs).toMatchInlineSnapshot(`
+    [
+      "./dist/cjs/index.js",
+    ]
+  `);
 });
diff --git a/e2e/cases/bundle-false/single-file/rslib.config.ts b/e2e/cases/bundle-false/single-file/rslib.config.ts
@@ -0,0 +1,18 @@
+import { generateBundleCjsConfig, generateBundleEsmConfig } from '@e2e/helper';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig(__dirname, {
+      bundle: false,
+    }),
+    generateBundleCjsConfig(__dirname, {
+      bundle: false,
+    }),
+  ],
+  source: {
+    entry: {
+      main: ['./src/**'],
+    },
+  },
+});
diff --git a/e2e/cases/bundle-false/single-file/src/index.ts b/e2e/cases/bundle-false/single-file/src/index.ts
@@ -0,0 +1 @@
+export const foo = 'foo';
diff --git a/e2e/cases/bundle-false/single-file/tsconfig.json b/e2e/cases/bundle-false/single-file/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "@rslib/tsconfig/base",
+  "compilerOptions": {
+    "baseUrl": "./"
+  },
+  "include": ["src"]
+}
diff --git a/e2e/scripts/shared.ts b/e2e/scripts/shared.ts
@@ -83,7 +83,7 @@ export async function getResults(
     }
 
     if (fileSet.length) {
-      files[libConfig.format!] = fileSet;
+      files[libConfig.format!] = fileSet.sort();
       contents[libConfig.format!] = filterContent;
     }
 
diff --git a/e2e/setupVitestTests.ts b/e2e/setupVitestTests.ts
diff --git a/e2e/vitest.config.ts b/e2e/vitest.config.ts
@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config';
+import { shared } from '../vitest.workspace';
+
+export default defineConfig({
+  test: {
+    ...shared,
+    name: 'artifact',
+    setupFiles: ['./setupVitestTests.ts'],
+    include: ['./cases/**/*.test.ts'],
+    exclude: ['./cases/**/*.pw.test.ts', '**/node_modules/**'],
+  },
+});
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "prettier-plugin-packagejson": "^2.5.0",
     "simple-git-hooks": "^2.11.1",
     "typescript": "^5.5.3",
-    "vitest": "^2.0.1"
+    "vitest": "^2.0.5"
   },
   "packageManager": "pnpm@9.5.0",
   "engines": {
diff --git a/packages/core/__mocks__/fs.cjs b/packages/core/__mocks__/fs.cjs
@@ -0,0 +1,5 @@
+// we can also use `import`, but then
+// every export should be explicitly defined
+
+const { fs } = require('memfs');
+module.exports = fs;
diff --git a/packages/core/__mocks__/fs/promises.cjs b/packages/core/__mocks__/fs/promises.cjs
@@ -0,0 +1,5 @@
+// we can also use `import`, but then
+// every export should be explicitly defined
+
+const { fs } = require('memfs');
+module.exports = fs.promises;
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -47,6 +47,7 @@
     "commander": "^12.1.0",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
+    "memfs": "^4.11.1",
     "picocolors": "1.0.1",
     "prebundle": "1.1.0",
     "rslog": "^1.2.2",
diff --git a/packages/core/src/config.ts b/packages/core/src/config.ts
@@ -285,7 +285,7 @@ const composeEntryConfig = async (
     }
 
     // Similar to `rootDir` in tsconfig and `outbase` in esbuild.
-    const lcp = calcLongestCommonPath(resolvedEntryFiles);
+    const lcp = await calcLongestCommonPath(resolvedEntryFiles);
     // Using the longest common path of all non-declaration input files by default.
     const outBase = lcp === null ? root : lcp;
 
diff --git a/packages/core/src/utils/extension.ts b/packages/core/src/utils/extension.ts
@@ -24,15 +24,26 @@ export const getDefaultExtension = (options: {
     };
   }
 
+  const pkgJsonPath = resolve(root, './package.json');
+  if (!fs.existsSync(pkgJsonPath)) {
+    logger.warn(
+      `package.json does not exist in ${pkgJsonPath}, autoExtension will not be applied.`,
+    );
+    return {
+      jsExtension,
+      dtsExtension,
+    };
+  }
+
   let isModule = false;
 
   try {
-    const json = JSON.parse(
-      fs.readFileSync(resolve(root, './package.json'), 'utf8'),
-    );
+    const json = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'));
     isModule = json.type === 'module';
   } catch (e) {
-    logger.warn(`package.json is broken in ${root}`);
+    logger.warn(
+      `Failed to parse ${pkgJsonPath}, it might not be valid JSON, autoExtension will not be applied.`,
+    );
     return {
       jsExtension,
       dtsExtension,
diff --git a/packages/core/src/utils/helper.ts b/packages/core/src/utils/helper.ts
@@ -1,3 +1,4 @@
+import fsP from 'node:fs/promises';
 import path from 'node:path';
 import color from 'picocolors';
 
@@ -67,26 +68,35 @@ export const nodeBuiltInModules: Array<string | RegExp> = [
   'pnpapi',
 ];
 
-function calcLongestCommonPath(absPaths: string[]): string | null {
+async function calcLongestCommonPath(
+  absPaths: string[],
+): Promise<string | null> {
   if (absPaths.length === 0) {
     return null;
   }
 
   const splitPaths = absPaths.map((p) => p.split(path.sep));
-  let lca = splitPaths[0]!;
+  let lcaFragments = splitPaths[0]!;
   for (let i = 1; i < splitPaths.length; i++) {
     const currentPath = splitPaths[i]!;
-    const minLength = Math.min(lca.length, currentPath.length);
+    const minLength = Math.min(lcaFragments.length, currentPath.length);
 
     let j = 0;
-    while (j < minLength && lca[j] === currentPath[j]) {
+    while (j < minLength && lcaFragments[j] === currentPath[j]) {
       j++;
     }
 
-    lca = lca.slice(0, j);
+    lcaFragments = lcaFragments.slice(0, j);
   }
 
-  return lca.length > 0 ? lca.join(path.sep) : '/';
+  let lca = lcaFragments.length > 0 ? lcaFragments.join(path.sep) : '/';
+
+  const stats = await fsP.stat(lca);
+  if (stats?.isFile()) {
+    lca = path.dirname(lca);
+  }
+
+  return lca;
 }
 
 export { color, calcLongestCommonPath };
diff --git a/packages/core/tests/helper.test.ts b/packages/core/tests/helper.test.ts
@@ -1,26 +1,52 @@
-import { describe, expect, it } from 'vitest';
+import { vol } from 'memfs';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { calcLongestCommonPath } from '../src/utils/helper';
 
+vi.mock('node:fs');
+vi.mock('node:fs/promises');
+
 describe('LCA calculate correctly', () => {
-  it('empty array', () => {
-    const result = calcLongestCommonPath([]);
+  beforeEach(() => {
+    vol.reset();
+  });
+
+  it('empty array', async () => {
+    const result = await calcLongestCommonPath([]);
     expect(result).toBe(null);
   });
 
-  it('correct 1', () => {
-    const result = calcLongestCommonPath([
+  it('correct 1', async () => {
+    vol.fromJSON({ '/Users/Someone/project-a/src': null });
+
+    const result = await calcLongestCommonPath([
       '/Users/Someone/project-a/src/helpers',
       '/Users/Someone/project-a/src',
       '/Users/Someone/project-a/src/utils',
     ]);
     expect(result).toBe('/Users/Someone/project-a/src');
   });
 
-  it('correct 2', () => {
-    const result = calcLongestCommonPath([
-      '/Users/Someone/project-monorepo/packages-a/src',
-      '/Users/Someone/project-monorepo/packages-util/src',
+  it('correct 2', async () => {
+    vol.fromJSON({ '/Users/Someone/project-monorepo': null });
+
+    const result = await calcLongestCommonPath([
+      '/Users/Someone/project-monorepo/packages-a/src/index.ts',
+      '/Users/Someone/project-monorepo/packages-util/src/index.js',
+      '/Users/Someone/project-monorepo/script.js',
     ]);
+
     expect(result).toBe('/Users/Someone/project-monorepo');
   });
+
+  it('correct 3', async () => {
+    vol.fromJSON({
+      '/Users/Someone/project/src/index.js': '',
+    });
+
+    const result = await calcLongestCommonPath([
+      '/Users/Someone/project/src/index.js',
+    ]);
+
+    expect(result).toBe('/Users/Someone/project/src');
+  });
 });
diff --git a/packages/core/vitest.config.ts b/packages/core/vitest.config.ts
@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config';
+import { shared } from '../../vitest.workspace';
+
+export default defineConfig({
+  test: {
+    ...shared,
+    name: 'unit',
+  },
+});
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/dictionary.txt b/scripts/dictionary.txt
diff --git a/vitest.workspace.ts b/vitest.workspace.ts

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ export async function getResults(`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`if (fileSet.length) {`
`86`		`- files[libConfig.format!] = fileSet;`
	`86`	`+ files[libConfig.format!] = fileSet.sort();`
`87`	`87`	`contents[libConfig.format!] = filterContent;`
`88`	`88`	`}`
`89`	`89`