Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detection Library #1

Open
wants to merge 44 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
9dbbc97
Draft directory structure for detection
vermakhushboo Jan 9, 2025
38d3127
Add SSG, Yarn and PNPM
vermakhushboo Jan 9, 2025
e850ae7
Add Enum for package manager and framework
vermakhushboo Jan 14, 2025
76442c0
Update detection order in example.php
vermakhushboo Jan 14, 2025
d40606f
Rename RenderingStrategy to Rendering
vermakhushboo Jan 15, 2025
87ae54e
Simplify calls to detectors
vermakhushboo Jan 16, 2025
065d8ce
Add contributing and code of conduct
vermakhushboo Jan 16, 2025
679486c
Improve folder structure
Meldiron Jan 20, 2025
944e9c2
Improve folder structure
Meldiron Jan 20, 2025
887d259
Add runtime methods
vermakhushboo Jan 21, 2025
ec0ddb1
Add framework files
vermakhushboo Jan 21, 2025
97d8ef0
Package manager detection
vermakhushboo Jan 21, 2025
bf9badb
Add logic to runtime detection
vermakhushboo Jan 22, 2025
e483425
Add methods to frameworks
vermakhushboo Jan 22, 2025
d32fbd3
More updates
vermakhushboo Jan 23, 2025
8c5c29a
Add rendering detection logic
vermakhushboo Jan 24, 2025
ae04fc7
Updated rendering detection logic
vermakhushboo Jan 30, 2025
6d0d8d1
Add test file
vermakhushboo Jan 30, 2025
db3dde9
Add tests for frameworks and rendering
vermakhushboo Jan 30, 2025
b9f0cec
Use specific files for Rendering detection
vermakhushboo Jan 30, 2025
6a7720f
Renamed names to lowercase
vermakhushboo Feb 4, 2025
b65a212
Remove nested structures from file matches
vermakhushboo Feb 4, 2025
399d709
Rewrite tests using data provider
vermakhushboo Feb 5, 2025
a830391
Use array_intersect instead of nested for loops
vermakhushboo Feb 5, 2025
5a19a52
Update names of test functions
vermakhushboo Feb 5, 2025
e2a943b
Change to generic exception
vermakhushboo Feb 5, 2025
4a65f64
Add README.md and other CI/CD files
vermakhushboo Feb 5, 2025
a18b638
Add GitHub workflow files
vermakhushboo Feb 5, 2025
b60cf66
Update tests.yml
vermakhushboo Feb 5, 2025
e000f50
Update github workflows
vermakhushboo Feb 5, 2025
57a9097
UPdate composer.lock
vermakhushboo Feb 5, 2025
c8e0b7e
Try tests.yml
vermakhushboo Feb 5, 2025
4cd2eae
Try tests.yml
vermakhushboo Feb 5, 2025
7e9bceb
Try tests.yml
vermakhushboo Feb 5, 2025
c4ca6d7
Fix phpstan errors
vermakhushboo Feb 5, 2025
1065da4
Fix phpstan errors
vermakhushboo Feb 5, 2025
45058f3
Fix phpstan errors
vermakhushboo Feb 5, 2025
7435573
Fix phpstan errors
vermakhushboo Feb 5, 2025
27223f7
Fix phpstan errors
vermakhushboo Feb 5, 2025
f5e6f2e
Update case of files
vermakhushboo Feb 6, 2025
09512d0
Separate Strategy class
vermakhushboo Feb 6, 2025
0f1d84c
Add SPA detection logic
vermakhushboo Feb 17, 2025
d7ecb85
Remove redundant if condition
vermakhushboo Feb 17, 2025
69958f4
rename next.js to nextjs
vermakhushboo Feb 18, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/vendor/
/.idea/
.phpunit.result.cache
.env
.DS_Store
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity, expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at team@appwrite.io. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
109 changes: 109 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Contributing

We would ❤️ for you to contribute to Utopia-php and help make it better! We want contributing to Utopia-php to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.

## How to Start?

If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or anyone from the [Appwrite team on Discord](https://appwrite.io/discord). You can also submit an issue, and a maintainer can guide you!

## Code of Conduct

Help us keep Utopia-php open and inclusive. Please read and follow our [Code of Conduct](https://github.com/utopia-php/abuse/blob/master/CODE_OF_CONDUCT.md).

## Submit a Pull Request 🚀

Branch naming convention is as following

```
TYPE-ISSUE_ID-DESCRIPTION
```

example:

```
doc-548-submit-a-pull-request-section-to-contribution-guide
```

When `TYPE` can be:

- **feat** - is a new feature
- **doc** - documentation only changes
- **cicd** - changes related to CI/CD system
- **fix** - a bug fix
- **refactor** - code change that neither fixes a bug nor adds a feature

**All PRs must include a commit message with the changes description!**

For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:

1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date.

```
$ git pull
```

2. Create new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`

```
$ git checkout -b [name_of_your_new_branch]
```

3. Work - commit - repeat ( be sure to be in your branch )

4. Push changes to GitHub

```
$ git push origin [name_of_your_new_branch]
```

6. Submit your changes for review If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.

7. Start a Pull Request Now submit the pull request and click on `Create pull request`.

8. Get a code review approval/reject

9. After approval, merge your PR

10. GitHub will automatically delete the branch after the merge is done. (they can still be restored).

## Introducing New Features

We would 💖 you to contribute to Utopia-php, but we would also like to make sure Utopia-php is as great as possible and loyal to its vision and mission statement 🙏.

For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request.

This will allow the Utopia-php community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.

This is also important for the Utopia-php lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc).

## Adding A New Adapter

You can follow our [Adding new Detector Adapter](docs/add-new-detector-adapter.md) tutorial to add a new Detector adapter.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We miss file mentioned here


## Other Ways to Help

Pull requests are great, but there are many other areas where you can help Utopia-php.

### Blogging & Speaking

Blogging, speaking about, or creating tutorials about one of Utopia-php’s many features is great way to contribute and help our project grow.

### Presenting at Meetups

Presenting at meetups and conferences about your Utopia-php projects. Your unique challenges and successes in building things with Utopia-php can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help!

### Sending Feedbacks & Reporting Bugs

Sending feedback is a great way for us to understand your different use cases of Utopia-php better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA).

### Submitting New Ideas

If you think Utopia-php could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.

### Improving Documentation

Submitting documentation updates, enhancements, designs, or bug fixes. Spelling or grammar fixes will be very much appreciated.

### Helping Someone

Searching for Utopia-php, GitHub or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Utopia-php's repo!
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use `composer test` for running tests
40 changes: 40 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"name": "utopia-php/detector",
"description": "A simple library to detect popular runtimes, frameworks and package managers etc.",
"type": "library",
"license": "MIT",
"keywords": [
"php",
"framework",
"utopia",
"detector"
],
"minimum-stability": "stable",
"scripts": {
"lint": "./vendor/bin/pint --test --config pint.json",
"format": "./vendor/bin/pint --config pint.json",
"check": "./vendor/bin/phpstan analyse --level 8 -c phpstan.neon src tests",
"test": "./vendor/bin/phpunit --configuration phpunit.xml --debug"
},
"autoload": {
"psr-4": {
"Utopia\\Detector\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Utopia\\Tests\\": "tests/Detector/"
}
},
"require": {
"php": ">=8.0"
},
"require-dev": {
"phpunit/phpunit": "^9.5",
"laravel/pint": "^1.20",
"phpstan/phpstan": "1.8.*"
},
"platform": {
"php": "8.3"
}
}
Loading