ScannerJS

A basic string parser based on the Scanner class in Java. Built for PSHS's annual coding scrimmage for beginners.

Prequisites

• Node.js
• TypeScript

Building

To build this repository, enter the following in command prompt:

git clone https://github.com/pshscc/scannerjs.git
cd scannerjs
npm install

Scripts

To run these scripts, enter the following in command prompt:

npm run <name of script>

Name	Description
compile	Compiles scanner.ts and generates scanner.js.
compile:rc	Compiles scanner.ts and generates scanner.js with no comments.
docs	Produces documention for scanner.js.
test	Runs the tests for scanner.js.

Documentation

All documentation is located in the generated ./docs folder and can also be found here.