Skip to content

feat(ls): provide completion rules for $ref field in supported objects #2203

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

Merged
merged 2 commits into from
Oct 27, 2022
Merged

feat(ls): provide completion rules for $ref field in supported objects #2203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7fd3d4
feat(ls): provide completion for field in supported objects
char0n Oct 27, 2022
0938fe6
Update packages/apidom-ls/src/config/openapi/example/completion.ts
char0n Oct 27, 2022
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
22 changes: 22 additions & 0 deletions packages/apidom-ls/src/config/openapi/callback/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import {
ApidomCompletionItem,
CompletionFormat,
CompletionType,
} from '../../../apidom-language-types';

const completion: ApidomCompletionItem[] = [
{
label: '$ref',
insertText: '\\$ref',
kind: 14,
format: CompletionFormat.QUOTED,
type: CompletionType.PROPERTY,
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Callback.',
},
},
];

export default completion;
2 changes: 2 additions & 0 deletions packages/apidom-ls/src/config/openapi/callback/meta.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import lint from './lint';
import completion from './completion';
import documentation from './documentation';
import { FormatMeta } from '../../../apidom-language-types';

const meta: FormatMeta = {
lint,
completion,
documentation,
};

Expand Down
12 changes: 12 additions & 0 deletions packages/apidom-ls/src/config/openapi/example/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import {
} from '../../../apidom-language-types';

const completion: ApidomCompletionItem[] = [
{
label: '$ref',
insertText: '\\$ref',
kind: 14,
format: CompletionFormat.QUOTED,
type: CompletionType.PROPERTY,
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to an Example.',
},
},
{
label: 'summary',
insertText: 'summary',
Expand Down
2 changes: 1 addition & 1 deletion packages/apidom-ls/src/config/openapi/header/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const completion: ApidomCompletionItem[] = [
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Header',
value: 'A reference to a Header.',
},
},
{
Expand Down
12 changes: 12 additions & 0 deletions packages/apidom-ls/src/config/openapi/link/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import {
} from '../../../apidom-language-types';

const completion: ApidomCompletionItem[] = [
{
label: '$ref',
insertText: '\\$ref',
kind: 14,
format: CompletionFormat.QUOTED,
type: CompletionType.PROPERTY,
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Link.',
},
},
{
label: 'operationRef',
insertText: 'operationRef',
Expand Down
2 changes: 1 addition & 1 deletion packages/apidom-ls/src/config/openapi/parameter/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const completion: ApidomCompletionItem[] = [
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Parameter',
value: 'A reference to a Parameter.',
},
},
{
Expand Down
12 changes: 12 additions & 0 deletions packages/apidom-ls/src/config/openapi/request-body/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import {
} from '../../../apidom-language-types';

const completion: ApidomCompletionItem[] = [
{
label: '$ref',
insertText: '\\$ref',
kind: 14,
format: CompletionFormat.QUOTED,
type: CompletionType.PROPERTY,
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Request Body.',
},
},
{
label: 'description',
insertText: 'description',
Expand Down
12 changes: 12 additions & 0 deletions packages/apidom-ls/src/config/openapi/response/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import {
} from '../../../apidom-language-types';

const completion: ApidomCompletionItem[] = [
{
label: '$ref',
insertText: '\\$ref',
kind: 14,
format: CompletionFormat.QUOTED,
type: CompletionType.PROPERTY,
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Response.',
},
},
{
label: 'description',
insertText: 'description',
Expand Down
12 changes: 12 additions & 0 deletions packages/apidom-ls/src/config/openapi/security-scheme/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import {
} from '../../../apidom-language-types';

const completion: ApidomCompletionItem[] = [
{
label: '$ref',
insertText: '\\$ref',
kind: 14,
format: CompletionFormat.QUOTED,
type: CompletionType.PROPERTY,
insertTextFormat: 2,
documentation: {
kind: 'markdown',
value: 'A reference to a Security Scheme.',
},
},
{
label: 'type',
insertText: 'type',
Expand Down