Class PostProcessFile

Post processes each file passed by PostProcessFiles

Hierarchy

PostProcessFile

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PostProcessFile(pathToFile: string, config: YassbConfig, isWatching: boolean): PostProcessFile

- Defined in src/post-processing/post-process-file.class.ts:21
Creates an instance of post process file.

Parameters
- pathToFile: string
  
  full absolute path to the file being processed
- config: YassbConfig
  
  full YASSB configuration object
- isWatching: boolean
  
  determins if in watch mode to skip roduction-only steps
Returns PostProcessFile

Properties

Private config

config: YassbConfig

full YASSB configuration object

Private fileContents

fileContents: string

Contents of the file to post process

Private fileData

fileData: FrontMatterData

Front Matter data found in fileContents

Private isWatching

isWatching: boolean

determins if in watch mode to skip roduction-only steps

Private pathToFile

pathToFile: string

full absolute path to the file being processed

Methods

init

init(): Promise<void>

- Defined in src/post-processing/post-process-file.class.ts:41
Inits post process file logic.

Returns Promise<void>

init

Private injectFrontMatterData

injectFrontMatterData(fileData: FrontMatterData): void

- Defined in src/post-processing/post-process-file.class.ts:112
Injects Front Matter data if any was fond in the file.

Parameters
- fileData: FrontMatterData
  
  Front Matter data retrieved from the store for the current file.
Returns void

Private postProcessFile

postProcessFile(): void

- Defined in src/post-processing/post-process-file.class.ts:67
Handles the logic to post process each file by calling the methods in charge of the actions to be performed.

Returns void

Private prepareCodeForSaving

prepareCodeForSaving(): void

- Defined in src/post-processing/post-process-file.class.ts:90
Prepares the content to be saved. If in watch mode, addes the WebSocket listener for live reloading. Else minifies the content.

Returns void

Private runCustomPostProcessors

runCustomPostProcessors(): void

- Defined in src/post-processing/post-process-file.class.ts:101
Runs custom post processors if set in congig.

Returns void

Private saveToDiskFinalVersionOfFile

saveToDiskFinalVersionOfFile(): void

- Defined in src/post-processing/post-process-file.class.ts:81
Saves to disk the final version of file

Returns void

Private setFileContents

setFileContents(): Promise<void>

- Defined in src/post-processing/post-process-file.class.ts:52
Reads asynchronously the file and sets the contents on fileContents.

Returns Promise<void>

file contents

Private setFileData

setFileData(): void

- Defined in src/post-processing/post-process-file.class.ts:60
Sets file data by fetching it from FRONT_MATTER_DATA_STORE. In this way any Front Matter data is removed from the page and is available for the final injections.

Returns void