@readme/spectral-config NPM

@readme/spectral-config

ReadMe coding standards for API documentation, using Spectral linting rules.

npm install --save @readme/spectral-config

Create a .spectral.yml file with the following contents:

extends: '@readme/spectral-config'

Note
This ruleset extends the core oas ruleset in Spectral. All of these rules are enabled by default.

Rule	Description
`alex-component-summary`	Component schema summaries should have inclusive and considerate language.
`alex-component-descriptions`	Component schema description should have inclusive and considerate language.
`alex-operation-summary`	Operation summaries should have inclusive and considerate language.
`alex-operation-description`	Operation descriptions should have inclusive and considerate language.
`alex-parameter`	Operation parameters should have inclusive and considerate language.
`alex-response`	Operation responses should have inclusive and considerate language.
`description-sentence-punctuation`	Descriptions should have ending punctuation.