vnu-jar 21.7.12 → 21.9.2

package/README.md

@@ -19,61 +19,47 @@ code][10].
    [9]: https://github.com/validator/validator
    [10]: https://validator.github.io/validator/#build-instructions
 
-A [Dockerfile][11] (see **Pulling the Docker image** below) and [npm][12],
-[pip][13], and [brew][14] packages are also available.
+`vnu.jar` is a packaged version of the Nu Html Checker for batch-checking
+documents from the command line and from other scripts/apps.
 
-   [11]: https://ghcr.io/validator/validator
-   [12]: https://www.npmjs.com/package/vnu-jar
-   [13]: https://github.com/svenkreiss/html5validator
-   [14]: https://formulae.brew.sh/formula/vnu
+You can work with `vnu.jar` in CommonJS modules.
 
-It is released upstream in these formats:
+## Install latest release version
 
-  * pre-compiled Linux, Windows, and macOS binaries that include an embedded
-  Java runtime
+```sh
+npm install --save vnu-jar
+```
 
-  * `vnu.jar` — a portable version you can use on any system that has Java 8 or
-  above installed
+## Install 'next' version
 
-  * `vnu.war` — for [deploying the checker service through a servlet container
-  such as Tomcat][15]
+```sh
+npm install --save vnu-jar@next
+```
 
-   [15]: https://validator.github.io/validator/#servlet
+## Example
 
-**Note:** The _vnu.jar_ and _vnu.war_ files require you to have Java 8 or above
-installed. The pre-compiled Linux, Windows, and macOS binaries don’t require you
-to have any version of Java already installed at all.
+For Node.js 6+
 
-You can [get the latest release][16] or run [`docker run -it --rm -p 8888:8888
-ghcr.io/validator/validator:latest`][17], [`npm install vnu-jar`][18],
-[`brew install vnu`][19], or [`pip install html5validator`][20] and see the
-**Usage** and **Web-based checking** sections below. Or automate your document
-checking with a frontend such as:
+```js
+'use strict';
 
-   [16]: https://github.com/validator/validator/releases/latest
-   [17]: https://github.com/validator/validator/pkgs/container/validator
-   [18]: https://www.npmjs.com/package/vnu-jar
-   [19]: https://libraries.io/homebrew/vnu
+const exec = require('child_process').exec;
+const vnu = require('vnu-jar');
 
-   [20]: https://github.com/svenkreiss/html5validator
-
-  * [Grunt plugin for HTML validation][21] or [Gulp plugin for HTML
-  validation][22] or [Maven plugin for HTML validation][23]
-
-  * [html5validator `pip` package][24] (for integration in Travis CI, CircleCI,
-  CodeShip, Jekyll, Pelican, etc.)
-
-  * [LMVTFY: Let Me Validate That For You][25] (auto-check JSFiddle/JSBin, etc.,
-  links in GitHub issue comments)
-
-   [21]: https://github.com/validator/grunt-html
-   [22]: https://github.com/validator/gulp-html
-   [23]: https://github.com/validator/maven-plugin
-   [24]: https://github.com/svenkreiss/html5validator
-   [25]: https://github.com/cvrebert/lmvtfy/
+// Print path to vnu.jar
+console.log(vnu);
 
+// Work with vnu.jar
+// for example get vnu.jar version
+exec(`java -jar ${vnu} --version`, (error, stdout) => {
+    if (error) {
+        console.error(`exec error: ${error}`);
+        return;
+    }
+    console.log(stdout);
+});
+```
 ## Usage
-
 Run the checker with one of the following invocations:
 
 • `vnu-runtime-image/bin/vnu OPTIONS FILES` (Linux or macOS)
@@ -91,10 +77,10 @@ the following options:
     --skip-non-svg --also-check-svg --html --skip-non-html
     --format gnu|xml|json|text --help --verbose --version
 
-The [Options][26] section below provides details on each option, and the rest of
+The [Options][27] section below provides details on each option, and the rest of
 this section provides some specific examples.
 
