feat: initial functionality ✨

JoshuaKGoldberg · JoshuaKGoldberg · commit 64a8331262e1 · 2025-03-14T13:40:47.000-04:00
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -19,7 +19,7 @@
 		}
 	],
 	"contributorsSortAlphabetically": true,
-	"projectName": "await-lazy-properties",
+	"projectName": "all-properties-lazy",
 	"projectOwner": "JoshuaKGoldberg",
 	"repoType": "github",
 	"commitConvention": "angular"
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for your interest in contributing to `await-lazy-properties`! 💖
+Thanks for your interest in contributing to `all-properties-lazy`! 💖
 
 > After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
 
@@ -10,7 +10,7 @@ This project contains a [Contributor Covenant code of conduct](./CODE_OF_CONDUCT
 
 ## Reporting Issues
 
-Please do [report an issue on the issue tracker](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
+Please do [report an issue on the issue tracker](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
 
 ## Sending Contributions
 
@@ -22,8 +22,8 @@ There are two steps involved:
 
 ### Finding an Issue
 
-With the exception of very small typos, all changes to this repository generally need to correspond to an [unassigned open issue marked as `status: accepting prs` on the issue tracker](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
-If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
+With the exception of very small typos, all changes to this repository generally need to correspond to an [unassigned open issue marked as `status: accepting prs` on the issue tracker](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
+If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
 If the issue you'd like to fix isn't found on the issue, see [Reporting Issues](#reporting-issues) for filing your own (please do!).
 
 #### Issue Claiming
@@ -42,7 +42,7 @@ Be sure to fill out the pull request template's requested information -- otherwi
 PRs are also expected to have a title that adheres to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0).
 Only PR titles need to be in that format, not individual commits.
 Don't worry if you get this wrong: you can always change the PR title after sending it.
-Check [previously merged PRs](https://github.com/JoshuaKGoldberg/await-lazy-properties/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
+Check [previously merged PRs](https://github.com/JoshuaKGoldberg/all-properties-lazy/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
 
 #### Draft PRs
 
diff --git a/.github/DEVELOPMENT.md b/.github/DEVELOPMENT.md
@@ -3,8 +3,8 @@
 After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo) and [installing pnpm](https://pnpm.io/installation):
 
 ```shell
-git clone https://github.com/(your-name-here)/await-lazy-properties
-cd await-lazy-properties
+git clone https://github.com/(your-name-here)/all-properties-lazy
+cd all-properties-lazy
 pnpm install
 ```
 
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,5 @@
 <!-- Note: Please must use one of our issue templates to file an issue! 🛑 -->
-<!-- 👉 https://github.com/JoshuaKGoldberg/await-lazy-properties/issues/new/choose 👈 -->
+<!-- 👉 https://github.com/JoshuaKGoldberg/all-properties-lazy/issues/new/choose 👈 -->
 <!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->
 
 <!-- This blank issue template is only for issues that don't fit any of the templates. -->
diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:
diff --git a/.github/ISSUE_TEMPLATE/02-documentation.yml b/.github/ISSUE_TEMPLATE/02-documentation.yml
@@ -5,7 +5,7 @@ body:
       options:
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:
diff --git a/.github/ISSUE_TEMPLATE/03-feature.yml b/.github/ISSUE_TEMPLATE/03-feature.yml
@@ -5,7 +5,7 @@ body:
       options:
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:
diff --git a/.github/ISSUE_TEMPLATE/04-tooling.yml b/.github/ISSUE_TEMPLATE/04-tooling.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,12 @@
-<!-- 👋 Hi, thanks for sending a PR to await-lazy-properties! 💖.
+<!-- 👋 Hi, thanks for sending a PR to all-properties-lazy! 💖.
 Please fill out all fields below and make sure each item is true and [x] checked.
 Otherwise we may not be able to review your PR. -->
 
 ## PR Checklist
 
 - [ ] Addresses an existing open issue: fixes #000
-- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/await-lazy-properties/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
-- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/await-lazy-properties/blob/main/.github/CONTRIBUTING.md) were taken
+- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/all-properties-lazy/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
+- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/all-properties-lazy/blob/main/.github/CONTRIBUTING.md) were taken
 
 ## Overview
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -56,7 +56,9 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/prepare
       - run: pnpm run test --coverage
-      - if: always()
+      - env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        if: always()
         uses: codecov/codecov-action@v3
   type_check:
     name: Type Check
diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
@@ -14,8 +14,8 @@ jobs:
 
             The release is available on:
 
-            * [GitHub releases](https://github.com/JoshuaKGoldberg/await-lazy-properties/releases/tag/{release_tag})
-            * [npm package (@latest dist-tag)](https://www.npmjs.com/package/await-lazy-properties/v/${{ env.npm_version }})
+            * [GitHub releases](https://github.com/JoshuaKGoldberg/all-properties-lazy/releases/tag/{release_tag})
+            * [npm package (@latest dist-tag)](https://www.npmjs.com/package/all-properties-lazy/v/${{ env.npm_version }})
 
             Cheers! 📦🚀
 
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-<h1 align="center">Await Lazy Properties</h1>
+<h1 align="center">All Properties Lazy</h1>
 
 <p align="center">
 	Evalutes the properties of an object, including functions, Promises, and their combination.
@@ -11,25 +11,41 @@
 	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 1" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-1-21bb42.svg" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 	<!-- prettier-ignore-end -->
-	<a href="https://github.com/JoshuaKGoldberg/await-lazy-properties/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
-	<a href="https://codecov.io/gh/JoshuaKGoldberg/await-lazy-properties" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/await-lazy-properties?label=%F0%9F%A7%AA%20coverage" /></a>
-	<a href="https://github.com/JoshuaKGoldberg/await-lazy-properties/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
-	<a href="http://npmjs.com/package/await-lazy-properties"><img alt="📦 npm version" src="https://img.shields.io/npm/v/await-lazy-properties?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/all-properties-lazy/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://codecov.io/gh/JoshuaKGoldberg/all-properties-lazy" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/all-properties-lazy?label=%F0%9F%A7%AA%20coverage" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/all-properties-lazy/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
+	<a href="http://npmjs.com/package/all-properties-lazy"><img alt="📦 npm version" src="https://img.shields.io/npm/v/all-properties-lazy?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
 	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>
 
 ## Usage
 
 ```shell
-npm i await-lazy-properties
+npm i all-properties-lazy
 ```
 
 ```ts
-import { greet } from "await-lazy-properties";
+import { allPropertiesLazy } from "all-properties-lazy";
 
-greet("Hello, world! 💖");
+await allPropertiesLazy({
+	immediate: "immediate",
+	lazy: () => "lazy",
+	lazyAsync: async () => {
+		await Promise.resolve();
+		return "lazy async";
+	},
+	promise: Promise.resolve("promise"),
+});
 ```
 
+Retrieves all properties of an object, factoring in lazy properties.
+Properties can be:
+
+- Immediate: a direct value
+- Lazy: a function for a value
+- Lazy and asynchronous: a function that returns a Promise
+- Promise: a direct Promise
+
 ## Development
 
 See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
@@ -44,7 +60,7 @@ Thanks! 💖
 <table>
   <tbody>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/await-lazy-properties/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#content-JoshuaKGoldberg" title="Content">🖋</a> <a href="https://github.com/JoshuaKGoldberg/await-lazy-properties/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#projectManagement-JoshuaKGoldberg" title="Project Management">📆</a> <a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/all-properties-lazy/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#content-JoshuaKGoldberg" title="Content">🖋</a> <a href="https://github.com/JoshuaKGoldberg/all-properties-lazy/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#projectManagement-JoshuaKGoldberg" title="Project Management">📆</a> <a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a></td>
     </tr>
   </tbody>
 </table>
diff --git a/cspell.json b/cspell.json
@@ -15,7 +15,7 @@
 		"apexskier",
 		"automerge",
 		"Await",
-		"await-lazy-properties",
+		"all-properties-lazy",
 		"dependencies",
 		"description",
 		"devDependencies",
diff --git a/eslint.config.js b/eslint.config.js
@@ -61,7 +61,7 @@ export default tseslint.config(
 		rules: {
 			"n/no-missing-import": [
 				"error",
-				{ allowModules: ["await-lazy-properties"] },
+				{ allowModules: ["all-properties-lazy"] },
 			],
 		},
 	},
diff --git a/package.json b/package.json
@@ -1,10 +1,10 @@
 {
-	"name": "await-lazy-properties",
+	"name": "all-properties-lazy",
 	"version": "0.0.0",
 	"description": "Evalutes the properties of an object, including functions, Promises, and their combination. 😴",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/JoshuaKGoldberg/await-lazy-properties.git"
+		"url": "git+https://github.com/JoshuaKGoldberg/all-properties-lazy.git"
 	},
 	"license": "MIT",
 	"author": {
@@ -34,6 +34,9 @@
 	"lint-staged": {
 		"*": "prettier --ignore-unknown --write"
 	},
+	"dependencies": {
+		"without-undefined-properties": "^0.1.1"
+	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.4.1",
 		"@eslint/js": "9.21.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/allPropertiesLazy.test.ts b/src/allPropertiesLazy.test.ts
@@ -0,0 +1,49 @@
+import { describe, expect, it } from "vitest";
+
+import { allPropertiesLazy } from "./allPropertiesLazy.js";
+
+describe("allPropertiesLazy", () => {
+	it("returns a property directly when it is not a function", async () => {
+		const actual = await allPropertiesLazy({ value: "abc" });
+
+		expect(actual).toEqual({ value: "abc" });
+	});
+
+	it("returns a property's return directly when it is a function", async () => {
+		const actual = await allPropertiesLazy({ value: () => "abc" });
+
+		expect(actual).toEqual({ value: "abc" });
+	});
+
+	it("returns a property's resolved result directly when it is a Promise", async () => {
+		const actual = await allPropertiesLazy({ value: Promise.resolve("abc") });
+
+		expect(actual).toEqual({ value: "abc" });
+	});
+
+	it("returns a property's await return when it is an asynchronous function", async () => {
+		const actual = await allPropertiesLazy({
+			value: () => Promise.resolve("abc"),
+		});
+
+		expect(actual).toEqual({ value: "abc" });
+	});
+
+	it("starts tasks immediately when multiple properties are asynchronous functions", async () => {
+		let iteration = 0;
+
+		async function returnStartIteration() {
+			const current = iteration;
+			await Promise.resolve();
+			iteration += 1;
+			return current;
+		}
+
+		const actual = await allPropertiesLazy({
+			first: returnStartIteration,
+			second: returnStartIteration,
+		});
+
+		expect(actual).toEqual({ first: 0, second: 0 });
+	});
+});
diff --git a/src/allPropertiesLazy.ts b/src/allPropertiesLazy.ts
@@ -0,0 +1,49 @@
+import { withoutUndefinedProperties } from "without-undefined-properties";
+
+import { AwaitedLazyProperties } from "./types.js";
+
+export async function allPropertiesLazy<T extends object>(
+	source: T,
+): Promise<AwaitedLazyProperties<T>> {
+	const result: Record<string, unknown> = {};
+	const tasks: Promise<void>[] = [];
+
+	for (const [key, creator] of Object.entries(source)) {
+		if (creator instanceof Promise) {
+			tasks.push(
+				creator.then((awaited) => {
+					result[key] = awaited;
+				}),
+			);
+		}
+
+		if (!isFunction(creator)) {
+			result[key] = creator;
+			continue;
+		}
+
+		const task = creator();
+
+		if (task instanceof Promise) {
+			tasks.push(
+				task.then((awaited) => {
+					result[key] = awaited;
+				}),
+			);
+		} else if (task !== undefined) {
+			result[key] = task;
+		}
+	}
+
+	await Promise.all(tasks);
+
+	return withoutUndefinedProperties(result) as AwaitedLazyProperties<T>;
+}
+
+/**
+ * This is technically not correct, as `creator` could be a class constructor.
+ * There's no good way to detect that though.
+ */
+function isFunction(creator: unknown): creator is () => unknown {
+	return typeof creator === "function";
+}
diff --git a/src/greet.test.ts b/src/greet.test.ts
diff --git a/src/greet.ts b/src/greet.ts
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/types.ts b/src/types.ts
diff --git a/vitest.config.ts b/vitest.config.ts

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`}`
`20`	`20`	`],`
`21`	`21`	`"contributorsSortAlphabetically": true,`
`22`		`- "projectName": "await-lazy-properties",`
	`22`	`+ "projectName": "all-properties-lazy",`
`23`	`23`	`"projectOwner": "JoshuaKGoldberg",`
`24`	`24`	`"repoType": "github",`
`25`	`25`	`"commitConvention": "angular"`