Not able to exclude node_modules folder #319

Migronon · 2016-10-28T14:54:28Z

I run the following command on an Angular2 project:

typedoc --experimentalDecorators --target 'es5' --module 'commonjs' --externalPattern node_modules --excludeExternals --ignoreCompilerErrors --out docs/ web/

I am apparently not able to properly exclude the node_modules folder from the documentation. Whatever I do, the node_modules packages get documented. This is the folder structure
/web
_ _/app
_ _/assets
_ _/e2e
_ _/node_modules
_ _/typings

I tried using exclude and externalPattern + excludeExternals. I tried many combinations of patterns, but apparently I am doing it wrong. I tried values like this:
node_modules
/node_modules/
node_modules/**
node_modules/*/.ts
etc.

I would be very grateful if someone pointed out my mistake and made a couple of examples how the patterns should be defined?

The text was updated successfully, but these errors were encountered:

jtc10005 · 2016-11-15T18:35:04Z

I used
"externalPattern": "**/node_modules/**",
or
"exclude": "**/node_modules/**"
in my typedoc.json (I can't remember which)

derushio · 2017-10-28T10:24:24Z

I succeeded with this command.
typedoc --excludeExternals --externalPattern "**/node_modules/**" --ignoreCompilerErrors --name "$PROJ_NAME" --mode "file" --out "../document/typedoc/" "$SRC_DIR"

but, printed many error logs.

btgoodwin · 2017-11-02T13:09:04Z

I left the ignoreCompilerErrors off on mine and didn't have any error logs.

The problem I'm trying to solve is having links/references put into the docs that are to my local project's node_modules directory when I generate the documentation. There doesn't seem to be a way to stop that behavior.

Edit: What I ended up doing was adding a "docs:sanitize" to my package.json:

    "docs": "npm run docs:clean && npm run docs:generate && npm run docs:sanitize",
    "docs:clean": "rimraf docs",
    "docs:generate": "typedoc --options typedoc.json --out docs src/lib",
    "docs:sanitize": "sed -i 's|'$PWD'||g' $(find docs -type f)"

bluelovers · 2018-02-17T04:05:32Z

i can't exclude too

  "scripts": {
    "doc": "typedoc --theme markdown --out ./docs --ignoreCompilerErrors --exclude **/{node_modules,test,doc}/**/* .",
    "doc2": "typedoc --theme markdown --externalPattern \"**/(node_modules|test|doc)/**\" --out ./docs --ignoreCompilerErrors --exclude \"**/(node_modules|test|doc)/**/*\" .",
    "doc3": "typedoc --theme markdown --out ./docs --ignoreCompilerErrors .",
    "test": "npx mocha \"!(node_modules)\\**\\*.+(test|spec).js\""
  },

they all print

> typedoc --theme markdown --out ./docs --ignoreCompilerErrors .

Loaded plugin typedoc-plugin-markdown

Using TypeScript 2.7.1 from node_modules\typescript\lib
Error: node_modules/@types/node/index.d.ts(41)
 Cannot redeclare block-scoped variable 'Error'.
Error: node_modules/@types/node/index.d.ts(80)
 Cannot redeclare block-scoped variable 'String'.
Error: node_modules/typescript/lib/lib.d.ts(24)
 Cannot redeclare block-scoped variable 'NaN'.
Error: node_modules/typescript/lib/lib.d.ts(25)
 Cannot redeclare block-scoped variable 'Infinity'.
Error: node_modules/typescript/lib/lib.es2018.full.d.ts(15467)
 Duplicate identifier 'VisibilityState'.
Error: node_modules/typescript/lib/lib.es2018.full.d.ts(15468)
 Duplicate identifier 'XMLHttpRequestResponseType'.
Error: node_modules/typescript/lib/lib.es2018.full.d.ts(15684)
 Duplicate identifier 'SafeArray'.
Error: node_modules/typescript/lib/lib.es2018.full.d.ts(15768)
 Duplicate identifier 'VarDate'.
Error: node_modules/typescript/lib/lib.es2018.full.d.ts(15777)
 Cannot redeclare block-scoped variable 'Date'.
Error: node_modules/typescript/lib/lib.es5.d.ts(24)
 Cannot redeclare block-scoped variable 'NaN'.
Error: node_modules/typescript/lib/lib.es5.d.ts(25)
 Cannot redeclare block-scoped variable 'Infinity'.
Error: node_modules/typescript/lib/lib.es5.d.ts(4076)
 Cannot redeclare block-scoped variable 'String'.
Error: node_modules/typescript/lib/lib.es5.d.ts(4086)
 Cannot redeclare block-scoped variable 'Number'.
Error: node_modules/typescript/lib/lib.es5.d.ts(4095)
 Cannot redeclare block-scoped variable 'Date'.
Error: node_modules/typescript/lib/lib.es6.d.ts(24)
 Cannot redeclare block-scoped variable 'NaN'.
Error: node_modules/typescript/lib/lib.es6.d.ts(25)
 Cannot redeclare block-scoped variable 'Infinity'.
Error: node_modules/typescript/lib/lib.es6.d.ts(106)
 Duplicate string index signature.
Error: node_modules/typescript/lib/lib.es6.d.ts(109)
 Cannot redeclare block-scoped variable 'Object'.
Error: node_modules/typescript/lib/lib.es6.d.ts(256)
 Cannot redeclare block-scoped variable 'Object'.
Error: node_modules/typescript/lib/lib.es6.d.ts(261)
 Cannot redeclare block-scoped variable 'Function'.
Error: node_modules/typescript/lib/lib.es6.d.ts(305)
 Cannot redeclare block-scoped variable 'Function'.
Error: node_modules/typescript/lib/lib.es6.d.ts(308)
 Duplicate number index signature.
Error: node_modules/typescript/lib/lib.es6.d.ts(313)
 Cannot redeclare block-scoped variable 'String'.
Error: node_modules/typescript/lib/lib.es6.d.ts(446)
 Cannot redeclare block-scoped variable 'String'.
Error: node_modules/typescript/lib/lib.es6.d.ts(448)
 Cannot redeclare block-scoped variable 'Boolean'.
Error: node_modules/typescript/lib/lib.es6.d.ts(459)
 Cannot redeclare block-scoped variable 'Boolean'.
Error: node_modules/typescript/lib/lib.es6.d.ts(461)
 Cannot redeclare block-scoped variable 'Number'.
Error: node_modules/typescript/lib/lib.es6.d.ts(521)
 Cannot redeclare block-scoped variable 'Number'.
Error: node_modules/typescript/lib/lib.es6.d.ts(527)
 Cannot redeclare block-scoped variable 'Math'.
Error: node_modules/typescript/lib/lib.es6.d.ts(636)
 Cannot redeclare block-scoped variable 'Math'.
Error: node_modules/typescript/lib/lib.es6.d.ts(639)
 Cannot redeclare block-scoped variable 'Date'.
Error: node_modules/typescript/lib/lib.es6.d.ts(818)
 Cannot redeclare block-scoped variable 'Date'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15466)
 Duplicate identifier 'ScopedCredentialType'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15467)
 Duplicate identifier 'ServiceWorkerState'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15468)
 Duplicate identifier 'Transport'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15469)
 Duplicate identifier 'VideoFacingModeEnum'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15470)
 Duplicate identifier 'VisibilityState'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15471)
 Duplicate identifier 'XMLHttpRequestResponseType'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15687)
 Duplicate identifier 'SafeArray'.
