Skip to content

Update Dependencies #14

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

Merged
merged 1 commit into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"sourceType": "module"
},
"rules": {
"no-extra-semi": "off",
"no-undef": "off"
"no-undef": "off",
"no-extra-semi": "off"
}
}
14 changes: 5 additions & 9 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,15 @@ jobs:
- name: "Checkout"
uses: actions/checkout@v4

- name: "Release Version Check"
if: ${{ github.event_name == 'release' }}
run: |
export version="$(jq '.version' < manifest.json | tr -d '"')"
if [ "${{ github.ref_name }}" != "${version}" ];then
echo "Manifest Version ${version} does not match release tag ${{ github.ref_name }}"
exit 1
fi

- name: "Setup Node"
uses: actions/setup-node@v4
with:
node-version: 20

- name: "Update Manifest Version"
if: ${{ github.event_name == 'release' }}
uses: cssnr/update-json-value-action@v1

- name: "Build All"
run: |
npm install
Expand All @@ -41,6 +36,7 @@ jobs:
path: web-ext-artifacts/

- name: "Upload to Release"
if: ${{ github.event_name == 'release' }}
uses: svenstaro/upload-release-action@v2
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
38 changes: 38 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "Test"

on:
push:
branches: ["master"]
paths:
- "src/**"
- "tests/**"
pull_request:
branches: ["master"]
paths:
- "src/**"
- "tests/**"
workflow_dispatch:

jobs:
test:
name: "Test"
runs-on: ubuntu-latest
timeout-minutes: 5
if: ${{ !contains(github.event.head_commit.message, '#notest') }}

steps:
- name: "Checkout"
uses: actions/checkout@v4

- name: "Setup Node"
uses: actions/setup-node@v4
with:
node-version: 20

- name: "Install"
run: |
npm install

- name: "Lint"
run: |
npm run lint
4 changes: 2 additions & 2 deletions .prettierrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
"singleQuote": true,
"overrides": [
{
"files": ["**/*.html", "**/*.yaml"],
"files": ["**/*.html", "**/*.yaml", "**/*.yml"],
"options": {
"singleQuote": false
}
},
{
"files": ["**/*.json", "**/*.yaml"],
"files": ["**/*.json", "**/*.yaml", "**/*.yml"],
"options": {
"tabWidth": 2
}
Expand Down
39 changes: 29 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
[![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/foalfafgmnglcgpgkhhmcfhjgmdcjide?label=chrome&logo=googlechrome)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Mozilla Add-on Version](https://img.shields.io/amo/v/smwc-web-extension?label=firefox&logo=firefox)](https://addons.mozilla.org/addon/smwc-web-extension)
[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/smwc-web-extension?logo=github)](https://github.com/cssnr/smwc-web-extension/releases/latest)
[![Manifest Version](https://img.shields.io/github/manifest-json/v/cssnr/smwc-web-extension?filename=manifest.json&logo=json&label=manifest)](https://github.com/cssnr/smwc-web-extension/blob/master/manifest.json)
[![Build](https://github.com/cssnr/smwc-web-extension/actions/workflows/build.yaml/badge.svg)](https://github.com/cssnr/smwc-web-extension/actions/workflows/build.yaml)
[![Build](https://img.shields.io/github/actions/workflow/status/cssnr/smwc-web-extension/build.yaml?logo=github&logoColor=white&label=build)](https://github.com/cssnr/smwc-web-extension/actions/workflows/build.yaml)
[![Test](https://img.shields.io/github/actions/workflow/status/cssnr/smwc-web-extension/test.yaml?logo=github&logoColor=white&label=test)](https://github.com/cssnr/smwc-web-extension/actions/workflows/test.yaml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_smwc-web-extension&metric=alert_status&label=quality)](https://sonarcloud.io/summary/overall?id=cssnr_smwc-web-extension)
[![Discord](https://img.shields.io/discord/536290056571453450?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/ZrRbfdE6kz)
# SMWC Web Extension
Expand All @@ -14,6 +14,7 @@ Modern Chrome Web Extension and Firefox Browser Addon to easily Patch and Play R
* [Install](#install)
* [Features](#features)
* [Configuration](#configuration)
* [Support](#support)
* [Development](#development)
- [Building](#building)

Expand All @@ -22,13 +23,13 @@ Modern Chrome Web Extension and Firefox Browser Addon to easily Patch and Play R
* [Google Chrome Web Store](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
* [Mozilla Firefox Add-ons](https://addons.mozilla.org/addon/smwc-web-extension)

[![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/main/src/chrome/chrome_48x48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/main/src/firefox/firefox_48x48.png)](https://addons.mozilla.org/addon/smwc-web-extension)
[![Edge](https://raw.githubusercontent.com/alrra/browser-logos/main/src/edge/edge_48x48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Chromium](https://raw.githubusercontent.com/alrra/browser-logos/main/src/chromium/chromium_48x48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Brave](https://raw.githubusercontent.com/alrra/browser-logos/main/src/brave/brave_48x48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Vivaldi](https://raw.githubusercontent.com/alrra/browser-logos/main/src/vivaldi/vivaldi_48x48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Opera](https://raw.githubusercontent.com/alrra/browser-logos/main/src/opera/opera_48x48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Chrome](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/chrome_48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Firefox](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/firefox_48.png)](https://addons.mozilla.org/addon/smwc-web-extension)
[![Edge](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/edge_48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Chromium](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/chromium_48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Brave](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/brave_48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Vivaldi](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/vivaldi_48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)
[![Opera](https://raw.githubusercontent.com/smashedr/logo-icons/master/browsers/opera_48.png)](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide)

All **Chromium** Based Browsers can install the extension from the
[Chrome Web Store](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide).
Expand All @@ -47,6 +48,24 @@ You can pin the Addon by clicking the `Puzzle Piece`, find the SMWC Web Extensio
**Chrome,** click the `Pin` icon.
**Firefox,** click the `Settings Wheel` and `Pin to Toolbar`.

# Support

For help using the web extension, utilize any these resources:

- Q&A Discussion: https://github.com/cssnr/smwc-web-extension/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/smwc-web-extension/discussions/categories/feature-requests

If you are experiencing an issue/bug or getting unexpected results, use:

- Report an Issue: https://github.com/cssnr/smwc-web-extension/issues
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
- Provide Anonymous Feedback: https://cssnr.github.io/feedback

Logs can be found inspecting the page (Ctrl+Shift+I), clicking on the Console, and;
Firefox: toggling Debug logs, Chrome: toggling Verbose from levels dropdown.

Note: When providing anonymous feedback there is no way to follow up and get more information unless you provide a contact method.

# Development

**Quick Start**
Expand All @@ -55,7 +74,7 @@ First, clone (or download) this repository and change into the directory.

Second, install the dependencies:
```shell
npm isntall
npm install
```

Finally, to run Chrome or Firefox with web-ext, run one of the following:
Expand Down
Loading