-   [26]: https://validator.github.io/validator/#options
+   [27]: https://validator.github.io/validator/#options
 
 **Note:** Throughout these examples, replace `~/vnu.jar` with the actual path to
 that jar file on your system, and replace `vnu-runtime-image/bin/vnu` and
@@ -341,389 +327,3 @@ provides the following options:
 
     Shows the checker version number.
 
-## Web-based checking
-
-The Nu Html Checker — along with being usable as [a standalone command-line
-client][27] — can be run as an HTTP service, similar to
-[validator.w3.org/nu][28], for browser-based checking of HTML documents, CSS
-stylesheets, and SVG images over the Web. To that end, the checker is released
-as several separate packages:
-
-   [27]: https://validator.github.io/validator/#usage
-   [28]: https://validator.w3.org/nu/
-
-  * Linux, Windows, and macOS binaries for deploying the checker as a simple
-  self-contained service on any system
-
-  * `vnu.jar` for deploying the checker as a simple self-contained service on a
-  system with Java installed
-
-  * `vnu.war` for deploying the checker to a servlet container such as Tomcat
-
-All deployments expose a REST API that enables checking of HTML documents, CSS
-stylesheets, and SVG images from other clients, not just web browsers. And the
-Linux, Windows, and macOS binaries and `vnu.jar` package also include a simple
-HTTP client that enables you to either send documents to a locally-running
-instance of the checker HTTP service — for fast command-line checking — or to
-any remote instance of the checker HTTP service running anywhere on the Web.
-
-The [latest releases of the Linux, Windows, and macOS binaries and vnu.jar and
-vnu.war packages][29] are available from the `validator` project at github. The
-following are detailed instructions on using them.
-
-   [29]: https://github.com/validator/validator/releases/latest
-
-**Note:** Throughout these instructions, replace `~/vnu.jar` with the actual
-path to that jar file on your system, and replace `vnu-runtime-image/bin/java`
-and `vnu-runtime-image\bin\java.exe` with the actual path to the checker `java`
-or `java.exe` program on your system — or if you add the `vnu-runtime-image/bin`
-or `vnu-runtime-image\bin` directory your system `PATH` environment variable,
-you can invoke the checker with just `java nu.validator.servlet.Main 8888`.
-
-### Standalone web server
-
-To run the checker as a standalone service (using a built-in Jetty server), open
-a new terminal window and invoke the checker like this:
-
-    java -cp ~/vnu.jar              nu.validator.servlet.Main 8888
-
-    vnu-runtime-image/bin/java      nu.validator.servlet.Main 8888
-
-    vnu-runtime-image\bin\java.exe  nu.validator.servlet.Main 8888
-
-Then open [http://0.0.0.0:8888][30] in a browser. (To listen on a different
-port, replace `8888` with the port number.)
-
-   [30]: http://0.0.0.0:8888
-
-**Warning:** Future checker releases will bind by default to the address
-`127.0.0.1`. Your checker deployment might become unreachable unless you use the
-`nu.validator.servlet.bind-address` system property to bind the checker to a
-different address:
-
-    java -cp ~/vnu.jar \
-        -Dnu.validator.servlet.bind-address=128.30.52.73 \
-        nu.validator.servlet.Main 8888
-
-    vnu-runtime-image/bin/java \
-        -Dnu.validator.servlet.bind-address=128.30.52.73 \
-        nu.validator.servlet.Main 8888
-
-    vnu-runtime-image\bin\java.exe  \
-        -Dnu.validator.servlet.bind-address=128.30.52.73 \
-        nu.validator.servlet.Main 8888
-
-When you open [http://0.0.0.0:8888][31] (or whatever URL corresponds to the
-`nu.validator.servlet.bind-address` value you’re using), you’ll see a form
-similar to [validator.w3.org/nu][32] that allows you to enter the URL of an HTML
-document, CSS stylesheet, or SVG image, and have the results of checking that
-resource displayed in the browser.
-
-   [31]: http://0.0.0.0:8888
-   [32]: https://validator.w3.org/nu/
-
-**Note:** If you get a `StackOverflowError` error when using the checker, try
-adjusting the thread stack size by providing the `-Xss` option to java:
-
-      java -Xss512k -cp ~/vnu.jar nu.validator.servlet.Main 8888
-
-      vnu-runtime-image/bin/java -Xss512k -m vnu/nu.validator.servlet.Main 8888
-
-### Deployment to servlet container
-
-To run the checker inside of an existing servlet container such as Apache Tomcat
-you will need to deploy the `vnu.war` file to that server following its
-documentation. For example, on Apache Tomcat you could do this using the
-[Manager][33] application or simply by copying the file to the `webapps`
-directory (since that is the default `appBase` setting). Typically you would see
-a message similar to the following in the `catalina.out` log file.
-
-   [33]: https://tomcat.apache.org/tomcat-8.0-doc/manager-howto.html
-
-    May 7, 2014 4:42:04 PM org.apache.catalina.startup.HostConfig deployWAR
-    INFO: Deploying web application archive /var/lib/tomcat7/webapps/vnu.war
-
-Assuming your servlet container is configured to receive HTTP requests sent to
-`localhost` on port `80` and the context root of this application is `vnu`
-(often the default behavior is to use the WAR file's filename as the context
-root unless one is explicitly specified) you should be able to access the
-application by connecting to [http://localhost/vnu/][34].
-
-   [34]: http://localhost/vnu/
-
-**Note:** You may want to customize the `/WEB-INF/web.xml` file inside the WAR
-file (you can use any ZIP-handling program) to modify the servlet filter
-configuration. For example, if you wanted to disable the inbound-size-limit
-filter, you could comment out that filter like this:
-
-    <!--
-      <filter>
-          <filter-name>inbound-size-limit-filter</filter-name>
-          <filter-class>nu.validator.servlet.InboundSizeLimitFilter</filter-class>
-      </filter>
-      <filter-mapping>
-          <filter-name>inbound-size-limit-filter</filter-name>
-          <url-pattern>/*</url-pattern>
-      </filter-mapping>
-    -->
-
-### HTTP client (for fast command-line checking)
-
-The checker is packaged with an HTTP client you can use from the command line to
-either send documents to a locally-running instance of the checker HTTP service
-— for fast command-line checking — or to a remote instance anywhere on the Web.
-
-To check documents locally using the packaged HTTP client, do this:
-
-  1. Start up the checker as a local HTTP service, as described in the
-  **Standalone web server** section.
-
-  2. Open a new terminal window and invoke the HTTP client like this:
-
-    java -cp ~/vnu.jar nu.validator.client.HttpClient FILE.html...
-
-    vnu-runtime-image/bin/java nu.validator.client.HttpClient FILE.html...
-
-To send documents to an instance of the checker on the Web, such as
-[html5.validator.nu/][35], use the nu.validator.client.host and
-nu.validator.client.port options, like this:
-
-   [35]: https://html5.validator.nu/
-
-    java -cp ~/vnu.jar -Dnu.validator.client.port=80 \
-        -Dnu.validator.client.host=html5.validator.nu \
-        nu.validator.client.HttpClient FILE.html...
-
-…or like this:
-
-    vnu-runtime-image/bin/java -Dnu.validator.client.port=80 \
-        -Dnu.validator.client.host=html5.validator.nu \
-        nu.validator.client.HttpClient FILE.html...
-
-Other options are documented below.
-
-### HTTP client options
-
-When using the packaged HTTP client for sending documents to an instance of the
-checker HTTP service for checking, you can set Java system properties to control
-configuration options for the checker behavior.
-
-For example, you can suppress warning-level messages and only show error-level
-ones by setting the value of the `nu.validator.client.level` system property to
-`error`, like this:
-
-    java -Dnu.validator.client.level=error \
-           -cp ~/vnu.jar nu.validator.client.HttpClient FILE.html...
-
-…or like this:
-
-    vnu-runtime-image/bin/java -Dnu.validator.client.level=error \
-           -cp ~/vnu.jar nu.validator.client.HttpClient FILE.html...
-
-Most of the properties listed below map to the common input parameters for the
-checker service, as documented at
-[github.com/validator/validator/wiki/Service-»-Common-params][36].
-
-   [36]: https://github.com/validator/validator/wiki/Service-%C2%BB-Common-params
-
-#### nu.validator.client.host
-
-    Specifies the hostname of the checker for the client to connect to.
-
-    default: "127.0.0.1"
-
-#### nu.validator.client.port
-
-    Specifies the hostname of the checker for the client to connect to.
-
-    default: "8888"
-
-    example: java -Dnu.validator.client.port=8080 -jar ~/vnu.jar FILE.html
-
-#### nu.validator.client.level
-
-    Specifies the severity level of messages to report; to suppress
-    warning-level messages, and only show error-level ones, set this property to
-    "error".
-
-    default: [unset]
-
-    possible values: "error"
-
-    example: java -Dnu.validator.client.level=error -jar ~/vnu.jar FILE.html
-
-#### nu.validator.client.parser
-
-    Specifies which parser to use.
-
-    default: "html"; or, for *.xhtml input files, "xml"
-
-    possible values: [see information at URL below]
-
-    https://github.com/validator/validator/wiki/Service-%C2%BB-Common-params#parser
-
-#### nu.validator.client.charset
-
-    Specifies the encoding of the input document.
-
-    default: [unset]
-
-#### nu.validator.client.content-type
-
-    Specifies the content-type of the input document.
-
-    default: "text/html"; or, for *.xhtml files, "application/xhtml+xml"
-
-#### nu.validator.client.out
-
-    Specifies the output format for messages.
-
-    default: "gnu"
-
-    possible values: [see information at URL below]
-
-    https://github.com/validator/validator/wiki/Service-%C2%BB-Common-params#out
-
-#### nu.validator.client.asciiquotes
-
-    Specifies whether ASCII quotation marks are substituted for Unicode smart
-    quotation marks in messages.
-
-    default: "yes"
-
-    possible values: "yes" or "no"
-
-### HTTP servlet options
-
-#### nu.validator.servlet.bind-address
-
-    Binds the validator service to the specified IP address.
-
-    default: 0.0.0.0 [causes the checker to listen on all interfaces]
-
-    possible values: The IP address of any network interface
-
-    example: -Dnu.validator.servlet.bind-address=127.0.0.1
-
-#### nu.validator.servlet.connection-timeout
-
-    Specifies the connection timeout.
-
-    default: 5000
-
-    possible values: number of milliseconds
-
-    example: -Dnu.validator.servlet.connection-timeout=5000
-
-#### nu.validator.servlet.socket-timeout
-
-    Specifies the socket timeout.
-
-    default: 5000
-
-    possible values: number of milliseconds
-
-    example: -Dnu.validator.servlet.socket-timeout=5000
-
-## Pulling the Docker image
-
-You can pull the checker Docker image from
-[https://ghcr.io/validator/validator][37] in the GitHub container registry.
-
-   [37]: https://ghcr.io/validator/validator
-
-To pull and run the latest version of the checker:
-
-      docker run -it --rm -p 8888:8888 ghcr.io/validator/validator:latest
-
-To pull and run a specific tag/version of the checker from the container
-registry — for example, the `17.11.1` version:
-
-      docker run -it --rm -p 8888:8888 ghcr.io/validator/validator:17.11.1
-
-To bind the checker to a specific address (rather than have it listening on all
-interfaces):
-
-      docker run -it --rm -p 128.30.52.73:8888:8888
-      ghcr.io/validator/validator:latest
-
-To make the checker run with a connection timeout and socket timeout different
-than the default 5 seconds, use the `CONNECTION_TIMEOUT_SECONDS` and
-`SOCKET_TIMEOUT_SECONDS` environment variables:
-
-      docker run -it --rm \
-         -e CONNECTION_TIMEOUT_SECONDS=15 \
-         -e SOCKET_TIMEOUT_SECONDS=15 \
-         -p 8888:8888 \
-         validator/validator
-
-To make the checker run with particular Java system properties set, use the
-`JAVA_TOOL_OPTIONS` environment variable:
-
-      docker run -it --rm \
-         -e JAVA_TOOL_OPTIONS=-Dnu.validator.client.asciiquotes=yes  \
-         -p 8888:8888 \
-         validator/validator
-
-To define a service named `vnu` for use with `docker compose`, create a Compose
-file named `docker-compose.yml` (for example), with contents such as the
-following:
-
-      version: '2' services:
-        vnu:
-          image: validator/validator ports:
-            - "8888:8888"
-          network_mode: "host" #so "localhost" refers to the host machine.
-
-## Build instructions
-
-Follow the steps below to build, test, and run the checker such that you can
-open `http://0.0.0.0:8888/` in a Web browser to use the checker Web UI.
-
-  1. Make sure you have git, python, and JDK 8 or above installed.
-
-  2. Set the `JAVA_HOME` environment variable:
-
-        export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64    <-- Ubuntu, etc.
-
-        export JAVA_HOME=$(/usr/libexec/java_home)            <-- MacOS
-
-  3. Create a working directory:
-
-        git clone https://github.com/validator/validator.git
-
-  4. Change into your working directory:
-
-        cd validator
-
-  5. Start the checker Python script:
-
-        python ./checker.py all
-
-The first time you run the checker Python script, you’ll need to be online and
-the build will need time to download several megabytes of dependencies.
-
-The steps above will build, test, and run the checker such that you can open
-`http://0.0.0.0:8888/` in a Web browser to use the checker Web UI.
-
-**Warning:** Future checker releases will bind by default to the address
-`127.0.0.1`. Your checker deployment might become unreachable unless you use the
-`--bind-address` option to bind the checker to a different address:
-
-        python ./checker.py --bind-address=128.30.52.73 all
-
-Use `python ./checker.py --help` to see command-line options for controlling the
-behavior of the script, as well as build-target names you can call separately;
-e.g.:
-
-  * python ./checker.py build  # to build only
-
-  * python ./checker.py build  # test to build and test
-
-  * python ./checker.py run    # to run only
-
-  * python ./checker.py jar    # to compile vnu.jar
-
-  * python ./checker.py update-shallow && \
-      python ./checker.py dldeps && \
-      python ./checker.py jar  # compile vnu.jar faster

package/package.json

@@ -1 +1 @@
-{"name": "vnu-jar", "version": "21.7.12", "description": "Provides the Nu Html Checker \u00abvnu.jar\u00bb file", "main": "vnu-jar.js", "author": "Michael[tm] Smith <mike@w3.org>", "engines": {"node": ">=0.10"}, "repository": {"type": "git", "url": "git+https://github.com/validator/validator.git"}, "license": "MIT", "bugs": {"url": "https://github.com/validator/validator/issues"}, "homepage": "https://github.com/validator/validator#readme", "keywords": ["checker", "html", "lint", "linter", "jar", "nu", "validator", "vnu", "w3c"], "files": ["build/dist/vnu.jar", "vnu-jar.js"]}
+{"name": "vnu-jar", "version": "21.9.2", "description": "Provides the Nu Html Checker \u00abvnu.jar\u00bb file", "main": "vnu-jar.js", "author": "Michael[tm] Smith <mike@w3.org>", "engines": {"node": ">=0.10"}, "repository": {"type": "git", "url": "git+https://github.com/validator/validator.git"}, "license": "MIT", "bugs": {"url": "https://github.com/validator/validator/issues"}, "homepage": "https://github.com/validator/validator#readme", "keywords": ["checker", "html", "lint", "linter", "jar", "nu", "validator", "vnu", "w3c"], "files": ["build/dist/vnu.jar", "vnu-jar.js"]}