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.

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

feat(rulesets): add unused components server rule #2097

Merged
merged 1 commit into from Mar 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions docs/reference/asyncapi-rules.md
Expand Up @@ -369,3 +369,15 @@ that acts as a library (a container storing reusable objects, leveraged by other
specifications that reference those objects).

**Recommended:** Yes

### asyncapi-unused-components-server

Potential unused reusable `server` entry has been detected.

<!-- theme: warning -->

_Warning:_ This rule may identify false positives when linting a specification
that acts as a library (a container storing reusable objects, leveraged by other
specifications that reference those objects).

**Recommended:** Yes
@@ -0,0 +1,40 @@
import { DiagnosticSeverity } from '@stoplight/types';
import produce from 'immer';
import testRule from './__helpers__/tester';

const document = {
asyncapi: '2.0.0',
servers: {
test: {
$ref: '#/components/servers/externallyDefinedServer',
},
},
channels: {},
components: {
servers: {
externallyDefinedServer: {},
},
},
};

testRule('asyncapi-unused-components-server', [
{
name: 'valid case',
document,
errors: [],
},

{
name: 'components.servers contains unreferenced objects',
document: produce(document, (draft: any) => {
delete draft.servers['test'];
}),
errors: [
{
message: 'Potentially unused components server has been detected.',
path: ['components', 'servers', 'externallyDefinedServer'],
severity: DiagnosticSeverity.Warning,
},
],
},
]);
13 changes: 13 additions & 0 deletions packages/rulesets/src/asyncapi/index.ts
Expand Up @@ -381,5 +381,18 @@ export default {
},
},
},
'asyncapi-unused-components-server': {
description: 'Potentially unused components server has been detected.',
recommended: true,
type: 'style',
resolved: false,
given: '$.components.servers',
then: {
function: unreferencedReusableObject,
functionOptions: {
reusableObjectsLocation: '#/components/servers',
},
},
},
},
};