Swap to biome for formatting and linting

.github/workflows/check.yml

@@ -1,47 +1,41 @@
 name: Check
 
 on:
-  pull_request:
-    paths:
-      - 'src/**'
-      - 'tests/**'
-      - '.eslintrc.json'
-      - 'tsconfig.json'
-      - '.github/workflows/check.yml'
+  push:
+    paths-ignore:
+      - .vscode/**
+      - README.md
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4
+    - run: corepack enable
+    - uses: actions/setup-node@v4
       with:
-        node-version: 18
-        cache: 'yarn'
-        cache-dependency-path: '**/yarn.lock'
-    - run: yarn install --immutable
-    - run: yarn lint --max-warnings 0
+        cache: yarn
+    - run: yarn install
+    - run: yarn lint
 
   typecheck:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4
+    - run: corepack enable
+    - uses: actions/setup-node@v4
       with:
-        node-version: 18
-        cache: 'yarn'
-        cache-dependency-path: '**/yarn.lock'
-    - run: yarn install --immutable
-    - run: yarn typecheck
+        cache: yarn
+    - run: yarn install
+    - run: yarn tsc
 
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4
+    - run: corepack enable
+    - uses: actions/setup-node@v4
       with:
-        node-version: 18
-        cache: 'yarn'
-        cache-dependency-path: '**/yarn.lock'
-    - run: yarn install --immutable
+        cache: yarn
+    - run: yarn install
     - run: yarn test

.github/workflows/release.yml

@@ -2,28 +2,29 @@ name: Release
 
 on:
   push:
-    branches: ['main']
+    branches:
+      - main
     paths:
       - '**/package.json'
-      - '.changeset/**'
-      - '.github/workflows/release.yml'
+      - .changeset/**
+      - .github/workflows/release.yml
 
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: actions/setup-node@v3
+    - run: corepack enable
+    - uses: actions/setup-node@v4
       with:
-        node-version: 18
-        cache: 'yarn'
-        cache-dependency-path: '**/yarn.lock'
-    - run: yarn install --immutable
+        cache: yarn
+    - run: yarn install
+    - run: yarn build
     - uses: changesets/action@v1
       with:
-        publish: yarn ci:release
+        publish: yarn changeset publish
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 dist
-.vscode
 yarn-error.log
+.yarn
+*.tsbuildinfo

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["biomejs.biome"]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.codeActionsOnSave": {
+    "source.organizeImports.biome": "explicit"
+  }
+}

.yarnrc.yml

@@ -0,0 +1,2 @@
+nodeLinker: node-modules
+compressionLevel: mixed

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Ewan Breakey
+Copyright (c) 2022 Stevent Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

biome.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "files": {
+    "ignore": [".yarn", "dist"]
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "formatter": {
+    "indentStyle": "space",
+    "lineWidth": 120
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded"
+    }
+  }
+}

package.json

@@ -2,15 +2,11 @@
   "name": "ayecal",
   "version": "0.1.7",
   "description": "Create and manipulate iCal files",
-  "keywords": [
-    "ical",
-    "ics",
-    "calendar",
-    "webcal"
-  ],
+  "keywords": ["ical", "ics", "calendar", "webcal"],
   "repository": "https://github.com/stevent-team/ayecal",
   "author": "Stevent team (https://stevent.club)",
   "license": "MIT",
+  "packageManager": "[email protected]",
   "type": "module",
   "main": "dist/ayecal.umd.cjs",
   "module": "dist/ayecal.js",
@@ -21,28 +17,21 @@
       "require": "./dist/ayecal.umd.cjs"
     }
   },
