Skip to content

Cannot find *.vue files #435

Open
Open
@crystalfp

Description

@crystalfp

Trying to extract TSDoc comments from *.vue file but failed. Using this configuration:

typedoc \
--out "doc/typedoc" \
--readme none \
--suppressCommentWarningsInDeclarationFiles \
--plugin typedoc-plugin-vue \
--plugin typedoc-plugin-missing-exports \
--disableGit \
--excludeInternal \
--excludeExternals \
--placeInternalsInOwningModule \
--tsconfig ./tsconfig.json \
src/components/About.vue

With all *.vue files included in tsconfig.json:

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "Preserve",
    "skipLibCheck": true,
    "verbatimModuleSyntax": true,
    "noErrorTruncation": true,
    "esModuleInterop": true,
    "composite": true,
    "allowSyntheticDefaultImports": true,
    "useUnknownInCatchVariables": true,
    "useDefineForClassFields": true,
    "moduleDetection": "force",

    /* Bundler mode */
    "moduleResolution": "bundler",
    "allowImportingTsExtensions": true,
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "preserve",
    "removeComments": true,

    /* Linting */
    "strict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noFallthroughCasesInSwitch": true,
    "noImplicitReturns": true,
    "noImplicitOverride": true,
    "allowUnreachableCode": false,

    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    },
  },
  "include": [
    "vite.config.mts",
    "troika-three-text.d.ts",
    "src/**/*.ts",
    "src/**/*.vue"
  ]
}

Gives the following error:

[info] Loaded plugin typedoc-plugin-vue
[info] Loaded plugin typedoc-plugin-missing-exports
[warning] The entry point ./src/components/About.vue is not referenced by the 'files' or 'include' option in your tsconfig
[error] Unable to find any entry points. See previous warnings
[error] Found 1 errors and 1 warnings

No problem if with the same configuration use typedoc on a *.ts file. Also removing noEmit changes nothing.
Thanks for your help!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions