Skip to content

Latest commit

 

History

History
116 lines (76 loc) · 4.04 KB

README.md

File metadata and controls

116 lines (76 loc) · 4.04 KB
Raw

RPA Doc

This app is used by the Robotic Process Automation (RPA) team at Flinders University to document our RPA projects. The app assumes that the project passes all checks implemented in our RPA Lint app.

We use UiPath to develop and manage our automations.

This app, developed using Node.js extracts information from the XAML code and project settings file to generate documentation.

Installation

To install the app:

  1. Download and install Node.js onto your computer

  2. Clone this repository

  3. Install the app dependencies using the following command:

    npm install

  4. Link to the package so it can be run from anywhere using the following command:

    npm link

Use the App

After the app has been linked you can use the app in one of two ways.

Specify the Path to the UiPath Project

You can run the app by specifying the path to the UiPath project folder using the -i option. For example:

rpa-doc -i U:\MyWork\UiPath\Flinders.Foundation\ -o U:\MyWork\UiPath\Flinders.Foundation.Docs

Automatically use the Current Working Directory

Alternatively, if the -i option is not set the current working directory is used. For example:

cd MyWork\UiPath\Flinders.Foundation\
rpa-doc -o U:\MyWork\UiPath\Flinders.Foundation.Docs

Command Line Options

To see a list of possible command line options, use the -h or --help option. For example:

rpa-doc --help

License

The app is licensed using the BSD 3-Clause License. Contributions, such as suggestions for new new features are welcome.

Frequently Asked Questions

Why use Node.js?

This is a good question. Using Invoke Code activities we could have implemented this type of analysis using UiPath. There are three main reasons for the decision to use Node.js.

  1. Our aim is to have as little code as possible in our automations. This makes them easier to develop and maintain. It also makes it easier for less experienced users to work with us on developing automations.
  2. The app needed to be cross platform. The app needs to be able to be run locally while developing an automation on Windows. The app also needs to be able to be run on common continuous integration infrastructure. So that code can be automatically checked.
  3. JavaScript continues to be one of the most popular development languages. Making it easier for developers to contribute and help maintain the app.

How do I run the unit tests?

We use the popular Mocha framework to develop and manage unit tests for the app. To run the tests, use the following command:

npm run test

How much of the app does the unit tests cover?

We use the popular c8 test coverage tool to monitor the test coverage. To generate a report, use the following command:

npm run coverage

Do you have a style for the JavaScript code?

We use the ESLint utility to lint our JavaScript code. To lint the code, use the following command:

npm run lint

Take a look at the .eslintrc.json file to see which rules we apply.

Is the JavaScript code documented?

We use JSDoc syntax and the related tool to generation internal documentation for the app. To generate the documentation using the latest version of the code, use the following command:

npm run docs