Merge branch 'feature/split' into develop

Author: vbuch

.babelrc

@@ -1,3 +1,4 @@
 node_modules
 coverage
 dist
+jest.config.js

.eslintignore

@@ -0,0 +1,53 @@
+on:
+  push:
+    branches:
+      - feature/split
+
+name: monorepo
+
+jobs:
+  do-de-stuff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: yarn
+      - run: ./node_modules/.bin/lerna run lint
+      - run: ./node_modules/.bin/lerna run test -- --coverage
+      - name: Coveralls (signpdf)
+        uses: coverallsapp/github-action@master
+        with:
+          parallel: true
+          flag-name: signpdf
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          base-path: packages/signpdf
+          path-to-lcov: packages/signpdf/coverage/lcov.info
+      - name: Coveralls (utils)
+        uses: coverallsapp/github-action@master
+        with:
+          parallel: true
+          flag-name: utils
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          base-path: packages/utils
+          path-to-lcov: packages/utils/coverage/lcov.info
+      - name: Coveralls (placeholder-pdfkit010)
+        uses: coverallsapp/github-action@master
+        with:
+          parallel: true
+          flag-name: placeholder-pdfkit010
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          base-path: packages/placeholder-pdfkit010
+          path-to-lcov: packages/placeholder-pdfkit010/coverage/lcov.info
+      - name: Coveralls (placeholder-plain)
+        uses: coverallsapp/github-action@master
+        with:
+          parallel: true
+          flag-name: placeholder-plain
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          base-path: packages/placeholder-plain
+          path-to-lcov: packages/placeholder-plain/coverage/lcov.info
+      - name: Close Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          parallel-finished: true
+          carryforward: "signpdf,utils,placeholder-pdfkit010,placeholder-plain"

.eslintrc

@@ -9,6 +9,7 @@ yarn-error.log*
 
 coverage
 .coveralls.yml
+packages/examples/output
 
 node_modules/
 .npm

.github/workflows/monorepo.yml

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## [3.0.0]
+
+* Deprecating `node-signpdf` to be replaced by the `@signpdf` scoped packages;
+* Split the helpers into separate packages `@signpdf/placeholder-pdfkit010` and `@signpdf/placeholder-plain`;
+* Decoupled the signing algorythm and the PDF signing process. Now `@signpdf/signpdf` understands PDFs and `@signpdf/signer-p12` understands P12 and `node-forge`;
+* sign() is now async to allow for hooking different signers;
+* placeholder helpers now require `contactInfo`, `location` and `name` which used to be optional;
+* Introduced examples in `packages/examples`;
+* Introduced more types declarations through TS and JSDoc;
+
 ## [2.0.0]
 
 * Only publish dist files into npm (see https://bit.ly/46rykd7 on why this requires a major version);

.github/workflows/not-travis.yml

@@ -1,11 +1,21 @@
 # Contributing
 
-* All PRs are welcome in the `develop` branch.
-* Please, stick to the repo's defined [Purpose](README.md#purpose) and try to write your code as readable as possible.
+* **All PRs are welcome** in the `develop` branch.
+* Please, stick to the defined [Purpose](https://github.com/vbuch/node-signpdf#purpose) of the repo and try to write your code as readable as possible.
+* [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/) + [Lerna](https://lerna.js.org/) are used in this **monorepo**.
 * We do code reviews and may ask you to change things before we merge code.
-* This is a git-flow repo. We use the default git flow with a `v` version prefix. You shouldn't care much while writeing a feature but good to know.
 * Note that [gitmoji](https://gitmoji.carloscuesta.me/) is used in the commit messages. That's not a must but we think it's nice.
 
+## Useful commands
+
+- `$ yarn lint` - As run in your pre-commit
+- `$ yarn test` - As run in your pre-push
+- `$ ./node_modules/.bin/lerna run build` builds all the packages in their respective `dist` folders.
+- `$ ./node_modules/.bin/lerna run test --scope=@signpdf/signpdf -- --watch --coverage` runs tests in a specified package tracking coverage and watching.
+- `$ yarn workspace @signpdf/signpdf add node-forge -D` adds a `node-forge` as a dev dependency 
+of `@signpdf/signpdf`
+- `$ yarn workspace @signpdf/signpdf add @signpdf/some-new-subpackage@* -D` adds a `@signpdf/some-new-subpackage` as a dev dependency of `@signpdf/signpdf`. Note the `@*` version specifier.
+
 ## Contributors
 
 * [vbuch](https://github.com/vbuch)