Skip to content

Commit 64acd63

Browse files
committed
run formatter against yml/yaml, json, md, and css files
1 parent 2b58050 commit 64acd63

File tree

6 files changed

+326
-307
lines changed

6 files changed

+326
-307
lines changed

.github/workflows/release.yml

Lines changed: 56 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -9,67 +9,63 @@ jobs:
99
runs-on: ubuntu-latest
1010
strategy:
1111
matrix:
12-
container:
13-
[
14-
'chrome',
15-
'firefox',
16-
]
12+
container: ['chrome', 'firefox']
1713
env:
1814
BROWSER: ${{ matrix.container }}
1915
VERSION: ${{ github.event.release.tag_name }}
2016
steps:
21-
- uses: actions/checkout@v4
22-
23-
- name: Setup pnpm
24-
uses: pnpm/action-setup@v4
25-
with:
26-
version: 9.14.4
27-
28-
- name: Use Node.js
29-
uses: actions/setup-node@v4
30-
with:
31-
node-version: '22.x'
32-
cache: 'pnpm'
33-
34-
- name: Install dependencies
35-
run: pnpm install --frozen-lockfile
36-
37-
- name: TypeScript type check
38-
run: pnpm run typecheck
39-
40-
- name: Set version number in manifest
41-
run: |
42-
VERSION_NUMBER=$(echo ${VERSION} | sed 's/^v//')
43-
sed -i 's/"version": *"[0-9.]*"/"version": "'$VERSION_NUMBER'"/' manifest.json
44-
45-
- name: Build Chrome
46-
if: ${{ matrix.container == 'chrome' }}
47-
run: pnpm run build
48-
49-
- name: Build Firefox
50-
if: ${{ matrix.container == 'firefox' }}
51-
run: |
52-
sed -i 's,"service_worker": "dist/background.js","scripts": ["dist/background.js"],g' ./manifest.json
53-
pnpm run build
54-
55-
- name: Package extension
56-
run: |
57-
PACKAGE_NAME="BandcampEnhancementSuite_${BROWSER}-$VERSION.zip"
58-
zip $PACKAGE_NAME LICENSE _locales/**/* icons/* css/* dist/* svg/* manifest.json html/browser_action.html
59-
60-
- name: Attach packages to GitHub Release
61-
env:
62-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
63-
run: |
64-
GH_RELEASE_ID=${{ github.event.release.id }}
65-
GH_REPO="https://uploads.github.com/repos/${{ github.repository }}/releases/$GH_RELEASE_ID/assets"
66-
PACKAGE_NAME="BandcampEnhancementSuite_${BROWSER}-$VERSION.zip"
67-
68-
curl -L \
69-
-X POST \
70-
-H "Accept: application/vnd.github+json" \
71-
-H "Authorization: Bearer $GITHUB_TOKEN" \
72-
-H "X-GitHub-Api-Version: 2022-11-28" \
73-
-H "Content-Type: application/octet-stream" \
74-
"$GH_REPO?name=$PACKAGE_NAME" \
75-
--data-binary "@$PACKAGE_NAME"
17+
- uses: actions/checkout@v4
18+
19+
- name: Setup pnpm
20+
uses: pnpm/action-setup@v4
21+
with:
22+
version: 9.14.4
23+
24+
- name: Use Node.js
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: '22.x'
28+
cache: 'pnpm'
29+
30+
- name: Install dependencies
31+
run: pnpm install --frozen-lockfile
32+
33+
- name: TypeScript type check
34+
run: pnpm run typecheck
35+
36+
- name: Set version number in manifest
37+
run: |
38+
VERSION_NUMBER=$(echo ${VERSION} | sed 's/^v//')
39+
sed -i 's/"version": *"[0-9.]*"/"version": "'$VERSION_NUMBER'"/' manifest.json
40+
41+
- name: Build Chrome
42+
if: ${{ matrix.container == 'chrome' }}
43+
run: pnpm run build
44+
45+
- name: Build Firefox
46+
if: ${{ matrix.container == 'firefox' }}
47+
run: |
48+
sed -i 's,"service_worker": "dist/background.js","scripts": ["dist/background.js"],g' ./manifest.json
49+
pnpm run build
50+
51+
- name: Package extension
52+
run: |
53+
PACKAGE_NAME="BandcampEnhancementSuite_${BROWSER}-$VERSION.zip"
54+
zip $PACKAGE_NAME LICENSE _locales/**/* icons/* css/* dist/* svg/* manifest.json html/browser_action.html
55+
56+
- name: Attach packages to GitHub Release
57+
env:
58+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
59+
run: |
60+
GH_RELEASE_ID=${{ github.event.release.id }}
61+
GH_REPO="https://uploads.github.com/repos/${{ github.repository }}/releases/$GH_RELEASE_ID/assets"
62+
PACKAGE_NAME="BandcampEnhancementSuite_${BROWSER}-$VERSION.zip"
63+
64+
curl -L \
65+
-X POST \
66+
-H "Accept: application/vnd.github+json" \
67+
-H "Authorization: Bearer $GITHUB_TOKEN" \
68+
-H "X-GitHub-Api-Version: 2022-11-28" \
69+
-H "Content-Type: application/octet-stream" \
70+
"$GH_REPO?name=$PACKAGE_NAME" \
71+
--data-binary "@$PACKAGE_NAME"

.github/workflows/test.yaml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,30 @@ jobs:
77
runs-on: ubuntu-latest
88

99
steps:
10-
- uses: actions/checkout@v4
11-
12-
- name: Setup pnpm
13-
uses: pnpm/action-setup@v4
14-
with:
15-
version: 9.14.4
16-
17-
- name: Use Node.js
18-
uses: actions/setup-node@v4
19-
with:
20-
node-version: '22.x'
21-
cache: 'pnpm'
22-
23-
- name: Install dependencies
24-
run: pnpm install --frozen-lockfile
25-
26-
- name: TypeScript type check
27-
run: pnpm run typecheck
28-
29-
- name: Build project
30-
run: pnpm run build
31-
32-
- name: Run linter
33-
run: pnpm run lint
34-
35-
- name: Run tests
36-
run: pnpm run test
10+
- uses: actions/checkout@v4
11+
12+
- name: Setup pnpm
13+
uses: pnpm/action-setup@v4
14+
with:
15+
version: 9.14.4
16+
17+
- name: Use Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: '22.x'
21+
cache: 'pnpm'
22+
23+
- name: Install dependencies
24+
run: pnpm install --frozen-lockfile
25+
26+
- name: TypeScript type check
27+
run: pnpm run typecheck
28+
29+
- name: Build project
30+
run: pnpm run build
31+
32+
- name: Run linter
33+
run: pnpm run lint
34+
35+
- name: Run tests
36+
run: pnpm run test

.oxlintrc.json

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@
1717
"beforeAll": "readonly",
1818
"afterAll": "readonly"
1919
},
20-
"plugins": [
21-
"typescript",
22-
"import",
23-
"unicorn"
24-
],
20+
"plugins": ["typescript", "import", "unicorn"],
2521
"rules": {
2622
"no-console": "error",
2723
"no-unused-vars": "warn",
@@ -40,9 +36,5 @@
4036
}
4137
}
4238
],
43-
"ignorePatterns": [
44-
"dist/**",
45-
"node_modules/**",
46-
"*.min.js"
47-
]
48-
}
39+
"ignorePatterns": ["dist/**", "node_modules/**", "*.min.js"]
40+
}

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# Bandcamp Enhancement Suite
2+
23
## About
4+
35
Chrome extension adding extra features to the Bandcamp experience.
46

57
The goal of this extension is to make Bandcamp easier to use when navigating larger sets of music (e.g. label pages with large back catalogues). It has been designed with DJs in mind.
68

79
## Features
10+
811
### Preview Button
12+
913
Provides a "Preview" button on pages with multiple albums. This button will open a player on the same page giving a quick and easy way to listen to tracks without having to navigate away from the page.
1014

1115
### History Tracking
12-
Adds a history display element next to album. This element is a clickable toggle which persists between page loads thus providing a history. This toggle is automatically set when `preview` button is used and can be manually clicked.
16+
17+
Adds a history display element next to album. This element is a clickable toggle which persists between page loads thus providing a history. This toggle is automatically set when `preview` button is used and can be manually clicked.
1318

1419
### Keyboard Bindings
20+
1521
On album and track pages the following keyboard controls are supported:
1622

17-
| Key Binding | Action |
18-
|-------------------|---------------------------------|
23+
| Key Binding | Action |
24+
| ------------------- | ----------------------------- |
1925
| Space Bar and "p" | Play/Pause |
2026
| Right Arrow | Move Playhead Forward 10s |
2127
| Left Arrow | Move Playhead Back 10s |
@@ -27,47 +33,61 @@ On album and track pages the following keyboard controls are supported:
2733
| Shift + Down Arrow | Decrease Audio Volume by 0.05 |
2834

2935
### Advanced Mouse Playbar
36+
3037
Click anywhere on the playbar to set the "playhead" of the player.
3138

3239
### Waveform Display
40+
3341
Adds a wavform display similar to visualization of Soundcloud. A toggle below the "play button" on album pages will enable/disable the display.
3442
**Note**: The waveform is processed browserside.
3543

3644
### BPM Estimate
45+
3746
Adds a BPM estimate for tracks played on Album or Track page.
3847
**Note**: The bpm estimation is processed browserside.
3948

4049
### Volume Control
50+
4151
Adds a slider on the right side of the player controls volume.
4252

4353
### Control Relocation
54+
4455
Moves the forward/back buttons for the player (on album and track pages) to right under the play/pause button.
4556

4657
### Tracklist Relocation
58+
4759
Moves the tracklist on an album's page directly below the player.
4860

4961
### Bundle Purchase Download Button
62+
5063
Adds a button to help automate the process of download a cart after purchase. Once all music download links are ready this button, when clicked, generate a `.txt` file which can be **pasted** into [terminal](https://en.wikipedia.org/wiki/List_of_terminal_emulators) to automate the downloading process. This `.txt` file uses [cURL](https://en.wikipedia.org/wiki/CURL).
5164

5265
Additionally, while the generated file is a `.txt`, it can be run directly in terminal with the command:
66+
5367
```
5468
. ./bandcamp_*.txt
5569
```
70+
5671
This will download the files into the same directory the terminal session is in.
5772

5873
### 1-Click Purchase
74+
5975
Adds buttons on track and album pages to easily add an item to your cart with a single click.
6076

6177
## Installation
78+
6279
Available from the [Chrome webstore](https://chrome.google.com/webstore/detail/bandcamp-label-view/padcfdpdlnpdojcihidkgjnmleeingep) and [Firefox Addons](https://addons.mozilla.org/en-US/firefox/addon/bandcamp-enhancement-suite)
6380

6481
## Feedback
82+
6583
Feedback, feature requests, and bug reports are always welcome.
6684

6785
## Development
86+
6887
This project uses `webpack` to generate the final project files from npm packages. This allows the use of `import` statements.
6988

7089
### Quick Start
90+
7191
From the root of the project run:
7292

7393
```
@@ -79,12 +99,14 @@ This will grab all of the js dependencies.
7999
Different `npm` commands defined in the `scripts` section of `package.json` can be used for to preform various tasks.
80100

81101
#### build
102+
82103
run:
83104

84105
```sh
85106
# Defaults to --mode=production:
86107
npm run build
87108
```
109+
88110
this will generate js files in `./dist`.
89111

90112
Continuous rebuild when files update:

_locales/en/messages.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "The title of the application, displayed in the web store."
55
},
66
"appDesc": {
7-
"message": "Adds extra features to the Bandcamp experience.",
8-
"description":"The description of the application, displayed in the web store."
7+
"message": "Adds extra features to the Bandcamp experience.",
8+
"description": "The description of the application, displayed in the web store."
99
}
1010
}

0 commit comments

Comments
 (0)