Installations

npm install @dweber019/backstage-plugin-api-docs-spectral-linter

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.19.2

NPM Version

10.8.2 Pull Requests

Open

0

Total

81

Closed

2

Merged

79

Issues

Open

7

Total

23

Closed

16

Releases

218

@dweber019/backstage-plugin-tips@0.1.0

Updated on Jun 27, 2025

@dweber019/backstage-plugin-missing-entity@0.1.0

Updated on Jun 27, 2025

@dweber019/backstage-plugin-simple-icons@0.1.0

Updated on Jun 27, 2025

@dweber019/backstage-plugin-api-docs-module-wsdl@0.1.0

Updated on Jun 27, 2025

@dweber019/backstage-plugin-relations@0.1.0

Updated on Jun 27, 2025

@dweber019/backstage-plugin-endoflife@0.1.0

Updated on Jun 27, 2025

View All 218 releases

Languages

5

TypeScript

XSLT

JavaScript

HTML

Shell

TypeScript (76.62%)

XSLT (21.2%)

JavaScript (1.26%)

HTML (0.91%)

Shell (0.02%)

Developer

dweber019

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

39 Stars

128 Commits

14 Forks

2 Watchers

4 Branches

8 Contributors

Updated on Jun 27, 2025

Maintainers

1

View All 8 Contributors

Package Meta Information

Latest Version

0.5.0

Package Id

@dweber019/backstage-plugin-api-docs-spectral-linter@0.5.0

Unpacked Size

39.20 kB

Size

9.98 kB

File Count

20

NPM Version

10.8.2

Node Version

20.19.2

Published on

Jun 27, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

11

@backstage/catalog-model @backstage/core-components @backstage/core-plugin-api @backstage/plugin-catalog-react @material-ui/core @material-ui/icons @material-ui/lab @stoplight/spectral-core @stoplight/spectral-ruleset-bundler @stoplight/spectral-runtime react-use

Peer Dependencies

3

react react-dom react-router-dom

Dev Dependencies

9

@backstage/cli @backstage/dev-utils @backstage/test-utils @testing-library/jest-dom @testing-library/react @testing-library/user-event @types/node cross-fetch msw

Spectral Linter Plugin

Welcome to the Spectral Linter plugin!

This plugin allows you to lint (validate) API's with rule sets.

Spectral linter

Setup

Install this plugin:

1# From your Backstage root directory
2yarn --cwd packages/app add @dweber019/backstage-plugin-api-docs-spectral-linter

Entity Pages

Add the plugin as a tab to your Entity pages:

1// In packages/app/src/components/catalog/EntityPage.tsx
2import { EntityApiDocsSpectralLinterContent, isApiDocsSpectralLinterAvailable } from '@dweber019/backstage-plugin-api-docs-spectral-linter';
3
4...
5
6const apiPage = (
7  <EntityLayout>
8    {/* other tabs... */}
9    <EntityLayout.Route if={isApiDocsSpectralLinterAvailable} path="/linter" title="Linter">
10      <EntityApiDocsSpectralLinterContent />
11    </EntityLayout.Route>
12  </EntityLayout>

Add backstage.io/spectral-ruleset-url annotation to your catalog-info.yaml:

1metadata:
2  annotations:
3    backstage.io/spectral-ruleset-url: <url-to-your-yaml-or-json-file>

Default rule sets

You can provide default rule sets in you app-config.yaml like this

1spectralLinter:
2  openApiRulesetUrl: <url-to-your-yaml-or-json-file>
3  asyncApiRulesetUrl: <url-to-your-yaml-or-json-file>

Local development

There is a local setup at plugins/api-docs-spectral-linter/dev which can be started with yarn --cwd plugins/api-docs-spectral-linter start from the root.

No vulnerabilities found.

No security vulnerabilities found.