From 0e649d41b836754cfaf1feed36a5578157c6a7fc Mon Sep 17 00:00:00 2001 From: Carl Ansley Date: Wed, 3 Apr 2024 15:14:43 -0400 Subject: [PATCH] convert examples in README.md to json to remove extraneous commas --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 01d03dc..3af8373 100644 --- a/README.md +++ b/README.md @@ -11,28 +11,30 @@ Spectral Config should be installed as a dev dependency: Once installed, add a file named `.spectral.json` to the root of your project. This file should extend Spectral Config: -```jsonc +```json { - "extends": ["@checkdigit/spectral-config"], + "extends": ["@checkdigit/spectral-config"] } ``` Also add the following to your `package.json` to run Spectral: -```jsonc -"scripts": { - // ... - "lint:openapi": "spectral lint src/**/swagger.yml", +```json +{ + "scripts": { + "lint:openapi": "spectral lint src/**/swagger.yml" + } } ``` To include Spectral in your project's CI/CD pipeline, add the following to your `package.json`: -```jsonc -"scripts": { - // ... - "ci:lint": "... && npm run lint:openapi", +```json +{ + "scripts": { + "ci:lint": "... && npm run lint:openapi" } +} ``` ### Plugins