[ { "path": ".babelrc", "content": "{\n \"presets\": [\n [\n \"@babel/preset-env\",\n {\n \"modules\": false\n }\n ]\n ],\n \"env\": {\n \"test\": {\n \"plugins\": [\n \"istanbul\"\n ]\n }\n }\n}\n" }, { "path": ".browserslistrc", "content": "defaults\nie >= 9\n" }, { "path": ".editorconfig", "content": "root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 2\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n" }, { "path": ".eslintignore", "content": "*.local*\n.husky\ncoverage\ndist\ndocs\nnode_modules\n" }, { "path": ".eslintrc.js", "content": "module.exports = {\n root: true,\n extends: 'airbnb-base',\n env: {\n browser: true,\n },\n plugins: [\n 'import',\n ],\n rules: {\n 'import/no-extraneous-dependencies': 'off',\n 'no-param-reassign': 'off',\n 'no-restricted-properties': 'off',\n 'valid-jsdoc': ['error', {\n requireReturn: false,\n }],\n },\n overrides: [\n {\n files: 'test/**/*.spec.js',\n env: {\n mocha: true,\n },\n globals: {\n Viewer: true,\n expect: true,\n },\n rules: {\n 'no-new': 'off',\n 'no-unused-expressions': 'off',\n },\n },\n ],\n};\n" }, { "path": ".gitattributes", "content": "# Auto detect text files and perform LF normalization\n* text=auto\n" }, { "path": ".github/CODE_OF_CONDUCT.md", "content": "# Contributor Code of Conduct\n\nAs contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.\n\nWe are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.\n\nExamples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html\n" }, { "path": ".github/CONTRIBUTING.md", "content": "# Contributing to Viewer.js\n\n> Based on [Angular's contributing guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md).\n\nWe would love for you to contribute to Viewer.js and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:\n\n- [Contributing to Viewer.js](#contributing-to-viewerjs)\n - [Code of Conduct](#code-of-conduct)\n - [Question or Problem](#question-or-problem)\n - [Issues and Bugs](#issues-and-bugs)\n - [Feature Requests](#feature-requests)\n - [Submission Guidelines](#submission-guidelines)\n - [Submitting an Issue](#submitting-an-issue)\n - [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)\n - [After your pull request is merged](#after-your-pull-request-is-merged)\n - [Coding Rules](#coding-rules)\n - [Commit Message Guidelines](#commit-message-guidelines)\n - [Commit Message Format](#commit-message-format)\n - [Revert](#revert)\n - [Type](#type)\n - [Scope](#scope)\n - [Subject](#subject)\n - [Body](#body)\n - [Footer](#footer)\n\n## Code of Conduct\n\nHelp us keep Viewer.js open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## Question or Problem\n\nDo not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [Stack Overflow](https://stackoverflow.com/questions/tagged/viewerjs) where the questions should be tagged with tag `viewerjs`.\n\nStack Overflow is a much better place to ask questions since:\n\n- There are thousands of people willing to help on Stack Overflow.\n- Questions and answers stay available for public viewing so your question/answer might help someone else.\n- Stack Overflow's voting system assures that the best answers are prominently visible.\n\nTo save you and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow.\n\n## Issues and Bugs\n\nIf you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [GitHub Repository](https://github.com/fengyuanchen/viewerjs). Even better, you can [submit a Pull Request](#submitting-a-pull-request-pr) with a fix.\n\n## Feature Requests\n\nYou can *request* a new feature by [submitting an issue](#submitting-an-issue) to our [GitHub Repository](https://github.com/fengyuanchen/viewerjs). If you would like to *implement* a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it.\n\nPlease consider what kind of change it is:\n\n- For a **Major Feature**, first, open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.\n- **Small Features** can be crafted and directly [submitted as a Pull Request](#submitting-a-pull-request-pr).\n\n## Submission Guidelines\n\n### Submitting an Issue\n\nBefore you submit an issue, please search the [issue tracker](https://github.com/fengyuanchen/viewerjs/issues), which may be an issue for your problem already exists and the discussion might inform you of workarounds readily available.\n\nWe want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. To reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using [CodePen](https://codepen.io/pen). Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:\n\n- version of Viewer.js used\n- 3rd-party libraries and their versions\n- and most importantly - a use-case that fails\n\nA minimal reproduction scenario using [CodePen](https://codepen.io/pen) allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. If [CodePen](https://codepen.io/pen) is not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem.\n\nWe will be insisting on a minimal reproduction scenario to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal reproduction scenario. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we need to isolate the problem before we can fix it.\n\nUnfortunately, we are not able to investigate/fix bugs without a minimal reproduction scenario, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.\n\nYou can file new issues by filling out our [new issue form](https://github.com/fengyuanchen/viewerjs/issues/new).\n\n### Submitting a Pull Request (PR)\n\nBefore you submit your Pull Request (PR) consider the following guidelines:\n\n1. Search [GitHub](https://github.com/fengyuanchen/viewerjs/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.\n1. Fork the **fengyuanchen/viewerjs** repo.\n1. Make your changes in a new git branch:\n\n ```shell\n git checkout -b my-fix-branch main\n ```\n\n1. Create your patch, **including appropriate test cases**.\n1. Follow our [Coding Rules](#coding-rules).\n1. Run the full Viewer.js test suite, and ensure that all tests pass.\n1. Commit your changes using a descriptive commit message that follows our [Commit Message Guidelines](#commit-message-guidelines). Adherence to these guidelines is necessary because release notes are automatically generated from these messages.\n\n ```shell\n git commit -a\n ```\n\n Note: the optional commit `-a` command-line option will automatically \"add\" and \"rm\" edited files.\n1. Push your branch to GitHub:\n\n ```shell\n git push origin my-fix-branch\n ```\n\n1. In GitHub, send a pull request to `viewerjs:main`.\n1. If we suggest changes then:\n - Make the required updates.\n - Re-run the Viewer.js test suites to ensure tests are still passing.\n - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):\n\n ```shell\n git rebase main -i\n git push -f\n ```\n\nThat's it! Thank you for your contribution!\n\n#### After your pull request is merged\n\nAfter your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:\n\n1. Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:\n\n ```shell\n git push origin --delete my-fix-branch\n ```\n\n1. Check out the main branch:\n\n ```shell\n git checkout main -f\n ```\n\n1. Delete the local branch:\n\n ```shell\n git branch -D my-fix-branch\n ```\n\n1. Update your main with the latest upstream version:\n\n ```shell\n git pull --ff upstream main\n ```\n\n## Coding Rules\n\nTo ensure consistency throughout the source code, keep these rules in mind as you are working:\n\n- All features or bug fixes **must be tested** by one or more specs (unit-tests).\n- All public API methods **must be documented**.\n- We follow [Airbnb's JavaScript Style Guide](https://github.com/airbnb/javascript).\n\n## Commit Message Guidelines\n\n### Commit Message Format\n\nA commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:\n\n```\n(): \n\n\n\n