.nodehawkrc

.nodehawkrc configuration files

.nodehawkrc

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your .nodehawkrc and it validates in your browser — nothing is uploaded.

Validate a .nodehawkrc → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`paths`	`oneOf`	A string or an array of paths to watch. Supports globbing. default: `"./src"`
`root`	`string`	The root path from which all other paths will be resolved. default: `"."`
`ignored`	`string`	Paths, globs or regular expressions to ignore. default: `""`
`exec`required	`string`	The command to execute on file change. default: `""`
`port`	`integer`	The port on which the server should run. This is passed to your application as `process.env.PORT` which should be used by you. default: `4000`
`logLevel`	`integer`	The level of logging. 0 - fatal, 1 - error, 2 - warning, 3 - info, 4 - debug default: `3`
`buffer`	`integer`	The buffer duration to wait before triggering a restart. default: `1500`
`bufferPoll`	`integer`	The buffer polling interval to check for the file stability. default: `100`
`display`	`object`	The various messages to display during different events.
`display.onBeforeStart`	`string`	The message to display before the watcher starts. default: `"Starting..."`
`display.onStart`	`string`	The message to display after the watcher starts. default: `"Started"`
`display.onBeforeRestart`	`string`	The message to display before the watcher restarts. default: `"Restarting..."`
`display.onRestart`	`string`	The message to display after the watcher restarts. default: `"Restarted"`
`display.onBeforeStop`	`string`	The message to display before the watcher stops. default: `"Stopping..."`
`clearScreen`	`boolean`	Clear the screen on start and on every restart. default: `true`
`env`	`object`	A set of key-value pairs which will be promptly passed on to your process and accessible via `process.env`. default: `{}`

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
16 properties, 100% carrying a description, max nesting depth 6.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas