Skip to content

Commit 1fae882

Browse files
committed
init
0 parents  commit 1fae882

File tree

243 files changed

+23299
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

243 files changed

+23299
-0
lines changed

.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

.github/contributing.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to Feathers
2+
3+
Thank you for contributing to Feathers! :heart: :tada:
4+
5+
## Report a bug
6+
7+
Before creating an issue please make sure you have checked out the docs, specifically the [FAQ](https://docs.feathersjs.com/help/faq.html) section. You might want to also try searching Github. It's pretty likely someone has already asked a similar question.
8+
9+
If you haven't found your answer please feel free to join our [Discord server](https://discord.gg/qa8kez8QBx), create an issue on Github, or post on [Stackoverflow](http://stackoverflow.com) using the `feathersjs` tag. We try our best to monitor Stackoverflow but you're likely to get more immediate responses in Discord and Github.
10+
11+
Issues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues). Since feathers combines many modules it can be hard for us to assess the root cause without knowing which modules are being used and what your configuration looks like, so **it helps us immensely if you can link to a simple example that reproduces your issue**.
12+
13+
## Report a Security Concern
14+
15+
We take security very seriously at Feathers. We welcome any peer review of our 100% open source code to ensure nobody's Feathers app is ever compromised or hacked. As a web application developer you are responsible for any security breaches. We do our very best to make sure Feathers is as secure as possible by default.
16+
17+
In order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Discord](https://discord.gg/qa8kez8QBx) or email us at <a href="mailto:">hello@feathersjs.com</a> with details and we will respond ASAP.
18+
19+
For full details refer to our [Security docs](https://docs.feathersjs.com/SECURITY.html).
20+
21+
## Pull Requests
22+
23+
We :heart: pull requests and we're continually working to make it as easy as possible for people to contribute.
24+
25+
We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A FeathersJS maintainer will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.
26+
27+
Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context, historical knowledge or information regarding the roadmap that the maintainers have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it. :smile:
28+
29+
**All PRs (except documentation) should be accompanied with tests and pass the linting rules.**
30+
31+
### Code style
32+
33+
Before running the tests from the `test/` folder `npm test` will run ESlint. You can check your code changes individually by running `npm run lint`.
34+
35+
### Tests
36+
37+
[Mocha](http://mochajs.org/) tests are located in the `test/` folder and can be run using the `npm run mocha` or `npm test` (with ESLint and code coverage) command.
38+
39+
### Documentation
40+
41+
Feathers documentation is contained in Markdown files in the [docs folder](https://github.com/feathersjs/feathers) of the main repository. To change the documentation submit a pull request to that repo, referencing any other PR if applicable, and the docs will be updated as soon as it is merged.
42+
43+
## Community Contributions
44+
45+
If you've written something awesome about Feathers, for the Feathers ecosystem, or created an app using Feathers please add it to the [awesome-feathersjs](https://github.com/feathersjs-ecosystem/awesome-feathersjs).
46+
47+
If you think your module would be a good core `feathersjs` module or [featherjs-ecosystem](https://github.com/feathersjs-ecosystem) module then please contact one of the Feathers maintainers on [Discord](https://discord.gg/qa8kez8QBx) and we can discuss whether it belongs and how to get it there. :beers:
48+
49+
## Contributor Code of Conduct
50+
51+
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.
52+
53+
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, ethnicity, age, or religion.
54+
55+
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.
56+
57+
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.
58+
59+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
60+
61+
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/)

.github/issue_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### Steps to reproduce
2+
3+
(First please check that this issue is not already solved as [described
4+
here](https://github.com/feathersjs/feathers/blob/master/.github/contributing.md#report-a-bug))
5+
6+
- [ ] Tell us what broke. The more detailed the better.
7+
- [ ] If you can, please create a simple example that reproduces the issue and link to a gist, jsbin, repo, etc.
8+
9+
### Expected behavior
10+
Tell us what should happen
11+
12+
### Actual behavior
13+
Tell us what happens instead
14+
15+
### System configuration
16+
17+
Tell us about the applicable parts of your setup.
18+
19+
**Module versions** (especially the part that's not working):
20+
21+
**NodeJS version**:
22+
23+
**Operating System**:
24+
25+
**Browser Version**:
26+
27+
**React Native Version**:
28+
29+
**Module Loader**:

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Summary
2+
3+
(If you have not already please refer to the contributing guideline as [described
4+
here](https://github.com/feathersjs/feathers/blob/master/.github/contributing.md#pull-requests))
5+
6+
- [ ] Tell us about the problem your pull request is solving.
7+
- [ ] Are there any open issues that are related to this?
8+
- [ ] Is this PR dependent on PRs in other repos?
9+
10+
If so, please mention them to keep the conversations linked together.
11+
12+
### Other Information
13+
14+
If there's anything else that's important and relevant to your pull
15+
request, mention that information here. This could include
16+
benchmarks, or other information.
17+
18+
Your PR will be reviewed by a core team member and they will work with you to get your changes merged in a timely manner. If merged your PR will automatically be added to the changelog in the next release.
19+
20+
If your changes involve documentation updates please mention that and link the appropriate PR in [feathers-docs](https://github.com/feathersjs/feathers-docs).
21+
22+
Thanks for contributing to Feathers! :heart:

.github/workflows/nodejs.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: CI
2+
on: [push, pull_request]
3+
jobs:
4+
test:
5+
runs-on: ubuntu-latest
6+
strategy:
7+
matrix:
8+
node-version: [20.x, 22.x, 24.x]
9+
steps:
10+
- uses: actions/checkout@v4
11+
- name: Use Node.js ${{ matrix.node-version }}
12+
uses: actions/setup-node@v4
13+
with:
14+
node-version: ${{ matrix.node-version }}
15+
- run: npm install
16+
- run: npm test
17+
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- name: Use Node.js 22.x
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: 22.x
26+
- run: npm install
27+
- run: npm run build
28+
29+
are_the_types_wrong:
30+
name: Are The Types Wrong?
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/checkout@v4
34+
- name: Use Node.js 22.x
35+
uses: actions/setup-node@v4
36+
with:
37+
node-version: 22.x
38+
- run: npm install
39+
- run: npm run build
40+
- run: npx --yes @arethetypeswrong/cli --pack . --profile esm-only
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Update dependencies
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 1 * *'
6+
workflow_dispatch:
7+
jobs:
8+
update-dependencies:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Use Node.js
13+
uses: actions/setup-node@v1
14+
with:
15+
node-version: '16.x'
16+
- run: npm ci
17+
- run: |
18+
git config user.name "GitHub Actions Bot"
19+
git config user.email "hello@feathersjs.com"
20+
git checkout -b update-dependencies-$GITHUB_RUN_ID
21+
- run: |
22+
npm run update-dependencies
23+
npm install
24+
- run: |
25+
git commit -am "chore(dependencies): Update dependencies"
26+
git push origin update-dependencies-$GITHUB_RUN_ID
27+
- run: |
28+
gh pr create --title "chore(dependencies): Update all dependencies" --body ""
29+
env:
30+
GITHUB_TOKEN: ${{secrets.CI_ACCESS_TOKEN}}

.gitignore

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.DS_Store
2+
3+
# Logs
4+
logs
5+
*.log
6+
7+
# Runtime data
8+
pids
9+
*.pid
10+
*.seed
11+
12+
# Directory for instrumented libs generated by jscoverage/JSCover
13+
lib-cov
14+
15+
# Coverage directory used by tools like istanbul
16+
coverage
17+
.nyc_output
18+
19+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
20+
.grunt
21+
22+
# Compiled binary addons (http://nodejs.org/api/addons.html)
23+
build/Release
24+
25+
# Dependency directory
26+
# Commenting this out is preferred by some people, see
27+
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
28+
node_modules
29+
30+
# Users Environment Variables
31+
.lock-wscript
32+
33+
dist/
34+
.idea/
35+
yarn.lock
36+
37+
docs/.vitepress/cache

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v22.16.0

.vscode/launch.json

Whitespace-only changes.

.vscode/settings.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"search.exclude": {
3+
"**/node_modules": true,
4+
"**/dist": true,
5+
"**/package-lock.json": true,
6+
"**/pnpm-lock.yaml": true
7+
},
8+
}
9+

0 commit comments

Comments
 (0)