A clone of ssh://git@git.pep-security.lu:23000/thunderbird/pEpForThunderbird.git, until that one is open source again.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

55 lines
1.5 KiB

3 years ago
3 years ago
  1. MOSTLY OUT-OF-DATE (Feb. 2021)
  2. # p≡p for Thunderbird
  3. This is a Thunderbird extension providing p≡privacy to your mail. It
  4. relies on the [p≡p JSON adapter][adapter] to access the key
  5. management, synchronisation and automation logic provided by the p≡p
  6. engine.
  7. ## How To Build
  8. Using bash
  9. Just run `make` to build from the current source, producing a file in
  10. `build/p4t.xpi` that can be installed from Thunderbird's add-ons
  11. manager page clicking on "Install from file". For information about
  12. building and running the engine adapter see [its repo][adapter].
  13. ```cd addon ; zip -r ../build/pEp4Tb@pEp.security.xpi . ; cd ..```
  14. ## Check syntax statically
  15. You can parse the code with [Babel](https://babeljs.io/) in order to
  16. catch syntax errors. After installing with `npm install` just run:
  17. npm run syntaxCheck
  18. ## Run ESLint
  19. You can run ESLint to check the style guides defined in `.eslintrc.json` with the npm script:
  20. npm run lint
  21. ESLint can auto fix some problems with the option `--fix` but most of them must be fixed manually:
  22. npm run lint --fix
  23. npm run lint -- --fix (on Windows)
  24. ## Tests
  25. To run tests first is needed to install all dependencies
  26. npm install
  27. ### Run
  28. npm run test
  29. npm run linttest
  30. ## More info
  31. Check the `DEVELOPMENT.md` file here for a collection of development
  32. notes. See also [our dev wiki](https://dev.pep.security/thunderbird/).
  33. [adapter]: https://pep.foundation/dev/repos/pEpJSONServerAdapter "JSON Adapter"