Error: node_modules/typescript/lib/lib.esnext.full.d.ts(15771)
 Duplicate identifier 'VarDate'.
Error: node_modules/typescript/lib/lib.scripthost.d.ts(226)
 Duplicate identifier 'SafeArray'.
Error: node_modules/typescript/lib/lib.scripthost.d.ts(310)
 Duplicate identifier 'VarDate'.
Error: node_modules/typescript/lib/lib.webworker.d.ts(1968)
 Duplicate identifier 'ResponseType'.
Error: node_modules/typescript/lib/lib.webworker.d.ts(1969)
 Duplicate identifier 'ServiceWorkerState'.
Error: node_modules/typescript/lib/lib.webworker.d.ts(1970)
 Duplicate identifier 'VisibilityState'.
Error: node_modules/typescript/lib/lib.webworker.d.ts(1971)
 Duplicate identifier 'XMLHttpRequestResponseType'.
Error: test/_local-dev.d.ts(0)
 Cannot find module 'chai'.
Error: test/_local-dev.d.ts(1)
 Cannot find module 'chai'.


Documentation generated at 


Process finished with exit code 0

Edited to shorten comment

alexisbg · 2018-06-06T19:52:18Z

Add:
"skipLibCheck": true
to tsconfig.json compilerOptions.

stephan-nordnes-eriksen · 2018-08-17T12:23:21Z

I did not have success with any of the proposed solutions here. My specific issue is with @types/bluebird:

...myProject/node_modules/@types/sequelize/node_modules/@types/bluebird/index.d.ts(944)

(of course the --ignoreCompilerErrors works, but that seems wrong. It might skip real issues.)

StJohn3D · 2018-10-15T20:34:13Z

Same issue here, none-of the proposed solutions have worked for me, and I am on the latest v0.13.0 as of writing this.

