https://github.com/lemaiwo/ui5-task-cachebuster-indexing

UI5 Tooling Task that for indexing files to enable the cachebuster directly into the dist folder
https://github.com/lemaiwo/ui5-task-cachebuster-indexing

Last synced: 19 days ago
JSON representation

UI5 Tooling Task that for indexing files to enable the cachebuster directly into the dist folder

• Host: GitHub
• URL: https://github.com/lemaiwo/ui5-task-cachebuster-indexing
• Owner: lemaiwo
• License: mit
• Created: 2021-04-13T21:19:03.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-04-19T20:45:51.000Z (over 3 years ago)
• Last Synced: 2024-09-27T04:42:18.284Z (about 2 months ago)
• Language: JavaScript
• Size: 20.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UI5 task for indexing cachebuster files

 UI5 Tooling Task that for indexing files to enable the cachebuster directly into the dist folder

## Install

```bash

npm install ui5-task-cachebuster-indexing --save-dev

```

## Configuration options (in `$yourapp/ui5.yaml`)

- debug: `true|false`  

  verbose logging

## Usage

1. Define the dependency in `$yourapp/package.json`:

```json

"devDependencies": {

    // ...

    "ui5-task-cachebuster-indexing": "*"

    // ...

},

"ui5": {

  "dependencies": [

    // ...

    "ui5-task-cachebuster-indexing",

    // ...

  ]

}

```

> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies.

2. configure it in `$yourapp/ui5.yaml`:

```yaml

builder:

  customTasks:

  - name: ui5-task-cachebuster-indexing

    afterTask: generateVersionInfo

    configuration:

      debug: true

```

Or when the task "generateCachebusterInfo" is enabled

```yaml

builder:

  customTasks:

  - name: ui5-task-cachebuster-indexing

    afterTask: generateCachebusterInfo

    configuration:

      debug: true

```

## How it works

The task will run the default generate cachebuster info task and make a clone of all resources with the timestamp from the cachebuster info in the path. This will generate the resources with a path that can be found by the cachebuster. 

For example a file with name "Component-dbg.js" will be cloned to  "~1618522173771~/Component-dbg.js", or another example "model/models.js" will be cloned to "~1618522173782~/model/models.js".

It is not needed to run the "generateCachebusterInfo" task as this already done inside this one. Nevertheless, this task should always be executed after the cachebuster info generation "generateCachebusterInfo".

## Known limitations

The task "generateCachebusterInfo" can be configured to use timestamp or hash. This task only supports timestamp as it's currently not possible to acces the global config inside a custom task.