topcoder-ui-testing-lib

Introduction

• This is the library which has protractor helper/common functions.

Technologies Used

• npm
• Node.js
• Protractor
• Typescript

How to build Library

• Go to root folder and run command npm install.
• Run command npm run build:prod.
• Running command npm run build:prod will create folder lib and all the built/npm publishable code will be there.

How to use library locally

• Go to root folder and run command npm run build:dev and it will detect the changes and will run in the watch mode.
• Go to the project which depends on topcoder-ui-testing-lib, config its package.json so that the topcoder-ui-testing-lib points to the local folder path of topcoder-ui-testing-lib:

(Note: Package name can be different for that just change name in package.json file and publish)

"dependencies": {
   "topcoder-ui-testing-lib": "<local-path-to-topcoder-ui-testing-lib>",
   .....
}

Lint

• Run command npm run lint for the checking lint.

Project structure

• All the main code is inside folder src.
• common folder has all the common helper functions and po-helper folder has page object helpers.
• module folder has module wise common functions, as for now we only have login part so login folder is there.
• All the files which needs to be exported is kept inside index.ts file.

How to publish npm package

• Go to website npmjs and sign up.
• Run command npm run build:prod which will create folder lib which has all built publishable files.
• After successful build run command npm login and provide the valid credentials there (If already login then ignore).
• Run command npm publish if you are publishing the package first time (The package version will be what is written in the file package.json file, you can provide the version as well by running command npm version <version>).
• If the library already published in that case run command npm version <version> for example npm version 0.0.2 and run command npm publish.
• Once package is published you will get the message in console and an email in the registered email and the package is ready to use.