+  "files": ["dist"],
   "scripts": {
-    "dev": "vite",
     "build": "tsc && vite build",
-    "build:demo": "tsc && vite build -m demo",
-    "lint": "eslint --ext .ts ./src",
-    "test": "vitest",
-    "typecheck": "tsc",
-    "ci:release": "yarn build && yarn changeset publish"
+    "lint": "biome check .",
+    "format": "biome check --apply .",
+    "test": "vitest"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.26.1",
-    "@types/node": "^18.15.11",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
-    "eslint": "^8.10.0",
-    "type-fest": "^3.7.2",
-    "typescript": "^5.0.3",
-    "vite": "^4.2.1",
-    "vite-plugin-dts": "^2.1.0",
-    "vitest": "^0.29.8"
-  },
-  "files": [
-    "dist"
-  ]
+    "@biomejs/biome": "^1.4.1",
+    "@changesets/cli": "^2.27.1",
+    "@types/node": "^20.10.6",
+    "type-fest": "^4.9.0",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.10",
+    "vite-plugin-dts": "^3.7.0",
+    "vitest": "^1.1.1"
+  }
 }

src/Calendar.ts

@@ -1,8 +1,18 @@
 import { Event } from './Event'
-import { CalendarMethod, CalendarName, CalendarProductId, CalendarScale, CalendarScope, CalendarTimeZone, CustomProperty } from './properties'
+import {
+  CalendarMethod,
+  CalendarName,
+  CalendarProductId,
+  CalendarScale,
+  CalendarScope,
+  CalendarTimeZone,
+  CustomProperty,
+} from './properties'
 import { takeOr } from './utils'
 
-export type CalendarProperties = Partial<Pick<Calendar, 'name' | 'scope' | 'timeZone' | 'scale' | 'method' | 'productId' | 'custom'>>
+export type CalendarProperties = Partial<
+  Pick<Calendar, 'name' | 'scope' | 'timeZone' | 'scale' | 'method' | 'productId' | 'custom'>
+>
 
 /**
  * An AyeCal Calendar.
@@ -37,11 +47,11 @@ export class Calendar {
 
   constructor(props: CalendarProperties = {}) {
     this.name = takeOr(props.name, null)
-    this.scope = takeOr(props.scope, null),
-    this.scale = takeOr(props.scale, 'GREGORIAN'),
-    this.method = takeOr(props.method, 'PUBLISH'),
-    this.productId = takeOr(props.productId, '-//AyeCal//AyeCal//EN'),
-    this.timeZone = takeOr(props.timeZone, Intl.DateTimeFormat().resolvedOptions().timeZone),
+    this.scope = takeOr(props.scope, null)
+    this.scale = takeOr(props.scale, 'GREGORIAN')
+    this.method = takeOr(props.method, 'PUBLISH')
+    this.productId = takeOr(props.productId, '-//AyeCal//AyeCal//EN')
+    this.timeZone = takeOr(props.timeZone, Intl.DateTimeFormat().resolvedOptions().timeZone)
     this.custom = takeOr(props.custom, {})
     this.#events = []
   }
@@ -58,9 +68,8 @@ export class Calendar {
    */
   addEvent(newEvent: Event) {
     // Look for uid collision
-    const collidingEvent = this.#events.find(event => event.id === newEvent.id)
-    if (collidingEvent)
-      throw new Error(`Failed to add event with id ${newEvent.id}, id already present in calendar`)
+    const collidingEvent = this.#events.find((event) => event.id === newEvent.id)
+    if (collidingEvent) throw new Error(`Failed to add event with id ${newEvent.id}, id already present in calendar`)
 
     this.#events = [...this.#events, newEvent]
 
@@ -71,7 +80,7 @@ export class Calendar {
    * Removes an event by ID from the Calendar. Does nothing if there are no matching events.
    */
   removeEvent(eventId: string) {
-    this.#events = this.#events.filter(event => event.id !== eventId)
+    this.#events = this.#events.filter((event) => event.id !== eventId)
   }
 
   /**
@@ -95,9 +104,7 @@ export class Calendar {
       .join('\n')
 
     // Convert calendar events to a string
-    const eventText = this.#events
-      .map(event => event.toString(this.scope))
-      .join('\n')
+    const eventText = this.#events.map((event) => event.toString(this.scope)).join('\n')
 
     return `BEGIN:VCALENDAR\n${text}\n${eventText}\nEND:VCALENDAR`
   }