TypeScript cannot find module with non-relative path 'src/xxx'

Question

I had meet the problem that resolve non-relative moduels in typescript. And try baseUrl, paths and so on, but it not works....

tsconfig.json

{
  "compilerOptions": {
    "allowJs": true,
    "baseUrl": ".",
    "esModuleInterop": true,
    "module": "commonjs",
    "sourceMap": true,
    "strict": true,
    "target": "esnext",
    "typeRoots": ["node_modules/@types"]
 }
}

The project dirs:

root
  ├─src
    ├── APIs
    ├── config
    ├── constants
    ├── middlewares
    ├── models
    ├── routes
    ├── services
          - foo.ts   
    ├── utils
    └── app.ts

in app.ts

import foo from 'src/services/foo'

And run with ts-node src/app.ts.

But the error occurs:

Cannot find module 'src/services/foo'

score 4 · Answer 1 · answered May 06 '19 at 14:19

4

Finally, I add paths option to resolve it.

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": ".",
    "esModuleInterop": true,
    "module": "commonjs",
    "moduleResolution": "node",
    "removeComments": true,
    "sourceMap": true,
    "target": "esnext",
    "strict": true,
    "noUnusedLocals": true,
    "paths": {
      "@/*": ["src/*"]
    },
    "typeRoots": ["./src/@types", "./node_modules/@types"]
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/node_modules/*", "**/*.spec.ts"]
}

In app.ts:

import foo from '@/services/foo'

answered May 06 '19 at 14:19

junlin

1,835
2
25
38

4

Not a really nice solution. Should work without the '@/' – balanceglove2 Jul 13 '21 at 08:12
I think you are better to define it as `"@src/*": ["src/*"]` so can use the more distinguisable `import foo from '@src/services/foo'` – HankCa Nov 02 '22 at 05:47

score 1 · Answer 2 · edited Jul 17 '23 at 14:53

You will need to add tsconfig-paths and module-alias to package.json like this:

    "_moduleDirectories:" ["src"]

And in app.ts use:

    import 'module-alias/register';

You will also need to create tsconfig-path.js file in your root directory that should look like this:

const tsConfigPaths = require('tsconfig-paths');
const tsConfig = require('./tsconfig.json');
tsConfigPaths.register({
    baseUrl: tsConfig.compilerOptions.outDir,
    paths: tsConfig.compilerOptions.paths,
});

Also change tsconfig.json:

{
    "compilerOptions": {
        "baseUrl": "src",
        "paths": {
            "*":["./*"]
        }
    },
    "exclude": ["node_modules"],
    "include": ["./src/**/*.ts"]
}

TypeScript cannot find module with non-relative path 'src/xxx'

2 Answers2