w3cjs - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #llm #golang #go #android #machine-learning #macos #java #cli #kubernetes #ios #open-source

w3cjs

(★ 158)

A npm package for testing files or url's again the wc3 validator

File Explorer

Download Latest Version (.zip)

- w3cjs
- demo.html
- index.js
- w3cjs.js
.gitignore
.travis.yml
LICENSE
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/thomasdavis/w3cjs

Downloads the entire project code from GitHub to your computer.

cd w3cjs

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install w3cjs

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://secure.travis-ci.org/thomasdavis/w3cjs.png?branch=master)](http://travis-ci.org/thomasdavis/w3cjs)
[![Dependencies](https://david-dm.org/thomasdavis/w3cjs.png)](https://david-dm.org/thomasdavis/w3cjs)

# w3cjs

A node.js library for testing files or url's against the w3c html validator.

## Installation

```js
npm install w3cjs
```

## Usage

```js
var w3cjs = require('w3cjs');

var results = w3cjs.validate({
	file: 'demo.html', // file can either be a local file or a remote file
	//file: 'http://html5boilerplate.com/',
	//input: '<html>...</html>',
	//input: myBuffer,
	output: 'json', // Defaults to 'json', other option includes html
	//proxy: 'http://proxy:8080', // Default to null
	callback: function (err, res) {
		console.log(res);
		// depending on the output type, res will either be a json object or a html string
	}
});
```

## Example async testing with Mocha

```js
var w3cjs = require('w3cjs');
describe('html validation', function(){
	it('index page should have no html errors', function(done){
		w3cjs.validate({
			file: 'index.html',
			callback: function (error, res) {
				console.log(error || res);
				if (res && res.messages.length > 0 ) {
					throw {error: 'html errors have been found', results: res};
				};
				done();
			}
		})
	})
})

```

## Older versions < 0.2.0

w3c has changed their validator API to not include some old options. It will eventually be fully deprecated and everyone is advised to update to 0.3.0 of this module.

```js
doctype: 'HTML5', // Defaults false for autodetect
charset: 'utf-8', // Defaults false for autodetect
```