svelte-copyright 1.2.0 → 2.0.0-rc.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Dave Lunny
+Copyright (c) 2023 Dave Lunny
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -50,7 +50,7 @@ This will output HTML which looks something like this:
 
 ```html
 <footer>
-  <span>© Copyright 2020 Dave Lunny</span>
+  <span>© Copyright 2023 Dave Lunny</span>
 </footer>
 ```
 

package/dist/Copyright.svelte

@@ -0,0 +1,22 @@
+<script>import { FORMAT, POSITION } from "./constants.js";
+import { getDisplayDate, today } from "./utils/index.js";
+export let date = today();
+export let format = FORMAT.NUMERIC;
+export let position = POSITION.PRE;
+export let showRange = false;
+const displayDate = getDisplayDate({
+  showRange,
+  format,
+  date
+});
+</script>
+
+<span {...$$restProps}>
+  {#if position === POSITION.PRE}
+    &#169; Copyright {displayDate}
+  {/if}
+  <slot />
+  {#if position === POSITION.POST}
+    &#169; Copyright {displayDate}
+  {/if}
+</span>

package/dist/Copyright.svelte.d.ts

@@ -0,0 +1,23 @@
+import { SvelteComponent } from "svelte";
+import type { Format, Position } from './types.js';
+declare const __propDef: {
+    props: {
+        [x: string]: any;
+        date?: Date | undefined;
+        format?: Format | undefined;
+        position?: Position | undefined;
+        showRange?: boolean | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {
+        default: {};
+    };
+};
+export type CopyrightProps = typeof __propDef.props;
+export type CopyrightEvents = typeof __propDef.events;
+export type CopyrightSlots = typeof __propDef.slots;
+export default class Copyright extends SvelteComponent<CopyrightProps, CopyrightEvents, CopyrightSlots> {
+}
+export {};

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+import type { Format, Position } from './types.js';
+export declare const FORMAT: Record<string, Format>;
+export declare const POSITION: Record<string, Position>;

package/dist/constants.js

@@ -0,0 +1,8 @@
+export const FORMAT = {
+    NUMERIC: 'numeric',
+    TWO_DIGIT: '2-digit',
+};
+export const POSITION = {
+    PRE: 'pre',
+    POST: 'post',
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./Copyright.svelte";

package/dist/index.js

@@ -0,0 +1,2 @@
+// Reexport your entry components here
+export { default } from './Copyright.svelte';

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export type Format = '2-digit' | 'numeric';
+export type Position = 'post' | 'pre';

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/date.d.ts

@@ -0,0 +1,30 @@
+export declare function today(): Date;
+export declare function toYear(date?: Date): string;
+/**
+ * Formats the date, just for you!
+ *
+ * @param {Date} date - Date to format
+ * @param {'numeric' | '2-digit'} format - Format for the date.
+ */
+export declare function formatDate(date?: Date, format?: import("../types.js").Format): string;
+/**
+ * Returns the "range string", unless the dates are the same.
+ *
+ * @param {string} date1 - First date (formatted to a string)
+ * @param {string} date2 - Second date (formatted to a string).
+ */
+export declare function getRange(date1: string, date2: string): string;
+type GetDisplayDateProps = {
+    showRange?: boolean;
+    date?: Date;
+    format?: string;
+};
+/**
+ * Returns the displayed date for the component.
+ *
+ * @param {boolean} options.showRange - If a date range should be displayed.
+ * @param {Date} options.date - Copyright year to be used. If showRange is true, this is the start year of the range.
+ * @param {'numeric' | '2-digit'} options.format - Date format to be used.
+ */
+export declare function getDisplayDate({ showRange, date, format, }: GetDisplayDateProps): string;
+export {};

package/{src → dist}/utils/date.js

@@ -1,15 +1,12 @@
-import { FORMAT } from '../constants';
-
+import { FORMAT } from '../constants.js';
 //  Returns new Date() - for default/fallback values.
 export function today() {
-  return new Date();
+    return new Date();
 }
-
 //  Gets the year string from a date.
 export function toYear(date = today()) {
-  return date.getFullYear().toString();
+    return date.getFullYear().toString();
 }
-
 /**
  * Formats the date, just for you!
  *
@@ -17,14 +14,13 @@ export function toYear(date = today()) {
  * @param {'numeric' | '2-digit'} format - Format for the date.
  */
 export function formatDate(date = today(), format = FORMAT.NUMERIC) {
-  if (format === FORMAT.NUMERIC) {
-    return toYear(date);
-  }
-  if (format === FORMAT.TWO_DIGIT) {
-    return `’${toYear(date).slice(-2)}`;
-  }
+    if (format === FORMAT.NUMERIC) {
+        return toYear(date);
+    }
+    if (format === FORMAT.TWO_DIGIT) {
+        return `’${toYear(date).slice(-2)}`;
+    }
 }
-
 /**
  * Returns the "range string", unless the dates are the same.
  *
@@ -32,13 +28,12 @@ export function formatDate(date = today(), format = FORMAT.NUMERIC) {
  * @param {string} date2 - Second date (formatted to a string).
  */
 export function getRange(date1, date2) {
-  //  Don't show a range if years are the same, as that would be dumb.
-  if (date1 === date2) {
-    return date1;
-  }
-  return `${date1} - ${date2}`;
+    //  Don't show a range if years are the same, as that would be dumb.
+    if (date1 === date2) {
+        return date1;
+    }
+    return `${date1} - ${date2}`;
 }
-
 /**
  * Returns the displayed date for the component.
  *
@@ -46,17 +41,13 @@ export function getRange(date1, date2) {
  * @param {Date} options.date - Copyright year to be used. If showRange is true, this is the start year of the range.
  * @param {'numeric' | '2-digit'} options.format - Date format to be used.
  */
-export function getDisplayDate({
-  showRange = false,
-  date = today(),
-  format = FORMAT.NUMERIC,
-}) {
-  const formatted = formatDate(date, format);
-  //  Early return if we don't show the range
-  if (!showRange) {
-    return formatted;
-  }
-  //  Get today's year, formatted correctly.
-  const formattedToday = formatDate(today(), format);
-  return getRange(formatted, formattedToday);
+export function getDisplayDate({ showRange = false, date = today(), format = FORMAT.NUMERIC, }) {
+    const formatted = formatDate(date, format);
+    //  Early return if we don't show the range
+    if (!showRange) {
+        return formatted;
+    }
+    //  Get today's year, formatted correctly.
+    const formattedToday = formatDate(today(), format);
+    return getRange(formatted, formattedToday);
 }

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export { getDisplayDate, today } from './date.js';

package/dist/utils/index.js

@@ -0,0 +1 @@
+export { getDisplayDate, today } from './date.js';

package/package.json

@@ -1,64 +1,75 @@
 {
   "name": "svelte-copyright",
   "description": "A Svelte component to format and display a copyright notice.",
-  "version": "1.2.0",
+  "version": "2.0.0-rc.0",
   "author": {
     "name": "himynameisdave",
     "email": "d@velunny.com",
     "url": "https://himynameisdave.com"
   },
-  "svelte": "src/index.js",
-  "module": "lib/index.mjs",
-  "main": "lib/index.js",
-  "files": [
-    "src",
-    "lib"
-  ],
+  "type": "module",
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "rollup -c --bundleConfigAsCjs",
-    "test": "jest src",
-    "release": "np --no-yarn"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.20.5",
-    "@babel/preset-env": "^7.20.2",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/svelte": "^3.2.2",
-    "babel-jest": "^29.3.1",
-    "husky": "^8.0.2",
-    "jest": "^29.3.1",
-    "jest-environment-jsdom": "^29.3.1",
-    "np": "^7.6.2",
-    "rollup": "^3.7.3",
-    "rollup-plugin-svelte": "^7.1.0",
-    "svelte": "^3.54.0",
-    "svelte-jester": "^2.3.2"
-  },
-  "peerDependencies": {
-    "svelte": "^3.0.0"
+    "dev": "vite dev",
+    "build": "vite build && npm run package",
+    "preview": "vite preview",
+    "package": "svelte-kit sync && svelte-package && publint",
+    "prepublishOnly": "npm run package",
+    "test": "npm run test:integration && npm run test:unit",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+    "lint": "eslint . --ext .js,.ts,.svelte",
+    "lint:fix": "eslint . --ext .js,.ts,.svelte --fix",
+    "test:integration": "playwright test",
+    "test:unit": "vitest --run",
+    "test:unit:watch": "vitest",
+    "release": "npm run package && np --no-yarn"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm test"
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js"
     }
   },
-  "keywords": [
-    "svelte",
-    "svelte-component",
-    "copyright",
-    "ui-component",
-    "svelte-copyright"
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
   ],
   "engines": {
-    "node": ">= 10"
+    "node": ">= 16"
+  },
+  "lint-staged": {
+    "*.ts": "eslint ./ --fix --quiet",
+    "*.svelte": "eslint ./ --fix --quiet"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/himynameisdave/svelte-copyright.git"
+  "peerDependencies": {
+    "svelte": "^4.0.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.37.0",
+    "@sveltejs/adapter-auto": "^2.0.0",
+    "@sveltejs/kit": "^1.22.6",
+    "@sveltejs/package": "^2.2.1",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
+    "eslint": "^8.47.0",
+    "eslint-config-himynameisdave": "^7.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-svelte": "^2.32.4",
+    "eslint-plugin-unicorn": "^48.0.1",
+    "husky": "^8.0.3",
+    "less": "^4.2.0",
+    "lint-staged": "^14.0.0",
+    "np": "^8.0.4",
+    "publint": "^0.2.0",
+    "svelte": "^4.2.0",
+    "svelte-check": "^3.5.0",
+    "tslib": "^2.6.1",
+    "typescript": "^5.0.0",
+    "vite": "^4.4.9",
+    "vitest": "^0.34.1"
   },
-  "homepage": "https://github.com/himynameisdave/svelte-copyright",
-  "license": "MIT",
-  "sideEffects": false,
   "private": false
 }