pEpForThunderbird/README.md

MOSTLY OUT-OF-DATE (Feb. 2021)

# p≡p for Thunderbird

This is a Thunderbird extension providing p≡privacy to your mail. It
relies on the [p≡p JSON adapter][adapter] to access the key
management, synchronisation and automation logic provided by the p≡p
engine.

## How To Build
Using bash

Just run `make` to build from the current source, producing a file in
`build/p4t.xpi` that can be installed from Thunderbird's add-ons
manager page clicking on "Install from file". For information about
building and running the engine adapter see [its repo][adapter].

```cd addon ; zip -r ../build/pEp4Tb@pEp.security.xpi . ; cd ..```

## Check syntax statically

You can parse the code with [Babel](https://babeljs.io/) in order to
catch syntax errors. After installing with `npm install` just run:

    npm run syntaxCheck

## Run ESLint

You can run ESLint to check the style guides defined in `.eslintrc.json` with the npm script:

    npm run lint

ESLint can auto fix some problems with the option `--fix` but most of them must be fixed manually:

    npm run lint --fix
    npm run lint -- --fix (on Windows)


## Tests

To run tests first is needed to install all dependencies

    npm install

### Run

    npm run test
    npm run linttest

## More info

Check the `DEVELOPMENT.md` file here for a collection of development
notes. See also [our dev wiki](https://dev.pep.security/thunderbird/).

[adapter]: https://pep.foundation/dev/repos/pEpJSONServerAdapter "JSON Adapter"