Skip to content

Vuejs support #1055

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

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
[![Coverage Status](https://coveralls.io/repos/github/documentationjs/documentation/badge.svg?branch=master)](https://coveralls.io/github/documentationjs/documentation?branch=master)
[![Inline docs](http://inch-ci.org/github/documentationjs/documentation.svg?branch=master&style=flat-square)](http://inch-ci.org/github/documentationjs/documentation)

* Supports modern JavaScript: ES5, ES2017, JSX, and [Flow](http://flowtype.org/) type annotations.
* Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](http://flowtype.org/) type annotations.
* Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
* Integrates with GitHub to link directly from documentation to the code it refers to.
* Customizable output: HTML, JSON, Markdown, and more
Expand Down
30 changes: 30 additions & 0 deletions __tests__/fixture/simple.input.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<template>
<div>not relevant</div>
</template>

<script>

/**
* This Vue Component is a test
* @returns {vue-tested} vue-tested component
*/
export default {

props: {

/**
* This is a number
*
* @property
*/
myNumber: {
default: 42,
type: Number
}
}
}
</script>

<style>

</style>
9 changes: 9 additions & 0 deletions __tests__/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,12 @@ test('.lint with bad input', async function() {
expect(err).toBeTruthy();
}
});

test('Vue file', async function() {
await pify(chdir)(__dirname);
const data = await documentation.build(
'__tests__/fixture/simple.input.vue',
{}
);
expect(data).toMatchSnapshot();
});
Loading