Fixes incorrect absolute path resolving in the plugin (#37)

* Fixes incorrect absolute path resolving in the plugin

* Reverts changes in the sample project

* Removes unnecessary logs

* Bumps up the version and updates the changelog

Author: kamkry

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.1] - 2022-07-28
+
+### Fixed
+
+- Incorrect relative path resolving
+
 ## [2.0.0] - 2021-29-11
 
 ### Changed

e2e/fixtures/path-config/tsconfig.json

@@ -12,7 +12,7 @@
       {
         "name": "../../dist/plugin",
         "paths": [
-          "./lib"
+          "./included"
         ]
       }
     ]

e2e/plugin/singleFile.spec.ts

@@ -45,4 +45,17 @@ describe('single file diagnostics', () => {
     // then
     expect(diagnostics).toHaveLength(1);
   });
+
+  it('should enable strict mode with a relative path config', async () => {
+    // given
+    const { projectPath, filePaths } = fixtureWithPathConfig;
+
+    // when
+    const diagnosticsIncluded = await getDiagnostics(projectPath, filePaths.included);
+    const diagnosticsExcluded = await getDiagnostics(projectPath, filePaths.excluded);
+
+    // then
+    expect(diagnosticsIncluded).toHaveLength(1);
+    expect(diagnosticsExcluded).toHaveLength(0);
+  });
 });

e2e/tsc-strict/tsc-strict.spec.ts

@@ -1,6 +1,6 @@
 import execa from 'execa';
 import { join } from 'path';
-import { fixtureWithDefaultConfig } from '../fixtures/paths';
+import { fixtureWithDefaultConfig, fixtureWithPathConfig } from '../fixtures/paths';
 
 const runInPath = async (path: string, args: string[] = []): Promise<string> => {
   const cwd = process.cwd();
@@ -35,3 +35,16 @@ it('should detect strict file errors', async () => {
   expect(stdout).toMatch(/Found 1 strict file/i);
   expect(stdout).toMatch(/Found 1 error/i);
 });
+
+it('should enable strict mode with a relative path config', async () => {
+  //given
+  const { projectPath, filePaths } = fixtureWithPathConfig;
+
+  // when
+  const stdout = await runInPath(projectPath);
+
+  // then
+  expect(stdout).not.toEqual(expect.stringContaining(filePaths.excluded));
+  expect(stdout).toEqual(expect.stringContaining(filePaths.included));
+  expect(stdout).toMatch(/error TS2322: Type 'null' is not assignable to type 'string'\./i);
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-strict-plugin",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Typescript tools that help with migration to the strict mode",
   "author": "Allegro",
   "contributors": [

src/cli/update-strict-comments/getFilePaths.ts

@@ -18,5 +18,5 @@ export const getFilePathsOnPathWithoutErrors = (
 ) =>
   allFilePaths.filter(
     (filePath) =>
-      isFileStrictByPath(filePath, configPaths) && !filePathsWithErrors.includes(filePath),
+      isFileStrictByPath({ filePath, configPaths }) && !filePathsWithErrors.includes(filePath),
   );

src/cli/update-strict-comments/updateStrictComments.ts

@@ -47,10 +47,10 @@ export async function updateStrictComments(
   return { updatedFileCount };
 }
 
-function shouldInsertIgnoreComment(filePath: string, strictPaths?: string[]): boolean {
-  return isFileStrictByPath(filePath, strictPaths) && !isIgnoreCommentPresent(filePath);
+function shouldInsertIgnoreComment(filePath: string, configPaths?: string[]): boolean {
+  return isFileStrictByPath({ filePath, configPaths }) && !isIgnoreCommentPresent(filePath);
 }
 
-function shouldRemoveStrictComment(filePath: string, strictPaths?: string[]): boolean {
-  return isFileStrictByPath(filePath, strictPaths) && isStrictCommentPresent(filePath);
+function shouldRemoveStrictComment(filePath: string, configPaths?: string[]): boolean {
+  return isFileStrictByPath({ filePath, configPaths }) && isStrictCommentPresent(filePath);
 }

src/common/__tests__/isFileStrict.spec.ts

@@ -15,7 +15,7 @@ describe('isFileStrict', () => {
   beforeEach(() => {
     jest.clearAllMocks();
 
-    isFileOnPathMock.mockImplementation((_, path) => path === filePath);
+    isFileOnPathMock.mockImplementation(({ targetPath }) => targetPath === filePath);
     isCommentPresent.mockReturnValue(false);
   });
 

src/common/isFileOnPath.ts

@@ -1,8 +1,18 @@
 import { getPosixFilePath } from './utils';
 import { getAbsolutePath } from './getAbsolutePath';
 
-export function isFileOnPath(currentFilePath: string, pathToStrictFiles: string): boolean {
-  const absolutePathToStrictFiles = getAbsolutePath(process.cwd(), pathToStrictFiles);
+interface IsFileOnPathParams {
+  filePath: string;
+  targetPath: string;
+  projectPath?: string;
+}
+
+export function isFileOnPath({
+  filePath,
+  targetPath,
+  projectPath = process.cwd(),
+}: IsFileOnPathParams): boolean {
+  const absolutePathToStrictFiles = getAbsolutePath(projectPath, targetPath);
 
-  return getPosixFilePath(currentFilePath).startsWith(getPosixFilePath(absolutePathToStrictFiles));
+  return getPosixFilePath(filePath).startsWith(getPosixFilePath(absolutePathToStrictFiles));
 }

src/common/isFileStrict.ts

@@ -4,12 +4,18 @@ import { TS_STRICT_COMMENT, TS_STRICT_IGNORE_COMMENT } from './constants';
 
 type IsFileStrictConfig = {
   filePath: string;
+  projectPath?: string;
   config?: Config;
   isCommentPresent: (comment: string, filePath: string) => boolean;
 };
 
 // Common logic determining whether file is strict or not
-export function isFileStrict({ filePath, config, isCommentPresent }: IsFileStrictConfig): boolean {
+export function isFileStrict({
+  filePath,
+  config,
+  projectPath,
+  isCommentPresent,
+}: IsFileStrictConfig): boolean {
   if (isCommentPresent(TS_STRICT_IGNORE_COMMENT, filePath)) {
     return false;
   }
@@ -18,9 +24,10 @@ export function isFileStrict({ filePath, config, isCommentPresent }: IsFileStric
     return true;
   }
 
-  const strictPaths = config?.paths ?? [];
+  const configPaths = config?.paths ?? [];
+  const fileStrictByPath = isFileStrictByPath({ filePath, configPaths, projectPath });
 
-  if (strictPaths.length > 0 && !isFileStrictByPath(filePath, strictPaths)) {
+  if (configPaths.length > 0 && !fileStrictByPath) {
     return false;
   }