I'm just trying to generate json and it's including all of the node_modules .d.ts files in there.
For now I'm just dealing with it, the other thing is that the node_modules get absolute paths. So I've got a script to transform all of the fileName paths from absolute to relative in the exported jsonFile. I wouldn't need that script and the output would be much faster/smaller if node_modules could actually be ignored.

Gerrit0 · 2018-11-01T16:44:57Z

Here's an overview of how the exclude option works now, and a few notes on potential issues with changing it.

User runs typedoc [options] <files/dirs>
files/dirs are expanded by Application.expandInputFiles
The expanded array of files is passed to ts.createProgram in the Converter.convert function.
TypeScript (not TypeDoc!) resolves any dependencies which are not included in the input files, and loads typing files. By default, this includes all .d.ts files under node_modules/@types.

It's important to note that this is expected behavior. TypeScript needs those files in order to correctly type the files we provided. Without it, you would likely end up with a lot of any showing up in your docs.
TypeDoc then loops over all project source files, without filtering according to the exclude array. This is what is causing the unexpected behavior here.

The obvious fix is to filter source files based on the exclude pattern... but this raises a few more issues.

We need to silently ignore any errors in files that are excluded... but what should be done about errors that are caused by misusing an imported type in an ignored file?
What happens when we reference a type from an excluded file? Just printing the type name doesn't really help anyone trying to read the docs.

Fixes #319 Fixes #839

* Avoid documenting excluded files. Fixes #319 Fixes #839 * Remove grunt Closes #836 * Add script to test with ts-node * Correct handling of declaration files * Delete __events.ts Unused file * Update updating instructions * Correct build & test instructions * Correct grammar

agfe2silver · 2024-01-05T09:20:12Z

Add: "skipLibCheck": true to tsconfig.json compilerOptions.

Still working with TypeDoc version 0.25.6

aciccarello added bug Functionality does not match expectation Priority: 1 labels Nov 1, 2018

aciccarello mentioned this issue Nov 1, 2018

Document only a library's exported files from a given starting point #639

Closed

Gerrit0 mentioned this issue Nov 4, 2018

Can't Exclude anything!? #839

Closed

Gerrit0 added a commit that referenced this issue Nov 4, 2018

Avoid documenting excluded files.

b1d4e1c

Fixes #319 Fixes #839

Gerrit0 mentioned this issue Nov 4, 2018

Avoid documenting excluded files. #896

Merged

aciccarello closed this as completed in #896 Dec 19, 2018

aciccarello pushed a commit that referenced this issue Dec 19, 2018

Avoid documenting excluded files. (#896)

1c4c515

Fixes #319 Fixes #839

9oelM mentioned this issue Dec 29, 2018

Avoid documenting excluded files. (#896) 9oelM/typedoc#1

Merged

j0nathan-ll0yd mentioned this issue Jul 11, 2021

bug: Workaround for typedoc generation j0nathan-ll0yd/aws-cloudformation-media-downloader#35

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Not able to exclude node_modules folder #319

Not able to exclude node_modules folder #319

Migronon commented Oct 28, 2016 •

edited

Loading

jtc10005 commented Nov 15, 2016

derushio commented Oct 28, 2017

btgoodwin commented Nov 2, 2017 •

edited

Loading

bluelovers commented Feb 17, 2018 •

edited by aciccarello

Loading

alexisbg commented Jun 6, 2018 •

edited

Loading

stephan-nordnes-eriksen commented Aug 17, 2018 •

edited

Loading

StJohn3D commented Oct 15, 2018 •

edited

Loading

Gerrit0 commented Nov 1, 2018

agfe2silver commented Jan 5, 2024

Not able to exclude node_modules folder #319

Not able to exclude node_modules folder #319

Comments

Migronon commented Oct 28, 2016 • edited Loading

jtc10005 commented Nov 15, 2016

derushio commented Oct 28, 2017

btgoodwin commented Nov 2, 2017 • edited Loading

bluelovers commented Feb 17, 2018 • edited by aciccarello Loading

alexisbg commented Jun 6, 2018 • edited Loading

stephan-nordnes-eriksen commented Aug 17, 2018 • edited Loading

StJohn3D commented Oct 15, 2018 • edited Loading

Gerrit0 commented Nov 1, 2018

agfe2silver commented Jan 5, 2024

Migronon commented Oct 28, 2016 •

edited

Loading

btgoodwin commented Nov 2, 2017 •

edited

Loading

bluelovers commented Feb 17, 2018 •

edited by aciccarello

Loading

alexisbg commented Jun 6, 2018 •

edited

Loading

stephan-nordnes-eriksen commented Aug 17, 2018 •

edited

Loading

StJohn3D commented Oct 15, 2018 •

edited

Loading