Skip to content

Vuepress should fail if imported code snippets is not found #1872

Closed
adamlaska/osmos-cosmos-sdk
#5
@nfnt

Description

@nfnt

Feature request

What problem does this feature solve?

Currently, when trying to import a code snippet from a non-existing file, vuepress will create a snippet that says "File not found".
Input:

<<< @/file_does_not_exist.js

Output:

Not found: /app/file_does_not_exist.js

This is a problem because it results in broken documentation. In a CI/CD environment it would be great to surface this problem early.

What does the proposed API look like?

Vuepress should fail to render if a code snippet isn't found.

How should this be implemented in your opinion?

Are you willing to work on this yourself?

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions