feat: introduce oldest, deprecate earliest (#77)

Signed-off-by: Tierney Cyren <[email protected]>

.github/workflows/lint-earliest.yml → .github/workflows/lint-oldest.yml

@@ -1,10 +1,10 @@
-name: "Test Suite: Linter (earliest)"
+name: "Test Suite: Linter (oldest)"
 
 on:
   push:
   pull_request:
     paths:
-        - 'earliest/**'
+        - 'oldest/**'
     branches:
       - main
   workflow_dispatch:
@@ -21,7 +21,7 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: current
-    - name: Run npm install -w earliest
-      run: npm install -w earliest
-    - name: Run npm run lint -w earliest
-      run: npm run lint -w earliest
+    - name: Run npm install -w oldest
+      run: npm install -w oldest
+    - name: Run npm run lint -w oldest
+      run: npm run lint -w oldest

.github/workflows/tests-earliest.yml → .github/workflows/tests-oldest.yml

@@ -1,9 +1,9 @@
-name: "Test Suite: @nodevu/core"
+name: "Test Suite: @nodevu/oldest"
 
 on:
   pull_request:
     paths:
-      - 'earliest/**'
+      - 'oldest/**'
     branches:
       - main
   workflow_dispatch:
@@ -25,7 +25,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - name: Install most recent npm
       run: npm install -g npm
-    - name: Run npm install -w earliest
-      run: npm install -w earliest
-    - name: Run npm test -w earliest
-      run: npm test -w earliest
+    - name: Run npm install -w oldest
+      run: npm install -w oldest
+    - name: Run npm test -w oldest
+      run: npm test -w oldest

README.md

@@ -8,7 +8,8 @@ nodevu is composed of a set of modules:
   * [core](./core/): this is the core, online-only module. It calls out to sources that have version information about Node.js and does the heavy lifting of coercion, merging, and reasoning about that data into a format that is easily accessible and (hopefully!) extremely useful. It transparently provides data from the sources it fetches from, but also adds additional useufl context that it figures out based on time, context, and other signals.
   * [static](./static/): this is the offline-only version of nodevu. It's simply an interface to both the full context of [core](./core/), in addition to a few subsets of the data core provides. It is automatically updated when there's new information available, though there aren't gaurantees on when that will be available. This is mostly useful if you're not particularly picky about when your version information is availble.
 - Additional Utilities
-  * [earliest](./earliest/): this is a utility for finding the earliest LTS or Security release in a Node.js release line.
+  * [oldest](./oldest/): this is a utility for finding the oldest LTS or Security release in a Node.js release line.
+  * [newest](./newest/): this is a utility for finding the newest LTS or Security release in a Node.js release line.
   * [ranges](./ranges/): a module that provides information about ranges of Node.js versions.
   * [aliases](./aliases/): a module that provides information about aliases for Node.js versions.
 - Helper Modules

oldest/README.md

@@ -0,0 +1,31 @@
+# @nodevu/oldest
+
+A module that returns oldest LTS or Security release of a given Node.js release line.
+
+## Usage
+
+```js
+const { oldest } = require('@nodevu/oldest')
+
+const oldestLts = oldest('v16', 'lts')
+const oldestSecurity = oldest('v16', 'security')
+```
+
+```js
+const { lts, security } = require('@nodevu/oldest')
+
+const oldestLts = oldest('v16', 'lts')
+const oldestSecurity = oldest('v16', 'security')
+```
+
+## API
+
+This module exports three functions:
+
+- `oldest(name, type)`
+  - `name` (string): Node.js release line name. Examples: `v16`, `v11`, `v8`, `v0.10`.
+  - `type` (string): `lts` or `security`.
+- `lts(name)`
+  - `name` (string): Node.js release line name. Examples: `v16`, `v11`, `v8`, `v0.10`.
+- `security(name)`
+  - `name` (string): Node.js release line name. Examples: `v16`, `v11`, `v8`, `v0.10`.

earliest/index.js → oldest/index.js

@@ -1,6 +1,6 @@
 const nodevu = require('@nodevu/core');
 
-async function earliest(name, type) {
+async function oldest(name, type) {
 	const data = await nodevu();
 
 	if (type === 'lts') {
@@ -13,13 +13,13 @@ async function earliest(name, type) {
 }
 
 async function lts(name) {
-	return await earliest(name, 'lts');
+	return await oldest(name, 'lts');
 }
 
 async function security(name) {
-	return await earliest(name, 'security');
+	return await oldest(name, 'security');
 }
 
-module.exports.earliest = earliest;
+module.exports.oldest = oldest;
 module.exports.lts = lts;
 module.exports.security = security;

earliest/package.json → oldest/package.json

@@ -1,7 +1,7 @@
 {
-	"name": "@nodevu/earliest",
+	"name": "@nodevu/oldest",
 	"version": "0.1.0",
-	"description": "a module that returns the earliest lts or security release of the release line passed.",
+	"description": "a module that returns the oldest lts or security release of the release line passed.",
 	"main": "index.js",
 	"files": ["index.js", "LICENSE"],
 	"scripts": {

earliest/test/test.js → oldest/test/test.js

@@ -1,16 +1,16 @@
 const assert = require('node:assert');
-const { earliest, lts, security } = require('../index');
+const { oldest, lts, security } = require('../index');
 const { describe, it } = require('node:test');
 
 describe('check v10', async () => {
-	describe('running earliest', async () => {
+	describe('running oldest', async () => {
 		it('should return the correct security version for v10', async () => {
-			const data = await earliest('v10', 'security');
+			const data = await oldest('v10', 'security');
 			assert.equal(data, '10.14.0');
 		});
 
 		it('should return the correct lts version for v10', async () => {
-			const data = await earliest('v10', 'lts');
+			const data = await oldest('v10', 'lts');
 			assert.equal(data, '10.13.0');
 		});
 	});

package.json

@@ -25,7 +25,7 @@
 		"core",
 		"static",
 		"parsefiles",
-		"earliest",
+		"oldest",
 		"newest",
 		"ranges",
 		"aliases",