question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[BUG] Not able to exclude files from documentation

See original GitHub issue
Overview of the issue

I’ve added files that I want to exclude in “exclude” option in tsconfig.json, but excluded files are still used to generate documentation.

Operating System, Node.js, npm, compodoc version(s)

macOS, node 6.10.1, npm 4.4.4, compodoc 1.0.0-beta.8

Angular configuration, a package.json file in the root folder
Compodoc installed globally or locally ?

Locally

Motivation for or Use Case
Reproduce the error

I ran: compodoc src -p tsconfig.compodoc.json -sw -disableGraph with tsconfig.compodoc.json: exclude: [ “/nodoc/*.ts" ] (I have also tried "src//nodoc/*.ts”) After generating documentation, files that should be excluded are still used to generate documentation.

Related issues
Suggest a Fix

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:1
  • Comments:9 (3 by maintainers)

github_iconTop GitHub Comments

2reactions
Zyzlecommented, May 4, 2017

@liuxinhu Hmmn, I’ve been able to exclude files by explicitly giving their path in tsconfig. The path should be relative to the tsconfig file compodoc looks at. So for an angular cli generated project this would be something like:

  "exclude": [
    "test.ts",
    "app/your-module/excluded.ts",
    "**/*.spec.ts",
  ]

When using the generated tsconfig.app.json file

1reaction
vogloblinskycommented, May 11, 2017

You are welcome 😉 Don’t forget to reference the issue number in your commit. “Fix #175

Read more comments on GitHub >

github_iconTop Results From Across the Web

cannot find a way to exclude file from TFS
Go to your Source Control Explorer and navigate to the excluded file. From there right-click on the file and delete it. Go to...
Read more >
Bug descriptions — spotbugs 4.7.3 documentation
This document lists the standard bug patterns reported by SpotBugs. ... Unless both strings are either constants in a source file, or have...
Read more >
Issues - SonarQube Documentation
Fixed: set automatically when a subsequent analysis shows that the issue has been corrected or the file is no longer available (removed from...
Read more >
The composer.json schema
PSR-4; PSR-0; Classmap; Files; Exclude files from classmaps ... We have a JSON schema that documents the format and can also be used...
Read more >
Downgrading versions and excluding dependencies
a bug was discovered in the latest release. your code depends on a lower version which is not binary compatible. your code doesn't...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found