@withuno/locust
v0.4.7
Published
A fork of @buttercup/locust with TypeScript support and new features incoming...
Downloads
1
Readme
Locust
Login form location utility forked from
@buttercup/locust
.
About
Locust helps find login forms by searching the DOM for common login form elements. It processes a page and returns targets which can be used for automating logins.
Installation
npm install @withuno/locust
Usage
import { LoginTarget } from "@withuno/locust";
const target = LoginTarget.find();
if (target) {
const form = target.get("form");
const usernameInput = target.get("username");
const passwordInput = target.get("password");
const submitButton = target.get("submit");
usernameInput.value = "myUsername";
passwordInput.value = "myPassword";
submitButton.click();
}
The example above enters the username and password in the best form found on the page and then proceeds to submit that form (logging the user in).
To find all forms on a page, use the LoginTarget.findAll()
method instead, which returns an array of login targets. You can then sort through these to find all the different login forms that may exist.
[!NOTE]
LoginTarget.find()
may returnnull
if no form is found.
Development
Environment Setup
First, download all dependencies using NPM:
npm install
You can start serving a hot-reloading development server with the following command:
npm run dev
Testing
Unit tests:
npm run test:unit
Integration tests:
npm run test:integration
On-demand integration test:
npm run test:integration <url>
# for example:
npm run test:integration https://github.com/login
VSCode Workspace Setup (optional)
Recommended Extensions:
Optimal Settings:
{
// A listing of language IDs which should be validated by ESLint.
// NOTE: If not installed, ESLint will show an error.
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
// ESLint rules that should be executed when computing `codeActionsOnSave`.
// You can ignore rules using glob patterns (e.g.: "!@typescript-eslint/no-unsafe-assignment").
"eslint.codeActionsOnSave.rules": [
"*"
],
// Code actions to be executed upon save.
//
// NOTE: To improve performance, code actions
// should be "opt-in" on a per-extension basis.
"editor.codeActionsOnSave": {
"source.fixAll": false,
"source.organizeImports": false,
"source.fixAll.eslint": true,
},
}