Create a graph of referenced resources
yarn add makestatic-graph-resources
Create a graph of referenced resources.
For each HTML, CSS and Javascript file inspect the abstract syntax tree and create a resource graph of referenced assets.
new GraphResources(context)
Create a GraphResources plugin.
Enable this plugin for the graph
phase.
-
context
Object the processing context.
GraphResources.prototype.sources(file, context, options)
Inspects the abstract syntax tree for each file to find referenced resources and add them to the graph.
If a file does not have an associated abstract syntax tree a document is added to the resource graph but no parsing is performed on the document.
-
file
Object the file being processed. -
context
Object the processing context. -
options
Object the plugin options.
Represents a document entry in the graph.
new Document(file)
Create a document.
-
file
File the encapsulated file.
readonly Array resources
List of resources referenced in this document.
readonly File file
Reference to the file that created this document.
readonly String id
Document identifier derived from the file path.
Represents an HTML document entry in the graph.
new HtmlDocument(file)
Create an HTML document.
-
file
File the encapsulated file.
Object anchors
List of anchor links.
Plugins that execute during the verify phase can use this to check if named anchors exist on the page or test whether external links return a valid HTTP status code.
Object identifiers
Map of id attributes.
Plugins that execute during the verify phase can use this to determine if a document contains duplicate id attributes.
Object ast
Get a reference to the file abstract syntax tree.
HtmlDocument.prototype.parse()
Traverse the file abstract syntax tree and parse resources in to this document.
Note that in the case of a base
element with an href
attribute a
resource is not created but all subsequent URLs are considered relative
to the base URL.
- href (a, area, base, link)
- src (audio, embed, iframe, img, input, script, source, track, video)
- action (form)
- cite (blockquote, del, ins, q)
- code (applet)
- codebase (applet)
- data (object)
- manifest (html)
Represents a CSS document entry in the graph.
new CssDocument(file)
Create a CSS document.
-
file
File the encapsulated file.
Object ast
Get a reference to the file abstract syntax tree.
CssDocument.prototype.parse()
Traverse the file abstract syntax tree and parse resources in to this document.
This implementation parses @import rules using either string URLs or the
url()
function notation. It also parses all url()
function
declarations in normal CSS rule declarations.
Represents the application resource graph.
new Graph()
Create a resource graph.
readonly Object map
Maps file keys to resources.
Graph.prototype.addDocument()
Adds a document to the graph.
readonly Array documents
List of documents without abstract syntax trees.
readonly Array htmlDocuments
List of HTML documents.
readonly Array cssDocuments
List of CSS documents.
Graph.prototype.createDocument(file)
Create a document.
Returns a new document.
-
file
File the encapsulated file.
Graph.prototype.createHtmlDocument(file)
Create an HTML document.
Returns a new HTML document.
-
file
File the encapsulated file.
Graph.prototype.createCssDocument(file)
Create a CSS document.
Returns a new CSS document.
-
file
File the encapsulated file.
Represents a referenced resource.
The resource may exist within the output file structure or may point to an external (absolute) resource.
new Resource(uri, node[, base])
Creates a resource.
-
uri
String uniform resource identifier. -
node
Object abstract syntax tree node. -
base
String a base URL.
readonly String uri
Uniform resource identifier.
readonly Object node
An abstract syntax tree node associated with this resource.
readonly String base
Base URL for this resource.
Resource.prototype.isAbsolute(uri)
Determine if a URI is absolute.
If no URI is given the URI for this resource is used.
Returns a boolean indicating if this resource is absolute.
-
uri
String uniform resource identifier.
readonly String canonical
Get the canonical URI for this resource relative to the base
if a base
URL has been associated with this resource.
When no base
URL is assigned to this resource it will return the uri
.
MIT
Created by mkdoc on March 13, 2017