Отступ VSCode в Swagger JSDoc - PullRequest
       45

Отступ VSCode в Swagger JSDoc

1 голос
/ 01 октября 2019

Я использую swagger-jsdoc с Express. Используя эту библиотеку для описания конечной точки API, я использую следующие строки в блоке JSDock в YAML:

/**
 * @swagger
 * /users:
 *    post:
 *      summary: Register a user
 *      tags: [Users]
 *      description: Register a new user and return its cookie token (connect.sid)
 *      parameters:
 *        - in: body
 *          name: body
 *          schema:
 *            type: object
 *            required: [login, password, confirm]
 *            description: user's credential
 *            properties:
 *              login:
 *                type: string
 *                minLength: 3
 *                maxLength: 10
 *              email:
 *                type: string
 *              password:
 *                type: string
 *                minLength: 6
 *              confirm:
 *                type: string
 *      responses:
 *        200:
 *          description: OK
 *          schema:
 *            $ref: '#/components/schemas/AuthState'
 *        422:
 *          $ref: '#/components/responses/UnprocessableEntity'
 */

router.post('/', usersController.register);

Но проблема в том, что VSCode полностью игнорирует отступ, когда я ставлю новую строку, он также не делаетпокажите уровень отступа, который делает действительно трудным сделать спецификацию, поскольку каждую новую строку мне приходится нажимать [tab], чтобы достичь необходимого уровня отступа. Расширения, такие как отступы радуги, также не работают, потому что они ориентируются на отступы vscode.

Есть ли какие-либо настройки или расширения, которые я мог бы использовать для работы с этим? Или, может быть, я использую неправильный подход, и есть лучшие и более используемые подходы для работы с этим с Express? Хотелось бы услышать и об этом

...