Skip to content

Commit

Permalink
feat(rulesets): add unused components server rule (#2097)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaslagoni authored Mar 21, 2022
1 parent 2d9abaf commit 71b312e
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/reference/asyncapi-rules.md
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
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',
},
},
},
},
};

0 comments on commit 71b312e

Please sign in to comment.