@ultirequiem/leap-year 2.0.0 → 3.0.0

package/{types/mod.d.ts → lib/index.d.ts}

@@ -5,7 +5,7 @@
  *
  * @example
  * ```javascript
- * import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
+ * import { isLeapYear } from "@ultirequiem/leap-year";
  *
  * isLeapYear(2014); //=> false
  * isLeapYear(2016); //=> true
@@ -14,9 +14,9 @@
  * isLeapYear(new Date(2016, 1, 1)); //=> true
  * ```
  */
-export declare function isLeapYear(year?: DateLike): boolean;
-export declare function generateLeapYear(config: {
-    min?: number;
-    max?: DateLike;
-}): number[];
-export declare type DateLike = Date | number | string;
+export declare function isLeapYear(year?: Date | string | number): boolean;
+export declare function isLeapYear(year?: Date | string | number, returnValue?: boolean): {
+    year: number;
+    result: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnE,wBAAgB,UAAU,CACxB,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,EAC7B,WAAW,CAAC,EAAE,OAAO,GACpB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC"}

package/lib/index.js

@@ -0,0 +1,6 @@
+import { parseDateLike } from "./parse-date-like.js";
+export function isLeapYear(year = new Date(), returnValue = false) {
+    year = parseDateLike(year);
+    const result = (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
+    return returnValue ? { result, year } : result;
+}

package/lib/parse-date-like.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Get the (UTC) year out of anything date-like.
+ *
+ * @param value - A `Date`, a year as number or string, or a date string.
+ *
+ * @throws {@link TypeError}
+ *
+ * Thrown if the value cannot be turned into a year.
+ */
+export declare function parseDateLike(value: Date | string | number): number;
+//# sourceMappingURL=parse-date-like.d.ts.map

package/lib/parse-date-like.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-date-like.d.ts","sourceRoot":"","sources":["../src/parse-date-like.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAsBnE"}

package/lib/parse-date-like.js

@@ -0,0 +1,26 @@
+/**
+ * Get the (UTC) year out of anything date-like.
+ *
+ * @param value - A `Date`, a year as number or string, or a date string.
+ *
+ * @throws {@link TypeError}
+ *
+ * Thrown if the value cannot be turned into a year.
+ */
+export function parseDateLike(value) {
+    if (value instanceof Date) {
+        return value.getUTCFullYear();
+    }
+    if (typeof value === "number") {
+        return value;
+    }
+    const year = Number(value);
+    if (value.trim() !== "" && Number.isInteger(year)) {
+        return year;
+    }
+    const date = new Date(value);
+    if (Number.isNaN(date.getTime())) {
+        throw new TypeError(`Could not get a year out of "${value}".`);
+    }
+    return date.getUTCFullYear();
+}

package/package.json

@@ -1,40 +1,53 @@
 {
-  "module": "./esm/mod.js",
-  "main": "./script/mod.js",
-  "types": "./types/mod.d.ts",
   "name": "@ultirequiem/leap-year",
+  "version": "3.0.0",
   "description": "Check if a year is leap.",
-  "version": "2.0.0",
-  "license": "MIT",
-  "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/ultirequiem"
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
   },
-  "repository": "github:ultirequiem/@ultirequiem/leap-year",
-  "homepage": "https://leap-year.js.org",
-  "bugs": {
-    "url": "https://github.com/ultirequiem/@ultirequiem/leap-year/issues",
-    "email": "eliaz.bobadilladev@gmail.com"
+  "files": [
+    "lib/**/*"
+  ],
+  "engines": {
+    "node": ">=20"
   },
   "keywords": [
     "leap",
     "year",
     "date"
   ],
-  "exports": {
-    ".": {
-      "import": "./esm/mod.js",
-      "require": "./script/mod.js",
-      "types": "./types/mod.d.ts"
-    }
+  "license": "MIT",
+  "homepage": "https://leap-year.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UltiRequiem/leap-year.git"
   },
   "scripts": {
-    "test": "node test_runner.js"
+    "build": "tsc",
+    "lint": "eslint 'src/**/*.ts' && prettier --check 'src/**/*.ts'",
+    "fmt": "prettier --write 'src/**/*.ts'",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@types/node": "16.11.26",
-    "chalk": "4.1.2",
-    "@deno/shim-deno": "~0.4.3"
-  }
-}
+    "@types/node": "^26.6.5",
+    "@vitest/coverage-v8": "^5.0.5",
+    "eslint": "^10.13.0",
+    "eslint-plugin-tsdoc": "^0.5.4",
+    "eslint-plugin-unicorn": "^78.0.0",
+    "prettier": "^3.9.10",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.72.0",
+    "vitest": "^5.0.5"
+  },
+  "dependencies": {
+    "@ultirequiem/leap-year": "^2.1.0"
+  },
+  "packageManager": "pnpm@12.6.0"
+}

