Skip to content

Commit c480d0d

Browse files
authored
Adding Tester Docs + Removing the old Compiler (#691)
* update readme * remove the legacy compiler * readme tweak
1 parent 511ffad commit c480d0d

16 files changed

+9
-951
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,15 @@ If you need to add an external dependency to an integration, **please ensure you
3434
Each integration directory has an npm script called `test` that you can use to easily run the unit tests with via `yarn test`.
3535

3636
### Test Locally
37-
You can test changes to integrations locally with the [a.js compiler](https://github.com/segmentio/analytics.js-integrations/tree/master/compiler).
37+
To test changes locally you can run:
38+
39+
```
40+
yarn --cwd tester install
41+
yarn dev
42+
```
43+
This will open the local development environment. To test a particular destination, enter a writeKey that has the destination connected, and the tool will load Analytics.js with the local version of the destinations connected, and the settings for the source. After the first load, you can referesh the page without having to load the writeKey each time.
44+
45+
If you want to test a new destination or a new settings parameter, you can override the settings using the integrated JSON editor. To fire track, page, etc. calls, you can use the Chrome DevTools and fire events using `analytics.track( .... )` etc.
3846

3947
### Code Formatting
4048
This project uses eslint to ensure uniform code formatting standards are maintained. You can see the specific eslint config in the root `.eslintrc` file. A pre-commit hook is used to help automate this process for you.

compiler/.gitignore

-73
This file was deleted.

compiler/README.md

-107
This file was deleted.

compiler/builds/.gitkeep

Whitespace-only changes.

compiler/compile

-91
This file was deleted.

compiler/lib/analytics.js

-17
This file was deleted.

compiler/lib/index.js

-55
This file was deleted.

0 commit comments

Comments
 (0)