Cartridge lib fs

Introduction

Cartridge library implementation of node fs api.

Build with

• Generator Cartridge Lib Module

Installation

As standard SFCC cartridge

This library can be installed as a standard SFRA cartridge cloning the repository and running npm script uploadCartridge

$ git clone [email protected]:pikamachu/pika-cartridge-lib-fs.git
$ cd pika-cartridge-lib-fs
$ npm run uploadCartridge

As npm library dependency on SFRA project

This library can be added to an existing SFRA project as npm library dependency using

$ npm i cartridge_lib_fs

This option is recommended for develop environments using vscode + Prophet Debugger

The Prophet Debugger Extension should be set with this configuration on user settings.json

"extension.prophet.upload.enabled": true,
"extension.prophet.ignore.list": ["\\.git", "\\.zip$"],

Usage

This cartridge library is a node fs api implementation using dw api.

The fs module can be loaded using require cartridge as a standard SFRA script.

var fs = require('*/cartridge/scripts/lib/fs/index');

See fs documentation for module usage.