@sfdocs-internal/remark-lint-reference-path v0.1.13

Remark lint reference path

What/why

This lint plugin will validate the reference paths to check if the deep linked resource type exists in the reference.

Sample reference path link, Test Raml Reference Type link

Running this lint will validate whether the resource type exists in the cc-shopper-basket-api-reference. If the resource doesn't exist, then the plugin will throw an error.

Currently the lint plugin validates the following type of references,

• Open API specifications.

• Raml specifications.

The plugin is extensible to add any other reference type validations in the future.

The link format that the plugin validates is of the form, ../../{project-id}/references/{reference-id}?meta=topic

How to setup

Install & build

yarn install && yarn build

Publish

yarn publish

Please make sure to push your changes (version number & other changes) to git once publishing is complete.