-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 84d52d0
Showing
27 changed files
with
5,199 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Changesets | ||
|
||
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works | ||
with multi-package repos, or single-package repos to help you version and publish your code. You can | ||
find the full documentation for it [in our repository](https://github.com/changesets/changesets) | ||
|
||
We have a quick list of common questions to get you started engaging with this project in | ||
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json", | ||
"changelog": "@changesets/cli/changelog", | ||
"commit": false, | ||
"fixed": [], | ||
"linked": [], | ||
"access": "restricted", | ||
"baseBranch": "master", | ||
"updateInternalDependencies": "patch", | ||
"ignore": [] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dist/bin.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
before making a PR check the box if you have done the following: | ||
- [ ] added a changelog | ||
|
||
### Your pull request short description | ||
|
||
----------------- | ||
|
||
|
||
#### What does this PR do? | ||
|
||
> | ||
#### Description of Task to be completed? | ||
|
||
> | ||
#### How should this be manually tested? | ||
|
||
> | ||
#### Any background context you want to provide? | ||
|
||
> | ||
#### Screenshots (if appropriate) | ||
|
||
#### Your PR Body | ||
|
||
> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: CI | ||
on: | ||
push: | ||
branches: | ||
- "**" | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: pnpm/action-setup@v2 | ||
with: | ||
version: 7 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16.x | ||
cache: "pnpm" | ||
|
||
- run: pnpm install --frozen-lockfile | ||
- run: pnpm run lint && pnpm run build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Publish | ||
on: | ||
workflow_run: | ||
workflows: [CI] | ||
branches: [main] | ||
types: [completed] | ||
|
||
concurrency: ${{ github.workflow }}-${{ github.ref }} | ||
|
||
permissions: | ||
contents: write | ||
pull-requests: write | ||
|
||
jobs: | ||
publish: | ||
if: ${{ github.event.workflow_run.conclusion == 'success' }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: pnpm/action-setup@v2 | ||
with: | ||
version: 7 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16.x | ||
cache: "pnpm" | ||
|
||
- run: pnpm install --frozen-lockfile | ||
- name: Create Release Pull Request or Publish | ||
id: changesets | ||
uses: changesets/action@v1 | ||
with: | ||
publish: pnpm run release | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} | ||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.cache | ||
.DS_Store | ||
.idea | ||
*.log | ||
*.tgz | ||
coverage | ||
dist | ||
lib-cov | ||
logs | ||
node_modules | ||
temp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"semi": true, | ||
"tabWidth": 2, | ||
"singleQuote": true, | ||
"trailingComma": "all", | ||
"printWidth": 100, | ||
"arrowParens": "always" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"space": true, | ||
"prettier": true, | ||
"bracketSpacing": true, | ||
"ignores": [ | ||
"*.js" | ||
], | ||
"overrides": [ | ||
{ | ||
"files": [ | ||
"**/*.ts" | ||
], | ||
"rules": { | ||
"import/extensions": [ | ||
"error", | ||
"ignorePackages", | ||
{ | ||
"ts": "never" | ||
} | ||
], | ||
"import/no-default-export": "off", | ||
"import/prefer-default-export": "off", | ||
"n/prefer-global/process": "off", | ||
"import/no-anonymous-default-export": "off" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# How to contribute | ||
|
||
It is a paramount to the development of `wifikeys` that the community is empowered to make changes and get them into the library. Here are some guidelines for making a cake walk through this process. | ||
|
||
## Reporting issues | ||
|
||
To report a bug, request a feature, or even ask a question, make use of the GitHub Issues | ||
section for [wifikeys][issues]. When submitting an issue please take the following steps: | ||
|
||
1. **Seach for existing issues.** Your question or bug may have already been answered or fixed, be sure to search the issues first before putting in a duplicate issue. | ||
|
||
2. **Create an isolated and reproducible test case.** If you are reporting a bug, make sure you also have a minimal, runnable, code example that reproduces the problem you have. | ||
|
||
3. **Include a live example.** After narrowing your code down to only the problem areas, make use of [repl.it][repl] or a link to your live site so that we can view a live example of the problem. | ||
|
||
4. **Share as much information as possible.** Include browser version affected, your OS, version of | ||
the library, steps to reproduce, etc. "X isn't working!!!1!" will probably just be closed. | ||
|
||
## Contributing Changes | ||
|
||
### Setting Up | ||
|
||
To set up for making changes you will need to take a few steps, we've outlined them below: | ||
|
||
1. Ensure you have [node][node] and npm installed. | ||
|
||
2. Fork the [wifikeys][wifikeys] repository, if you are unsure how to do this GitHub has guides for the [command line][fork-repo] and for the [GitHub Client][fork-client]. | ||
|
||
3. Next, run `npm install` from within the clone of your fork. That will install all dependencies necessary to build wifikeys. | ||
|
||
### Making a Change | ||
|
||
Once you have the repository on your machine and have installed dependencies you are almost ready to make your change(s). The only other thing to do before you start is to checkout to the correct branch. Which branch you should make your change to (and send a PR to) depends on the type of change you are making. | ||
|
||
Always make your change to `develop` as it is the branch for QA testing and feature compilation before pushing to master. | ||
|
||
Your change should be made directly to the branch in your fork, or to a branch in your fork made off of one of the above branches. | ||
|
||
### Branch Naming | ||
|
||
Branches created should be named using the following format: | ||
|
||
``` | ||
{type}-{2-3 word summary separated with hyphen} | ||
``` | ||
|
||
Type: | ||
|
||
- feature | ||
- bug | ||
- chore | ||
- refactor | ||
|
||
Example: | ||
|
||
``` | ||
refactor-data | ||
``` | ||
|
||
### PR Description Template | ||
|
||
The description of the PR should contain the following headings and corresponding content in Markdown format. | ||
|
||
``` | ||
#### What does this PR do? | ||
#### Description of Task to be completed? | ||
#### How should this be manually tested? | ||
#### Any background context you want to provide? | ||
#### Screenshots (if appropriate) | ||
``` | ||
|
||
### Testing Your Change | ||
|
||
You can run these tests by running `npm run test` from the command line. If you fix a bug please add a test that will catch that bug if it ever happens again. This prevents regressions from sneaking in. | ||
|
||
> [!IMPORTANT] | ||
> tests to be done in future | ||
### Submitting Your Change | ||
|
||
After you have made and tested your change, commit and push it to your fork. Then, open a Pull Request from your fork to the main [wifikeys][wifikeys] repository on the branch you used in the `Making a Change` section of this document. | ||
|
||
## Quickie Code Style Guide | ||
|
||
[wifikeys][wifikeys] adheres strictly to the [eslint airbnb](https://www.npmjs.com/package/eslint-config-airbnb-base) style guide. Read below for a quickie style guide: | ||
|
||
- Rely heavily on ES5 style of writing code. | ||
- Indentation of two spaces | ||
|
||
[issues]: https://github.com/FADHILI-Josue/wifikeys/issues | ||
[wifikeys]: https://github.com/FADHILI-Josue/wifikeys | ||
[repl]: http://repl.it | ||
[node]: https://nodejs.org/en/ | ||
[fork-repo]: https://help.github.com/articles/fork-a-repo/ | ||
[fork-client]: https://guides.github.com/activities/forking/ | ||
|
||
## Support | ||
|
||
[wifikeys][wifikeys] supports `typescript`. | ||
Bear in mind this when altering and/or extending the sources. | ||
|
||
# Important | ||
|
||
- Please make sure that you run tests before making a PR. | ||
- please make sure you make a changeset before making a PR. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# wifikeys | ||
|
||
 | ||
 | ||
|
||
**wifikeys** is a command-line interface (CLI) tool for retrieving Wi-Fi passwords on your system. It allows you to easily retrieve passwords for saved Wi-Fi networks. | ||
|
||
> purpose: Get a saved WiFi password (when someone asks for it) with specifying a WiFi name/SSID only or get the password of internet you are currently connected to. | ||
## Installation | ||
|
||
You can install **wifikeys** globally using npm: | ||
|
||
```bash | ||
npm install -g wifikeys | ||
``` | ||
|
||
## Usage | ||
|
||
#### Get Password for Wi-Fi you're connected to | ||
|
||
To get the password for a Wi-Fi you're currently using: | ||
|
||
```bash | ||
wifikeys get | ||
``` | ||
|
||
#### Get Password for a Specific Wi-Fi Network | ||
|
||
To get the password for a specific Wi-Fi network, use the get command followed by the SSID (network name): | ||
|
||
```bash | ||
wifikeys get <ssid> | ||
# eg: wifikeys get RCA-WiFii" | ||
``` | ||
<!-- NOTE: provide image example --> | ||
|
||
#### Get Passwords for Multiple Wi-Fi Networks | ||
|
||
To get passwords for multiple Wi-Fi networks at once, you can provide a list of SSIDs using the `-n` or `--networks` option: | ||
|
||
```bash | ||
wifikeys get -n <network1> <network2> <network3> ... | ||
# eg: wifikeys get -n RCA-WiFii "Benax-WiFi(2.4G)" | ||
``` | ||
<!-- NOTE: provide image example --> | ||
|
||
## Options | ||
|
||
`-n, --networks <networks...>`: Specify one or more Wi-Fi networks to retrieve passwords for. | ||
```bash | ||
# Get passwords for multiple Wi-Fi networks | ||
wifikeys get -n Network1 Network2 Network3 | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request by following the [contributing guide](/CONTRIBUTING.md) | ||
|
||
[](https://github.com/FADHILI-Josue/wifikeys/stargazers) | ||
[](https://twitter.com/FADHILIJosue) | ||
[](https://www.linkedin.com/in/fadhili-josue/) |
Oops, something went wrong.