Enhancements & Dependencies Upgrade

Breaking Changes

The merge step (which merges the close text items) has been disabled by default, that's because in the latest versions of pdf-js it's no longer needed.

And thus it's important to upgrade your projects to the latest pdf-js or use new the mergeItems options that can be passed to the top-level functions.

Otherwise the API is actually still compatible with it's previous release (2.0.4).

Enhancements

• Improved how student name & father name are parsed.
• Improved how the full mark is determined (Fix #107).

Other Changes

• Upgrade all the development dependencies to their latest versions.
• New options parameter for extractMarksFromDocument and extractMarksFromPage.
• Added a script for visualizing the document items in development (run yarn visualize in your cloned instance of this repository).
• Fix some English typos here and there.
• Rename the default branch from master to main.
• Fix the README.md badges links.

Happy Studying!

Full Changelog: v2.0.4...v3.0.0

Upgrade dependencies

• Upgrade to the latest dependencies.
• Apply the security patch for ansi-regex.
• Switch to a monthly packages upgrade cycle (instead of weekly).

Improve documentation

• Typedoc has been updated to provide dark theme support for the documentation.
• Switch back to the default typedoc theme because minimal has been removed.

Bundling Improvements

Improvements

• Add ES modules support, which allows for tree shaking.
• CommonJS support is still included.
• The module minzipped size is now down to 1.4 KB.
• Reached code quality A+ on Codefactor.
• Achieved 100% code coverage.
• More suitable for browsers usage.

Breaking changes

• Removed loadAndExtractMarksFromDocument, because it's causing the pdfjs-dist dependency, and not suitable for the browser.
• Users should now import pdfjs-dist on and load the document on their own.

Miscellaneous

• Remove pdfjs-dist from the dependencies, and make it a dev dependency instead.
• Updated the examples in README.md to include how to load the documents using pdfjs-dist.
• Added Jest for unit testing, the module is now tested with 100% coverage as reported by Codecov.
• Added eslint for linting the source code.

Code quality improvements

Code quality improvements by @YamanQD to reach level A on Codefactor.

Minor 'package.json' improvement

Update the homepage url in package.json.

README.md Improvements

Improve the README.md documentation.

Initial release

The initial release of the ourmarks module