ical-generator 7.2.1-develop.2 → 7.2.1-develop.3

package/package.json

@@ -9,6 +9,7 @@
   "description": "ical-generator is a small piece of code which generates ical calendar files",
   "devDependencies": {
     "@eslint/js": "^9.9.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@qiwi/semantic-release-gh-pages-plugin": "^5.2.12",
     "@sebbo2002/semantic-release-jsr": "^1.1.0",
     "@semantic-release/changelog": "^6.0.3",
@@ -36,8 +37,8 @@
     "semantic-release": "^24.0.0",
     "semantic-release-license": "^1.0.2",
     "source-map-support": "^0.5.21",
-    "ts-node": "^10.9.2",
     "tsup": "^8.2.4",
+    "tsx": "^4.16.2",
     "typedoc": "^0.26.3",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.0.0-alpha.62"
@@ -120,7 +121,7 @@
     "build": "tsup && cp ./dist/index.d.ts ./dist/index.d.cts",
     "build-all": "./.github/workflows/build.sh",
     "coverage": "c8 mocha",
-    "develop": "TS_NODE_TRANSPILE_ONLY=true node --no-warnings --enable-source-maps --loader ts-node/esm src/bin/start.ts",
+    "develop": "tsx src/bin/start.ts",
     "example": "node ./dist/examples/push.js",
     "license-check": "license-checker --production --summary",
     "lint": "eslint .",
@@ -128,5 +129,5 @@
     "test": "mocha"
   },
   "type": "module",
-  "version": "7.2.1-develop.2"
+  "version": "7.2.1-develop.3"
 }