package/readme.md

@@ -0,0 +1,54 @@
+# leap-year
+
+[![npm](https://img.shields.io/npm/v/@ultirequiem/leap-year?logo=npm&color=cb3837)](https://www.npmjs.com/package/@ultirequiem/leap-year)
+[![npm downloads](https://img.shields.io/npm/dm/@ultirequiem/leap-year?color=cb3837)](https://www.npmjs.com/package/@ultirequiem/leap-year)
+[![CI](https://github.com/UltiRequiem/leap-year/actions/workflows/ci.yaml/badge.svg)](https://github.com/UltiRequiem/leap-year/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/UltiRequiem/leap-year/graph/badge.svg)](https://codecov.io/gh/UltiRequiem/leap-year)
+
+Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year),
+that's a calendar year that contains an additional day added to keep the
+calendar year synchronized with the astronomical year or seasonal year.
+
+## Usage
+
+ESM only, types included: the same import works in Node.js, Bun and browsers.
+
+```javascript
+import { isLeapYear } from "@ultirequiem/leap-year";
+
+isLeapYear(2014); //=> false
+isLeapYear(2016); //=> true
+isLeapYear("6 October 2006 00:07:00 GMT"); //=> false
+isLeapYear("2000"); //=> false
+isLeapYear(new Date(2016, 1, 1)); //=> true
+isLeapYear("13 December 400 00:07:00 GMT", true); //=> { year: 400, result: true }
+```
+
+## Related
+
+- [leap_year_utils](https://github.com/UltiRequiem/leap_year_utils): Utilities
+  around this package.
+
+- [parse_datelike](https://github.com/UltiRequiem/parse_datelike): Parse a
+  number/string/date to a number/string/date.
+
+- [leap-year-api](https://github.com/UltiRequiem/leap-year-api): A REST API to
+  know if a year is leap or not.
+
+## Support
+
+Open an Issue, I will check it as soon as possible 👀
+
+If you want to hurry me up a bit
+[send me a tweet](https://twitter.com/UltiRequiem) 😆
+
+Don't forget to star the repo ⭐
+
+## Versioning
+
+We use [Semantic Versioning](http://semver.org). For the versions available, see
+the [tags](https://github.com/UltiRequiem/leap-year/tags) 🏷️
+
+## Licence
+
+Licensed under the MIT License 📄

package/README.md

@@ -1,70 +0,0 @@
-# leap-year
-
-[![CI](https://github.com/UltiRequiem/leap-year/actions/workflows/ci.yaml/badge.svg)](https://github.com/UltiRequiem/leap-year/actions/workflows/ci.yaml)
-[![codecov](https://codecov.io/gh/ultirequiem/leap-year/branch/main/graph/badge.svg)](https://codecov.io/gh/ultirequiem/leap-year)
-[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/leap_year/mod.ts)
-
-![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fdep-count%2Fx%2Fleap_year%2Fmod.ts)
-![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Fupdates%2Fx%2Fleap_year%2Fmod.ts)
-[![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fleap_year%2Fmod.ts)](https://deno.land/x/leap_year)
-
-Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
-
-## Usage
-
-### [Deno 🚀](https://deno.land/x/leap_year)
-
-```javascript
-import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
-
-isLeapYear(2014); //=> false
-isLeapYear(2016); //=> true
-isLeapYear("6 October 2006 00:07:00 GMT"); //=> false
-isLeapYear("2000"); //=> false
-isLeapYear(new Date(2016, 1, 1)); //=> true
-```
-
-### [Node.js 🐢](https://www.npmjs.com/package/@ultirequiem/leap-year)
-
-```typescript
-import { isLeapYear } from "@ultirequiem/leap-year";
-```
-
-### [Browser 🕸](https://developer.mozilla.org/en-US/docs/Glossary/Browser)
-
-You can use any [CDN](https://en.wikipedia.org/wiki/Content_delivery_network)
-that you like.
-
-As an example, for
-[type module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
-👇
-
-- [SkyPack](https://cdn.skypack.dev/@ultirequiem/leap-year)
-
-Or for a plain
-[script tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) 🦔
-
-- [jsdelivr](https://cdn.jsdelivr.net/npm/@ultirequiem/leap-year)
-
-The API is the same on all this platforms.
-
-## API
-
-[Autogenerated Documentation](https://doc.deno.land/https://deno.land/x/leap_year/mod.ts)
-🚀
-
-## Support
-
-Open an Issue, I will check it a soon as possible 👀
-
-If you want to hurry me up a bit
-[send me a tweet](https://twitter.com/intent/tweet?text=%40UltiRequiem%20) 😆
-
-Consider [supporting me on Patreon](https://patreon.com/UltiRequiem) if you like
-my work 🚀
-
-Don't forget to start the repo ⭐
-
-## Licence
-
-Licensed under the MIT License.

package/esm/mod.js

@@ -1,40 +0,0 @@
-/**
- * Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
- *
- * @param year - Default: `new Date()`.
- *
- * @example
- * ```javascript
- * import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
- *
- * isLeapYear(2014); //=> false
- * isLeapYear(2016); //=> true
- * isLeapYear("6 October 2006 00:07:00 GMT") //=> false
- * isLeapYear("200"); //=> false
- * isLeapYear(new Date(2016, 1, 1)); //=> true
- * ```
- */
-export function isLeapYear(year = new Date()) {
-    year = internalParse(year);
-    return (year % 4 === 0 && year % 100 !== 0) ?? year % 400 === 0;
-}
-export function generateLeapYear(config) {
-    const { min = 0, max = new Date() } = config;
-    const maxYear = internalParse(max);
-    const leapYears = [];
-    for (let year = min; year <= maxYear; year++) {
-        if (isLeapYear(year)) {
-            leapYears.push(year);
-        }
-    }
-    return leapYears;
-}
-function internalParse(date) {
-    if (typeof date === "string") {
-        date = new Date(date);
-    }
-    if (!(date instanceof Date) && typeof date !== "number") {
-        throw new TypeError(`Expected "year" type to be "Date" | "number" | "string" and got ${typeof date}.`);
-    }
-    return date instanceof Date ? date.getUTCFullYear() : date;
-}

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/script/mod.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateLeapYear = exports.isLeapYear = void 0;
-/**
- * Check if a year is a [leap year](https://en.wikipedia.org/wiki/Leap_year).
- *
- * @param year - Default: `new Date()`.
- *
- * @example
- * ```javascript
- * import { isLeapYear } from "https://deno.land/x/leap_year/mod.ts";
- *
- * isLeapYear(2014); //=> false
- * isLeapYear(2016); //=> true
- * isLeapYear("6 October 2006 00:07:00 GMT") //=> false
- * isLeapYear("200"); //=> false
- * isLeapYear(new Date(2016, 1, 1)); //=> true
- * ```
- */
-function isLeapYear(year = new Date()) {
-    year = internalParse(year);
-    return (year % 4 === 0 && year % 100 !== 0) ?? year % 400 === 0;
-}
-exports.isLeapYear = isLeapYear;
-function generateLeapYear(config) {
-    const { min = 0, max = new Date() } = config;
-    const maxYear = internalParse(max);
-    const leapYears = [];
-    for (let year = min; year <= maxYear; year++) {
-        if (isLeapYear(year)) {
-            leapYears.push(year);
-        }
-    }
-    return leapYears;
-}
-exports.generateLeapYear = generateLeapYear;
-function internalParse(date) {
-    if (typeof date === "string") {
-        date = new Date(date);
-    }
-    if (!(date instanceof Date) && typeof date !== "number") {
-        throw new TypeError(`Expected "year" type to be "Date" | "number" | "string" and got ${typeof date}.`);
-    }
-    return date instanceof Date ? date.getUTCFullYear() : date;
-}

package/script/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}