@tyleretters/discography 2.2.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -11,12 +11,14 @@
11
11
 
12
12
  ## Setup
13
13
 
14
- - `cd discography`
15
- - `npm i`
16
- - `cd src`
17
- - `python3 -m venv venv`
18
- - `source venv/bin/activate`
19
- - `pip install -r requirements.txt`
14
+ ```zsh
15
+ cd discography
16
+ npm i
17
+ cd src
18
+ python3 -m venv venv
19
+ source venv/bin/activate
20
+ pip install -r requirements.txt
21
+ ```
20
22
 
21
23
  ## Adding a Compilation
22
24
 
@@ -31,24 +33,48 @@ python3 scrape_bandcamp.py <bandcamp_url> \
31
33
 
32
34
  Review the prepended entry in `src/discography.yml`, then build and publish as normal.
33
35
 
34
- ## Updating & Publishing
36
+ ## Build
37
+
38
+ ```zsh
39
+ npm run build
40
+ ```
41
+
42
+ This runs the full pipeline: Python converter (YAML to TS), Vite bundler (ESM + UMD), TypeScript compiler (type declarations), and copies the source YAML to `dist/`.
43
+
44
+ `dist/` is gitignored — built artifacts are not committed. The `"files"` field in `package.json` ensures `dist/` is always included in the npm tarball.
35
45
 
36
- ### One Shot
46
+ ## Test
37
47
 
38
48
  ```zsh
39
- cd src && python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt && cd ../ && npm run build && git add . && git commit -m "++" && git push origin main && npm version patch && npm publish
49
+ source src/venv/bin/activate
50
+ pytest tests/
40
51
  ```
41
52
 
42
- ### Sequential
53
+ ## Lint
54
+
55
+ ```zsh
56
+ npm run lint
57
+ ```
43
58
 
44
- - Update `./src/discography.yml`
45
- - `npm run build` (convert yml to ts & build dist ready js)
46
- - `git add . && git commit -m "++" && git push origin main`
47
- - QA: [https://github.com/tyleretters/discography](https://github.com/tyleretters/discography)
48
- - `npm version patch`
49
- - `npm publish`
59
+ ## Publishing
60
+
61
+ After updating `src/discography.yml`:
62
+
63
+ ```zsh
64
+ git add . && git commit -m "++" && git push origin main
65
+ npm login
66
+ npm version patch
67
+ npm publish
68
+ ```
69
+
70
+ `npm publish` automatically runs `npm run build` via the `prepublishOnly` hook, so there's no need to build manually before publishing.
50
71
 
51
72
  ## Downstream Implementations
52
73
 
53
- - `npm i @tyleretters/discography`
54
- - `import discography from '@tyleretters/discography'`
74
+ ```zsh
75
+ npm i @tyleretters/discography
76
+ ```
77
+
78
+ ```typescript
79
+ import discography from "@tyleretters/discography";
80
+ ```
@@ -1,3 +1,36 @@
1
+ - title: SINGULARITY PROTOCOL
2
+ slug: singularity-protocol
3
+ project: DJ STUXNET
4
+ released: 02026-04-02
5
+ type: Mix
6
+ format: Digital
7
+ role: DJ
8
+ label: Intertext
9
+ mp3: true
10
+ wav: true
11
+ trackIds:
12
+ - "Meditation by Eduard Artemyev"
13
+ - "Gnosis by Russian Circles"
14
+ - "Берег моря (Из к/ф 'Красная палатка') by Aleksandr Zatsepin"
15
+ - "Slow Moving Trains / The Cowboy... / Drugs in Tokyo by Godspeed You! Black Emperor"
16
+ - "The Great Leap Forward Poured Down Upon Us One Day Like A Mighty Storm, Suddenly And Furiously Blinding Our Senses. by Red Sparowes"
17
+ - "Ataraxia by Hilyard"
18
+ - "Tablet III by Blood Incantation"
19
+ - "And Technological Advancements by SIOUM"
20
+ tracks:
21
+ - number: 1
22
+ title: SINGULARITY PROTOCOL
23
+ slug: singularity-protocol
24
+ length: 00:59:56
25
+ streams:
26
+ - platform: SoundCloud
27
+ url: https://soundcloud.com/tyleretters/singularity-protocol-mixtape
28
+ - platform: Untitled Stream
29
+ url: https://untitled.stream/library/project/Tl87IWEW1j4hbdPMI9cUU
30
+ notes: From everywhere and all at once.
31
+
32
+ credits: STUXNET is Tyler Etters.
33
+
1
34
  - title: Incendiary Nocturne
2
35
  slug: incendiary-nocturne
3
36
  project: DJ STUXNET