package/src/alarm.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-import ICalEvent from './event.ts';
+import type ICalEvent from './event.ts';
 import {
     addOrGetCustomAttributes,
     formatDate,
@@ -11,8 +11,8 @@ import {
     toJSON,
     checkNameAndMail
 } from './tools.ts';
-import {ICalDateTimeValue} from './types.ts';
-import ICalAttendee, { ICalAttendeeData } from './attendee.ts';
+import { type ICalDateTimeValue } from './types.ts';
+import ICalAttendee, { type ICalAttendeeData } from './attendee.ts';
 
 
 export enum ICalAlarmType {
@@ -324,7 +324,8 @@ export default class ICalAlarm {
      * alarm is triggered after the event started.
      *
      * @since 0.2.1
-     * @alias trigger
+     * @see {@link trigger}
+     * @see {@link triggerAfter}
      */
     triggerBefore (trigger: number | ICalDateTimeValue): this;
 
@@ -345,7 +346,8 @@ export default class ICalAlarm {
      * for details about supported values and timezone handling.
      *
      * @since 0.2.1
-     * @alias trigger
+     * @see {@link trigger}
+     * @see {@link triggerAfter}
      */
     triggerBefore (): number | ICalDateTimeValue;
     triggerBefore (trigger?: number | ICalDateTimeValue): this | number | ICalDateTimeValue {

package/src/attendee.ts

@@ -2,8 +2,8 @@
 
 
 import {addOrGetCustomAttributes, checkEnum, checkNameAndMail, escape} from './tools.ts';
-import ICalEvent from './event.ts';
-import ICalAlarm from './alarm.ts';
+import type ICalEvent from './event.ts';
+import type ICalAlarm from './alarm.ts';
 
 
 interface ICalInternalAttendeeData {

package/src/calendar.ts

@@ -8,8 +8,8 @@ import {
     isMomentDuration,
     toDurationString
 } from './tools.ts';
-import ICalEvent, {ICalEventData, ICalEventJSONData} from './event.ts';
-import { ICalMomentDurationStub, ICalTimezone } from './types.ts';
+import ICalEvent, { type ICalEventData, type ICalEventJSONData } from './event.ts';
+import { type ICalMomentDurationStub, type ICalTimezone } from './types.ts';
 
 
 export interface ICalCalendarData {

package/src/event.ts

@@ -14,19 +14,19 @@ import {
     toDate,
     toJSON
 } from './tools.ts';
-import ICalAttendee, {ICalAttendeeData} from './attendee.ts';
-import ICalAlarm, {ICalAlarmData} from './alarm.ts';
-import ICalCategory, {ICalCategoryData} from './category.ts';
+import ICalAttendee, { type ICalAttendeeData } from './attendee.ts';
+import ICalAlarm, { type ICalAlarmData } from './alarm.ts';
+import ICalCategory, { type ICalCategoryData } from './category.ts';
 import ICalCalendar from './calendar.ts';
 import {
-    ICalDateTimeValue,
-    ICalDescription,
     ICalEventRepeatingFreq,
-    ICalLocation,
-    ICalOrganizer,
-    ICalRepeatingOptions,
-    ICalRRuleStub,
-    ICalWeekday
+    ICalWeekday,
+    type ICalDateTimeValue,
+    type ICalDescription,
+    type ICalLocation,
+    type ICalOrganizer,
+    type ICalRRuleStub,
+    type ICalRepeatingOptions
 } from './types.ts';
 
 
@@ -266,7 +266,7 @@ export default class ICalEvent {
     /**
      * Get the event's ID
      * @since 0.2.0
-     * @alias id
+     * @see {@link id}
      */
     uid(): string;
 
@@ -275,7 +275,6 @@ export default class ICalEvent {
      * If not set, a UUID will be generated randomly.
      *
      * @param id Event ID you want to set
-     * @alias id
      */
     uid(id: string | number): this;
     uid(id?: string | number): this | string {
@@ -487,6 +486,7 @@ export default class ICalEvent {
     /**
      * Get the event's timestamp
      * @since 0.2.0
+     * @see {@link timestamp}
      */
     stamp(): ICalDateTimeValue;
 
@@ -496,6 +496,7 @@ export default class ICalEvent {
      * for details about supported values and timezone handling.
      *
      * @since 0.2.0
+     * @see {@link timestamp}
      */
     stamp(stamp: ICalDateTimeValue): this;
     stamp(stamp?: ICalDateTimeValue): this | ICalDateTimeValue {
@@ -510,7 +511,7 @@ export default class ICalEvent {
     /**
      * Get the event's timestamp
      * @since 0.2.0
-     * @alias stamp
+     * @see {@link stamp}
      */
     timestamp(): ICalDateTimeValue;
 
@@ -520,7 +521,7 @@ export default class ICalEvent {
      * for details about supported values and timezone handling.
      *
      * @since 0.2.0
-     * @alias stamp
+     * @see {@link stamp}
      */
     timestamp(stamp: ICalDateTimeValue): this;
     timestamp(stamp?: ICalDateTimeValue): this | ICalDateTimeValue {

package/src/index.ts

@@ -4,7 +4,7 @@
 
 'use strict';
 
-import ICalCalendar, {ICalCalendarData} from './calendar.ts';
+import ICalCalendar, { type ICalCalendarData } from './calendar.ts';
 
 
 /**
@@ -47,77 +47,77 @@ function ical(data?: ICalCalendarData): ICalCalendar {
 export default ical;
 
 export {
-    default as ICalAlarm,
-    ICalAlarmData,
-    ICalAlarmBaseData,
-    ICalAlarmJSONData,
     ICalAlarmRelatesTo,
-    ICalAlarmRepeatData,
-    ICalAlarmTriggerData,
-    ICalAlarmTriggerAfterData,
-    ICalAlarmTriggerBeforeData,
     ICalAlarmType,
-    ICalAlarmTypeValue,
-    ICalAttachment,
+    default as ICalAlarm,
+    type ICalAlarmBaseData,
+    type ICalAlarmData,
+    type ICalAlarmJSONData,
+    type ICalAlarmRepeatData,
+    type ICalAlarmTriggerAfterData,
+    type ICalAlarmTriggerBeforeData,
+    type ICalAlarmTriggerData,
+    type ICalAlarmTypeValue,
+    type ICalAttachment
 } from './alarm.ts';
 
 export {
-    default as ICalAttendee,
-    ICalAttendeeData,
-    ICalAttendeeType,
     ICalAttendeeRole,
     ICalAttendeeStatus,
-    ICalAttendeeJSONData
+    ICalAttendeeType,
+    default as ICalAttendee,
+    type ICalAttendeeData,
+    type ICalAttendeeJSONData
 } from './attendee.ts';
 
 export {
-    default as ICalCalendar,
-    ICalCalendarData,
-    ICalCalendarProdIdData,
     ICalCalendarMethod,
-    ICalCalendarJSONData
+    default as ICalCalendar,
+    type ICalCalendarData,
+    type ICalCalendarJSONData,
+    type ICalCalendarProdIdData
 } from './calendar.ts';
 
 export {
     default as ICalCategory,
-    ICalCategoryData,
-    ICalCategoryJSONData
+    type ICalCategoryData,
+    type ICalCategoryJSONData
 } from './category.ts';
 
 export {
-    default as ICalEvent,
-    ICalEventStatus,
     ICalEventBusyStatus,
-    ICalEventTransparency,
-    ICalEventData,
-    ICalEventJSONData,
-    ICalEventJSONRepeatingData,
     ICalEventClass,
+    ICalEventStatus,
+    ICalEventTransparency,
+    default as ICalEvent,
+    type ICalEventData,
+    type ICalEventJSONData,
+    type ICalEventJSONRepeatingData
 } from './event.ts';
 
 export {
-    ICalDateTimeValue,
-    ICalRepeatingOptions,
-    ICalLocation,
-    ICalLocationWithTitle,
-    ICalLocationWithoutTitle,
-    ICalGeo,
-    ICalOrganizer,
-    ICalDescription,
     ICalEventRepeatingFreq,
     ICalWeekday,
-    ICalTimezone,
-    ICalMomentStub,
-    ICalMomentTimezoneStub,
-    ICalMomentDurationStub,
-    ICalLuxonDateTimeStub,
-    ICalDayJsStub,
-    ICalRRuleStub
+    type ICalDateTimeValue,
+    type ICalDayJsStub,
+    type ICalDescription,
+    type ICalGeo,
+    type ICalLocation,
+    type ICalLocationWithTitle,
+    type ICalLocationWithoutTitle,
+    type ICalLuxonDateTimeStub,
+    type ICalMomentDurationStub,
+    type ICalMomentStub,
+    type ICalMomentTimezoneStub,
+    type ICalOrganizer,
+    type ICalRRuleStub,
+    type ICalRepeatingOptions,
+    type ICalTimezone,
 } from './types.ts';
 
 export {
-    formatDate,
-    formatDateTZ,
     escape,
-    foldLines
+    foldLines,
+    formatDate,
+    formatDateTZ
 } from './tools.ts';

package/src/tools.ts

@@ -1,13 +1,14 @@
 'use strict';
 
 import {
-    ICalDateTimeValue,
-    ICalDayJsStub,
-    ICalLuxonDateTimeStub,
-    ICalMomentDurationStub,
-    ICalMomentStub,
-    ICalMomentTimezoneStub,
-    ICalOrganizer, ICalRRuleStub
+    type ICalDateTimeValue,
+    type ICalDayJsStub,
+    type ICalLuxonDateTimeStub,
+    type ICalMomentDurationStub,
+    type ICalMomentStub,
+    type ICalMomentTimezoneStub,
+    type ICalOrganizer,
+    type ICalRRuleStub
 } from './types.ts';
 
 /**