diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 00000000..f01aa865 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,38 @@ +# Javascript Node CircleCI 2.0 configuration file +# +# Check https://circleci.com/docs/2.0/language-javascript/ for more details +# +version: 2 + + +jobs: + build: + docker: + # specify the version you desire here + - image: circleci/node:8-browsers + + working_directory: ~/repo + + steps: + - checkout + + # Download and cache dependencies + - restore_cache: + keys: + - v1-dependencies-{{ checksum "package.json" }} + # fallback to using the latest cache if no exact match is found + - v1-dependencies- + + - run: npm install + + - save_cache: + paths: + - node_modules + key: v1-dependencies-{{ checksum "package.json" }} + + # run tests! + - run: npm test + + - run: + name: Send code coverage + command: './node_modules/.bin/codecov' diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 00000000..2ea6b650 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,10 @@ +{ + "extends": "standard", + "plugins": ["html"], + "env": { + "amd": true + }, + "rules": { + "no-new": 0 + } +} diff --git a/.firebaserc b/.firebaserc deleted file mode 100644 index 89d4876a..00000000 --- a/.firebaserc +++ /dev/null @@ -1,5 +0,0 @@ -{ - "projects": { - "default": "vue-fire-store" - } -} diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 4ead0e1d..00000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,13 +0,0 @@ -# Contributor Code of Conduct - -As 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. - -We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. - -Examples 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. - -Project 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. - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. - -This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 81c8c588..00000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,35 +0,0 @@ -# Contributing - -Contributions are welcome and will be fully credited! - -We accept contributions via Pull Requests on [Github]({{ githubAccount }}/{{ name }}). - -## Setup - -- Use `pnpm@8` -- Install `firebase-tools` globally: `npm install -g firebase-tools` - -## Pull Requests - -Here are some guidelines to make the process smoother: - -- **Add a test** - New features and bugfixes need tests. If you find it difficult to test, please tell us in the pull request and we will try to help you! -- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. -- **Run `npm test` locally** - This will allow you to go faster -- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. -- **Send coherent history** - Make sure your commits message means something -- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. - -## Project structure - -### Root - -The root folder includes the VueFire library - -### `packages/nuxt` - -This folder includes the Nuxt module. To have proper TS support in your IDE, you might need to open this folder individually rather than opening the root folder of the VueFire project. - -### `playground` - -Includes a Vue 3 playground to test out with a real app. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 325f6eef..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: "\U0001F41E Bug report" -description: Report an issue with VueFire -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: input - id: reproduction - attributes: - label: Reproduction - description: "If possible, provide a boiled down editable reproduction based off [this vite template](https://github.com/posva/vuefire-repro-template) or [this nuxt template](https://github.com/posva/nuxt--vuefire-repro-template) with minimal dependencies (avoid testing, linting, and other unrelated dependencies). A failing unit test is even better! Otherwise provide as much information as possible to reproduce the problem. If no reproduction is provided and the information is not enough to reproduce the problem, we won't be able to give it a look **and the issue will be converted into a question and moved to discussions**." - placeholder: Reproduction - validations: - required: true - - type: textarea - id: steps - attributes: - label: Steps to reproduce the bug - description: | - 1. Click on ... - 2. Check log - validations: - required: true - - type: textarea - id: expected-behavior - attributes: - label: Expected behavior - description: A clear and concise description of what you expected to happen. - validations: - required: true - - type: textarea - id: actual-behavior - attributes: - label: Actual behavior - description: 'A clear and concise description of what actually happens.' - validations: - required: true - - type: textarea - id: other-info - attributes: - label: Additional information - description: Add any other context about the problem here. - - type: markdown - attributes: - value: | - ## Before creating an issue make sure that: - - This hasn't been [reported before](https://github.com/vuejs/vuefire/issues). - - The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug **with no external dependencies (e.g. vuetify, pinia)** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index b2c6b084..00000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,11 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: Question - url: https://github.com/vuejs/vuefire/discussions/new?category=Q-A - about: Ask a question or discuss about VueFire - - name: Ideas - url: https://github.com/vuejs/vuefire/discussions/new?category=Ideas - about: Start a discussion to improve VueFire - - name: GitHub Sponsors - url: https://github.com/sponsors/posva - about: Like this project? Please consider supporting the author. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index bf2a7988..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: "\U0001F680 New feature proposal" -description: Suggest an idea for VueFire -labels: ['feature request'] -body: - - type: markdown - attributes: - value: | - Thanks for your interest in the project and taking the time to fill out this feature report! - - type: textarea - id: feature-description - attributes: - label: What problem is this solving - description: 'A clear and concise description of what the problem is. Ex. when using the function X we cannot do Y.' - validations: - required: true - - type: textarea - id: proposed-solution - attributes: - label: Proposed solution - description: 'A clear and concise description of what you want to happen with an API proposal when applicable' - validations: - required: true - - type: textarea - id: alternative - attributes: - label: Describe alternatives you've considered - description: A clear and concise description of any alternative solutions or features you've considered. diff --git a/.github/commit-convention.md b/.github/commit-convention.md deleted file mode 100644 index 665b1da3..00000000 --- a/.github/commit-convention.md +++ /dev/null @@ -1,91 +0,0 @@ -## Git Commit Message Convention - -> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). - -#### TL;DR: - -Messages must be matched by the following regex: - -```text -/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/ -``` - -#### Examples - -Appears under "Features" header, `link` subheader: - -``` -feat(link): add `force` option -``` - -Appears under "Bug Fixes" header, `view` subheader, with a link to issue #28: - -``` -fix(view): handle keep-alive with aborted navigations - -close #28 -``` - -Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: - -``` -perf: improve guard extraction - -BREAKING CHANGE: The 'beforeRouteEnter' option has been removed. -``` - -The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header. - -``` -revert: feat(compiler): add 'comments' option - -This reverts commit 667ecc1654a317a13331b17617d973392f415f02. -``` - -### Full Message Format - -A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: - -``` -(): - - - -