Running ui-jar in an NX setup

@nording I like your approach running this tool within a test environment. I tried to run it within an NX setup which has a slightly different structure than pure Angular CLI projects.

├── README.md
├── angular.json
├── apps
│   ├── app1
│   │   ├── browserslist
│   │   ├── src
│   │   ├── tsconfig.app.json
│   │   └── tslint.json
│   └── ui-jar
│       ├── browserslist
│       ├── src
│       │   ├── app
│       │   │   ├── app.component.html
│       │   │   ├── app.component.scss
│       │   │   ├── app.component.ts
│       │   │   └── app.module.ts
│       │   ├── assets
│       │   ├── environments
│       │   │   ├── environment.prod.ts
│       │   │   └── environment.ts
│       │   ├── favicon.ico
│       │   ├── index.html
│       │   ├── main.ts
│       │   ├── polyfills.ts
│       │   ├── styles.scss
│       │   └── test.ts
│       ├── tsconfig.app.json
│       └── tslint.json
├── jest-global-mocks.ts
├── jest.config.js
├── libs
│   ├── lib1
│   │   ├── src
│   │   └── tsconfig.lib.json
│   └── lib2
│       ├── src
│       │   ├── xyz
│       │   │   ├── xyz.component.spec.ts
│       │   │   ├── xyz.component.ts
│       │   └── ute.module.ts
│       └── tsconfig.lib.json
├── nx.json
├── package-lock.json
├── package.json
├── setup-jest.ts
├── tools
├── tsconfig.json
├── tsconfig.spec.json
└── tslint.json

As a testing framework I’m using jest. To me it’s not exactly clear, wherefore the exclude/include setup is and how it can match the expectations within my setup.

Open “projects/ui-jar/tsonfig.app.json” and add following:

"exclude": [
    ...
    "../../src/**/*.spec.ts"
]
"include": [
    "**/*.ts",
    "../../src/**/*.ts"
]

Appreciate your work and feedback.

[alyalin]

I use nx and generated the docs app with this tsconfig.app.json:

{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "outDir": "../../dist/out-tsc/apps/docs",
    "module": "es2015",
    "types": []
  },
  "exclude": [
    "src/test.ts",
    "**/*.spec.ts",
    "../../libs/**/*.spec.ts"
  ],
  "include": [
    "**/*.ts",
    "../../libs/**/*.ts"
  ]
}

NPM scripts:

"ui-jar": "node node_modules/ui-jar/dist/bin/cli.js --directory ./libs/ --includes \\.ts$",
"docs:watch": "npm run ui-jar -- --watch",
"docs:serve": "npm run ui-jar && ng serve docs"

Works as expected.

[paesku]

@picomis thank you pointing me in the right direction.
First I referenced my app’s path for ui-jar instead the ./libs/ path. Second I missed the comment in my component to group it within the sidebar:

/**
 * @group Layout
 * @component LabelValue
 * @description Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 */

Thanks all for help.