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.

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

Jump to bottom

implement a plugin framework #1448

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

implement a plugin framework #1448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8dfb58f
implement a plugin framework
mmomtchev Nov 30, 2021
17b8f8a
pass the configuration object to the plugin init
mmomtchev Dec 1, 2021
39c4fb1
absorb context info from the parsing phase
mmomtchev Dec 1, 2021
8f91761
allow explicit jsdoc tags to override the parsing
mmomtchev Dec 1, 2021
1137f38
check using/overriding context data from the plugin
mmomtchev Dec 2, 2021
3c4d853
remove the selective shallow dependencies
mmomtchev Dec 2, 2021
46cd67b
correctly sort undefined values
mmomtchev Dec 3, 2021
38bcfcb
the new sort order is the correct one
mmomtchev Dec 3, 2021
009c0c0
Merge branch 'sort-undefined' into plugin-framework
mmomtchev Dec 3, 2021
257c54e
support sorting by memberof
mmomtchev Dec 3, 2021
095665f
Merge branch 'sort-memberof' into plugin-framework
mmomtchev Dec 3, 2021
2dc9c2f
support a custom sort order
mmomtchev Dec 4, 2021
7978aa9
Merge branch 'sort-custom-order' into plugin-framework
mmomtchev Dec 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
271 changes: 271 additions & 0 deletions __tests__/__snapshots__/bin.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2024,6 +2024,277 @@ f5 comment

exports[`lint command generates lint output 1`] = `""`;

exports[`load a plugin 1`] = `
Array [
Object {
"augments": Array [],
"context": Object {
"file": "[path]",
"loc": Object {
"end": Object {
"column": 2,
"line": 8,
},
"start": Object {
"column": 0,
"line": 5,
},
},
},
"description": Object {
"children": Array [
Object {
"children": Array [
Object {
"type": "text",
"value": "This function returns the number one.",
},
],
"type": "paragraph",
},
],
"type": "root",
},
"examples": Array [],
"implements": Array [],
"kind": "function",
"loc": Object {
"end": Object {
"column": 3,
"line": 4,
},
"start": Object {
"column": 0,
"line": 1,
},
},
"members": Object {
"events": Array [],
"global": Array [],
"inner": Array [],
"instance": Array [],
"static": Array [],
},
"name": "simple.input",
"namespace": "simple.input",
"params": Array [],
"path": Array [
Object {
"kind": "function",
"name": "simple.input",
},
],
"properties": Array [],
"returns": Array [
Object {
"description": Object {
"children": Array [
Object {
"children": Array [
Object {
"type": "text",
"value": "numberone",
},
],
"type": "paragraph",
},
],
"type": "root",
},
"title": "returns",
"type": Object {
"name": "number",
"type": "NameExpression",
},
},
],
"sees": Array [],
"tags": Array [
Object {
"description": "numberone",
"lineNumber": 2,
"title": "returns",
"type": Object {
"name": "number",
"type": "NameExpression",
},
},
],
"throws": Array [],
"todos": Array [],
"yields": Array [],
},
Object {
"augments": Array [],
"context": Object {
"file": "[path]",
"loc": Object {
"end": Object {
"column": 4,
"line": 5,
},
"start": Object {
"column": 1,
"line": 5,
},
},
},
"description": "",
"examples": Array [],
"implements": Array [],
"kind": "function",
"members": Object {
"events": Array [],
"global": Array [],
"inner": Array [],
"instance": Array [],
"static": Array [],
},
"name": "dummy",
"namespace": "dummy",
"params": Array [],
"path": Array [
Object {
"kind": "function",
"name": "dummy",
},
],
"properties": Array [],
"returns": Array [],
"sees": Array [],
"tags": Array [
Object {
"description": null,
"lineNumber": 1,
"name": "dummy",
"title": "method",
},
],
"throws": Array [],
"todos": Array [],
"yields": Array [],
},
Object {
"augments": Array [],
"context": Object {
"file": "[path]",
"kind": "method",
"loc": Object {
"end": Object {
"column": 4,
"line": 5,
},
"start": Object {
"column": 1,
"line": 5,
},
},
"name": "dummy_method",
},
"description": "",
"examples": Array [],
"implements": Array [],
"kind": "method",
"members": Object {
"events": Array [],
"global": Array [],
"inner": Array [],
"instance": Array [],
"static": Array [],
},
"name": "dummy_method",
"namespace": "dummy_method",
"params": Array [
Object {
"lineNumber": 1,
"name": "dummy_param",
"title": "param",
"type": Object {
"name": "number",
"type": "NameExpression",
},
},
],
"path": Array [
Object {
"kind": "method",
"name": "dummy_method",
},
],
"properties": Array [],
"returns": Array [],
"sees": Array [],
"tags": Array [
Object {
"description": null,
"lineNumber": 1,
"name": "dummy_param",
"title": "param",
"type": Object {
"name": "number",
"type": "NameExpression",
},
},
],
"throws": Array [],
"todos": Array [],
"yields": Array [],
},
Object {
"augments": Array [],
"context": Object {
"file": "[path]",
"kind": "SHOULD_NOT_APPEAR_IN_THE_RESULT",
"loc": Object {
"end": Object {
"column": 4,
"line": 5,
},
"start": Object {
"column": 1,
"line": 5,
},
},
"name": "SHOULD_NOT_APPEAR_IN_THE_RESULT",
},
"description": "",
"examples": Array [],
"implements": Array [],
"kind": "function",
"members": Object {
"events": Array [],
"global": Array [],
"inner": Array [],
"instance": Array [],
"static": Array [],
},
"name": "not_so_dummy",
"namespace": "not_so_dummy",
"params": Array [],
"path": Array [
Object {
"kind": "function",
"name": "not_so_dummy",
},
],
"properties": Array [],
"returns": Array [],
"sees": Array [],
"tags": Array [
Object {
"description": null,
"lineNumber": 1,
"name": "not_so_dummy",
"title": "method",
},
],
"throws": Array [],
"todos": Array [],
"yields": Array [],
},
]
`;

exports[`should use browser resolve 1`] = `
Array [
Object {
Expand Down