Skip to content

Commit

Permalink
docs: remove linting section from the README
Browse files Browse the repository at this point in the history
  • Loading branch information
@rabi-siddique
rabi-siddique committed May 23, 2024
1 parent 2d1210e commit dc8679f
Showing 1 changed file with 37 additions and 38 deletions.
75 changes: 37 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

#

`@agoric/synpress` is a testing framework designed to test DApps that use the Keplr Wallet.
`@agoric/synpress` is a testing framework designed to test DApps that use the
Keplr Wallet.

For full commands and their examples,
[check here](https://github.com/agoric-labs/synpress/blob/master/support/index.d.ts).
Expand Down Expand Up @@ -34,27 +35,12 @@ project_dir
└── src
└── tests
└── e2e
└── .eslintrc.js
└── support.js
└── specs
└── example-spec.js
```

1. Create `.eslintrc.js` inside your tests folder (`/project_dir/tests/e2e`):

```js
const path = require('path');
const synpressPath = path.join(
process.cwd(),
'/node_modules/@agoric/synpress',
);

module.exports = {
extends: `${synpressPath}/.eslintrc.js`,
};
```

2. Create `support.js` inside your tests folder (`/project_dir/tests/e2e`):
1. Create `support.js` inside your tests folder (`/project_dir/tests/e2e`):

```js
import '@agoric/synpress/support/index';
Expand All @@ -63,7 +49,8 @@ import '@agoric/synpress/support/index';
_^ hint: you can also use this file to extend synpress - add custom commands,
and more.._

3. Add a command to your package.json file
2. Add a command to your package.json file

```json
{
...
Expand All @@ -74,7 +61,12 @@ and more.._
}
```

4. **(Optional)** Create a custom config file. @agoric/synpress aleardy has some configurations set up in this [file](https://github.com/agoric-labs/synpress/blob/master/synpress.config.js). To override this and add your custom config, you can create your own config file `synpress.config.js` in `/project_dir/tests/e2e`
3. **(Optional)** Create a custom config file. @agoric/synpress aleardy has some
configurations set up in this
[file](https://github.com/agoric-labs/synpress/blob/master/synpress.config.js).
To override this and add your custom config, you can create your own config
file `synpress.config.js` in `/project_dir/tests/e2e`

```js
const baseConfig = require('@agoric/synpress/synpress.config');
const { defineConfig } = require('cypress');
Expand All @@ -87,8 +79,10 @@ module.exports = defineConfig({
},
});
```
       
use this config by passing the `--configFile` flag to synpress

        use this config by passing the
`--configFile` flag to synpress

```json
{
...
Expand All @@ -100,29 +94,34 @@ use this config by passing the `--configFile` flag to synpress

```


5. You're done! 🎉
4. You're done! 🎉

</br>

For an example project, you can take a look at how we've set up tests in this [repository](https://github.com/agoric-labs/synpress/tree/dev/tests/e2e)
For an example project, you can take a look at how we've set up tests in this
[repository](https://github.com/agoric-labs/synpress/tree/dev/tests/e2e)

## 📃 Environmental variables

| Variable | Description |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `EXTENSION` (Required) | Picks which extension to use during tests. `keplr` and `metamask` are the only possible values |
| `SECRET_WORDS` | Space separated words for the test wallet recovery phrase (mnemonic; 24 words) |
| `PRIVATE_KEY` | Test wallet private key |
| `SYNDEBUG` | Set debugging mode to be on |
| `STABLE_MODE` | Introduce delay between main actions, 300ms by default (eg `STABLE_MODE=300ms`, `STABLE_MODE=true`) |
| `SLOW_MODE` | Introduce delay between every action, 50ms by default (eg `SLOW_MODE=true`, `SLOW_MODE=200ms`) |
| `KEPLR_VERSION` | Keplr version to be installed |
| `SKIP_KEPLR_INSTALL` | Will skip installation of keplr wallet |
| `SKIP_EXTENSION_SETUP` | Will skip initial setup of wallet |

These is a basic list of environment variables to be used. A more in depth list can be found [here](https://github.com/Synthetixio/synpress#-environmental-variables)
| Variable | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------- |
| `EXTENSION` (Required) | Picks which extension to use during tests. `keplr` and `metamask` are the only possible values |
| `SECRET_WORDS` | Space separated words for the test wallet recovery phrase (mnemonic; 24 words) |
| `PRIVATE_KEY` | Test wallet private key |
| `SYNDEBUG` | Set debugging mode to be on |
| `STABLE_MODE` | Introduce delay between main actions, 300ms by default (eg `STABLE_MODE=300ms`, `STABLE_MODE=true`) |
| `SLOW_MODE` | Introduce delay between every action, 50ms by default (eg `SLOW_MODE=true`, `SLOW_MODE=200ms`) |
| `KEPLR_VERSION` | Keplr version to be installed |
| `SKIP_KEPLR_INSTALL` | Will skip installation of keplr wallet |
| `SKIP_EXTENSION_SETUP` | Will skip initial setup of wallet |

These is a basic list of environment variables to be used. A more in depth list
can be found
[here](https://github.com/Synthetixio/synpress#-environmental-variables)

## 📝 More resources

`@agoric/synpress` uses Synpress as its base and therefore supports most of its functionality. To learn more about command line options, usage examples, and CI/CD setup, you can use the original [README file](https://github.com/Synthetixio/synpress/blob/dev/README.md)
`@agoric/synpress` uses Synpress as its base and therefore supports most of its
functionality. To learn more about command line options, usage examples, and
CI/CD setup, you can use the original
[README file](https://github.com/Synthetixio/synpress/blob/dev/README.md)

0 comments on commit dc8679f

Please sign in to comment.