The following case study is meant to show the technical understanding and tangible workflow of a new Filter/Automation Engineer..

To install all dependencies, run:

npm install

To start the project, run:

npm run

To start the project, run:

npm test

Top-leve directory layout of the project

.
├── doc                     # Documentation files
├── lib                     # Library files
├── out                     # Output files
├── test                    # Unit test files
├── app.js                  # Main program
├── package.json
└── README.md

Directory layout of lib which contains common functions used by the project like delay, files, log etc.,

.
├── ...
├── lib                     # Library files
│   ├── abp_chrome          # AdBlockPlus chrome extension
│   ├── common.js           # Common functions
│   └── extra.js            # Extra features needed
└── ...

Directory layout of out which contains output files like screenshot, bounding rectangles data etc.,

.
├── ...
├── out                                # Output files
│   ├── bounding_rects.json            # Bounding rectangles
│   ├── marked_screenshot.png          # Entire page screenshot with marked rectangles
│   └── screenshot.png                 # Entire page screenshot
└── ...

See /doc for more information.

• canvas: Canvas is used to draw bounding rectangles on screenshot.
• fs: 'fs' is a file system package used to read/write files.
• puppeteer: A high-level API to control headless Chrome over the DevTools Protocol.

• chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
• chai-fs: Chai assertions for Node.js filesystem.
• jsdoc: An API documentation generator for JavaScript.
• mocha: Simple, flexible, fun test framework.