Merge pull request #30 from studiorack/feature/clean-start

Feature/clean start

.github/workflows/release.yml

@@ -1,31 +1,31 @@
 name: Release
 
-on: 
+on:
   workflow_dispatch:
   schedule:
-      # https://crontab.guru/#10_0_*_*_0
-      # At 00:10 on Sunday.
+    # https://crontab.guru/#10_0_*_*_0
+    # At 00:10 on Sunday.
     - cron: '10 0 * * 0'
   push:
     tags:
-      - "v*"
+      - 'v*'
 
 jobs:
   release:
     name: Create release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install dependencies
         run: npm ci
 
-      - name: Build site
+      - name: Build and run code
         run: npm run build
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./out

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install
         run: |
@@ -25,4 +25,8 @@ jobs:
 
       - name: Test
         run: |
-          npm run test
+          npm test
+
+      - name: Build
+        run: |
+          npm run build

.gitignore

@@ -1,24 +1,31 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# Logs
+logs
+*.log
+npm-debug.log*
 
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
+# Dependencies
+node_modules/
 
-# testing
-/coverage
+# Coverage
+coverage
 
-# next.js
-/.next/
-/out/
+# Transpiled files
+build/
+out/
+.next/
 
-# production
-/build
+# VS Code
+.vscode
+!.vscode/tasks.js
 
-# misc
-.DS_Store
+# JetBrains IDEs
+.idea/
 
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Misc
+.DS_Store

.prettierrc.json

@@ -0,0 +1,15 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "bracketSameLine": false,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
+}

README.md

@@ -1,21 +1,20 @@
 # studiorack-site
