https://github.com/phanect/sitegazer
Runtime Lint for Web Applications: SiteGazer find console errors & HTML errors from the generated HTML.
https://github.com/phanect/sitegazer
Last synced: 5 months ago
JSON representation
Runtime Lint for Web Applications: SiteGazer find console errors & HTML errors from the generated HTML.
- Host: GitHub
- URL: https://github.com/phanect/sitegazer
- Owner: phanect
- Created: 2019-07-31T13:22:50.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2022-10-29T07:48:45.000Z (over 3 years ago)
- Last Synced: 2025-12-07T12:33:48.636Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 500 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SiteGazer
Runtime Lint for Web Applications: SiteGazer find console errors & HTML errors from the generated HTML.
## Requirement
- Node.js 10.x, 12.x, 14.x, or 15.x
- Java 8+ (if you want to run `nu` plugin)
- [puppeteer dependencies](https://github.com/puppeteer/puppeteer/blob/master/docs/troubleshooting.md#chrome-headless-doesnt-launch-on-unix) if you want to install SiteGazer on Linux (SiteGazer depends on puppeteer)
Note: SiteGazer does not work on Windows Subsystems for Linux due to puppeteer limitation. See also [this issue](https://github.com/puppeteer/puppeteer/issues/1837).
## Install
```shell
$ yarn global add sitegazer
```
```shell
$ npm install -g sitegazer
```
If you want to install with `sudo` on Linux systems, yarn is recommended way to install.
Unfortunately, `sudo npm install -g sitegazer` may fail to install due to permission issue.
## Usage
1. Create sitegazer.config.js
Here's example of sitegazer.config.js. For full reference, see [sitegazer.config.js reference](#sitegazerconfigjs-reference) section
```js
"use strict";
module.exports = {
urls: [
"https://phanective.org",
"https://google.com",
],
sitemap: true,
plugins: [ "nu", "chrome-console" ],
};
```
2. Start SiteGazer
```shell
$ cd /path/to/directory # Move to the directory which sitegazer.config.js exists
$ sitegazer
```
## sitegazer.config.js reference
```js
"use strict";
module.exports = {
urls: [
"https://phanective.org",
"https://phanective.org/cv/",
"https://google.com",
],
sitemap: true,
plugins: [ "nu", "chrome-console" ],
userAgents: {
desktop: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36",
mobile: "Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Mobile Safari/537.36"
},
};
```
### `urls`
Type: `string[]`
Default: `[]`
URLs to lint.
### `sitemap`
Type: `boolean`
Default: `false`
If true, SiteGazer lint the URLs listed in sitemap.xml, in addition to URLs listed in `urls`.
### `plugins`
Type: `string[]`
Default: `[]`
Linter plugins.
Currently SiteGazer Supports following plugins:
- `nu` ([Nu HTML Checker](https://validator.github.io/validator/))
- `chrome-console` (List errors detected on Console of Chrome Developer Tools)
### userAgents
Type: `object`
Default:
```js
{
desktop: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36",
mobile: "Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Mobile Safari/537.36",
}
```
Object of user agent strings.
If two or more user agent strings are given, SiteGazer lint with each user agent strings.
## License
Apache 2.0
© 2019 Jumpei Ogawa