Secondary Entry Points Multiple Subdirectories

Type of Issue

[ ] Bug Report
[x] Feature Request

Description

Hello everyone, I want to add secondary entry points to our library but am running into path related issues searching for public_api.ts. I want to clarify if using secondary entry points is applicable with this folder layout.

The library folder layout looks like this:

my_library
└── projects
    └── my-package
        ├── src
        |   ├── lib
        |   |   ├── modules
        |   |   |   ├── my-module-one
        |   |   |   |   ├── component
        |   |   |   |   |   └── ...
        |   |   |   |   ├── component
        |   |   |   |   |   └── ...
        |   |   |   |   ├── index.ts <--
        |   |   |   |   ├── package.json <-- want to add these
        |   |   |   |   ├── public-api.ts <--
        |   |   |   |   └── my-module-one.module.ts
        |   |   |   └── my-module-two
        |   |   |       ├── component
        |   |   |       |   └── ...
        |   |   |       ├── component
        |   |   |       |   └── ...
        |   |   |       ├── index.ts <--
        |   |   |       ├── package.json <-- to each module that contains components
        |   |   |       ├── public-api.ts <--
        |   |   |       └── my-module-two.module.ts
        |   |   ├── index.ts
        |   |   ├── package.json
        |   |   ├── public-api.ts
        |   |   ├── library.module.ts
        |   |   └── library.service.ts
        |   └── public-api.ts (exports everything)
        ├── ng-package.json (targets public-api above)
        └── tsconfig.lib.json

How To Reproduce

When building the first entry point will build with no issues (@name/my-package). Then the next entry point is @name/my-package/src/lib/modules/my-module-one on which it fails with Cannot find module './public_api.ts'

Version Information

ng-packagr: 9.0.0
@angular/*: 9.1.9
typescript: ~3.8.3
rxjs: ~6.5.4
npm: 6.11.3

[SchnWalter]

You can have empty directories without a problem, but AFAIK this is NOT a documented feature and it’s NOT tested to prevent it from being removed in the future or to prevent regressions.

But you can always provide a minimal sub-package (or even a minimal root-package) that just exports something, you only need these files:

• ng-package.json

  {
    "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
    "lib": {
      "entryFile": "public-api.ts"
    }
  }
  

• public-api.ts

  /**
   * @file This file is required for building this "empty" package.
   */
  export const EMPTY_PACKAGE: boolean = true;  // or you could export the package version.
  

Effectively making the package an “empty” package.

Sub-package names include the relative path to the primary package; so, one can have an empty directory as parent for sub-packages and a structure like this example here will work just fine, but AFAIK it’s NOT a documented feature:

/projects/@example/package/src/
├── core
│   ├── ng-package.json
│   └── public-api.ts
├── components
│   ├── badge
│   │   ├── ng-package.json
│   │   └── public-api.ts
│   ├── toggle
│   │   ├── testing
│   │   │   ├── ng-package.json
│   │   │   └── public-api.ts
│   │   ├── ng-package.json
│   │   └── public-api.ts
│   └── testing
│       └── integration
│           ├── ng-package.json
│           └── public-api.ts
├── ng-package.json
├── package.json
└── public-api.ts

And you will have these packages, notice the missing entries for /components and /components/testing sub-packages:

@example/package
@example/package/core
@example/package/components/badge
@example/package/components/toggle
@example/package/components/toggle/testing
@example/package/components/testing/integration

If the library maintainers would like to make this a documented feature, I can quickly extend the tests to watch for these sub-packages that contain “empty directories” in their name.

[github-actions[bot]]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

_{This action has been performed automatically by a bot.}