Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Config

Index

Enumerations

Classes

Variables

Functions

Object literals

Variables

Const BUILT_IN_DIRECTIVES

BUILT_IN_DIRECTIVES: (HtmlFromDataSource | PublicFileList | InsertScriptSrc | InsertStylesSrc | UrlTo)[] = [HtmlFromDataSource,PublicFileList,InsertScriptSrc,InsertStylesSrc,UrlTo]

Array of the built-in directives that can be invoked in the forEach loop in DirectivesInvoker.

see

DirectivesInvoker

Functions

getConfigurationFromFile

setDirs

  • setDirs(skipOut: boolean): void

setupYassb

  • Setups YASSB. After getting the configuration copies the renderers to the RENDERERS_STORE store. Then it cals workingDirSetter and langSetter to set respectively the folders of the project and the languages.

    Returns YassbConfig

    yassbConfig returns the configuration object so it can be used by build and watch.

skipOutCondition

  • skipOutCondition(key: keyof typeof WORKING_DIR, skipOut: boolean): boolean

workingDirSetter

  • workingDirSetter(workingDir: YassbConfig["workingDir"], skipOut?: boolean): void

  • Set the working dir based on the default values or the values passed in the configuration.

    Parameters

    • workingDir: YassbConfig["workingDir"]

      the values for the workingDir option passed in the ocnfiguration.

    • Default value skipOut: boolean = false

      whether to skip the creation of out folders and assets. Used to create a new project.

    Returns void

Object literals

Const WORKING_DIR

WORKING_DIR: object

Constant to store the paths to the assets of the project to elaborate

app

app: string = undefined as string

Contains all the files processed by YASSB

assets

assets: string = undefined as string

Website assets. It's cloned in out. Scripts and Styles are also placed here

base

base: string = undefined as string as string

Root folder of the project

components

components: string = undefined as string

Contains HTML files with fragments to be injected into pages (e.g. footer)

dataSources

dataSources: string = undefined as string

Contains the JSON files with the data to generate iterable items

i18n

i18n: string = undefined as string

Contains the localization files ([lang].json) with translation strings

out

out: string = undefined as string

Destination dir of the compiled project - defaults to dist/public

pages

pages: string = undefined as string

HTML pages of the web site (excluded those to be generated automatically)

pagesToGenerate

pagesToGenerate: string = undefined as string

HTML templates to be used when creating pages from .md files

posts

posts: string = undefined as string

ALIAS of app, default entry point for the user-defined folder in the generate-from-files directive.

remarks

Need to allow scanning of the root folder of the user "posts" folder cannot have an empty value

scripts

scripts: string = undefined as string

Entry file to be processd by webpack. Can end with: .js | .ts

scriptsOutFolder

scriptsOutFolder: string = undefined as string

Destination dir of minified JS file, retains the same name of the entry file + version + min.js

src

src: string = undefined as string

Container the whole YASSB project

styles

styles: string = undefined as string

Entry file to be processd by node-sass. Can end with: .css | .scss

stylesOutFolder

stylesOutFolder: string = undefined as string

Destination di of minified css file, retains the same name of the entry file + version + min.css