Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cannot find *.vue files #435

Open
crystalfp opened this issue Dec 22, 2024 · 0 comments
Open

Cannot find *.vue files #435

crystalfp opened this issue Dec 22, 2024 · 0 comments

Comments

@crystalfp
Copy link

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant