ssg-api

ssg-api

TypeScript API to generate a static website.

ssg-api has been developed to generate the RR0 website, so you'll find examples of Steps and Replacers in the website repository.

Concepts

Step

The Ssg execute a number of Steps, sequentially. A Step can do anything, but here are some pre-defined steps:

• CopyStep copies files;
• ContentStep executes a series of ReplaceCommands, sequentially.
• DirectoryStep performs operations on sub-directories, sequentially.

For instance:

 const context = new SsgContextImpl("fr")

new Ssg(config)
        .add(new ContentStep(contentConfigs, outputFunc))
        .add(dir1SubdirectoriesStep)
        .add(dir2SubdirectoriesStep)
        .add(...anArrayOfSteps)
        .add(new CopyStep(copiesToDo))
        .start(context)
        .then(result => console.log("Completed", result))
        .catch(err => console.error(err, context.inputFile.name, "=>", context.outputFile.name))

Extensibility

You can create:

• your own steps by implementing the SsgStep interface.
• your own context by implementing the SsgContext interface, typically to provide additional info to the custom .

Replacements

In the case of a ContentStep, predefined replacements are also available:

• RegexReplaceCommand executes a RegexReplacer as long it changes the contents of the current file.
  • StringEchoVarReplaceCommand replaces variables expressed as template literals (${varName}) in the input files.
  • SsiEchoVarCommand
• DomReplaceCommand replaces a DomReplacer on all nodes matched by a DOM selector.
• HtAccessReplaceCommand replaces .htaccess sections.