`just.config.js`

just.config.js is a configuration file for the Just an Ultimate Site Tool. This is JavaScript file that should export the configuration as Object that will be parsed to a JSON file by Just an Ultimate Site Tool. When running, Just an Ultimate Site Tool always tries to resolve the config file named just.config.js in the repository root.
The most basic configuration file would look like this:

JavaScript
module.exports = {
  // ...
}

Note that Just an Ultimate Site Tool does not support export default.

You don't need a package.json file or its type option.

Preprocessing

Just an Ultimate Site Tool supports preprocessing by compilers:

TypeScript compiler
Dart Sass

Third-party compilers may not be as fast, so they can slow down the process significantly.

To use any of these compilers, add compile:
just.config.js

JavaScript
module.exports = {
  // ...
  compile: {
    // ... ( extension : true )
  }
}

›Example

just.config.js

JavaScript
module.exports = {
  // ...
  compile: {
    ts: true, // TypeScript compiler
    sass: true, // Dart Sass
    scss: true // Dart Sass
  }
}

But then, before running Just an Ultimate Site Tool, make sure you have installed the compilers that you are going to use. You can also install those compilers through Just an Ultimate Site Tool when running it:

Installing third-party dependencies

To install any of the supported compilers listed above, add install:
just.config.js

JavaScript
module.exports = {
  // ...
  install: {
    // ... ( lowercased name with spaces replaced with underscores : true )
  }
}

›Example

just.config.js

JavaScript
module.exports = {
  // ...
  install: {
    typescript_compiler: true,
    dart_sass: true
  }
}

The positions of compile and install in the config file do not matter.

Postprocessing

Just an Ultimate Site Tool provides some postprocessing options:

Sitemap generator
Inserter

These are included in Just an Ultimate Site Tool and are not third-parties nor need to be installed separately from Just an Ultimate Site Tool.

Sitemap generator

It generates a sitemap.xml file.
just.config.js

JavaScript
module.exports = {
  // ...
  sitemap: {
    generateSitemap: true,
    protocol: 'https:', // or 'http:'. Required.
    // ...
  }
}

You can specify input and output directories, as well as modify output URLs:
just.config.js

JavaScript
module.exports = {
  // ...
  sitemap: {
    // ...
    base: 'path/to/website', // Input dir. GitHub Action path input from your workflow file or '.' by default.
    output: 'path/to/website/output', // Output dir. Input dir by default.
    path: 'example/path/', // Modifies output URLs. This example will add "example/path" to the output URLs right after the host name ("https://example.com/example/path/file.html"). GitHub Action fix-path input from your workflow file by default.
    unpath: 'example_prefix' // Modifies output URLs. This example will remove "example_prefix" from the file path ("https://example.com/example_prefix_file.html" -> "https://example.com/_file.html").
  }
}

You can also specify pages that should not be included in the sitemap:
just.config.js

JavaScript
module.exports = {
  // ...
  sitemap: {
    // ...
    hidePages: [
      '/path/to/page' // The path to a page should start with a slash and should not end with an extension name.
    ]
  }
}

Inserter

Currently, it allows you to insert anything you want into the <head> of every HTML page:
just.config.js

JavaScript
module.exports = {
  // ...
  insert: {
    htmlHead: '<!-- This will be inserted into the head tag of every HTML page /-->'
  }
}