+
 ![Release](https://github.com/studiorack/studiorack-site/workflows/Release/badge.svg)
 
 Audio plugin site with searchable plugin list, tools and documentation using:
 
-* NodeJS 17.x
-* TypeScript 4.x
-* NextJS 12.x
-* React 17.x
-
+- NodeJS 18.x
+- TypeScript 5.x
+- NextJS 14.x
+- React 18.x
 
 ## Installation
 
 Install dependencies using:
 
     npm install
 
-
 ## Usage
 
 Run the development server using:
@@ -30,7 +29,6 @@ Get the api at:
 
     http://localhost:3000/api/plugins
 
-
 ## Deployment
 
 Release an updated version on GitHub by simply creating a version tag:
@@ -42,7 +40,6 @@ This will run an automated build and deploy process on GitHub Actions:
 
     .github/workflows/release.yml
 
-
 ## Contact
 
 For more information please contact kmturley

_docs/03-add-remove-plugins.md

@@ -11,7 +11,7 @@ Add a plugin and update project.json config using:
     studiorack project install <project-id> <plugin-id>
 
 Remove a plugin and update project.json config using:
- 
+
     studiorack plugin uninstall <project-id> <plugin-id>
 
 [Launch project config &gt;](/docs/04-launch-project-config)

_docs/06-command-line.md

@@ -6,34 +6,33 @@ The StudioRack CLI allows you to create, install, and publish plugins.
 
 Configuration commands:
 
-* [Config get](#config-get)
-* [Config set](#config-set)
+- [Config get](#config-get)
+- [Config set](#config-set)
 
 Plugin commands:
 
-* [Plugin create](#plugin-create)
-* [Plugin get](#plugin-get)
-* [Plugin getLocal](#plugin-getlocal)
-* [Plugin install](#plugin-install)
-* [Plugin list](#plugin-list)
-* [Plugin listLocal](#plugin-listlocal)
-* [Plugin search](#plugin-search)
-* [Plugin uninstall](#plugin-uninstall)
+- [Plugin create](#plugin-create)
+- [Plugin get](#plugin-get)
+- [Plugin getLocal](#plugin-getlocal)
+- [Plugin install](#plugin-install)
+- [Plugin list](#plugin-list)
+- [Plugin listLocal](#plugin-listlocal)
+- [Plugin search](#plugin-search)
+- [Plugin uninstall](#plugin-uninstall)
 
 Project commands:
 
-* [Project create](#project-create)
-* [Project getLocal](#project-getlocal)
-* [Project install](#project-install)
-* [Project listLocal](#project-listlocal)
-* [Project open](#project-open)
-* [Project uninstall](#project-uninstall)
+- [Project create](#project-create)
+- [Project getLocal](#project-getlocal)
+- [Project install](#project-install)
+- [Project listLocal](#project-listlocal)
+- [Project open](#project-open)
+- [Project uninstall](#project-uninstall)
 
 Other commands:
 
-* [Validate](#validate)
-* [Help](#help)
-
+- [Validate](#validate)
+- [Help](#help)
 
 ## Config get
 
@@ -56,7 +55,6 @@ Other commands:
     projectTypes: ProjectTypes;
     validatorUrl: string;
 
-
 ## Config set
 
 `studiorack config set set <key> <val>` Get a config setting by key. List of keys and values available:
@@ -78,7 +76,6 @@ Other commands:
     projectTypes: ProjectTypes;
     validatorUrl: string;
 
-
 ## Plugin create
 
 `studiorack plugin create <path> --type <type>` creates a new plugin using the starter template with one of the types:
@@ -94,7 +91,6 @@ Other commands:
 
 Follow the instructions in generated README.md to install and build your plugin.
 
-
 ## Plugin get
 
 `studiorack plugin get <input>` Get registry plugin metadata by id:
@@ -106,7 +102,6 @@ Follow the instructions in generated README.md to install and build your plugin.
     │ studiorack/template-steinberg/adelay │ ADelayTest Factory │ Test Class  │ 2020-12-25 │ 1.1.0   │ Fx, Delay │
     └────────────────────────────────────┴────────────────────┴─────────────┴────────────┴─────────┴───────────┘
 
-
 ## Plugin getLocal
 
 `studiorack plugin getLocal <input>` Get local plugin details by id:
@@ -118,13 +113,11 @@ Follow the instructions in generated README.md to install and build your plugin.
     │ studiorack/template-steinberg/adelay │ ADelayTest Factory │ Test Class  │ 2020-12-25 │ 1.1.0   │ Fx, Delay │
     └────────────────────────────────────┴────────────────────┴─────────────┴────────────┴─────────┴───────────┘
 
-
 ## Plugin install
 
 `studiorack plugin install <input>` Install a plugin manually by id:
 
-    studiorack plugin install studiorack/studiorack-template-steinberg/adelay
-
+    studiorack plugin install studiorack/mda
 
 ## Plugin list
 
@@ -141,7 +134,6 @@ Follow the instructions in generated README.md to install and build your plugin.
     │ steinberg/channelcontext       │ ContextController  │ Component      │ 2020-12-25 │ 1.0.0   │ Spatial,  │
     └────────────────────────────────┴────────────────────┴────────────────┴────────────┴─────────┴───────────┘
 
-
 ## Plugin listLocal
 
 `studiorack plugin listLocal` Get local plugin details by id:
@@ -153,26 +145,22 @@ Follow the instructions in generated README.md to install and build your plugin.
     │ studiorack/plugin-steinberg/adelay │ ADelayTest Factory │ Test Class  │ 2020-12-25 │ 1.1.0   │ Fx, Delay │
     └────────────────────────────────────┴────────────────────┴─────────────┴────────────┴─────────┴───────────┘
 
-
 ## Plugin search
 
 `studiorack search <query>` Search plugin registry by query. For example:
 
     studiorack plugin search "delay"
 
-
 ## Plugin uninstall
 
 `studiorack plugin <input>` Uninstall a plugin manually by id:
 
     studiorack plugin uninstall studiorack/studiorack-template-steinberg/adelay
 
-
 ## Project create
 
 `studiorack project create <path>` creates a new project using the starter template.
 
-
 ## Project getLocal
 
 `studiorack project getLocal <input>` Get local project details by id:
@@ -184,14 +172,12 @@ Follow the instructions in generated README.md to install and build your plugin.
     │ demos/94th-project/94th │ 94th │ Created using StudioRack │ 2021-01-29 │ 1.0.0   │ Ableton │
     └─────────────────────────┴──────┴──────────────────────────┴────────────┴─────────┴─────────┘
 
-
 ## Project install
 
 `studiorack project install <id> [input]` Install a project by id:
 
     studiorack project install demos/94th-project/94th
 
-
 ## Project listLocal
 
 `studiorack project listLocal` Get local plugin details by id:
@@ -207,29 +193,25 @@ Follow the instructions in generated README.md to install and build your plugin.
     │ demos/alfredo-project/alfredo   │ Alfredo          │ Created using StudioRack │ 2020-10-24 │ 1.0.0   │ Ableton  │
     └─────────────────────────────────┴──────────────────┴──────────────────────────┴────────────┴─────────┴──────────┘
 
-
 ## Project open
 
 `studiorack project open <id>` open the current music project. For example:
 
     studiorack project open demos/94th-project/94th
 
-
 ## Project uninstall
 
 `studiorack project uninstall <id> [input]` Uninstall a project's plugins by id:
 
     studiorack plugin uninstall studiorack/studiorack-template-steinberg/adelay
 
-
 ## Validate
 
 `studiorack validate [path]` Validate plugin(s) using the Steinberg VST3 SDK validator. For example:
 
     studiorack validate "./myplugin/build/VST3/Release/myplugin.vst3"
     studiorack validate "./myplugin/build/VST3/Release/**/*.{vst,vst3}"
 
-
 ## Help
 
 `studiorack --help` lists the available CLI commands:

components/crumb.tsx

@@ -11,7 +11,10 @@ const Crumb = ({ items }: CrumbProps) => (
       {items.map((item: string, itemIndex: number) => (
         <li className={styles.crumbItem} key={`${item}-${itemIndex}`}>
           /
-          <a className={styles.crumbLink} href={`${getBasePath()}${getCrumbUrl(items, item)}`}>
+          <a
+            className={styles.crumbLink}
+            href={`${getBasePath()}${getCrumbUrl(items, item)}`}
+          >
             {item}
           </a>
         </li>