https://github.com/efiand/posthtml-w3c-validator

Online node W3C validator with fallback to offline version.
https://github.com/efiand/posthtml-w3c-validator

npm-package portfolio-project posthtml vanilla-js w3c-validation

Last synced: about 1 month ago
JSON representation

Online node W3C validator with fallback to offline version.

• Host: GitHub
• URL: https://github.com/efiand/posthtml-w3c-validator
• Owner: efiand
• Created: 2022-03-11T14:30:15.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-29T18:32:36.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T07:04:35.885Z (2 months ago)
• Topics: npm-package, portfolio-project, posthtml, vanilla-js, w3c-validation
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/posthtml-w3c-validator
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# posthtml-w3c-validator [![npm version](https://img.shields.io/npm/v/posthtml-w3c-validator.svg)](https://www.npmjs.com/package/posthtml-w3c-validator)

Онлайн-валидатор W3C с резервным оффлайн-валидатором.

## Установка

`npm i -E posthtml-w3c-validator`

## Использование в произвольном коде

```js

const { validateHtml } = require('posthtml-w3c-validator');

// Где-то внутри middleware, получившей HTML-код:

if (process.env.NODE_ENV === 'development') {

  const validationMessage = await validateHtml({ htmlCode });

  console.log(validationMessage);

}

```

`validateHtml` принимает объект с параметрами:

1. `htmlCode` – проверяемый HTML-код.

2. `sourceName` – источник кода, отображаемый перед выводом номеров строки и символа. По умолчанию – пустая строка.

3. `htmlvalidateOptions` – опции [резервного валидатора](https://www.npmjs.com/package/html-validate). По умолчанию – содержимое `.htmlvalidate.json` данного пакета.

## Использование в posthtml.config.js

```js

const { getPosthtmlW3cValidator } = require('posthtml-w3c-validator');

module.exports = () => ({

  plugins: [

    // other plugins

    getPosthtmlW3cValidator()

  ]

});

```

`getPosthtmlW3cValidator` может принимать объект с необязательными параметрами:

1. `getSourceName` – коллбэк для генерации имени источника на основе posthtml-дерева. По умолчанию – `(tree) => tree.options.from` .

2. `log` – коллбэк-логгер. По умолчанию – `console.log`.

3. `htmlvalidateOptions` – Опции [резервного валидатора](https://www.npmjs.com/package/html-validate). По умолчанию – содержимое `.htmlvalidate.json` данного пакета.

4. `forceOffline` – запускает резервный валидатор не только при недоступности основного, но и при ненахождении им ошибок (чтобы задействовать некоторые проверки доступности, отсутствующие в основном валидаторе). По умолчанию – `false`.

5. `exit` – осуществляет принудительный выход из приложения (например, при тестировании в сборочной линии или в прекоммит-хуке). По умолчанию – `false`.