Skip to content

Support other plugins using the @apiExample element #6

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Support other plugins using the @apiExample element #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
108ade8
ref #4 - make regular expression stricter by only matching on json|js…
Arxcis Mar 21, 2019
e9d58a8
ref #4 - return unchanged elements if parser fails
Arxcis Mar 21, 2019
d1af6ca
index.js - renamed parts -> values
Arxcis Mar 21, 2019
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
21 changes: 14 additions & 7 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,22 @@ function parserExampleElement(elements, element, block, filename) {
}

function parserExampleElements(elements, element, block, filename) {
if ( element.name !== 'apiexample' ) { return elements; }
elements.pop();

const values = elementParser.parse(element.content, element.source);
if (values && schemas[values.schema]) {
app.log.debug('apiexample.path',values.path);
const data = fs.readFileSync( path.join(path.dirname(filename), values.path), 'utf8').toString();
element = schemas[values.schema](data, values.element, values.title);
if ( element.name !== 'apiexample' ) {
return elements;
}

const values = elementParser.parse(element.content, element.source);
if (!values) {
return elements
}

app.log.debug('apiexample.path', values.path);
const data = fs.readFileSync(path.join(path.dirname(filename), values.path), 'utf8').toString();

element = schemas[values.schema](data, values.element, values.title);
elements.pop()
elements.push(element);

return elements;
}
2 changes: 1 addition & 1 deletion parser/api_example.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ function parse(content) {
return null;

// @apiExample {json=relative_path} additional_argument
var parseRegExp = /^\{(.+?)=(.+?)\}\s*(?:\s+(.+?))?\s(.+?)$/g;
var parseRegExp = /^\{\s*(json|jsonschema|xml)\s*=(.+?)\}\s*(?:\s+(.+?))?\s(.+?)$/g;
var matches = parseRegExp.exec(content);

if ( ! matches)
Expand Down