I'm encountering two problems with my TypeScript project.
Imagine I have a interface-only TypeScript project called myproject-api. My plan is to implement the interfaces in two separate projects named myproject-impl1 and myroject-impl2. I am utilizing Lerna to manage these modules as part of a root project named myproject, all of which have been appropriately bootstrapped using npm link. Additionally, I am using gulp for transpilation of TypeScript source code, with a simple configuration setup at this point.
Problem 1: Despite adding "types": "dist/main.d.ts" or "types": "src/index.ts" to the package.json file, the implementation module is unable to recognize the type definitions from myproject-api. Even moving myproject-api/src/index.ts to myproject-api/index.ts did not solve the issue. The compiler consistently throws an error stating Cannot find module 'myproject-api'.
Problem 2: It appears that TypeScript does not generate the .d.ts files if there are no actual implementations in the .ts source files, unless I compile the project specifically using tsc -d --outFile dist/main.js. Essentially, when compiling with the tsconfig.json configuration (e.g., tsc --project tsconfig.json), the .js files are generated but not the .d.ts files.
P.S.: This project was initiated to refine some conceptual ideas I had in mind. If anyone has suggestions for improving this project layout, I would appreciate your input.
More Information...
All .ts projects utilize ES6 imports.
Here is the folder structure:
.
├── lerna.json
├── package.json
├── packages
│ ├── myproject-api
│ | ├── dist
│ │ ├── gulpfile.js
│ │ ├── package.json
│ │ ├── src
│ │ │ └── index.ts
│ │ └── tsconfig.json
│ └── myproject-impl*
│ ├── dist
│ ├── gulpfile.js
│ ├── package.json
│ ├── src
│ │ └── index.ts
│ └── tsconfig.json
└── README.md
packages/myproject-api/src/someClass.tsexport interface ISomeClass { /* ... */ }
packages/myproject-api/src/index.tsexport * from "./someClass.ts"
// (repeating this kind of export for all inner modules)
packages/myproject-impl*/src/index.tsimport { ISomeClass } from "myproject-api"
// ...
Gulp Configuration:
var gulp = require("gulp");
var ts = require("gulp-typescript");
var tsProject = ts.createProject("tsconfig.json");
gulp.task("default", ["build"]);
gulp.task("build", function () {
return tsProject.src()
.pipe(tsProject())
.js.pipe(gulp.dest("."));
});
This represents the shared tsconfig.json across all projects:
{
"compilerOptions": {
"target": "es6",
"module": "amd",
"strict": true,
"baseUrl": ".",
"outFile": "dist/main.js",
"declaration": true,
"lib": [
"es5",
"es2015.promise",
"es2015.iterable"
]
},
"exclude": [
"node_modules",
"dist"
]
}
System Information:
[flisboac@sonic ~]$ tsc --version
Version 2.6.2
[flisboac@sonic ~]$ node --version
v9.3.0
[flisboac@sonic ~]$ lerna --version
2.5.1
[flisboac@sonic ~]$ gulp --version
[03:39:24] CLI version 2.0.0
[flisboac@sonic ~]$ npm --version
5.6.0
[flisboac@sonic ~]$ uname -a
Linux sonic 4.14.6-1-ARCH #1 SMP PREEMPT Thu Dec 14 21:26:16 UTC 2017 x86_64 GNU/Linux
[flisboac@sonic ~]$ lsb_release -a
LSB Version: 1.4
Distributor ID: Arch
Description: Arch Linux
Release: rolling
Codename: n/a