Husky 無法解析 tsconfig.ts 的路徑

Question

我正在使用 Jest 進行單元測試，並且在我的 tsconfig.json 中有自定義paths ，在本地可以正常工作。

但是，當我嘗試通過 husky 和 ​​lint-staged 提交更改時，會出現“找不到測試文件”或“無法解析 @core/..”之類的錯誤。

我們是否必須對 husky 進行自定義配置以允許親屬路徑通過 husky ？

我的 tsconfig.json ：

{
  "ts-node": {
    "transpileOnly": true,
    "require": [ "typescript-transform-paths/register" ]
  },
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "rootDirs": ["./src", "./build"],
    "baseUrl": "src",
    "paths": {
      "@core/*": ["core/*"],
      "@api/*": ["api/*"]
    },
    "plugins": [
      { "transform": "typescript-transform-paths" },
      { "transform": "typescript-transform-paths", "afterDeclarations": true }
    ],
    "resolveJsonModule": true,
    "declaration": true,
    "outDir": "./build",
    "importHelpers": true,
    "importsNotUsedAsValues": "remove",
    "noEmitOnError": true,
    "declarationDir": "build/@types",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "strictFunctionTypes": true,
    "strictBindCallApply": true,
    "strictPropertyInitialization": true,
    "noImplicitThis": true,
    "useUnknownInCatchVariables": true,
    "alwaysStrict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "exactOptionalPropertyTypes": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true,
    "noUncheckedIndexedAccess": true,
    "noImplicitOverride": true,
    "noPropertyAccessFromIndexSignature": true,
    "allowUnusedLabels": true,
    "allowUnreachableCode": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*.ts", "tests/**/*.ts", ".husky/**/*"],
  "exclude": ["node_modules", ".vscode"]
}

我的 jest.config.ts 文件：

// For a detailed explanation regarding each configuration property and type check, visit:
// https://jestjs.io/docs/configuration

// eslint-disable-next-line import/no-extraneous-dependencies
import { pathsToModuleNameMapper } from "ts-jest/dist";
import { compilerOptions } from "./tsconfig.json";

export default {
    // All imported modules in your tests should be mocked automatically
    automock: false,

    // Stop running tests after `n` failures
    // bail: 0,

    // The directory where Jest should store its cached dependency information
    // cacheDirectory: "C:\\Users\\ssoylu\\AppData\\Local\\Temp\\jest",

    // Automatically clear mock calls, instances, contexts and results before every test
    clearMocks: true,

    // Indicates whether the coverage information should be collected while executing the test
    collectCoverage: false,

    // An array of glob patterns indicating a set of files for which coverage information should be collected
    collectCoverageFrom: ["<rootDir>/**/*.ts"],

    // The directory where Jest should output its coverage files
    coverageDirectory: "tests/coverage",

    // An array of regexp pattern strings used to skip coverage collection
    coveragePathIgnorePatterns: ["/tests/"],

    // Indicates which provider should be used to instrument code for coverage
    coverageProvider: "babel",

    // A list of reporter names that Jest uses when writing coverage reports
    coverageReporters: ["json", "text", "lcov", "clover"],

    // An object that configures minimum threshold enforcement for coverage results
    // coverageThreshold: undefined,

    // A path to a custom dependency extractor
    // dependencyExtractor: undefined,

    // Make calling deprecated APIs throw helpful error messages
    errorOnDeprecated: true,

    // The default configuration for fake timers
    // fakeTimers: {
    //   "enableGlobally": false
    // },

    // Force coverage collection from ignored files using an array of glob patterns
    // forceCoverageMatch: [],

    // A path to a module which exports an async function that is triggered once before all test suites
    // globalSetup: undefined,

    // A path to a module which exports an async function that is triggered once after all test suites
    // globalTeardown: undefined,

    // A set of global variables that need to be available in all test environments
    // globals: {},

    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
    maxWorkers: "10%",

    // An array of directory names to be searched recursively up from the requiring module's location
    moduleDirectories: ["src", "node_modules"],

    // An array of file extensions your modules use
    moduleFileExtensions: ["js", "mjs", "ts", "tsx", "json"],

    // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),

    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
    // modulePathIgnorePatterns: [],

    // Activates notifications for test results
    // notify: false,

    // An enum that specifies notification mode. Requires { notify: true }
    // notifyMode: "failure-change",

    // A preset that is used as a base for Jest's configuration
    preset: "ts-jest",

    // Run tests from one or more projects
    // projects: undefined,

    // Use this configuration option to add custom reporters to Jest
    // reporters: undefined,

    // Automatically reset mock state before every test
    resetMocks: true,

    // Reset the module registry before running each individual test
    // resetModules: false,

    // A path to a custom resolver
    // resolver: undefined,

    // Automatically restore mock state and implementation before every test
    // restoreMocks: false,

    // The root directory that Jest should scan for tests and modules within
    rootDir: "./tests",

    // A list of paths to directories that Jest should use to search for files in
    // roots: ["tests", "src"],

    // Allows you to use a custom runner instead of Jest's default test runner
    // runner: "jest-runner",

    // The paths to modules that run some code to configure or set up the testing environment before each test
    // setupFiles: [],

    // A list of paths to modules that run some code to configure or set up the testing framework before each test
    // setupFilesAfterEnv: [],

    // The number of seconds after which a test is considered as slow and reported as such in the results.
    slowTestThreshold: 5,

    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
    // snapshotSerializers: [],

    // The test environment that will be used for testing
    // testEnvironment: "jest-environment-node",

    // Options that will be passed to the testEnvironment
    // testEnvironmentOptions: {},

    // Adds a location field to test results
    // testLocationInResults: false,

    // The glob patterns Jest uses to detect test files
    testMatch: ["**/launcher.test.ts?(x)"],

    // This option allows the use of a custom results processor
    // testResultsProcessor: undefined,

    // This option allows use of a custom test runner
    // testRunner: "jest-circus/runner",

    // A map from regular expressions to paths to transformers
    // transform: undefined,

    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
    // transformIgnorePatterns: [
    //   "\\\\node_modules\\\\",
    //   "\\.pnp\\.[^\\\\]+$"
    // ],

    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
    // unmockedModulePathPatterns: undefined,

    // Indicates whether each individual test should be reported during the run
    // verbose: undefined,

    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
    // watchPathIgnorePatterns: [],

    // Whether to use watchman for file crawling
    // watchman: true,
};

Answer 1

沙啞！

假設 #1你沒有lint-staged配置？ 😅

更新：再次考慮后，如果這是一個問題，那么您還有另一個問題，因為這只會解決掉毛問題，但您說 Jest 也是如此。 無論如何，可能有2個問題^^偽裝成1。

要么是lintstagedrc.yml|yaml|json

...或來自package.json的示例

"lint-staged": {
    "*.{ts,tsx,json,scss,md}": [
      "prettier --write"
    ],
    "*.{ts,tsx}": [
      "eslint --max-warnings=0"
    ]
  },

lint-staged也解釋了這一點：

• 安裝和設置#4
• 配置

假設 #2不同的路徑別名表示法

可能沒什么，但您也可以像這樣設置路徑：

{
  "compilerOptions": {
    "baseUrl": "./src",
    "paths": {
      "@api": ["./api"],
      "@core": ["./core"],
    }
  }
}

我沒有測試過：

• *符號在您的配置中
• @前綴在我們的項目中也沒有使用

Answer 2

您應該在jest.config.ts中配置路徑，以便 Jest 解析模塊。

module.exports = {
  // ... existing JEST config
  "moduleNameMapper": {
    "@core/(.*)": [
      "<rootDir>/src/core/$1"
    ],
    "@api/(.*)": [
      "<rootDir>/src/api/$1"
    ]
  }
}